Sumber data - Elasticsearch (pratinjau)

Artikel
10/16/2024

Opsi yang dapat dikonfigurasi untuk Elasticsearch saat menggunakan Azure OpenAI On Your Data. Sumber data ini didukung dalam versi 2024-02-15-previewAPI .

Nama	Tipe	Wajib	Deskripsi
`parameters`	Parameter	Benar	Parameter yang digunakan saat mengonfigurasi Elasticsearch.
`type`	string	Benar	Harus berupa `elasticsearch` .

Parameter

Nama	Tipe	Wajib	Deskripsi
`endpoint`	string	Benar	Jalur titik akhir absolut untuk digunakan sumber daya Elasticsearch.
`index_name`	string	Benar	Nama indeks yang akan digunakan dalam Elasticsearch yang dirujuk.
`authentication`	Salah satu KeyAndKeyIdAuthenticationOptions, EncodedApiKeyAuthenticationOptions	Benar	Metode autentikasi yang digunakan saat mengakses sumber data yang ditentukan.
`embedding_dependency`	Salah satu DeploymentNameVectorizationSource, EndpointVectorizationSource, ModelIdVectorizationSource	Salah	Dependensi penyematan untuk pencarian vektor. Diperlukan ketika `query_type` adalah `vector`.
`fields_mapping`	FieldsMappingOptions	Salah	Perilaku pemetaan bidang yang dikustomisasi untuk digunakan saat berinteraksi dengan indeks pencarian.
`in_scope`	Boolean	Salah	Apakah kueri harus dibatasi untuk menggunakan data terindeks. Defaultnya adalah `True`.
`query_type`	QueryType	Salah	Jenis kueri yang akan digunakan dengan Elasticsearch. Standarnya adalah `simple`
`role_information`	string	Salah	Berikan instruksi model tentang bagaimana seharusnya perilakunya dan konteks apa pun yang harus dirujuknya saat menghasilkan respons. Anda dapat menjelaskan kepribadian asisten dan memberi tahunya cara memformat respons.
`strictness`	Integer	Salah	Ketatnya pemfilteran relevansi pencarian yang dikonfigurasi. Semakin tinggi ketegasan, semakin tinggi presisi tetapi pengenalan jawaban yang lebih rendah. Defaultnya adalah `3`.
`top_n_documents`	Integer	Salah	Jumlah dokumen teratas yang dikonfigurasi untuk ditampilkan untuk kueri yang dikonfigurasi. Defaultnya adalah `5`.

Opsi autentikasi KUNCI dan ID kunci

Opsi autentikasi untuk Azure OpenAI On Your Data saat menggunakan kunci API.

Nama	Tipe	Wajib	Deskripsi
`key`	string	Benar	Kunci Elasticsearch yang digunakan untuk autentikasi.
`key_id`	string	Benar	ID kunci Elasticsearch yang digunakan untuk autentikasi.
`type`	string	Benar	Harus berupa `key_and_key_id` .

Opsi autentikasi kunci API yang dikodekan

Opsi autentikasi untuk Azure OpenAI On Your Data saat menggunakan kunci API yang dikodekan Elasticsearch.

Nama	Tipe	Wajib	Deskripsi
`encoded_api_key`	string	Benar	Kunci API yang dikodekan Elasticsearch untuk digunakan untuk autentikasi.
`type`	string	Benar	Harus berupa `encoded_api_key` .

Sumber vektorisasi nama penyebaran

Detail sumber vektorisasi, digunakan oleh Azure OpenAI On Your Data saat menerapkan pencarian vektor. Sumber vektorisasi ini didasarkan pada nama penyebaran model penyematan internal di sumber daya Azure OpenAI yang sama. Sumber vektorisasi ini memungkinkan Anda menggunakan pencarian vektor tanpa kunci api Azure OpenAI dan tanpa akses jaringan publik Azure OpenAI.

Nama	Tipe	Wajib	Deskripsi
`deployment_name`	string	Benar	Nama penyebaran model penyematan dalam sumber daya Azure OpenAI yang sama.
`type`	string	Benar	Harus berupa `deployment_name` .

Sumber vektorisasi titik akhir

Detail sumber vektorisasi, digunakan oleh Azure OpenAI On Your Data saat menerapkan pencarian vektor. Sumber vektorisasi ini didasarkan pada titik akhir API penyematan Azure OpenAI.

Nama	Tipe	Wajib	Deskripsi
`endpoint`	string	Benar	Menentukan URL titik akhir sumber daya tempat penyematan harus diambil. Ini harus dalam format `https://{YOUR_RESOURCE_NAME}.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/embeddings`. Parameter kueri versi api tidak diizinkan.
`authentication`	ApiKeyAuthenticationOptions	Benar	Menentukan opsi autentikasi yang akan digunakan saat mengambil penyematan dari titik akhir yang ditentukan.
`type`	string	Benar	Harus berupa `endpoint` .

Sumber vektorisasi ID Model

Detail sumber vektorisasi, digunakan oleh Azure OpenAI On Your Data saat menerapkan pencarian vektor. Sumber vektorisasi ini didasarkan pada ID model Elasticsearch.

Nama	Tipe	Wajib	Deskripsi
`model_id`	string	Benar	Menentukan ID model yang akan digunakan untuk vektorisasi. ID model ini harus didefinisikan dalam Elasticsearch.
`type`	string	Benar	Harus berupa `model_id` .

Opsi autentikasi kunci API

Opsi autentikasi untuk Azure OpenAI On Your Data saat menggunakan kunci API.

Nama	Tipe	Wajib	Deskripsi
`key`	string	Benar	Kunci API yang digunakan untuk autentikasi.
`type`	string	Benar	Harus berupa `api_key` .

Opsi pemetaan bidang

Pengaturan opsional untuk mengontrol bagaimana bidang diproses saat menggunakan sumber daya Elasticsearch yang dikonfigurasi.

Nama	Tipe	Wajib	Deskripsi
`content_fields`	string[]	Salah	Nama bidang indeks yang harus diperlakukan sebagai konten.
`vector_fields`	string[]	Salah	Nama bidang yang mewakili data vektor.
`content_fields_separator`	string	Salah	Pola pemisah yang harus digunakan bidang konten. Defaultnya adalah `\n`.
`filepath_field`	string	Salah	Nama bidang indeks yang akan digunakan sebagai jalur file.
`title_field`	string	Salah	Nama bidang indeks yang akan digunakan sebagai judul.
`url_field`	string	Salah	Nama bidang indeks yang akan digunakan sebagai URL.

Jenis kueri

Jenis kueri pengambilan Elasticsearch yang harus dijalankan saat menggunakannya dengan Azure OpenAI On Your Data.

Nilai Enum	Deskripsi
`simple`	Mewakili pengurai kueri sederhana default.
`vector`	Mewakili pencarian vektor atas data komputasi.

Contoh

Prasyarat:

Konfigurasikan penetapan peran dari pengguna ke sumber daya Azure OpenAI. Peran yang diperlukan: Cognitive Services OpenAI User.
Instal Az CLI dan jalankan az login.
Tentukan variabel lingkungan berikut: AzureOpenAIEndpoint, , ChatCompletionsDeploymentName, SearchEndpoint, IndexName, Key. KeyId

export AzureOpenAIEndpoint=https://example.openai.azure.com/
export ChatCompletionsDeploymentName=turbo
export SearchEndpoint='https://example.eastus.azurecontainer.io'
export IndexName=testindex
export Key='***'
export KeyId='***'

Python 1.x
REST

Instal paket openaipip terbaru , 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")
index_name = os.environ.get("IndexName")
search_endpoint = os.environ.get("SearchEndpoint")
key = os.environ.get("Key")
key_id = os.environ.get("KeyId")

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": "elasticsearch",
                "parameters": {
                    "endpoint": search_endpoint,
                    "index_name": index_name,
                    "authentication": {
                        "type": "key_and_key_id",
                        "key": key,
                        "key_id": key_id
                    }
                }
            }
        ]
    }
)

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": "elasticsearch",
        "parameters": {
          "endpoint": "'$SearchEndpoint'",
          "index_name": "'$IndexName'",
          "authentication": {
            "type": "key_and_key_id",
            "key": "'$Key'",
            "key_id": "'$KeyId'"
          }
        }
      }
    ],
    "messages": [
      {
        "role": "user",
        "content": "Who is DRI?"
      }
    ]
}
'

Bagikan melalui