通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

数据源 - Azure 机器学习索引（预览版）

  • 项目

使用基于自有数据的 Azure OpenAI 时的 Azure 机器学习索引的可配置选项。 API 版本 2024-02-15-preview 支持此数据源。

名称 类型​​ 必需 说明
parameters Parameters True 配置 Azure 机器学习索引时要使用的参数。
type string True 必须是 azure_ml_index。

参数

客户 类型​​ 必需 说明
project_resource_id 字符串 True Azure 机器学习项目的资源 ID。
name string True Azure 机器学习索引名称。
version string True Azure 机器学习索引的版本。
authentication AccessTokenAuthenticationOptions、SystemAssignedManagedIdentityAuthenticationOptions、UserAssignedManagedIdentityAuthenticationOptions 之一 True 访问定义的数据源时要使用的身份验证方法。
in_scope boolean False 是否应将查询限制为使用索引数据。 默认值为 True。
role_information string False 为模型提供有关它应该如何运行以及在生成回复时应引用的任何上下文的说明。 你可以描述助手的个性，告诉它如何设置回复的格式。
strictness integer False 搜索相关性筛选的已配置严格性。 严格度越高，精准率越高，但回复的召回率越低。 默认值为 3。
top_n_documents integer False 为配置的查询提供的已配置最多文档数。 默认值为 5。
filter string False 搜索筛选器。 仅当 Azure 机器学习索引的类型为 Azure 认知搜索时，才受支持。

访问令牌验证选项

使用访问令牌时，基于自有数据的 Azure OpenAI 的验证选项。

名称 类型​​ 必需 说明
access_token 字符串 True 要用于身份验证的访问令牌。
type string True 必须是 access_token。

系统分配的托管标识验证选项

使用系统分配的托管标识时，基于自有数据的 Azure OpenAI 的验证选项。

名称 类型​​ 必需 说明
type 字符串 True 必须是 system_assigned_managed_identity。

用户分配的托管标识验证选项

使用用户分配的托管标识时，基于自有数据的 Azure OpenAI 的验证选项。

名称 类型​​ 必需 说明
managed_identity_resource_id 字符串 True 用于进行身份验证的用户分配托管标识的资源 ID。
type string True 必须是 user_assigned_managed_identity。

示例

先决条件：

  • 配置从 Azure OpenAI 系统分配的托管标识到 Azure 机器学习工作区资源的角色分配。 必需的角色：AzureML Data Scientist。
  • 配置用户到 Azure OpenAI 资源的角色分配。 所需角色：Cognitive Services OpenAI User。
  • 安装 Az CLI 并运行 az login。
  • 定义以下环境变量：AzureOpenAIEndpoint、ChatCompletionsDeploymentName、ProjectResourceId、IndexName、IndexVersion。
  • 如果使用 MINGW，请运行 export MSYS_NO_PATHCONV=1。
export AzureOpenAIEndpoint=https://example.openai.azure.com/
export ChatCompletionsDeploymentName=turbo
export ProjectResourceId='/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/Microsoft.MachineLearningServices/workspaces/{workspace-id}'
export IndexName=testamlindex
export IndexVersion=2

安装最新的 pip 包 openai、azure-identity。

import os
from openai import AzureOpenAI
from azure.identity import DefaultAzureCredential, get_bearer_token_provider

endpoint = os.environ.get("AzureOpenAIEndpoint")
deployment = os.environ.get("ChatCompletionsDeploymentName")
project_resource_id = os.environ.get("ProjectResourceId")
index_name = os.environ.get("IndexName")
index_version = os.environ.get("IndexVersion")

token_provider = get_bearer_token_provider(
    DefaultAzureCredential(), "https://cognitiveservices.azure.com/.default")

client = AzureOpenAI(
    azure_endpoint=endpoint,
    azure_ad_token_provider=token_provider,
    api_version="2024-02-15-preview",
)

completion = client.chat.completions.create(
    model=deployment,
    messages=[
        {
            "role": "user",
            "content": "Who is DRI?",
        },
    ],
    extra_body={
        "data_sources": [
            {
                "type": "azure_ml_index",
                "parameters": {
                    "project_resource_id": project_resource_id,
                    "name": index_name,
                    "version": index_version,
                    "authentication": {
                        "type": "system_assigned_managed_identity"
                    },
                }
            }
        ]
    }
)

print(completion.model_dump_json(indent=2))