promptflow.connections 模块#

class promptflow.connections.AzureAIServicesConnection(endpoint: str, api_key: Optional[str] = None, auth_mode: str = 'key', **kwargs)#

基类：_StrongTypeAADSupportedConnection

Azure AI 服务连接。

参数:

  • api_key (str) – API 密钥。

  • endpoint (str) – API 终结点。

  • auth_mode (str) – 身份验证模式，支持的值请参见：ConnectionAuthMode。

  • name (str) – 连接名称。

TYPE = 'AzureAIServices'#
property endpoint#

返回连接终结点。

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

基类：_StrongTypeConnection

Azure 内容安全连接。

参数:

  • api_key (str) – API 密钥。

  • endpoint (str) – API 终结点。

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

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

  • name (str) – 连接名称。

TYPE = 'AzureContentSafety'#
property api_type#

返回连接 API 类型。

property api_version#

返回连接 API 版本。

property endpoint#

返回连接终结点。

class promptflow.connections.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)#

基类：_StrongTypeAADSupportedConnection

Azure OpenAI 连接。

参数:

  • api_key (str) – API 密钥。

  • api_base (str) – API 基本 URL。

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

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

  • auth_mode (str) – 身份验证模式，支持的值请参见：ConnectionAuthMode。

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

  • name (str) – 连接名称。

TYPE = 'AzureOpenAI'#
property api_base#

返回连接 API 基本 URL。

property api_type#

返回连接 API 类型。

property api_version#

返回连接 API 版本。

classmethod from_env(name=None)#

从环境变量构建连接。

相关环境变量

  • AZURE_OPENAI_ENDPOINT：API 基本 URL。

  • AZURE_OPENAI_API_KEY：API 密钥。

  • OPENAI_API_VERSION：可选。

API 版本默认为 AZURE_OPEN_AI。

property resource_id#

返回连接资源 ID。

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

基类：_StrongTypeAADSupportedConnection

认知搜索连接。

参数:

  • api_key (str) – API 密钥。

  • api_base (str) – API 基本 URL。

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

  • auth_mode (str) – 身份验证模式，支持的值请参见：ConnectionAuthMode。

  • name (str) – 连接名称。

TYPE = 'CognitiveSearch'#
property api_base#

返回连接 API 基本 URL。

property api_version#

返回连接 API 版本。

class promptflow.connections.ConnectionProvider#

基类：ABC

用于列出/获取当前环境中连接的连接提供程序接口。

PROVIDER_CONFIG_KEY = 'PF_CONNECTION_PROVIDER'#
abstract get(name: str) → _Connection#

按名称获取连接。

classmethod get_instance(**kwargs) → ConnectionProvider#

获取当前环境中的连接提供程序实例。它将根据当前环境返回不同的实现。

classmethod init_from_provider_config(provider_config: str, credential=None)#

从提供程序配置初始化连接提供程序。

预期值：- local - azureml://subscriptions/<your-subscription>/resourceGroups/<your-resourcegroup>/providers/Microsoft.MachineLearningServices/workspaces/<your-workspace>

abstract list(**kwargs) → List[_Connection]#

列出所有不包含机密的连接。

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

基类：_Connection

自定义连接。

参数:

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

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

  • name (str) – 连接名称

TYPE = 'Custom'#
is_secret(item)#

检查项是否为机密。

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

基类：_Connection

自定义强类型连接。

注意

此连接类型不应直接使用。以下是 CustomStrongTypeConnection 的使用示例

class MyCustomConnection(CustomStrongTypeConnection):
    api_key: Secret
    api_base: str
参数:

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

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

  • name (str) – 连接名称

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

基类：AzureContentSafetyConnection

表单识别器连接。

参数:

  • api_key (str) – API 密钥。

  • endpoint (str) – API 终结点。

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

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

  • name (str) – 连接名称。

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

基类：_StrongTypeConnection

OpenAI 连接。

参数:

  • api_key (str) – API 密钥。

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

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

  • name (str) – 连接名称。

TYPE = 'OpenAI'#
property base_url#

返回连接 API 基本 URL。

classmethod from_env(name=None)#

从环境变量构建连接。

相关环境变量：- OPENAI_API_KEY：API 密钥。- OPENAI_ORG_ID：可选。用于 API 请求的组织的唯一标识符。- OPENAI_BASE_URL：可选。在使用自定义 API 基本 URL 时指定，留空则使用 OpenAI 默认 API 基本 URL。

property organization#

返回连接组织。

class promptflow.connections.SerpConnection(api_key: str, **kwargs)#

基类：_StrongTypeConnection

Serp 连接。

参数:

  • api_key (str) – API 密钥。

  • name (str) – 连接名称。

TYPE = 'Serp'#
class promptflow.connections.ServerlessConnection(api_key: str, api_base: str, **kwargs)#

基类：_StrongTypeConnection

无服务器连接。

参数:

  • api_key (str) – API 密钥。

  • api_base (str) – API 基本 URL。

  • name (str) – 连接名称。

TYPE = 'Serverless'#
property api_base#

返回连接 API 基本 URL。