Veri kaynağı - MongoDB için Azure Cosmos DB sanal çekirdeği

Makale
03/13/2024

Verilerinizde Azure OpenAI kullanırken MongoDB sanal çekirdeği için Azure Cosmos DB'nin yapılandırılabilir seçenekleri. Bu veri kaynağı API sürümünde 2024-02-01desteklenir.

Adı	Tür	Zorunlu	Açıklama
`parameters`	Parametreler	True	MongoDB sanal çekirdeği için Azure Cosmos DB yapılandırırken kullanılacak parametreler.
`type`	Dize	True	olmalıdır `azure_cosmos_db`.

Parametreler

Ad	Tür	Zorunlu	Açıklama
`database_name`	Dize	True	Azure Cosmos DB ile kullanılacak MongoDB sanal çekirdek veritabanı adı.
`container_name`	Dize	True	Azure Cosmos DB kaynak kapsayıcısının adı.
`index_name`	Dize	True	Azure Cosmos DB ile kullanılacak MongoDB sanal çekirdek dizin adı.
`fields_mapping`	FieldsMappingOptions	True	Arama diziniyle etkileşim kurarken kullanılacak özelleştirilmiş alan eşleme davranışı.
`authentication`	Bağlan ionStringAuthenticationOptions	True	Tanımlanan veri kaynağına erişirken kullanılacak kimlik doğrulama yöntemi.
`embedding_dependency`	DeploymentNameVectorizationSource, EndpointVectorizationSource'lardan biri	True	Vektör araması için ekleme bağımlılığı.
`in_scope`	boolean	False	Sorguların dizine alınan verilerin kullanımıyla sınırlandırılıp kısıtlanmaması gerektiği. Varsayılan `True` değeridir.
`role_information`	Dize	False	Modele nasıl davranması gerektiği ve yanıt oluştururken başvurması gereken bağlamlar hakkında yönergeler verin. Yardımcının kişiliğini açıklayabilir ve yanıtları nasıl biçimlendirebileceğini anlatabilirsiniz.
`strictness`	integer	False	Arama ilgi filtresinin yapılandırılmış katılığı. Katılık ne kadar yüksekse, duyarlık o kadar yüksektir ancak yanıtın daha düşük geri çağrılır. Varsayılan `3` değeridir.
`top_n_documents`	integer	False	Yapılandırılan sorgu için öne çıkan en fazla belge sayısı. Varsayılan `5` değeridir.

Bağlan ion dizesi kimlik doğrulama seçenekleri

bağlantı dizesi kullanırken Verilerinizde Azure OpenAI kimlik doğrulama seçenekleri.

Adı	Tür	Zorunlu	Açıklama
`connection_string`	Dize	True	Kimlik doğrulaması için kullanılacak bağlantı dizesi.
`type`	Dize	True	olmalıdır `connection_string`.

Dağıtım adı vektörleştirme kaynağı

Vektör aramasını uygularken Verilerinizde Azure OpenAI tarafından kullanılan vektörleştirme kaynağının ayrıntıları. Bu vektörleştirme kaynağı, aynı Azure OpenAI kaynağındaki iç ekleme modeli dağıtım adını temel alır. Bu vektörleştirme kaynağı, Azure OpenAI api anahtarı olmadan ve Azure OpenAI genel ağ erişimi olmadan vektör araması kullanmanıza olanak tanır.

Adı	Tür	Zorunlu	Açıklama
`deployment_name`	Dize	True	Aynı Azure OpenAI kaynağı içindeki ekleme modeli dağıtım adı.
`type`	Dize	True	olmalıdır `deployment_name`.

Uç nokta vektörleştirme kaynağı

Vektör aramasını uygularken Verilerinizde Azure OpenAI tarafından kullanılan vektörleştirme kaynağının ayrıntıları. Bu vektörleştirme kaynağı, Azure OpenAI ekleme API'sinin uç noktasını temel alır.

Adı	Tür	Zorunlu	Açıklama
`endpoint`	Dize	True	Eklemelerin alınması gereken kaynak uç noktası URL'sini belirtir. biçiminde `https://{YOUR_RESOURCE_NAME}.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/embeddings`olmalıdır. Api sürümü sorgu parametresine izin verilmiyor.
`authentication`	ApiKeyAuthenticationOptions	True	Belirtilen uç noktadan eklemeleri alırken kullanılacak kimlik doğrulama seçeneklerini belirtir.
`type`	Dize	True	olmalıdır `endpoint`.

API anahtarı kimlik doğrulama seçenekleri

API anahtarı kullanırken Verilerinizde Azure OpenAI kimlik doğrulama seçenekleri.

Adı	Tür	Zorunlu	Açıklama
`key`	Dize	True	Kimlik doğrulaması için kullanılacak API anahtarı.
`type`	Dize	True	olmalıdır `api_key`.

Alan eşleme seçenekleri

Alanların nasıl işlendiğini denetlemek için ayarlar.

Adı	Tür	Zorunlu	Açıklama
`content_fields`	string[]	True	İçerik olarak ele alınması gereken dizin alanlarının adları.
`vector_fields`	string[]	True	Vektör verilerini temsil eden alanların adları.
`content_fields_separator`	Dize	False	İçerik alanlarının kullanması gereken ayırıcı desen. Varsayılan `\n` değeridir.
`filepath_field`	Dize	False	Dosya yolu olarak kullanılacak dizin alanının adı.
`title_field`	Dize	False	Başlık olarak kullanılacak dizin alanının adı.
`url_field`	Dize	False	URL olarak kullanılacak dizin alanının adı.

Örnekler

Ön koşullar:

Kullanıcıdan Azure OpenAI kaynağına rol atamalarını yapılandırın. Gerekli rol: Cognitive Services OpenAI User.
Az CLI'yi yükleyin ve çalıştırınaz login.
Aşağıdaki ortam değişkenlerini tanımlayın: AzureOpenAIEndpoint, ChatCompletionsDeploymentName,ConnectionString, Database, Container, Index, EmbeddingDeploymentName.

export AzureOpenAIEndpoint=https://example.openai.azure.com/
export ChatCompletionsDeploymentName=turbo
export ConnectionString='mongodb+srv://username:***@example.mongocluster.cosmos.azure.com/?tls=true&authMechanism=SCRAM-SHA-256&retrywrites=false&maxIdleTimeMS=120000'
export Database=testdb
export Container=testcontainer
export Index=testindex
export EmbeddingDeploymentName=ada

Python 1.x
REST

En son pip paketlerini openaiyükleyin, 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?"
      }
    ]
}
'

Aracılığıyla paylaş