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 内容安全连接。

参数:

• api_key (str) – API 密钥。

• endpoint (str) – API 终结点。

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

• api_type (str) – API 类型，默认“Content Safety”。

• 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 连接。

参数:

• 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

认知搜索连接。

参数:

• 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

自定义连接。

参数:

• 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

流上下文实体。此上下文中的设置将在执行流时应用。

参数:

• connections (Optional[Dict[str, Dict]]) – 流的连接。

• variant (Optional[Dict[str, Dict]]) – 流的变体。

• variant – 流的重写。

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

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

基类：FormRecognizerConnection, AzureContentSafetyConnection

表单识别器连接。

参数:

• 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 连接。

参数:

• 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 连接。

参数:

• 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[Run, 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

流运行实体。

参数:

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

• name (str) – 运行名称。

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

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

• run (Optional[Union[Run, str]]) – 父运行或运行 ID。

• column_mapping (Optional[dict]) – 运行的列映射。可选，因为它不存储在数据库中。

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

• description (Optional[str]) – 运行的描述。

• tags (Optional[List[Dict[str, str]]]) – 运行的标签。

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

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

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

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

• environment_variables (Optional[Dict[str, str]]) – 运行的环境变量。

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

• properties (Optional[Dict[str, Any]]) – 运行的属性。

• init (Optional[Dict[str, Any]]) – 可调用类的类初始化参数，仅支持弹性流。

• kwargs (Optional[dict]) – 附加关键字参数。

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 连接。

参数:

• api_key (str) – API 密钥。

• name (str) – 连接名称。

DATA_CLASS

的别名 SerpConnection