Fonte de dados - Elasticsearch (pré-visualização) (clássico)

Aplica-se apenas a:Portal da fundição (clássico). Este artigo não está disponível para o novo portal da Foundry. Saiba mais sobre o novo portal.

As opções configuráveis para Elasticsearch ao usar Azure OpenAI On Your Data. Esta fonte de dados é suportada a partir da versão 2024-02-15-previewda API.

Parameters

Authentication Options

O Azure OpenAI On Your Data suporta múltiplos tipos de autenticação:

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

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

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

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

Fonte de vetorização de nomes de implementação

Os detalhes da fonte de vetorização, usados pelo Azure OpenAI On Your Data ao aplicar a pesquisa vetorial. Esta fonte de vetorização baseia-se num nome de implementação de modelo interno de embeddings no mesmo recurso Azure OpenAI. Esta fonte de vetorização permite-lhe usar pesquisa vetorial sem a chave API Azure OpenAI e sem acesso à rede pública Azure OpenAI.

Fonte de vetorização do ponto final

Os detalhes da fonte de vetorização, usados pelo Azure OpenAI On Your Data ao aplicar a pesquisa vetorial. Esta fonte de vetorização baseia-se no endpoint da API de embedding Azure OpenAI.

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

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

Fonte de vetorização do ID do modelo

Os detalhes da fonte de vetorização, usados pelo Azure OpenAI On Your Data ao aplicar a pesquisa vetorial. Esta fonte de vetorização baseia-se no ID do modelo Elasticsearch.

Opções de mapeamento de campos

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

Query type

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

Examples

Prerequisites:

• Configure as atribuições de funções do utilizador para o recurso Azure OpenAI. Função obrigatória: Cognitive Services OpenAI User.
• Instale o 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://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?"
      }
    ]
}
'