資料來源 - Azure Cosmos DB for MongoDB 虛擬核心

發行項
09/26/2024

使用 Azure OpenAI On Your Data 時，Azure Cosmos DB for MongoDB V 核心的可設定選項。 API 第 2024-02-01 版支援此資料來源。

名稱	類型	必要	描述
`parameters`	參數	True	設定 Azure Cosmos DB for MongoDB V 核心時要使用的參數。
`type`	字串	True	必須是 `azure_cosmos_db`。

參數

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

連接字串驗證選項

Azure OpenAI On Your Data 在使用連接字串時的驗證選項。

名稱	類型	必要	描述
`connection_string`	string	True	要用於驗證的連接字串。
`type`	字串	True	必須是 `connection_string`。

部署名稱向量化來源

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

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

端點向量化來源

套用向量搜尋時，Azure OpenAI On Your Data 所使用的向量化來源詳細資料。此向量化來源是以 Azure OpenAI 內嵌 API 端點為基礎。

名稱	類型	必要	描述
`endpoint`	string	True	指定應從中擷取內嵌的資源端點 URL。其格式應為 `https://{YOUR_RESOURCE_NAME}.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/embeddings`。不允許 api-version 查詢參數。
`authentication`	ApiKeyAuthenticationOptions	True	指定從指定端點擷取內嵌時要使用的驗證選項。
`type`	字串	True	必須是 `endpoint`。

API 金鑰驗證選項

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

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

欄位對應選項

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

名稱	類型	必要	描述
`content_fields`	string[]	True	應視為內容的索引欄位名稱。
`vector_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、ConnectionString、Database、Container、Index、EmbeddingDeploymentName。

注意

下列僅限為範例。如果您使用連接字串，請將其安全地儲存在別處，例如 Azure Key Vault。請勿在程式碼中直接包含 API 金鑰，且切勿公開張貼金鑰。

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

安裝最新的 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")
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?"
      }
    ]
}
'

共用方式為