Knowledge Sources - Get
Mengambil definisi sumber pengetahuan.
GET {endpoint}/knowledgesources('{sourceName}')?api-version=2025-08-01-preview
Parameter URI
| Nama | Dalam | Diperlukan | Jenis | Deskripsi |
|---|---|---|---|---|
|
endpoint
|
path | True |
string |
URL titik akhir layanan pencarian. |
|
source
|
path | True |
string |
Nama sumber pengetahuan yang akan diambil. |
|
api-version
|
query | True |
string |
Versi API Klien. |
Header Permintaan
| Nama | Diperlukan | Jenis | Deskripsi |
|---|---|---|---|
| x-ms-client-request-id |
string (uuid) |
ID pelacakan yang dikirim dengan permintaan untuk membantu penelusuran kesalahan. |
Respons
| Nama | Jenis | Deskripsi |
|---|---|---|
| 200 OK | KnowledgeSource: | |
| Other Status Codes |
Respons kesalahan. |
Contoh
|
Search |
|
Search |
SearchServiceGetKnowledgeSource
Permintaan sampel
GET https://previewexampleservice.search.windows.net/knowledgesources('ks-preview-test')?api-version=2025-08-01-preview
Respon sampel
{
"@odata.etag": "0x1234568AE7E58A1",
"name": "ks-preview-test",
"kind": "searchIndex",
"description": "Description of the knowledge source.",
"encryptionKey": {
"keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
"keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
"keyVaultUri": "https://myKeyVault.vault.azure.net",
"accessCredentials": {
"applicationId": "00000000-0000-0000-0000-000000000000",
"applicationSecret": "<applicationSecret>"
}
},
"searchIndexParameters": {
"searchIndexName": "preview-test",
"sourceDataSelect": "description,category"
}
}
SearchServiceGetKnowledgeSourceAzureBlob
Permintaan sampel
GET https://previewexampleservice.search.windows.net/knowledgesources('ks-preview-test')?api-version=2025-08-01-preview
Respon sampel
{
"@odata.etag": "0x1234568AE7E58A1",
"name": "ks-preview-test",
"kind": "azureBlob",
"description": "Description of the knowledge source.",
"encryptionKey": {
"keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
"keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
"keyVaultUri": "https://myKeyVault.vault.azure.net",
"accessCredentials": {
"applicationId": "00000000-0000-0000-0000-000000000000",
"applicationSecret": "<applicationSecret>"
}
},
"azureBlobParameters": {
"connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
"containerName": "test-container",
"folderPath": "test-path",
"identity": {
"@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity",
"userAssignedIdentity": "/my/userassigned/id"
},
"embeddingModel": {
"name": "openai",
"kind": "azureOpenAI",
"azureOpenAIParameters": {
"resourceUri": "https://test-sample.openai.azure.com",
"deploymentId": "model",
"apiKey": "<redacted>",
"modelName": "text-embedding-3-large"
}
},
"chatCompletionModel": {
"kind": "azureOpenAI",
"azureOpenAIParameters": {
"resourceUri": "https://test-sample.openai.azure.com",
"deploymentId": "myDeployment",
"apiKey": "<redacted>",
"modelName": "gpt-4o-mini"
}
},
"ingestionSchedule": {
"interval": "P1D",
"startTime": "2024-06-06T00:01:50.265Z"
}
}
}
Definisi
| Nama | Deskripsi |
|---|---|
|
AIFoundry |
Nama model penyematan dari Azure AI Foundry Catalog yang akan dipanggil. |
|
AIServices |
Menentukan parameter AI Services Vision untuk vektorisasi gambar atau teks kueri. |
|
AIServices |
Menentukan parameter AI Services Vision untuk vektorisasi gambar atau teks kueri. |
| AMLParameters |
Menentukan properti untuk menghubungkan ke vektor AML. |
| AMLVectorizer |
Menentukan titik akhir Azure Machine Learning yang disebarkan melalui Katalog Model Azure AI Foundry untuk menghasilkan penyematan vektor string kueri. |
|
Azure |
Kredensial aplikasi terdaftar yang dibuat untuk layanan pencarian Anda, digunakan untuk akses terautentikasi ke kunci enkripsi yang disimpan di Azure Key Vault. |
|
Azure |
Konfigurasi untuk sumber pengetahuan Azure Blob Storage. |
|
Azure |
Parameter untuk sumber pengetahuan Azure Blob Storage. |
|
Azure |
Memungkinkan Anda membuat penyematan vektor untuk input teks tertentu menggunakan sumber daya Azure OpenAI. |
|
Azure |
Nama model Azure Open AI yang akan dipanggil. |
|
Azure |
Menentukan parameter untuk menyambungkan ke sumber daya Azure OpenAI. |
|
Azure |
Menentukan sumber daya Azure OpenAI yang digunakan untuk mengvektorkan string kueri. |
|
Error |
Info tambahan kesalahan manajemen sumber daya. |
|
Error |
Detail kesalahan. |
|
Error |
Tanggapan kesalahan |
|
Indexing |
Mewakili jadwal untuk eksekusi pengindeks. |
|
Input |
Pemetaan bidang input untuk keterampilan. |
|
Knowledge |
Menentukan sumber daya Azure OpenAI yang digunakan untuk melakukan perencanaan kueri. |
|
Knowledge |
Model AI yang akan digunakan untuk perencanaan kueri. |
|
Knowledge |
Jenis sumber pengetahuan. |
|
Output |
Pemetaan bidang keluaran untuk keterampilan. |
|
Search |
Menghapus properti identitas sumber data. |
|
Search |
Menentukan identitas untuk digunakan sumber data. |
|
Search |
Sumber Pengetahuan menargetkan indeks penelusuran. |
|
Search |
Parameter untuk sumber pengetahuan indeks pencarian. |
|
Search |
Kunci enkripsi yang dikelola pelanggan di Azure Key Vault. Kunci yang Anda buat dan kelola dapat digunakan untuk mengenkripsi atau mendekripsi data-at-rest, seperti indeks dan peta sinonim. |
|
Vector |
Metode vektorisasi yang akan digunakan selama waktu kueri. |
|
Web |
Menentukan properti untuk menyambungkan ke vektor yang ditentukan pengguna. |
|
Web |
Menentukan vektor yang ditentukan pengguna untuk menghasilkan penyematan vektor string kueri. Integrasi vektor eksternal dicapai menggunakan antarmuka API Web khusus dari set keterampilan. |
AIFoundryModelCatalogName
Nama model penyematan dari Azure AI Foundry Catalog yang akan dipanggil.
| Nilai | Deskripsi |
|---|---|
| OpenAI-CLIP-Image-Text-Embeddings-vit-base-patch32 | |
| OpenAI-CLIP-Image-Text-Embeddings-ViT-Large-Patch14-336 | |
| Facebook-DinoV2-Image-Embeddings-ViT-Base | |
| Facebook-DinoV2-Image-Embeddings-ViT-Giant | |
| Cohere-embed-v3-english | |
| Cohere-embed-v3-multilingual | |
| Cohere-embed-v4 |
Cohere embed v4 model untuk menghasilkan penyematan dari teks dan gambar. |
AIServicesVisionParameters
Menentukan parameter AI Services Vision untuk vektorisasi gambar atau teks kueri.
| Nama | Jenis | Deskripsi |
|---|---|---|
| apiKey |
string |
Kunci API dari sumber daya Layanan AI yang ditunjuk. |
| authIdentity | SearchIndexerDataIdentity: |
Identitas terkelola yang ditetapkan pengguna yang digunakan untuk koneksi keluar. Jika authResourceId disediakan dan tidak ditentukan, identitas terkelola yang ditetapkan sistem akan digunakan. Pada pembaruan indeks, jika identitas tidak ditentukan, nilainya tetap tidak berubah. Jika diatur ke "none", nilai properti ini akan dihapus. |
| modelVersion |
string |
Versi model yang akan digunakan saat memanggil layanan AI Services Vision. Ini akan default ke yang terbaru tersedia jika tidak ditentukan. |
| resourceUri |
string (uri) |
URI sumber daya sumber daya Layanan AI. |
AIServicesVisionVectorizer
Menentukan parameter AI Services Vision untuk vektorisasi gambar atau teks kueri.
| Nama | Jenis | Deskripsi |
|---|---|---|
| aiServicesVisionParameters |
Berisi parameter khusus untuk vektorisasi penyematan AI Services Vision. |
|
| kind |
string:
ai |
Nama jenis metode vektorisasi yang dikonfigurasi untuk digunakan dengan pencarian vektor. |
| name |
string |
Nama untuk dikaitkan dengan metode vektorisasi khusus ini. |
AMLParameters
Menentukan properti untuk menghubungkan ke vektor AML.
| Nama | Jenis | Deskripsi |
|---|---|---|
| key |
string |
(Wajib untuk autentikasi kunci) Kunci untuk layanan AML. |
| modelName |
Nama model penyematan dari Azure AI Foundry Catalog yang disebarkan di titik akhir yang disediakan. |
|
| region |
string |
(Opsional untuk autentikasi token). Wilayah tempat layanan AML digunakan. |
| resourceId |
string |
(Diperlukan untuk autentikasi token). ID sumber daya Azure Resource Manager dari layanan AML. Itu harus dalam format subscriptions/{guid}/resourceGroups/{resource-group-name}/Microsoft.MachineLearningServices/workspaces/{workspace-name}/services/{service_name}. |
| timeout |
string (duration) |
(Opsional) Saat ditentukan, menunjukkan batas waktu untuk klien http yang melakukan panggilan API. |
| uri |
string (uri) |
(Wajib untuk tidak ada autentikasi atau autentikasi kunci) URI penilaian layanan AML tempat payload JSON akan dikirim. Hanya skema URI https yang diizinkan. |
AMLVectorizer
Menentukan titik akhir Azure Machine Learning yang disebarkan melalui Katalog Model Azure AI Foundry untuk menghasilkan penyematan vektor string kueri.
| Nama | Jenis | Deskripsi |
|---|---|---|
| amlParameters |
Menentukan properti vektor AML. |
|
| kind |
string:
aml |
Nama jenis metode vektorisasi yang dikonfigurasi untuk digunakan dengan pencarian vektor. |
| name |
string |
Nama untuk dikaitkan dengan metode vektorisasi khusus ini. |
AzureActiveDirectoryApplicationCredentials
Kredensial aplikasi terdaftar yang dibuat untuk layanan pencarian Anda, digunakan untuk akses terautentikasi ke kunci enkripsi yang disimpan di Azure Key Vault.
| Nama | Jenis | Deskripsi |
|---|---|---|
| applicationId |
string |
ID Aplikasi AAD yang diberikan izin akses yang diperlukan ke Azure Key Vault yang akan digunakan saat mengenkripsi data Anda saat tidak aktif. ID Aplikasi tidak boleh disamakan dengan ID Objek untuk Aplikasi AAD Anda. |
| applicationSecret |
string |
Kunci otentikasi dari aplikasi AAD yang ditentukan. |
AzureBlobKnowledgeSource
Konfigurasi untuk sumber pengetahuan Azure Blob Storage.
| Nama | Jenis | Deskripsi |
|---|---|---|
| @odata.etag |
string |
ETag agen. |
| azureBlobParameters |
Jenis sumber pengetahuan. |
|
| description |
string |
Deskripsi opsional yang ditentukan pengguna. |
| encryptionKey |
Deskripsi kunci enkripsi yang Anda buat di Azure Key Vault. Kunci ini digunakan untuk memberikan tingkat enkripsi tambahan untuk definisi agen Anda ketika Anda menginginkan jaminan penuh bahwa tidak ada seorang pun, bahkan Microsoft, yang dapat mendekripsinya. Setelah Anda mengenkripsi definisi agen Anda, itu akan selalu terenkripsi. Layanan pencarian akan mengabaikan upaya untuk mengatur properti ini ke null. Anda dapat mengubah properti ini sesuai kebutuhan jika Anda ingin memutar kunci enkripsi Anda; Definisi agen Anda tidak akan terpengaruh. Enkripsi dengan kunci yang dikelola pelanggan tidak tersedia untuk layanan penelusuran gratis, dan hanya tersedia untuk layanan berbayar yang dibuat pada atau setelah 1 Januari 2019. |
|
| kind |
string:
azure |
Jenis sumber pengetahuan. |
| name |
string |
Nama sumber pengetahuan. |
AzureBlobKnowledgeSourceParameters
Parameter untuk sumber pengetahuan Azure Blob Storage.
| Nama | Jenis | Deskripsi |
|---|---|---|
| chatCompletionModel | KnowledgeAgentModel: |
Model penyelesaian obrolan opsional untuk verbalisasi gambar atau ekstraksi konteks. |
| connectionString |
string |
String koneksi berbasis kunci atau format ResourceId jika menggunakan identitas terkelola. |
| containerName |
string |
Nama kontainer penyimpanan blob. |
| createdResources |
object |
Sumber daya yang dibuat oleh sumber pengetahuan. |
| disableImageVerbalization |
boolean |
Menunjukkan apakah verbalisasi gambar harus dinonaktifkan. |
| embeddingModel | VectorSearchVectorizer: |
Konfigurasi vektor opsional untuk vektorisasi konten. |
| folderPath |
string |
Jalur folder opsional dalam kontainer. |
| identity | SearchIndexerDataIdentity: |
Identitas eksplisit untuk digunakan untuk sumber pengetahuan ini. |
| ingestionSchedule |
Jadwal opsional untuk penyerapan data. |
AzureOpenAIEmbeddingSkill
Memungkinkan Anda membuat penyematan vektor untuk input teks tertentu menggunakan sumber daya Azure OpenAI.
| Nama | Jenis | Deskripsi |
|---|---|---|
| @odata.type |
string:
#Microsoft. |
Fragmen URI yang menentukan jenis keterampilan. |
| apiKey |
string |
Kunci API dari sumber daya Azure OpenAI yang ditunjuk. |
| authIdentity | SearchIndexerDataIdentity: |
Identitas terkelola yang ditetapkan pengguna yang digunakan untuk koneksi keluar. |
| context |
string |
Mewakili tingkat di mana operasi berlangsung, seperti akar dokumen atau konten dokumen (misalnya, /document atau /document/content). Defaultnya adalah /document. |
| deploymentId |
string |
ID penyebaran model Azure OpenAI pada sumber daya yang ditentukan. |
| description |
string |
Deskripsi keterampilan yang menggambarkan input, output, dan penggunaan keterampilan. |
| dimensions |
integer (int32) |
Jumlah dimensi yang harus dimiliki oleh embedding output yang dihasilkan. Hanya didukung dalam text-embedding-3 dan model yang lebih baru. |
| inputs |
Input keterampilan dapat berupa kolom dalam kumpulan data sumber, atau output dari keterampilan hulu. |
|
| modelName |
Nama model penyematan yang disebarkan di jalur deploymentId yang disediakan. |
|
| name |
string |
Nama keterampilan yang secara unik mengidentifikasinya dalam keahlian. Keterampilan tanpa nama yang ditentukan akan diberi nama default dari indeks berbasis 1 dalam array keterampilan, diawali dengan karakter '#'. |
| outputs |
Output keterampilan adalah bidang dalam indeks pencarian, atau nilai yang dapat digunakan sebagai input oleh keterampilan lain. |
|
| resourceUri |
string (uri) |
URI sumber daya sumber daya Azure OpenAI. |
AzureOpenAIModelName
Nama model Azure Open AI yang akan dipanggil.
| Nilai | Deskripsi |
|---|---|
| text-embedding-ada-002 | |
| text-embedding-3-large | |
| text-embedding-3-small | |
| gpt-4o | |
| gpt-4o-mini | |
| gpt-4.1 | |
| gpt-4.1-mini | |
| gpt-4.1-nano |
AzureOpenAIParameters
Menentukan parameter untuk menyambungkan ke sumber daya Azure OpenAI.
| Nama | Jenis | Deskripsi |
|---|---|---|
| apiKey |
string |
Kunci API dari sumber daya Azure OpenAI yang ditunjuk. |
| authIdentity | SearchIndexerDataIdentity: |
Identitas terkelola yang ditetapkan pengguna yang digunakan untuk koneksi keluar. |
| deploymentId |
string |
ID penyebaran model Azure OpenAI pada sumber daya yang ditentukan. |
| modelName |
Nama model penyematan yang disebarkan di jalur deploymentId yang disediakan. |
|
| resourceUri |
string (uri) |
URI sumber daya sumber daya Azure OpenAI. |
AzureOpenAIVectorizer
Menentukan sumber daya Azure OpenAI yang digunakan untuk mengvektorkan string kueri.
| Nama | Jenis | Deskripsi |
|---|---|---|
| azureOpenAIParameters | AzureOpenAIParameters: |
Berisi parameter khusus untuk vektorisasi penyematan Azure OpenAI. |
| kind |
string:
azure |
Nama jenis metode vektorisasi yang dikonfigurasi untuk digunakan dengan pencarian vektor. |
| name |
string |
Nama untuk dikaitkan dengan metode vektorisasi khusus ini. |
ErrorAdditionalInfo
Info tambahan kesalahan manajemen sumber daya.
| Nama | Jenis | Deskripsi |
|---|---|---|
| info |
object |
Info tambahan. |
| type |
string |
Jenis info tambahan. |
ErrorDetail
Detail kesalahan.
| Nama | Jenis | Deskripsi |
|---|---|---|
| additionalInfo |
Info tambahan kesalahan. |
|
| code |
string |
Kode kesalahan. |
| details |
Detail kesalahan. |
|
| message |
string |
Pesan kesalahan. |
| target |
string |
Target kesalahan. |
ErrorResponse
Tanggapan kesalahan
| Nama | Jenis | Deskripsi |
|---|---|---|
| error |
Objek kesalahan. |
IndexingSchedule
Mewakili jadwal untuk eksekusi pengindeks.
| Nama | Jenis | Deskripsi |
|---|---|---|
| interval |
string (duration) |
Interval waktu antara eksekusi pengindeks. |
| startTime |
string (date-time) |
Waktu ketika pengindeks harus mulai berjalan. |
InputFieldMappingEntry
Pemetaan bidang input untuk keterampilan.
| Nama | Jenis | Deskripsi |
|---|---|---|
| inputs |
Input rekursif yang digunakan saat membuat jenis yang kompleks. |
|
| name |
string |
Nama input. |
| source |
string |
Sumber input. |
| sourceContext |
string |
Konteks sumber yang digunakan untuk memilih input rekursif. |
KnowledgeAgentAzureOpenAIModel
Menentukan sumber daya Azure OpenAI yang digunakan untuk melakukan perencanaan kueri.
| Nama | Jenis | Deskripsi |
|---|---|---|
| azureOpenAIParameters | AzureOpenAIParameters: |
Berisi parameter khusus untuk titik akhir model Azure OpenAI. |
| kind |
string:
azure |
Jenis model AI. |
KnowledgeAgentModelKind
Model AI yang akan digunakan untuk perencanaan kueri.
| Nilai | Deskripsi |
|---|---|
| azureOpenAI |
Gunakan model Azure Open AI untuk perencanaan kueri. |
KnowledgeSourceKind
Jenis sumber pengetahuan.
| Nilai | Deskripsi |
|---|---|
| searchIndex |
Sumber pengetahuan yang membaca data dari Indeks Pencarian. |
| azureBlob |
Sumber pengetahuan yang membaca dan menyerap data dari Azure Blob Storage ke Indeks Pencarian. |
OutputFieldMappingEntry
Pemetaan bidang keluaran untuk keterampilan.
| Nama | Jenis | Deskripsi |
|---|---|---|
| name |
string |
Nama output yang ditentukan oleh keterampilan. |
| targetName |
string |
Nama target output. Ini opsional dan default untuk bernama. |
SearchIndexerDataNoneIdentity
Menghapus properti identitas sumber data.
| Nama | Jenis | Deskripsi |
|---|---|---|
| @odata.type |
string:
#Microsoft. |
Fragmen URI yang menentukan jenis identitas. |
SearchIndexerDataUserAssignedIdentity
Menentukan identitas untuk digunakan sumber data.
| Nama | Jenis | Deskripsi |
|---|---|---|
| @odata.type |
string:
#Microsoft. |
Fragmen URI yang menentukan jenis identitas. |
| userAssignedIdentity |
string |
Id sumber daya Azure yang memenuhi syarat penuh dari identitas terkelola yang ditetapkan pengguna biasanya dalam bentuk "/subscriptions/12345678-1234-1234-1234567890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId" yang seharusnya ditetapkan ke layanan pencarian. |
SearchIndexKnowledgeSource
Sumber Pengetahuan menargetkan indeks penelusuran.
| Nama | Jenis | Deskripsi |
|---|---|---|
| @odata.etag |
string |
ETag agen. |
| description |
string |
Deskripsi opsional yang ditentukan pengguna. |
| encryptionKey |
Deskripsi kunci enkripsi yang Anda buat di Azure Key Vault. Kunci ini digunakan untuk memberikan tingkat enkripsi tambahan untuk definisi agen Anda ketika Anda menginginkan jaminan penuh bahwa tidak ada seorang pun, bahkan Microsoft, yang dapat mendekripsinya. Setelah Anda mengenkripsi definisi agen Anda, itu akan selalu terenkripsi. Layanan pencarian akan mengabaikan upaya untuk mengatur properti ini ke null. Anda dapat mengubah properti ini sesuai kebutuhan jika Anda ingin memutar kunci enkripsi Anda; Definisi agen Anda tidak akan terpengaruh. Enkripsi dengan kunci yang dikelola pelanggan tidak tersedia untuk layanan penelusuran gratis, dan hanya tersedia untuk layanan berbayar yang dibuat pada atau setelah 1 Januari 2019. |
|
| kind |
string:
search |
Jenis sumber pengetahuan. |
| name |
string |
Nama sumber pengetahuan. |
| searchIndexParameters |
Parameter untuk sumber pengetahuan. |
SearchIndexKnowledgeSourceParameters
Parameter untuk sumber pengetahuan indeks pencarian.
| Nama | Jenis | Deskripsi |
|---|---|---|
| searchIndexName |
string |
Nama indeks Pencarian. |
| sourceDataSelect |
string |
Digunakan untuk meminta bidang tambahan untuk data sumber yang direferensikan. |
SearchResourceEncryptionKey
Kunci enkripsi yang dikelola pelanggan di Azure Key Vault. Kunci yang Anda buat dan kelola dapat digunakan untuk mengenkripsi atau mendekripsi data-at-rest, seperti indeks dan peta sinonim.
| Nama | Jenis | Deskripsi |
|---|---|---|
| accessCredentials |
Kredensial Azure Active Directory opsional yang digunakan untuk mengakses Azure Key Vault Anda. Tidak diperlukan jika menggunakan identitas terkelola sebagai gantinya. |
|
| identity | SearchIndexerDataIdentity: |
Identitas terkelola eksplisit untuk digunakan untuk kunci enkripsi ini. Jika tidak ditentukan dan properti kredensial akses null, identitas terkelola yang ditetapkan sistem digunakan. Saat memperbarui sumber daya, jika identitas eksplisit tidak ditentukan, identitas tersebut tetap tidak berubah. Jika "none" ditentukan, nilai properti ini dihapus. |
| keyVaultKeyName |
string |
Nama kunci Azure Key Vault Anda yang akan digunakan untuk mengenkripsi data Anda saat tidak aktif. |
| keyVaultKeyVersion |
string |
Versi kunci Azure Key Vault Anda yang akan digunakan untuk mengenkripsi data Anda saat tidak aktif. |
| keyVaultUri |
string |
URI Azure Key Vault Anda, juga disebut sebagai nama DNS, yang berisi kunci yang akan digunakan untuk mengenkripsi data Anda saat tidak aktif. Contoh URI mungkin . |
VectorSearchVectorizerKind
Metode vektorisasi yang akan digunakan selama waktu kueri.
| Nilai | Deskripsi |
|---|---|
| azureOpenAI |
Hasilkan penyematan menggunakan sumber daya Azure OpenAI pada waktu kueri. |
| customWebApi |
Hasilkan penyematan menggunakan titik akhir web kustom pada waktu kueri. |
| aiServicesVision |
Hasilkan penyematan untuk input gambar atau teks pada waktu kueri menggunakan API Azure AI Services Vision Vectorize. |
| aml |
Hasilkan penyematan menggunakan titik akhir Azure Machine Learning yang disebarkan melalui Katalog Model Azure AI Foundry pada waktu kueri. |
WebApiParameters
Menentukan properti untuk menyambungkan ke vektor yang ditentukan pengguna.
| Nama | Jenis | Deskripsi |
|---|---|---|
| authIdentity | SearchIndexerDataIdentity: |
Identitas terkelola yang ditetapkan pengguna yang digunakan untuk koneksi keluar. Jika authResourceId disediakan dan tidak ditentukan, identitas terkelola yang ditetapkan sistem akan digunakan. Pada pembaruan pada pengindeks, jika identitas tidak ditentukan, nilainya tetap tidak berubah. Jika diatur ke "none", nilai properti ini akan dihapus. |
| authResourceId |
string |
Berlaku untuk titik akhir kustom yang terhubung ke kode eksternal dalam fungsi Azure atau beberapa aplikasi lain yang menyediakan transformasi. Nilai ini harus berupa ID aplikasi yang dibuat untuk fungsi atau aplikasi saat terdaftar di Azure Active Directory. Saat ditentukan, vektorisasi terhubung ke fungsi atau aplikasi menggunakan ID terkelola (baik sistem atau yang ditetapkan pengguna) dari layanan pencarian dan token akses fungsi atau aplikasi, menggunakan nilai ini sebagai ID sumber daya untuk membuat cakupan token akses. |
| httpHeaders |
object |
Header yang diperlukan untuk membuat permintaan HTTP. |
| httpMethod |
string |
Metode untuk permintaan HTTP. |
| timeout |
string (duration) |
Batas waktu yang diinginkan untuk permintaan. Defaultnya adalah 30 detik. |
| uri |
string (uri) |
URI API Web yang menyediakan vektorisasi. |
WebApiVectorizer
Menentukan vektor yang ditentukan pengguna untuk menghasilkan penyematan vektor string kueri. Integrasi vektor eksternal dicapai menggunakan antarmuka API Web khusus dari set keterampilan.
| Nama | Jenis | Deskripsi |
|---|---|---|
| customWebApiParameters |
Menentukan properti vektor yang ditentukan pengguna. |
|
| kind |
string:
custom |
Nama jenis metode vektorisasi yang dikonfigurasi untuk digunakan dengan pencarian vektor. |
| name |
string |
Nama untuk dikaitkan dengan metode vektorisasi khusus ini. |