Knowledge Bases - Get

Layanan:: Search Service

Versi API:: 2026-08-01-preview

Mengambil definisi basis pengetahuan.

GET {endpoint}/knowledgebases('{knowledgeBaseName}')?api-version=2026-08-01-preview

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
endpoint	path	True	string (uri)	URL titik akhir layanan pencarian.
knowledgeBaseName	path	True	string	Nama pangkalan pengetahuan.
api-version	query	True	string minLength: 1	Versi API yang akan digunakan untuk operasi ini.

Header Permintaan

Nama	Diperlukan	Jenis	Deskripsi
Accept		Accept	Header Terima.
x-ms-client-request-id		string (uuid)	Pengidentifikasi string yang buram dan unik secara global yang dihasilkan klien untuk permintaan tersebut.

Respons

Nama	Jenis	Deskripsi
200 OK	KnowledgeBase	Permintaan telah berhasil.
Other Status Codes	ErrorResponse	Respons kesalahan yang tidak terduga.

Keamanan

api-key

Jenis: apiKey
Dalam: header

OAuth2Auth

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Cakupan

Nama	Deskripsi
https://search.azure.com/.default

Contoh

SearchServiceGetKnowledgeBase

Permintaan sampel

HTTP

GET https://typespecpreviewexampleservice.search.windows.net/knowledgebases('base-preview-test')?api-version=2026-08-01-preview

Respon sampel

Kode status:: 200

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "base-preview-test",
  "description": "Description of the knowledge base.",
  "retrievalInstructions": "Instructions for retrieval for the knowledge base.",
  "answerInstructions": "Instructions for answer synthesis.",
  "outputMode": "extractiveData",
  "knowledgeSources": [
    {
      "name": "ks-preview-test"
    }
  ],
  "models": [
    {
      "kind": "azureOpenAI",
      "azureOpenAIParameters": {
        "resourceUri": "https://test-sample.openai.azure.com",
        "deploymentId": "myDeployment",
        "apiKey": "<redacted>",
        "modelName": "gpt-4o-mini"
      }
    }
  ],
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "isServiceLevelKey": false,
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "tags": {
    "businessUnit": "Contoso Engineering Department",
    "costCenter": "ABC-123",
    "owner": "Contoso"
  },
  "retrievalReasoningEffort": {
    "kind": "low"
  },
  "corsOptions": {
    "allowedOrigins": [
      "https://myapp.example.com"
    ],
    "maxAgeInSeconds": 300
  },
  "retrieveDefaults": {
    "maxRuntimeInSeconds": 45,
    "maxOutputDocuments": 8,
    "maxOutputSizeInTokens": 12000
  }
}

Definisi

Nama	Deskripsi
Accept	Header Terima.
AzureOpenAIModelName	Nama model Azure Open AI yang akan dipanggil.
AzureOpenAIVectorizerParameters	Menentukan parameter untuk menyambungkan ke sumber daya Azure OpenAI.
CorsOptions	Menentukan opsi untuk mengontrol Berbagi Sumber Daya Lintas Asal (CORS) untuk indeks.
ErrorAdditionalInfo	Informasi tambahan tentang kesalahan pengelolaan sumber daya.
ErrorDetail	Detail kesalahan.
ErrorResponse	Respons kesalahan umum untuk semua API Azure Resource Manager untuk mengembalikan detail kesalahan untuk operasi yang gagal. (Ini juga mengikuti format respons kesalahan OData.).
KnowledgeBase	Mewakili definisi basis pengetahuan.
KnowledgeBaseAzureOpenAIModel	Menentukan sumber daya Azure OpenAI yang digunakan untuk melakukan perencanaan kueri.
KnowledgeBaseModelKind	Model AI yang akan digunakan untuk perencanaan kueri.
KnowledgeBaseRetrieveDefaults	Default permintaan yang dipertahankan untuk permintaan pengambilan basis pengetahuan. Setiap nilai memberikan default untuk bidang permintaan pengambilan yang sesuai; default layanan berlaku saat tidak diatur, dan nilai waktu permintaan menjadi prioritas saat ada.
KnowledgeRetrievalAutoReasoningEffort	Secara otomatis memilih upaya penalaran saat pengambilan. Layanan ini menanamkan setiap permintaan pada tingkat termurah dan hanya meningkat sejauh yang diperlukan, hingga tingkat maksimum yang tersedia dalam layanan.
KnowledgeRetrievalLowReasoningEffort	Jalankan pengambilan pengetahuan dengan upaya penalaran yang rendah.
KnowledgeRetrievalMediumReasoningEffort	Jalankan pengambilan pengetahuan dengan upaya penalaran sedang.
KnowledgeRetrievalMinimalReasoningEffort	Jalankan pengambilan pengetahuan dengan upaya penalaran minimal.
KnowledgeRetrievalOutputMode	Konfigurasi keluaran untuk pengambilan ini.
KnowledgeRetrievalReasoningEffortKind	Jumlah upaya yang digunakan selama pengambilan.
KnowledgeSourceReference	Referensi ke sumber pengetahuan.
SearchIndexerDataNoneIdentity	Menghapus properti identitas sumber data.
SearchIndexerDataUserAssignedIdentity	Menentukan identitas untuk sumber data yang akan digunakan.
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.

Accept

Enumerasi

Header Terima.

Nilai	Deskripsi
application/json;odata.metadata=minimal

AzureOpenAIModelName

Enumerasi

Nama model Azure Open AI yang akan dipanggil.

Nilai	Deskripsi
text-embedding-ada-002	TextEmbeddingModel Ada002.
text-embedding-3-large	TextEmbedding3Model besar.
text-embedding-3-small	TextEmbedding3Model kecil.
gpt-4o	Model Gpt4o.
gpt-4o-mini	Model Gpt4oMini.
gpt-4.1	Model Gpt41.
gpt-4.1-mini	Model Gpt41Mini.
gpt-4.1-nano	Model Gpt41Nano.
gpt-5	Model Gpt5.
gpt-5-mini	Model Gpt5Mini.
gpt-5-nano	Model Gpt5Nano.
gpt-5.1	Model Gpt51.
gpt-5.2	Model Gpt52.
gpt-5.4	Model Gpt54.
gpt-5.4-mini	Model Gpt54Mini.
gpt-5.4-nano	Model Gpt54Nano.
gpt-5.5	Model GPT55.
gpt-5.6-sol	Model Gpt56Sol.
gpt-5.6-terra	Model Gpt56Terra.
gpt-5.6-luna	Model Gpt56Luna.

AzureOpenAIVectorizerParameters

Objek

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: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	Identitas terkelola yang ditetapkan pengguna yang digunakan untuk koneksi keluar.
deploymentId	string	ID penyebaran model Azure OpenAI pada sumber daya yang ditunjuk.
modelName	AzureOpenAIModelName	Nama model penyematan yang disebarkan di jalur deploymentId yang disediakan.
resourceUri	string (uri)	URI sumber daya sumber daya Azure OpenAI.

CorsOptions

Objek

Menentukan opsi untuk mengontrol Berbagi Sumber Daya Lintas Asal (CORS) untuk indeks.

Nama	Jenis	Deskripsi
allowedOrigins	string[]	Daftar asal dari mana kode JavaScript akan diberikan akses ke indeks Anda. Dapat berisi daftar host dari bentuk {protocol}://{fully-qualified-domain-name}[:{port#}], atau satu '*' untuk mengizinkan semua asal (tidak disarankan).
maxAgeInSeconds	integer (int64)	Durasi browser harus menyimpan respons prapenerbangan CORS dalam cache. Default ke 5 menit.

ErrorAdditionalInfo

Objek

Informasi tambahan tentang kesalahan pengelolaan sumber daya.

Nama	Jenis	Deskripsi
info		Info tambahan.
type	string	Jenis informasi tambahan.

ErrorDetail

Objek

Detail kesalahan.

Nama	Jenis	Deskripsi
additionalInfo	ErrorAdditionalInfo[]	Informasi tambahan tentang kesalahan.
code	string	Kode kesalahan.
details	ErrorDetail[]	Rincian kesalahan.
message	string	Pesan kesalahan.
target	string	Sasaran kesalahan.

ErrorResponse

Objek

Respons kesalahan umum untuk semua API Azure Resource Manager untuk mengembalikan detail kesalahan untuk operasi yang gagal. (Ini juga mengikuti format respons kesalahan OData.).

Nama	Jenis	Deskripsi
error	ErrorDetail	Objek kesalahan.

KnowledgeBase

Objek

Mewakili definisi basis pengetahuan.

Nama	Jenis	Deskripsi
@odata.etag	string	ETag basis pengetahuan.
answerInstructions	string	Instruksi yang dipertimbangkan oleh basis pengetahuan saat menghasilkan jawaban.
corsOptions	CorsOptions	Opsi untuk mengontrol Berbagi Sumber Daya Lintas Asal (CORS) untuk basis pengetahuan.
description	string	Deskripsi basis pengetahuan.
encryptionKey	SearchResourceEncryptionKey	Deskripsi kunci enkripsi yang Anda buat di Azure Key Vault.
knowledgeSources	KnowledgeSourceReference[]	Sumber pengetahuan yang direferensikan oleh basis pengetahuan ini.
models	KnowledgeBaseModel[]: KnowledgeBaseAzureOpenAIModel[]	Berisi opsi konfigurasi tentang cara terhubung ke model AI.
name	string	Nama pangkalan pengetahuan.
outputMode	KnowledgeRetrievalOutputMode	Mode keluaran untuk basis pengetahuan.
retrievalInstructions	string	Instruksi yang dipertimbangkan oleh basis pengetahuan saat mengembangkan rencana kueri.
retrievalReasoningEffort	KnowledgeRetrievalReasoningEffort: KnowledgeRetrievalAutoReasoningEffort KnowledgeRetrievalLowReasoningEffort KnowledgeRetrievalMediumReasoningEffort KnowledgeRetrievalMinimalReasoningEffort	Konfigurasi upaya penalaran pengambilan.
retrieveDefaults	KnowledgeBaseRetrieveDefaults	Default pengambilan seluruh permintaan yang disimpan untuk basis pengetahuan ini. Nilai-nilai ini berlaku untuk mengambil permintaan yang menghilangkan bidang yang sesuai; nilai waktu permintaan menjadi prioritas jika ada.
tags	object	Pasangan kunci-nilai yang ditentukan pengguna untuk mengkategorikan basis pengetahuan serta mengatribusikan penggunaan dan biayanya.

KnowledgeBaseAzureOpenAIModel

Objek

Menentukan sumber daya Azure OpenAI yang digunakan untuk melakukan perencanaan kueri.

Nama	Jenis	Deskripsi
azureOpenAIParameters	AzureOpenAIVectorizerParameters	Parameter Azure OpenAI.
kind	string: azureOpenAI	Model AI yang akan digunakan untuk perencanaan kueri.

KnowledgeBaseModelKind

Enumerasi

Model AI yang akan digunakan untuk perencanaan kueri.

Nilai	Deskripsi
azureOpenAI	Gunakan model Azure Open AI untuk perencanaan kueri.

KnowledgeBaseRetrieveDefaults

Objek

Default permintaan yang dipertahankan untuk permintaan pengambilan basis pengetahuan. Setiap nilai memberikan default untuk bidang permintaan pengambilan yang sesuai; default layanan berlaku saat tidak diatur, dan nilai waktu permintaan menjadi prioritas saat ada.

Nama	Jenis	Deskripsi
maxOutputDocuments	integer (int32)	Jumlah maksimum dokumen default dalam output pengambilan.
maxOutputSizeInTokens	integer (int32)	Ukuran maksimum default, dalam token, dari konten dalam output pengambilan.
maxRuntimeInSeconds	integer (int32)	Waktu eksekusi maksimum default dalam detik untuk permintaan pengambilan.

KnowledgeRetrievalAutoReasoningEffort

Objek

Secara otomatis memilih upaya penalaran saat pengambilan. Layanan ini menanamkan setiap permintaan pada tingkat termurah dan hanya meningkat sejauh yang diperlukan, hingga tingkat maksimum yang tersedia dalam layanan.

Nama	Jenis	Deskripsi
kind	string: auto	Jenis upaya penalaran.

KnowledgeRetrievalLowReasoningEffort

Objek

Jalankan pengambilan pengetahuan dengan upaya penalaran yang rendah.

Nama	Jenis	Deskripsi
kind	string: low	Jenis upaya penalaran.

KnowledgeRetrievalMediumReasoningEffort

Objek

Jalankan pengambilan pengetahuan dengan upaya penalaran sedang.

Nama	Jenis	Deskripsi
kind	string: medium	Jenis upaya penalaran.

KnowledgeRetrievalMinimalReasoningEffort

Objek

Jalankan pengambilan pengetahuan dengan upaya penalaran minimal.

Nama	Jenis	Deskripsi
kind	string: minimal	Jenis upaya penalaran.

KnowledgeRetrievalOutputMode

Enumerasi

Konfigurasi keluaran untuk pengambilan ini.

Nilai	Deskripsi
extractiveData	Mengembalikan data dari sumber pengetahuan secara langsung tanpa perubahan generatif.
answerSynthesis	Mensintesis jawaban untuk payload respons.

KnowledgeRetrievalReasoningEffortKind

Enumerasi

Jumlah upaya yang digunakan selama pengambilan.

Nilai	Deskripsi
minimal	Tidak melakukan pemilihan sumber, perencanaan kueri, atau pencarian berulang.
low	Gunakan penalaran rendah selama pengambilan.
medium	Gunakan penalaran dalam jumlah sedang selama pengambilan.
auto	Secara otomatis pilih usaha penalaran saat pengambilan, naik dari tingkat termurah hanya sejauh yang diperlukan.

KnowledgeSourceReference

Objek

Referensi ke sumber pengetahuan.

Nama	Jenis	Deskripsi
enableFreshness	boolean	Menunjukkan apakah pengambilan sadar kesegaran harus diaktifkan untuk sumber pengetahuan ini. Jika benar, profil penilaian kesegaran diterapkan selama pengambilan untuk membias hasil terhadap dokumen yang lebih baru.
enableImageServing	boolean	Menunjukkan apakah penayangan gambar harus diaktifkan untuk sumber pengetahuan ini. Jika benar, gambar yang diekstrak selama penyerapan dikirimkan ke model hilir pada waktu kueri.
name	string	Nama sumber pengetahuan.

SearchIndexerDataNoneIdentity

Objek

Menghapus properti identitas sumber data.

Nama	Jenis	Deskripsi
@odata.type	string: #Microsoft.Azure.Search.DataNoneIdentity	Fragmen URI yang menentukan jenis identitas.

SearchIndexerDataUserAssignedIdentity

Objek

Menentukan identitas untuk sumber data yang akan digunakan.

Nama	Jenis	Deskripsi
@odata.type	string: #Microsoft.Azure.Search.DataUserAssignedIdentity	Fragmen URI yang menentukan jenis identitas.
federatedIdentityClientId	string	Dukungan Identitas Terkelola User-Assigned Multi-penyewa: ID klien Aplikasi multi-tentant yang telah dikonfigurasi untuk berfederasi dengan identitas terkelola yang ditetapkan pengguna.
userAssignedIdentity	string	Id sumber daya Azure yang sepenuhnya memenuhi syarat dari identitas terkelola yang ditetapkan pengguna biasanya dalam formulir "/subscriptions/12345678-1234-1234-1234567890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId" yang seharusnya ditetapkan ke layanan pencarian.

SearchResourceEncryptionKey

Objek

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	Nilai default	Deskripsi
accessCredentials.applicationId	string		ID Aplikasi AAD yang diberikan izin akses yang diperlukan ke Azure Key Vault yang akan digunakan saat mengenkripsi data Anda tidak aktif. ID Aplikasi tidak boleh bingung dengan ID Objek untuk Aplikasi AAD Anda.
accessCredentials.applicationSecret	string		Kunci autentikasi aplikasi AAD yang ditentukan.
identity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity		Identitas terkelola eksplisit yang digunakan untuk kunci enkripsi ini. Jika tidak ditentukan dan properti kredensial akses null, identitas terkelola yang ditetapkan sistem akan digunakan. Pada pembaruan ke sumber daya, jika identitas eksplisit tidak ditentukan, identitas tersebut tetap tidak berubah. Jika "tidak ada" ditentukan, nilai properti ini akan dihapus.
isServiceLevelKey	boolean	False	Nilai opsional yang menunjukkan apakah kunci ini adalah kunci tingkat layanan. Secara default adalah false.
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 `https://my-keyvault-name.vault.azure.net`.