Fonte de dados - Azure Cosmos DB para MongoDB vCore

Artigo
09/25/2024

As opções configuráveis do Azure Cosmos DB para MongoDB vCore 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 Cosmos DB para MongoDB vCore.
`type`	string	True	Deve ser `azure_cosmos_db`.

Parâmetros

Nome	Type	Obrigatório	Description
`database_name`	string	True	O nome do banco de dados vCore do MongoDB a ser usado com o Azure Cosmos DB.
`container_name`	string	True	O nome do contêiner de recursos do Azure Cosmos DB.
`index_name`	string	True	O nome do índice vCore do MongoDB a ser usado com o Azure Cosmos DB.
`fields_mapping`	CamposMapeamentoOpções	True	Comportamento de mapeamento de campo personalizado para usar ao interagir com o índice de pesquisa.
`authentication`	ConnectionStringAuthenticationOptions	True	O método de autenticação a ser usado ao acessar a fonte de dados definida.
`embedding_dependency`	Um de DeploymentNameVectorizationSource, EndpointVectorizationSource	True	A dependência de incorporação para pesquisa vetorial.
`in_scope`	boolean	False	Se as consultas devem ser restritas ao uso de dados indexados. A predefinição é `True`.
`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.
`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`.

Opções de autenticação da cadeia de conexão

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

Nome	Type	Obrigatório	Description
`connection_string`	string	True	A cadeia de conexão a ser usada para autenticação.
`type`	string	True	Deve ser `connection_string`.

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`.

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`.

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 mapeamento de campos

As configurações para controlar como os campos são processados.

Nome	Type	Obrigatório	Description
`content_fields`	string[]	True	Os nomes dos campos de índice que devem ser tratados como conteúdo.
`vector_fields`	string[]	True	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.

Exemplos

Pré-requisitos:

Configure as atribuições de função do usuário para o recurso do Azure OpenAI. Função requerida: Cognitive Services OpenAI User.
Instale o Az CLI e execute az logino .
Defina as seguintes variáveis de ambiente: AzureOpenAIEndpoint, ChatCompletionsDeploymentName,ConnectionString, Database, , IndexContainer, EmbeddingDeploymentName.

Nota

O seguinte é apenas por exemplo. Se você usar uma cadeia de conexão, armazene-a com segurança em outro lugar, como no Cofre da Chave do Azure. Não inclua a chave da API diretamente no seu código e nunca a publique publicamente.

export AzureOpenAIEndpoint=https://example.openai.azure.com/
export ChatCompletionsDeploymentName=turbo
export ConnectionString='<db-connection-string>'
export Database=testdb
export Container=testcontainer
export Index=testindex
export EmbeddingDeploymentName=ada

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")
connection_string = os.environ.get("ConnectionString")
database = os.environ.get("Database")
container = os.environ.get("Container")
index = os.environ.get("Index")
embedding_deployment_name = os.environ.get("EmbeddingDeploymentName")

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_cosmos_db",
                "parameters": {
                    "authentication": {
                        "type": "connection_string",
                        "connection_string": connection_string
                    },
                    "database_name": database,
                    "container_name": container,
                    "index_name": index,
                    "fields_mapping": {
                        "content_fields": [
                            "content"
                        ],
                        "vector_fields": [
                            "contentvector"
                        ]
                    },
                    "embedding_dependency": {
                        "type": "deployment_name",
                        "deployment_name": embedding_deployment_name
                    }
                }
            }
        ],
    }
)

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_cosmos_db",
        "parameters": {
          "authentication": {
            "type": "connection_string",
            "connection_string": "'$ConnectionString'"
          },
          "database_name": "'$Database'",
          "container_name": "'$Container'",
          "index_name": "'$Index'",
          "fields_mapping": {
            "content_fields": [
              "content"
            ],
            "vector_fields": [
              "contentvector"
            ]
          },
          "embedding_dependency": {
            "type": "deployment_name",
            "deployment_name": "'$EmbeddingDeploymentName'"
          }
        }
      }
    ],
    "messages": [
      {
        "role": "user",
        "content": "Who is DRI?"
      }
    ]
}
'

Partilhar via