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

Aplica-se somente a:Portal de fundimento (clássico). Este artigo não está disponível para o novo portal do Foundry. Saiba mais sobre o novo portal.

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

Parameters

Authentication Options

O Azure OpenAI em seus dados dá suporte a vários tipos de autenticação:

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

As opções de autenticação do Azure OpenAI em seus dados ao usar uma chave de API.

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

As opções de autenticação do Azure OpenAI em seus dados ao usar uma chave de API codificada do Elasticsearch.

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

Os detalhes da fonte de vetor, usada pelo Azure OpenAI em seus dados ao aplicar a pesquisa de vetor. Essa fonte de vetorização baseia-se em um nome de implantação de modelo de inserções internas no mesmo recurso do Azure OpenAI. Essa fonte de vetorização permite que você use a pesquisa de vetor sem a chave de api do Azure OpenAI e sem acesso à rede pública do Azure OpenAI.

Origem de vetorização de ponto de extremidade

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

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

As opções de autenticação do Azure OpenAI em seus dados ao usar uma chave de API.

Origem da vetorização da ID do modelo

Os detalhes da fonte de vetor, usada pelo Azure OpenAI em seus dados ao aplicar a pesquisa de vetor. Essa origem de vetorização baseia-se na ID do modelo Elasticsearch.

Opções de mapeamento de campos

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

Query type

O tipo de consulta de recuperação do Elasticsearch que deve ser executada ao usá-la com o Azure OpenAI em seus dados.

Examples

Prerequisites:

• Configure as atribuições de função do usuário para o recurso do Azure OpenAI. Função necessária: Cognitive Services OpenAI User.
• Instalar a CLI do Az e executar 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?"
      }
    ]
}
'