Source de données : Elasticsearch (préversion)

Options configurables d’Elasticsearch lors de l’utilisation d’Azure OpenAI sur vos données. Cette source de données est prise en charge à partir de la version 2024-02-15-preview de l’API.

Nom	Catégorie	Obligatoire	Descriptif
parameters	Paramètres	Vrai	Paramètres à utiliser lors de la configuration d’Elasticsearch.
type	ficelle	Vrai	Doit être elasticsearch.

Paramètres

Nom	Catégorie	Obligatoire	Descriptif
endpoint	ficelle	Vrai	Chemin d’accès du point de terminaison absolu de la ressource Elasticsearch à utiliser.
index_name	ficelle	Vrai	Nom de l’index à utiliser dans l’Elasticsearch référencée.
authentication	L’un parmi KeyAndKeyIdAuthenticationOptions, EncodedApiKeyAuthenticationOptions	Vrai	Méthode d’authentification à utiliser lors de l’accès à la source de données définie.
embedding_dependency	L’un parmi DeploymentNameVectorizationSource, EndpointVectorizationSource, ModelIdVectorizationSource	Faux	Dépendance d’incorporation pour la recherche vectorielle. Obligatoire quand query_type est vector.
fields_mapping	FieldsMappingOptions	Faux	Comportement de mappage de champs personnalisé à utiliser lors de l’interaction avec l’index de recherche.
in_scope	booléen	Faux	Indique si les requêtes doivent être limitées à l’utilisation de données indexées. La valeur par défaut est True.
query_type	QueryType	Faux	Type de requête à utiliser avec Elasticsearch. La valeur par défaut est simple
role_information	ficelle	Faux	Fournissez au modèle des instructions sur son comportement et sur tout contexte qu’il doit référencer en générant une réponse. Vous pouvez décrire la personnalité de l’assistant, lui dire ce qu’il doit et ne doit pas répondre, et lui indiquer comment formater les réponses.
strictness	entier	Faux	La rigueur configurée du filtrage de pertinence de la recherche. Plus la rigueur est élevée, plus la précision est élevée, mais plus faible sera le rappel de la réponse. La valeur par défaut est 3.
top_n_documents	entier	Faux	Le nombre maximal de documents à proposer pour la requête configurée. La valeur par défaut est 5.

Options d’authentification

Azure OpenAI sur vos données prend en charge plusieurs types d’authentification :

Options d’authentification de clé et d’ID de clé

Options d’authentification pour Azure OpenAI sur vos données lors de l’utilisation d’une clé API.

Nom	Catégorie	Obligatoire	Descriptif
key	ficelle	Vrai	Clé Elasticsearch à utiliser pour l’authentification.
key_id	ficelle	Vrai	ID de clé Elasticsearch à utiliser pour l’authentification.
type	ficelle	Vrai	Doit être key_and_key_id.

Options d’authentification de clé API encodées

Les options d’authentification d’Azure OpenAI sur vos données lors de l’utilisation d’une clé API encodée Elasticsearch.

Nom	Catégorie	Obligatoire	Descriptif
encoded_api_key	ficelle	Vrai	Clé API encodée Elasticsearch à utiliser pour l’authentification.
type	ficelle	Vrai	Doit être encoded_api_key.

Source de vectorisation du nom de déploiement

Détails de la source de vectorisation, utilisée par Azure OpenAI sur vos données lors de l’application de la recherche vectorielle. Cette source de vectorisation est basée sur un nom de déploiement de modèle d’incorporation interne dans la même ressource Azure OpenAI. Cette source de vectorisation vous permet d’utiliser la recherche vectorielle sans clé API Azure OpenAI et sans accès au réseau public Azure OpenAI.

Nom	Catégorie	Obligatoire	Descriptif
deployment_name	ficelle	Vrai	Nom de déploiement du modèle d’incorporation dans la même ressource Azure OpenAI.
type	ficelle	Vrai	Doit être deployment_name.

Source de vectorisation du point de terminaison

Détails de la source de vectorisation, utilisée par Azure OpenAI sur vos données lors de l’application de la recherche vectorielle. Cette source de vectorisation est basée sur le point de terminaison de l'API d'intégration Azure OpenAI.

Nom	Catégorie	Obligatoire	Descriptif
endpoint	ficelle	Vrai	Spécifie l'URL du point de terminaison de la ressource à partir duquel les éléments intégrés doivent être récupérés. Il doit être au format https://{YOUR_RESOURCE_NAME}.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/embeddings. Le paramètre de requête api-version n’est pas autorisée.
authentication	ApiKeyAuthenticationOptions	Vrai	Spécifie les options d'authentification à utiliser lors de la récupération d'incorporations à partir du point de terminaison spécifié.
type	ficelle	Vrai	Doit être endpoint.

Options d’authentification par clé API

Options d’authentification pour Azure OpenAI sur vos données lors de l’utilisation d’une clé API.

Nom	Catégorie	Obligatoire	Descriptif
key	ficelle	Vrai	Clé API à utiliser pour l’authentification.
type	ficelle	Vrai	Doit être api_key.

Source de vectorisation de l’ID de modèle

Détails de la source de vectorisation, utilisée par Azure OpenAI sur vos données lors de l’application de la recherche vectorielle. Cette source de vectorisation est basée sur l’ID de modèle Elasticsearch.

Nom	Catégorie	Obligatoire	Descriptif
model_id	ficelle	Vrai	Spécifie l’ID de modèle à utiliser pour la vectorisation. Cet ID de modèle doit être défini dans Elasticsearch.
type	ficelle	Vrai	Doit être model_id.

Options de mappage de champs

Paramètres facultatifs pour contrôler le traitement des champs lors de l’utilisation d’une ressource Elasticsearch configurée.

Nom	Catégorie	Obligatoire	Descriptif
content_fields	chaîne de caractères[]	Faux	Les noms des champs d’index qui doivent être traités comme du contenu.
vector_fields	chaîne de caractères[]	Faux	Noms de champs qui représentent des données vectorielles.
content_fields_separator	ficelle	Faux	Le modèle de séparation que les champs de contenu doivent utiliser. La valeur par défaut est \n.
filepath_field	ficelle	Faux	Le nom du champ d’index à utiliser comme chemin d’accès au fichier.
title_field	ficelle	Faux	Nom du champ d’index à utiliser comme titre.
url_field	ficelle	Faux	Nom du champ d’index à utiliser comme URL.

Type de requête

Type de requête de récupération Elasticsearch qui doit être exécuté lors de son utilisation avec Azure OpenAI sur vos données.

Valeur Enum	Descriptif
simple	Représente l'analyseur de requêtes simple par défaut.
vector	Représente la recherche vectorielle sur des données calculées.

Exemples

Configuration requise :

• Configurez les attributions de rôles de l’utilisateur vers la ressource Azure OpenAI. Rôle nécessaire : Cognitive Services OpenAI User.
• Installez Az CLI et exécutez az login.
• Définissez les variables d’environnement suivantes : 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='***'

Python 1.x

Installez le dernier package 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")
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))

Se reposer

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