共用方式為

資料來源 - Pinecone (預覽)

  • 發行項

使用 Azure OpenAI On Your Data 時 Pinecone 的可設定選項。 API 第 2024-02-15-preview 版支援此資料來源。

名稱 類型​​ 必要 描述
parameters 參數 True 設定 Pinecone 時要使用的參數。
type 字串 True 必須是 pinecone。

參數

姓名 類型​​ 必要 描述
environment string True Pinecone 的環境名稱。
index_name 字串 True Pinecone 資料庫索引的名稱。
fields_mapping FieldsMappingOptions True 與搜尋索引互動時要使用的自訂欄位對應行為。
authentication ApiKeyAuthenticationOptions True 存取已定義資料來源時要使用的驗證方法。
embedding_dependency DeploymentNameVectorizationSource True 向量搜尋的內嵌相依性。
in_scope boolean False 查詢是否應限制為使用已編製索引的資料。 預設值為 True。
role_information 字串 False 提供模型關於其行為方式的指示，以及產生回應時應該參考的任何內容。 您可以描述助理的特質，並對其告知如何格式化回應。
strictness 整數 False 已設定的搜尋相關性篩選嚴格度。 嚴格度越高，精確度就越高，但答案的召回率越低。 預設值為 3。
top_n_documents 整數 False 要為設定的查詢顯示的已設定文件數目上限。 預設值為 5。

API 金鑰驗證選項

Azure OpenAI On Your Data 在使用 API 金鑰時的驗證選項。

名稱 類型​​ 必要 描述
key string True 要用於驗證的 API 金鑰。
type 字串 True 必須是 api_key。

部署名稱向量化來源

套用向量搜尋時，Azure OpenAI On Your Data 所使用的向量化來源詳細資料。 此向量化來源是以相同 Azure OpenAI 資源中的內部內嵌模型部署名稱為基礎。 此向量化來源可讓您在沒有 Azure OpenAI API 金鑰的情況下使用向量搜尋，而不需要 Azure OpenAI 公用網路存取。

名稱 類型​​ 必要 描述
deployment_name string True 相同 Azure OpenAI 資源內的內嵌模型部署名稱。
type 字串 True 必須是 deployment_name。

欄位對應選項

用於控制欄位處理方式的設定。

名稱 類型​​ 必要 描述
content_fields string[] True 應視為內容的索引欄位名稱。
content_fields_separator 字串 False 內容欄位應使用的分隔符號模式。 預設值為 \n。
filepath_field 字串 False 要用作檔案路徑的索引欄位名稱。
title_field 字串 False 要用作標題的索引欄位名稱。
url_field 字串 False 要用作 URL 的索引欄位名稱。

範例

先決條件：

  • 設定從使用者到 Azure OpenAI 資源的角色指派。 必要角色：Cognitive Services OpenAI User。
  • 安裝 Az CLI，然後執行 az login。
  • 定義下列環境變數：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

安裝最新的 pip 套件 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))