Fonte de dados - Pinecone (pré-visualização)
As opções configuráveis do Pinecone ao usar o Azure OpenAI On Your Data. Esta fonte de dados é suportada na versão 2024-02-15-preview
da API.
Nome | Type | Obrigatório | Description |
---|---|---|---|
parameters |
Parâmetros | True | Os parâmetros a serem usados ao configurar o Pinecone. |
type |
string | True | Deve ser pinecone . |
Parâmetros
Nome | Type | Obrigatório | Description |
---|---|---|---|
environment |
string | True | O nome do ambiente de Pinecone. |
index_name |
string | True | O nome do índice do banco de dados Pinecone. |
fields_mapping |
CamposMapeamentoOpções | True | Comportamento de mapeamento de campo personalizado para usar ao interagir com o índice de pesquisa. |
authentication |
ApiKeyAuthenticationOptions | True | O método de autenticação a ser usado ao acessar a fonte de dados definida. |
embedding_dependency |
DeploymentNameVectorizationSource | 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 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 . |
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 . |
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. |
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 login
o . - Defina as seguintes variáveis de ambiente:
AzureOpenAIEndpoint
,ChatCompletionsDeploymentName
,Environment
,IndexName
,Key
,EmbeddingDeploymentName
.
export AzureOpenAIEndpoint=https://example.openai.azure.com/
export ChatCompletionsDeploymentName=turbo
export Environment=testenvironment
export Key=***
export IndexName=pinecone-test-index
export EmbeddingDeploymentName=ada
Instale os pacotes openai
pip 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")
environment = os.environ.get("Environment")
key = os.environ.get("Key")
index_name = os.environ.get("IndexName")
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-15-preview",
)
completion = client.chat.completions.create(
model=deployment,
messages=[
{
"role": "user",
"content": "Who is DRI?",
},
],
extra_body={
"data_sources": [
{
"type": "pinecone",
"parameters": {
"environment": environment,
"authentication": {
"type": "api_key",
"key": key
},
"index_name": index_name,
"fields_mapping": {
"content_fields": [
"content"
]
},
"embedding_dependency": {
"type": "deployment_name",
"deployment_name": embedding_deployment_name
}
}}
],
}
)
print(completion.model_dump_json(indent=2))