Fonte de dados - Azure AI Search

Artigo
09/20/2024

As opções configuráveis do Azure AI Search ao usar o Azure OpenAI On Your Data. Esta fonte de dados é suportada na versão 2024-02-01da API.

Nome	Type	Obrigatório	Description
`parameters`	Parâmetros	True	Os parâmetros a serem usados ao configurar o Azure Search.
`type`	string	True	Deve ser `azure_search`.

Parâmetros

Nome	Type	Obrigatório	Description
`endpoint`	string	True	O caminho de ponto de extremidade absoluto para o recurso de Pesquisa do Azure a ser usado.
`index_name`	string	True	O nome do índice a ser usado no recurso de Pesquisa do Azure referenciado.
`authentication`	Uma das opções ApiKeyAuthenticationOptions, SystemAssignedManagedIdentityAuthenticationOptions, UserAssignedManagedIdentityAuthenticationOptions, onYourDataAccessTokenAuthenticationOptions	True	O método de autenticação a ser usado ao acessar a fonte de dados definida.
`embedding_dependency`	Um de DeploymentNameVectorizationSource, EndpointVectorizationSource	False	A dependência de incorporação para pesquisa vetorial. Necessário quando `query_type` é `vector`, `vector_simple_hybrid`ou `vector_semantic_hybrid`.
`fields_mapping`	CamposMapeamentoOpções	False	Comportamento de mapeamento de campo personalizado para usar ao interagir com o índice de pesquisa.
`filter`	string	False	Filtro de pesquisa.
`in_scope`	boolean	False	Se as consultas devem ser restritas ao uso de dados indexados. A predefinição é `True`.
`query_type`	Tipo de consulta	False	O tipo de consulta a ser usado com a Pesquisa do Azure. O padrão é `simple`
`role_information`	string	False	Dê instruções ao modelo sobre como ele deve se comportar e qualquer contexto que ele deve referenciar ao gerar uma resposta. Pode descrever a personalidade do assistente e dizer-lhe como formatar as respostas.
`semantic_configuration`	string	False	A configuração semântica para a consulta. Obrigatório quando `query_type` é `semantic` ou `vector_semantic_hybrid`.
`strictness`	integer	False	O rigor configurado da filtragem de relevância da pesquisa. Quanto maior o rigor, maior a precisão, mas menor a recordação da resposta. A predefinição é `3`.
`top_n_documents`	integer	False	O número superior configurado de documentos a serem apresentados para a consulta configurada. A predefinição é `5`.
`max_search_queries`	integer	False	O número máximo de consultas reescritas deve ser enviado ao provedor de pesquisa para uma mensagem de usuário. Se não for especificado, o sistema decidirá o número de consultas a enviar.
`allow_partial_result`	integer	False	Se especificado como true, o sistema permitirá que resultados parciais de pesquisa sejam usados e a solicitação falhará se todas as consultas falharem. Se não for especificado ou especificado como falso, a solicitação falhará se qualquer consulta de pesquisa falhar.
`include_contexts`	matriz	False	As propriedades incluídas do contexto de saída. Se não for especificado, o valor padrão será `citations` e `intent`. Os valores podem ser `citations`,`intent`, `all_retrieved_documents`.

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

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

Nome	Type	Obrigatório	Description
`key`	string	True	A chave de API a ser usada para autenticação.
`type`	string	True	Deve ser `api_key`.

Opções de autenticação de identidade gerenciada atribuída pelo sistema

As opções de autenticação para o Azure OpenAI On Your Data ao usar uma identidade gerenciada atribuída ao sistema.

Nome	Type	Obrigatório	Description
`type`	string	True	Deve ser `system_assigned_managed_identity`.

Opções de autenticação de identidade gerenciada atribuída pelo usuário

As opções de autenticação para o Azure OpenAI On Your Data ao usar uma identidade gerenciada atribuída pelo usuário.

Nome	Type	Obrigatório	Description
`managed_identity_resource_id`	string	True	A ID do recurso da identidade gerenciada atribuída pelo usuário a ser usada para autenticação.
`type`	string	True	Deve ser `user_assigned_managed_identity`.

Opções de autenticação de token de acesso

As opções de autenticação para o Azure OpenAI On Your Data ao usar o token de acesso.

Nome	Type	Obrigatório	Description
`access_token`	string	True	O token de acesso a ser usado para autenticação.
`type`	string	True	Deve ser `access_token`.

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

Os detalhes da fonte de vetorização, usada pelo Azure OpenAI On Your Data ao aplicar a pesquisa vetorial. Essa fonte de vetorização é baseada em um nome de implantação de modelo de incorporação interna no mesmo recurso do Azure OpenAI. Essa fonte de vetorização permite que você use a pesquisa vetorial sem a chave de api do Azure OpenAI e sem o acesso à rede pública do Azure OpenAI.

Nome	Type	Obrigatório	Description
`deployment_name`	string	True	O nome da implantação do modelo de incorporação no mesmo recurso do Azure OpenAI.
`type`	string	True	Deve ser `deployment_name`.
`dimensions`	integer	False	O número de dimensões que as incorporações devem ter. Apenas suportado em `text-embedding-3` modelos e modelos posteriores.

Origem da vetorização do ponto final

Os detalhes da fonte de vetorização, usada pelo Azure OpenAI On Your Data ao aplicar a pesquisa vetorial. Essa fonte de vetorização é baseada no ponto de extremidade da API de incorporação do Azure OpenAI.

Nome	Type	Obrigatório	Description
`endpoint`	string	True	Especifica a URL do ponto de extremidade do recurso a partir da qual as incorporações devem ser recuperadas. Deve ser no formato de `https://{YOUR_RESOURCE_NAME}.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/embeddings`. O parâmetro de consulta api-version não é permitido.
`authentication`	ApiKeyAuthenticationOptions	True	Especifica as opções de autenticação a serem usadas ao recuperar incorporações do ponto de extremidade especificado.
`type`	string	True	Deve ser `endpoint`.
`dimensions`	integer	False	O número de dimensões que as incorporações devem ter. Apenas suportado em `text-embedding-3` modelos e modelos posteriores.

Opções de mapeamento de campos

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

Nome	Type	Obrigatório	Description
`content_fields`	string[]	False	Os nomes dos campos de índice que devem ser tratados como conteúdo.
`vector_fields`	string[]	False	Os nomes dos campos que representam dados vetoriais.
`content_fields_separator`	string	False	O padrão separador que os campos de conteúdo devem usar. A predefinição é `\n`.
`filepath_field`	string	False	O nome do campo de índice a ser usado como um caminho de arquivo.
`title_field`	string	False	O nome do campo de índice a ser usado como título.
`url_field`	string	False	O nome do campo de índice a ser usado como URL.

Tipo de consulta

O tipo de consulta de recuperação do Azure Search que deve ser executada ao usá-lo como um Azure OpenAI On Your Data.

Valor do Enum	Description
`simple`	Representa o analisador de consulta simples padrão.
`semantic`	Representa o analisador de consulta semântica para modelagem semântica avançada.
`vector`	Representa a pesquisa vetorial sobre dados computados.
`vector_simple_hybrid`	Representa uma combinação da estratégia de consulta simples com dados vetoriais.
`vector_semantic_hybrid`	Representa uma combinação de pesquisa semântica e consulta de dados vetoriais.

Exemplos

Pré-requisitos:

Configure as atribuições de função do sistema Azure OpenAI atribuído identidade gerenciada ao serviço de pesquisa do Azure. Funções obrigatórias: Search Index Data Reader, Search Service Contributor.
Configure as atribuições de função do usuário para o recurso do Azure OpenAI. Função requerida: Cognitive Services OpenAI User.
Instale Az CLI e execute az login.
Defina as seguintes variáveis de ambiente: AzureOpenAIEndpoint, ChatCompletionsDeploymentName,SearchEndpoint, SearchIndex.

export AzureOpenAIEndpoint=https://example.openai.azure.com/
export ChatCompletionsDeploymentName=turbo
export SearchEndpoint=https://example.search.windows.net
export SearchIndex=example-index

Python 1.x
REST

Instale os pacotes openaipip mais recentes, 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")
search_endpoint = os.environ.get("SearchEndpoint")
search_index = os.environ.get("SearchIndex")

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-01",
)

completion = client.chat.completions.create(
    model=deployment,
    messages=[
        {
            "role": "user",
            "content": "Who is DRI?",
        },
    ],
    extra_body={
        "data_sources": [
            {
                "type": "azure_search",
                "parameters": {
                    "endpoint": search_endpoint,
                    "index_name": search_index,
                    "authentication": {
                        "type": "system_assigned_managed_identity"
                    }
                }
            }
        ]
    }
)

print(completion.model_dump_json(indent=2))

az rest --method POST \
 --uri $AzureOpenAIEndpoint/openai/deployments/$ChatCompletionsDeploymentName/chat/completions?api-version=2024-02-01 \
 --resource https://cognitiveservices.azure.com/ \
 --body \
'
{
    "data_sources": [
        {
            "type": "azure_search",
            "parameters": {
                "endpoint": "'$SearchEndpoint'",
                "index_name": "'$SearchIndex'",
                "authentication": {
                    "type": "system_assigned_managed_identity"
                }
            }
        }
    ],
    "messages": [
        {
            "role": "user",
            "content": "Who is DRI?",
        }
    ]
}
'

Partilhar via