promptflow.connections 模块#

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

基础：_StrongTypeAADSupportedConnection

Azure AI 服务连接。

Parameters:

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

Parameters:

  • api_key (str) – API密钥。

  • endpoint (str) – API端点。

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

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

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

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) – 连接名称。

TYPE = 'AzureOpenAI'#
property api_base#

返回连接API基础。

property api_type#

返回连接API类型。

property api_version#

返回连接API版本。

classmethod from_env(name=None)#

从环境变量构建连接。

Relevant environment variables:

  • AZURE_OPENAI_ENDPOINT: API的基础地址。

  • 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

认知搜索连接。

Parameters:

  • api_key (str) – API密钥。

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

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

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

  • name (str) – 连接名称。

TYPE = 'CognitiveSearch'#
property api_base#

返回连接API基础。

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)#

从提供者配置初始化连接提供者。

期望值： - 本地 - azureml://subscriptions//resourceGroups// providers/Microsoft.MachineLearningServices/workspaces/

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

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

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

基础：_Connection

自定义连接。

Parameters:

  • 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
Parameters:

  • 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

表单识别器连接。

Parameters:

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

Parameters:

  • api_key (str) – API密钥。

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

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

  • name (str) – 连接名称。

TYPE = 'OpenAI'#
property base_url#

返回连接API基础。

classmethod from_env(name=None)#

从环境变量构建连接。

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

property organization#

返回连接组织。

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

基础：_StrongTypeConnection

Serp 连接。

Parameters:

  • api_key (str) – API密钥。

  • name (str) – 连接名称。

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

基础：_StrongTypeConnection

无服务器连接。

Parameters:

  • api_key (str) – API密钥。

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

  • name (str) – 连接名称。

TYPE = 'Serverless'#
property api_base#

返回连接API基础。