Gegevensbron - Elasticsearch (preview)

Artikel
10/16/2024

De configureerbare opties voor Elasticsearch bij het gebruik van Azure OpenAI op uw gegevens. Deze gegevensbron wordt ondersteund in api-versie 2024-02-15-preview.

Name	Type	Vereist	Beschrijving
`parameters`	Parameters	Waar	De parameters die moeten worden gebruikt bij het configureren van Elasticsearch.
`type`	tekenreeks	Waar	Moet `elasticsearch` zijn.

Parameters

Naam	Type	Vereist	Beschrijving
`endpoint`	tekenreeks	Waar	Het absolute eindpuntpad voor de Elasticsearch-resource die moet worden gebruikt.
`index_name`	tekenreeks	Waar	De naam van de index die moet worden gebruikt in elasticsearch waarnaar wordt verwezen.
`authentication`	Een van KeyAndKeyIdAuthenticationOptions, EncodedApiKeyAuthenticationOptions	Waar	De verificatiemethode die moet worden gebruikt bij het openen van de gedefinieerde gegevensbron.
`embedding_dependency`	Een van DeploymentNameVectorizationSource, EndpointVectorizationSource, ModelIdVectorizationSource	Onwaar	De insluitingsafhankelijkheid voor vectorzoekopdrachten. Vereist wanneer `query_type` is `vector`.
`fields_mapping`	FieldsMappingOptions	Onwaar	Aangepast veldtoewijzingsgedrag dat moet worden gebruikt bij interactie met de zoekindex.
`in_scope`	boolean	Onwaar	Of query's moeten worden beperkt tot het gebruik van geïndexeerde gegevens. Standaard is `True`.
`query_type`	QueryType	Onwaar	Het querytype dat moet worden gebruikt met Elasticsearch. Standaard is `simple`
`role_information`	tekenreeks	Onwaar	Geef het model instructies over hoe het zich moet gedragen en eventuele context waarnaar wordt verwezen bij het genereren van een antwoord. U kunt de persoonlijkheid van de assistent beschrijven en vertellen hoe u antwoorden kunt opmaken.
`strictness`	geheel getal	Onwaar	De geconfigureerde striktheid van het filteren op zoekrelevantie. Hoe strikter, hoe hoger de precisie, maar een lagere terugroeping van het antwoord. Standaard is `3`.
`top_n_documents`	geheel getal	Onwaar	Het geconfigureerde bovenste aantal documenten dat moet worden aanbevolen voor de geconfigureerde query. Standaard is `5`.

Verificatieopties voor sleutel- en sleutel-id's

De verificatieopties voor Azure OpenAI op uw gegevens wanneer u een API-sleutel gebruikt.

Name	Type	Vereist	Beschrijving
`key`	tekenreeks	Waar	De Elasticsearch-sleutel die moet worden gebruikt voor verificatie.
`key_id`	tekenreeks	Waar	De elasticsearch-sleutel-id die moet worden gebruikt voor verificatie.
`type`	tekenreeks	Waar	Moet `key_and_key_id` zijn.

Verificatieopties voor gecodeerde API-sleutels

De verificatieopties voor Azure OpenAI Op uw gegevens wanneer u een met Elasticsearch gecodeerde API-sleutel gebruikt.

Name	Type	Vereist	Beschrijving
`encoded_api_key`	tekenreeks	Waar	De met Elasticsearch gecodeerde API-sleutel die moet worden gebruikt voor verificatie.
`type`	tekenreeks	Waar	Moet `encoded_api_key` zijn.

Vectorisatiebron voor implementatienamen

De details van de vectorisatiebron die door Azure OpenAI op uw gegevens worden gebruikt bij het toepassen van vectorzoekopdrachten. Deze vectorisatiebron is gebaseerd op een interne naam voor de implementatie van het model voor insluitingen in dezelfde Azure OpenAI-resource. Met deze vectorisatiebron kunt u vectorzoekopdrachten gebruiken zonder Azure OpenAI API-sleutel en zonder toegang tot openbare Azure OpenAI-netwerken.

Name	Type	Vereist	Beschrijving
`deployment_name`	tekenreeks	Waar	De naam van de insluitmodelimplementatie binnen dezelfde Azure OpenAI-resource.
`type`	tekenreeks	Waar	Moet `deployment_name` zijn.

Eindpuntvectorisatiebron

De details van de vectorisatiebron die door Azure OpenAI op uw gegevens worden gebruikt bij het toepassen van vectorzoekopdrachten. Deze vectorisatiebron is gebaseerd op het Azure OpenAI-insluitings-API-eindpunt.

Name	Type	Vereist	Beschrijving
`endpoint`	tekenreeks	Waar	Hiermee geeft u de URL van het broneindpunt op waaruit insluitingen moeten worden opgehaald. Het moet de indeling hebben van `https://{YOUR_RESOURCE_NAME}.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/embeddings`. De queryparameter api-versie is niet toegestaan.
`authentication`	ApiKeyAuthenticationOptions	Waar	Hiermee geeft u de verificatieopties die moeten worden gebruikt bij het ophalen van insluitingen vanaf het opgegeven eindpunt.
`type`	tekenreeks	Waar	Moet `endpoint` zijn.

Bron van model-id-vectorisatie

De details van de vectorisatiebron die door Azure OpenAI op uw gegevens worden gebruikt bij het toepassen van vectorzoekopdrachten. Deze vectorisatiebron is gebaseerd op de model-id van Elasticsearch.

Name	Type	Vereist	Beschrijving
`model_id`	tekenreeks	Waar	Hiermee geeft u de model-id op die moet worden gebruikt voor vectorisatie. Deze model-id moet worden gedefinieerd in Elasticsearch.
`type`	tekenreeks	Waar	Moet `model_id` zijn.

Verificatieopties voor API-sleutels

De verificatieopties voor Azure OpenAI op uw gegevens wanneer u een API-sleutel gebruikt.

Name	Type	Vereist	Beschrijving
`key`	tekenreeks	Waar	De API-sleutel die moet worden gebruikt voor verificatie.
`type`	tekenreeks	Waar	Moet `api_key` zijn.

Opties voor het toewijzen van velden

Optionele instellingen om te bepalen hoe velden worden verwerkt wanneer u een geconfigureerde Elasticsearch-resource gebruikt.

Name	Type	Vereist	Beschrijving
`content_fields`	tekenreeks[]	Onwaar	De namen van indexvelden die als inhoud moeten worden behandeld.
`vector_fields`	tekenreeks[]	Onwaar	De namen van velden die vectorgegevens vertegenwoordigen.
`content_fields_separator`	tekenreeks	Onwaar	Het scheidingsteken dat inhoudsvelden moeten gebruiken. Standaard is `\n`.
`filepath_field`	tekenreeks	Onwaar	De naam van het indexveld dat moet worden gebruikt als bestandspad.
`title_field`	tekenreeks	Onwaar	De naam van het indexveld dat moet worden gebruikt als titel.
`url_field`	tekenreeks	Onwaar	De naam van het indexveld dat moet worden gebruikt als URL.

Querytype

Het type elasticsearch-ophaalquery dat moet worden uitgevoerd wanneer u deze gebruikt met Azure OpenAI op uw gegevens.

Opsommingswaarde	Beschrijving
`simple`	Vertegenwoordigt de standaard, eenvoudige queryparser.
`vector`	Vertegenwoordigt vectorzoekopdrachten over berekende gegevens.

Voorbeelden

Vereisten:

Configureer de roltoewijzingen van de gebruiker naar de Azure OpenAI-resource. Vereiste rol: Cognitive Services OpenAI User.
Installeer Az CLI en voer deze uit az login.
Definieer de volgende omgevingsvariabelen: 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
REST

Installeer de nieuwste pip-pakketten 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))


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

Delen via