Fonte de dados – Elasticsearch (versão prévia)

As opções configuráveis do Elasticsearch ao usar o Azure OpenAI em seus dados. Essa fonte de dados tem suporte na versão da API 2024-02-15-preview.

Parâmetros

Opções de autenticação de chave e ID de chave

As opções de autenticação do Azure OpenAI On Your Data ao usar uma chave de API.

Opções de autenticação de chave de API codificada

As opções de autenticação para Azure OpenAI On Your Data ao usar uma chave de API codificada pelo Elasticsearch.

Origem da vetorização do nome da implantação

Os detalhes da fonte de vetorização, usada pelo OpenAI do Azure em seus dados ao aplicar a busca em vetores. Essa fonte de vetorização baseia-se em um nome de implantação de modelo de incorporação interno no mesmo recurso do OpenAI do Azure. A fonte de vetorização permite que você use a busca em vetores sem uma chave de API do OpenAI do Azure e sem acesso à rede pública do OpenAI do Azure.

A fonte da vetorização do ponto de extremidade

Os detalhes da fonte de vetorização, usada pelo OpenAI do Azure em seus dados ao aplicar a busca em vetores. Essa fonte de vetorização baseia-se no ponto de extremidade da API de incorporação do OpenAI do Azure.

Fonte de vetorização do ID do modelo

Os detalhes da fonte de vetorização, usada pelo OpenAI do Azure em seus dados ao aplicar a busca em vetores. Essa fonte de vetorização é baseada no ID do modelo Elasticsearch.

Opções de autenticação da chave de API

As opções de autenticação do Azure OpenAI On Your Data ao usar uma chave de API.

Opções de mapeamento de campos

Configurações opcionais para controlar como os campos são processados ao usar um recurso Elasticsearch configurado.

Tipo de consulta

O tipo de consulta de recuperação do Elasticsearch que deve ser executada ao usá-la com o Azure OpenAI On Your Data.

Exemplos

Pré-requisitos:

• Configure as atribuições de função do usuário para o recurso de OpenAI do Azure. Função necessária: Cognitive Services OpenAI User.
• Instale Az CLI e execute az login.
• Defina as seguintes variáveis de ambiente: AzureOpenAIEndpoint, ChatCompletionsDeploymentName, SearchEndpoint, IndexName, Key, KeyId.

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://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": "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?"
      }
    ]
}
'