Источник данных — Elasticsearch (предварительный просмотр) (классика)

Применяется только к:Портал Foundry (классический). Эта статья недоступна для нового портала Foundry. Дополнительные сведения о новом портале.

Настраиваемые опции Elasticsearch при использовании Azure OpenAI на ваших данных. Этот источник данных поддерживается начиная с версии 2024-02-15-previewAPI.

Parameters

Параметры аутентификации

Azure OpenAI On Your Data поддерживает несколько типов аутентификации:

Опции аутентификации по ключу и идентификатору ключа

Опции аутентификации для Azure OpenAI на ваших данных при использовании ключа API.

Варианты аутентификации ключей API с кодированным кодом

Опции аутентификации для Azure OpenAI на ваших данных при использовании ключа API, закодированного Elasticsearch.

Источник векторизации имени развертывания

Детали источника векторизации, используемого Azure OpenAI On Your Data при применении векторного поиска. Этот источник векторизации основан на названии внутренней модели вложения в том же ресурсе Azure OpenAI. Этот источник векторизации позволяет использовать векторный поиск без API-ключа Azure OpenAI и без доступа к публичной сети Azure OpenAI.

Источник векторизации конечной точки

Детали источника векторизации, используемого Azure OpenAI On Your Data при применении векторного поиска. Этот источник векторизации основан на Azure OpenAI embedding API endpoint.

Опции аутентификации ключей API

Опции аутентификации для Azure OpenAI на ваших данных при использовании ключа API.

Источник векторизации ID модели

Детали источника векторизации, используемого Azure OpenAI On Your Data при применении векторного поиска. Этот источник векторизации основан на Elasticsearch model ID.

Опции отображения полей

Опциональные настройки для управления обработкой полей при использовании настроенного ресурса Elasticsearch.

Тип запроса

Тип поискового запроса Elasticsearch, который должен выполняться при использовании с Azure OpenAI On Your Data.

Примеры

Prerequisites:

• Настройте назначение ролей от пользователя к ресурсу Azure OpenAI. Обязательная роль: Cognitive Services OpenAI User.
• Установите Az CLI и запустите az login.
• Определим следующие переменные среды: AzureOpenAIEndpoint, ChatCompletionsDeploymentName, SearchEndpointIndexNameKeyKeyId.

export AzureOpenAIEndpoint=https://example.openai.azure.com/
export ChatCompletionsDeploymentName=turbo
export SearchEndpoint='https://example.eastus.azurecontainer.io'
export IndexName=testindex
export Key='***'
export KeyId='***'

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")
index_name = os.environ.get("IndexName")
search_endpoint = os.environ.get("SearchEndpoint")
key = os.environ.get("Key")
key_id = os.environ.get("KeyId")

token_provider = get_bearer_token_provider(
    DefaultAzureCredential(), "https://ai.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": "elasticsearch",
                "parameters": {
                    "endpoint": search_endpoint,
                    "index_name": index_name,
                    "authentication": {
                        "type": "key_and_key_id",
                        "key": key,
                        "key_id": key_id
                    }
                }
            }
        ]
    }
)

print(completion.model_dump_json(indent=2))

az rest --method POST \
 --uri $AzureOpenAIEndpoint/openai/deployments/$ChatCompletionsDeploymentName/chat/completions?api-version=2024-02-15-preview \
 --resource https://cognitiveservices.azure.com/ \
 --body \
'
{
    "data_sources": [
      {
        "type": "elasticsearch",
        "parameters": {
          "endpoint": "'$SearchEndpoint'",
          "index_name": "'$IndexName'",
          "authentication": {
            "type": "key_and_key_id",
            "key": "'$Key'",
            "key_id": "'$KeyId'"
          }
        }
      }
    ],
    "messages": [
      {
        "role": "user",
        "content": "Who is DRI?"
      }
    ]
}
'