Datakälla – Pinecone (förhandsversion)

Artikel
09/02/2024

De konfigurerbara alternativen för Pinecone när du använder Azure OpenAI på dina data. Den här datakällan stöds i API-versionen 2024-02-15-preview.

Namn	Typ	Obligatoriskt	Beskrivning
`parameters`	Parameters	Sant	Parametrarna som ska användas när du konfigurerar Pinecone.
`type`	sträng	Sant	Måste vara `pinecone`.

Parameters

Namn	Typ	Obligatoriskt	Beskrivning
`environment`	sträng	Sant	Miljönamnet Pinecone.
`index_name`	sträng	Sant	Namnet på Pinecone-databasindexet.
`fields_mapping`	FieldsMappingOptions	Sant	Anpassat fältmappningsbeteende som ska användas när du interagerar med sökindexet.
`authentication`	ApiKeyAuthenticationOptions	Sant	Den autentiseringsmetod som ska användas vid åtkomst till den definierade datakällan.
`embedding_dependency`	DeploymentNameVectorizationSource	Sant	Inbäddningsberoendet för vektorsökning.
`in_scope`	boolean	Falsk	Om frågor ska begränsas till användning av indexerade data. Standard är `True`.
`role_information`	sträng	Falsk	Ge modellinstruktionerna om hur den ska bete sig och vilken kontext den ska referera till när du genererar ett svar. Du kan beskriva assistentens personlighet och berätta hur du formaterar svar.
`strictness`	integer	Falsk	Den konfigurerade strängheten för sökrelevansfiltreringen. Ju högre strikthet, desto högre precision men lägre återkallande av svaret. Standard är `3`.
`top_n_documents`	integer	Falsk	Det konfigurerade högsta antalet dokument som ska användas för den konfigurerade frågan. Standard är `5`.

Alternativ för API-nyckelautentisering

Autentiseringsalternativen för Azure OpenAI På dina data när du använder en API-nyckel.

Namn	Typ	Obligatoriskt	Beskrivning
`key`	sträng	Sant	API-nyckeln som ska användas för autentisering.
`type`	sträng	Sant	Måste vara `api_key`.

Distributionsnamnvektoriseringskälla

Information om vektoriseringskällan som används av Azure OpenAI På dina data när du tillämpar vektorsökning. Den här vektoriseringskällan baseras på ett internt distributionsnamn för inbäddningsmodellen i samma Azure OpenAI-resurs. Med den här vektoriseringskällan kan du använda vektorsökning utan Api-nyckel för Azure OpenAI och utan offentlig nätverksåtkomst i Azure OpenAI.

Namn	Typ	Obligatoriskt	Beskrivning
`deployment_name`	sträng	Sant	Distributionsnamnet för inbäddningsmodellen i samma Azure OpenAI-resurs.
`type`	sträng	Sant	Måste vara `deployment_name`.

Mappningsalternativ för fält

Inställningarna för att styra hur fält bearbetas.

Namn	Typ	Obligatoriskt	Beskrivning
`content_fields`	string[]	Sant	Namnen på indexfält som ska behandlas som innehåll.
`content_fields_separator`	sträng	Falsk	Det avgränsarmönster som innehållsfält ska använda. Standard är `\n`.
`filepath_field`	sträng	Falsk	Namnet på det indexfält som ska användas som en filsökväg.
`title_field`	sträng	Falsk	Namnet på det indexfält som ska användas som rubrik.
`url_field`	sträng	Falsk	Namnet på det indexfält som ska användas som en URL.

Exempel

Förutsättningar:

Konfigurera rolltilldelningarna från användaren till Azure OpenAI-resursen. Obligatorisk roll: Cognitive Services OpenAI User.
Installera Az CLI och kör az login.
Definiera följande miljövariabler: 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

Python 1.x
REST

Installera de senaste pip-paketen 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")
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))


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": "pinecone",
        "parameters": {
          "environment": "'$Environment'",
          "authentication": {
            "type": "api_key",
            "key": "'$Key'"
          },
          "index_name": "'$IndexName'",
          "fields_mapping": {
            "content_fields": [
              "content"
            ]
          },
          "embedding_dependency": {
            "type": "deployment_name",
            "deployment_name": "'$EmbeddingDeploymentName'"
          }
        }
      }
    ],
    "messages": [
      {
        "role": "user",
        "content": "Who is DRI?"
      }
    ]
}
'

Dela via