promptflow.entities 模块#

class promptflow.entities.AzureContentSafetyConnection(api_key: str, endpoint: str, api_version: str = '2023-10-01', api_type: str = 'Content Safety', **kwargs)#

基础类: AzureContentSafetyConnection, _StrongTypeConnection

Azure 内容安全连接。

Parameters:

  • api_key (str) – API密钥。

  • endpoint (str) – API端点。

  • api_version (str) – API版本，默认参见：AZURE_CONTENT_SAFETY。

  • api_type (str) – API类型，默认为“内容安全”。

  • name (str) – 连接名称。

DATA_CLASS#

AzureContentSafetyConnection 的别名

class promptflow.entities.AzureOpenAIConnection(api_base: str, api_key: Optional[str] = None, api_type: str = 'azure', api_version: str = '2024-02-01', auth_mode: str = 'key', resource_id: Optional[str] = None, **kwargs)#

基础：AzureOpenAIConnection, _StrongTypeConnection

Azure OpenAI 连接。

Parameters:

  • api_key (str) – API密钥。

  • api_base (str) – API基础地址。

  • api_type (str) – API类型，默认为“azure”。

  • api_version (str) – API版本，默认参见：AZURE_OPEN_AI

  • auth_mode (str) – 认证模式，支持的取值参见：ConnectionAuthMode。

  • resource_id (str) – 可选的，ARM资源ID。

  • name (str) – 连接名称。

DATA_CLASS#

AzureOpenAIConnection 的别名

class promptflow.entities.CognitiveSearchConnection(api_base: str, api_key: Optional[str] = None, api_version: str = '2023-11-01', auth_mode: str = 'key', **kwargs)#

基础类: CognitiveSearchConnection, _StrongTypeConnection

认知搜索连接。

Parameters:

  • api_key (str) – API密钥。

  • api_base (str) – API基础地址。

  • api_version (str) – API版本，默认为“2023-11-01”。

  • auth_mode (str) – 认证模式，支持的取值参见：ConnectionAuthMode。

  • name (str) – 连接名称。

DATA_CLASS#

CognitiveSearchConnection 的别名

class promptflow.entities.CustomConnection(secrets: Dict[str, str], configs: Optional[Dict[str, str]] = None, **kwargs)#

基础类: CustomConnection, _Connection

自定义连接。

Parameters:

  • configs (Dict[str, str]) – 配置项的键值对。

  • secrets (Dict[str, str]) – 密钥键值对。

  • name (str) – 连接名称

DATA_CLASS#

CustomConnection 的别名

class promptflow.entities.DynamicList(function: dataclasses.InitVar[Union[str, Callable]], input_mapping: dataclasses.InitVar[Dict] = None)#

基础类: object

func_kwargs: List#
func_path: str#
function: dataclasses.InitVar[Union[str, Callable]]#

动态列表功能。

input_mapping: dataclasses.InitVar[Dict] = None#

动态列表函数输入与工具输入之间的映射关系。

class promptflow.entities.FlowContext(*, connections=None, variant=None, overrides=None, streaming=None)#

基础类: object

流程上下文实体。执行时，此上下文上的设置将应用于流程。

Parameters:

  • connections (可选[字典[字符串, 字典]]) – 流的连接。

  • variant (可选[Dict[str, Dict]]) – 流程的变体。

  • variant – 流程的覆盖。

  • streaming (可选[bool]) – 流的输出是否需要以流模式返回。

class promptflow.entities.FormRecognizerConnection(api_key: str, endpoint: str, api_version: str = '2023-07-31', api_type: str = 'Form Recognizer', **kwargs)#

基础：FormRecognizerConnection, AzureContentSafetyConnection

表单识别器连接。

Parameters:

  • api_key (str) – API密钥。

  • endpoint (str) – API端点。

  • api_version (str) – API版本，默认参见：FORM_RECOGNIZER。

  • api_type (str) – API类型，默认为“Form Recognizer”。

  • name (str) – 连接名称。

DATA_CLASS#

FormRecognizerConnection 的别名

class promptflow.entities.InputSetting(**kwargs)#

基础类: object

工具输入的设置

allow_manual_entry: bool = None#

允许用户手动输入值。

dynamic_list: DynamicList = None#

动态列表功能的设置。

enabled_by: str = None#

输入字段必须是枚举类型，用于控制依赖输入字段的可见性。

enabled_by_value: List = None#

定义从 enabled_by 字段接受的枚举值，这些值将使此依赖输入字段可见。

generated_by: GeneratedBy = None#

由函数生成的设置。

is_multi_select: bool = None#

允许用户选择多个值。

class promptflow.entities.OpenAIConnection(api_key: str, organization: Optional[str] = None, base_url=None, **kwargs)#

基础类: OpenAIConnection, _StrongTypeConnection

OpenAI 连接。

Parameters:

  • api_key (str) – API密钥。

  • organization (str) – 可选。您组织的唯一标识符，可用于API请求。

  • base_url (str) – 可选。使用自定义API基础时指定，留空则使用OpenAI默认的API基础。

  • name (str) – 连接名称。

DATA_CLASS#

OpenAIConnection 的别名

class promptflow.entities.QdrantConnection(api_key: str, api_base: str, **kwargs)#

基础类: QdrantConnection, _StrongTypeConnection

Qdrant 连接。

Parameters:

  • api_key (str) – API密钥。

  • api_base (str) – API基础地址。

  • name (str) – 连接名称。

DATA_CLASS#

QdrantConnection 的别名

class promptflow.entities.Run(flow: Optional[Union[str, Path]] = None, name: Optional[str] = None, data: Optional[str] = None, variant: Optional[str] = None, run: Optional[Union[运行, str]] = None, column_mapping: Optional[dict] = None, display_name: Optional[str] = None, description: Optional[str] = None, tags: Optional[List[Dict[str, str]]] = None, *, created_on: Optional[datetime] = None, start_time: Optional[datetime] = None, end_time: Optional[datetime] = None, status: Optional[str] = None, environment_variables: Optional[Dict[str, str]] = None, connections: Optional[Dict[str, Dict]] = None, properties: Optional[Dict[str, Any]] = None, source: Optional[Union[str, Path]] = None, init: Optional[Dict[str, Any]] = None, **kwargs)#

基础：YAMLTranslatableMixin

流程运行实体。

Parameters:

  • flow (Path) – 本地流条目或远程流的路径。

  • name (str) – 运行的名称。

  • data (Optional[str]) – 运行的输入数据。支持本地路径或远程URI（以azureml:或公共URL开头）。注意：远程URI仅支持云运行。# noqa: E501

  • variant (可选[str]) – 运行的变体。

  • run (可选[联合[Run, str]]) – 父运行或运行ID。

  • column_mapping (可选[字典]) – 运行的列映射。由于它不存储在数据库中，因此是可选的。

  • display_name (可选[str]) – 运行的显示名称。

  • 描述 (可选[str]) – 运行的描述。

  • tags (可选[列表[字典[str, str]]]) – 运行的标签。

  • created_on (可选[datetime.datetime]) – 运行创建的日期和时间。

  • start_time (可选[datetime.datetime]) – 运行开始的日期和时间。

  • end_time (可选[datetime.datetime]) – 运行结束的日期和时间。

  • status (可选[str]) – 运行的状态。

  • environment_variables (可选[字典[字符串, 字符串]]) – 运行的环境变量。

  • connections (可选[Dict[str, Dict]]) – 运行的连接。

  • properties (可选[字典[字符串, 任意类型]]) – 运行的属性。

  • init (可选[字典[字符串, 任意类型]]) – 可调用类的初始化参数，仅支持flex flow。

  • kwargs (可选[字典]) – 额外的关键字参数。

property created_on: str#
property init#
property properties: Dict[str, str]#
property status: str#
class promptflow.entities.SerpConnection(api_key: str, **kwargs)#

基础类: SerpConnection, _StrongTypeConnection

Serp 连接。

Parameters:

  • api_key (str) – API密钥。

  • name (str) – 连接名称。

DATA_CLASS#

SerpConnection 的别名