Knowledge Bases - Get
Bir bilgi tabanı tanımını alır.
GET {endpoint}/knowledgebases('{knowledgeBaseName}')?api-version=2026-10-01
URI Parametreleri
| Veri Akışı Adı | İçinde | Gerekli | Tür | Description |
|---|---|---|---|---|
|
endpoint
|
path | True |
string (uri) |
Arama hizmetinin uç nokta URL'si. |
|
knowledge
|
path | True |
string |
Bilgi bankasının adı. |
|
api-version
|
query | True |
string minLength: 1 |
Bu işlem için kullanılacak API sürümü. |
İstek Başlığı
| Veri Akışı Adı | Gerekli | Tür | Description |
|---|---|---|---|
| x-ms-client-request-id |
string (uuid) |
İstek için opak, genel olarak benzersiz, istemci tarafından oluşturulan bir dize tanımlayıcısı. |
|
| Accept |
Accept başlığı. |
Yanıtlar
| Veri Akışı Adı | Tür | Description |
|---|---|---|
| 200 OK |
İstek başarılı oldu. |
|
| Other Status Codes |
Beklenmeyen bir hata yanıtı. |
Güvenlik
api-key
Tür:
apiKey
İçinde:
header
OAuth2Auth
Tür:
oauth2
Akış:
implicit
Yetkilendirme URL’si:
https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Kapsamlar
| Veri Akışı Adı | Description |
|---|---|
| https://search.azure.com/.default |
Örnekler
SearchServiceGetKnowledgeBase
Örnek isteği
GET https://typespecstableexampleservice.search.windows.net/knowledgebases('base-preview-test')?api-version=2026-10-01
Örnek yanıt
{
"@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-stable-test"
}
],
"models": [
{
"kind": "azureOpenAI",
"azureOpenAIParameters": {
"resourceUri": "https://test-sample.openai.azure.com",
"deploymentId": "myDeployment",
"apiKey": "<redacted>",
"modelName": "gpt-5-mini"
}
}
],
"encryptionKey": {
"keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
"keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
"keyVaultUri": "https://myKeyVault.vault.azure.net",
"accessCredentials": {
"applicationId": "00000000-0000-0000-0000-000000000000",
"applicationSecret": "<applicationSecret>"
}
},
"retrievalReasoningEffort": {
"kind": "low"
},
"corsOptions": {
"allowedOrigins": [
"https://myapp.example.com"
],
"maxAgeInSeconds": 300
}
}
Tanımlar
| Veri Akışı Adı | Description |
|---|---|
| Accept |
Accept başlığı. |
|
Azure |
Çağrılacak Azure Open AI model adı. |
|
Azure |
Azure OpenAI kaynağına bağlanmak için parametreleri belirtir. |
|
Cors |
Dizin için Çıkış Noktaları Arası Kaynak Paylaşımını (CORS) denetleme seçeneklerini tanımlar. |
|
Error |
Kaynak yönetimi hatasına ilişkin ek bilgiler. |
|
Error |
Hata ayrıntısı. |
|
Error |
Başarısız işlemlerin hata ayrıntılarını döndürmek için tüm Azure Resource Manager API'leri için genel hata yanıtı. (Bu, OData hata yanıt biçimini de izler.). |
|
Knowledge |
Bir bilgi tabanı tanımını temsil eder. |
|
Knowledge |
Sorgu planlaması yapmak için kullanılan Azure OpenAI kaynağını belirtir. |
|
Knowledge |
Sorgu planlaması için kullanılacak yapay zeka modeli. |
|
Knowledge |
Düşük muhakeme çabasıyla bilgi alımını çalıştırın. |
|
Knowledge |
Orta düzeyde akıl yürütme çabasıyla bilgi erişimini çalıştırın. |
|
Knowledge |
Minimum muhakeme çabasıyla bilgi alımını çalıştırın. |
|
Knowledge |
Bu alma için çıkış yapılandırması. |
|
Knowledge |
Alma sırasında kullanılacak çaba miktarı. |
|
Knowledge |
Bilgi kaynağına referans. |
|
Search |
Veri kaynağının kimlik özelliğini temizler. |
|
Search |
Kullanılacak veri kaynağının kimliğini belirtir. |
|
Search |
Azure Key Vault'ta müşteri tarafından yönetilen bir şifreleme anahtarı. Oluşturduğunuz ve yönettiğiniz anahtarlar, dizinler ve eş anlamlı eşlemeler gibi bekleyen verileri şifrelemek veya şifresini çözmek için kullanılabilir. |
Accept
Accept başlığı.
| Değer | Description |
|---|---|
| application/json;odata.metadata=minimal |
AzureOpenAIModelName
Çağrılacak Azure Open AI model adı.
| Değer | Description |
|---|---|
| text-embedding-ada-002 |
TextEmbeddingAda002 modeli. |
| text-embedding-3-large |
TextEmbedding3Large modeli. |
| text-embedding-3-small |
TextEmbedding3Small modeli. |
| gpt-5-mini |
Gpt5Mini modeli. |
| gpt-5-nano |
Gpt5Nano modeli. |
| gpt-5.4 |
Gpt54 modeli. |
| gpt-5.4-mini |
Gpt54Mini modeli. |
| gpt-5.4-nano |
Gpt54Nano modeli. |
| gpt-5.5 |
Gpt55 modeli. |
| gpt-5.6-sol |
Gpt56Sol modeli. |
| gpt-5.6-terra |
Gpt56Terra modeli. |
| gpt-5.6-luna |
Gpt56Luna modeli. |
AzureOpenAIVectorizerParameters
Azure OpenAI kaynağına bağlanmak için parametreleri belirtir.
| Veri Akışı Adı | Tür | Description |
|---|---|---|
| apiKey |
string |
Belirlenen Azure OpenAI kaynağının API anahtarı. |
| authIdentity | SearchIndexerDataIdentity: |
Giden bağlantılar için kullanılan kullanıcı tarafından atanan yönetilen kimlik. |
| deploymentId |
string |
Belirlenen kaynakta Azure OpenAI modeli dağıtımının kimliği. |
| modelName |
Sağlanan deploymentId yolunda dağıtılan ekleme modelinin adı. |
|
| resourceUri |
string (uri) |
Azure OpenAI kaynağının kaynak URI'si. |
CorsOptions
Dizin için Çıkış Noktaları Arası Kaynak Paylaşımını (CORS) denetleme seçeneklerini tanımlar.
| Veri Akışı Adı | Tür | Description |
|---|---|---|
| allowedOrigins |
string[] |
JavaScript koduna dizininize erişim izni verilecek kaynakların listesi. {protocol}://{fully-qualified-domain-name}[:{port#}] biçimindeki ana bilgisayarların bir listesini veya tüm çıkış noktalarına izin vermek için tek bir '*' içerebilir (önerilmez). |
| maxAgeInSeconds |
integer (int64) |
Tarayıcıların CORS ön kontrol yanıtlarını önbelleğe alması gereken süre. Varsayılan olarak 5 dakikadır. |
ErrorAdditionalInfo
Kaynak yönetimi hatasına ilişkin ek bilgiler.
| Veri Akışı Adı | Tür | Description |
|---|---|---|
| info |
Ek bilgiler. |
|
| type |
string |
Ek bilgi türü. |
ErrorDetail
Hata ayrıntısı.
| Veri Akışı Adı | Tür | Description |
|---|---|---|
| additionalInfo |
Hata ek bilgisi. |
|
| code |
string |
Hata kodu. |
| details |
Hata ayrıntıları. |
|
| message |
string |
Hata iletisi. |
| target |
string |
Hata hedefi |
ErrorResponse
Başarısız işlemlerin hata ayrıntılarını döndürmek için tüm Azure Resource Manager API'leri için genel hata yanıtı. (Bu, OData hata yanıt biçimini de izler.).
| Veri Akışı Adı | Tür | Description |
|---|---|---|
| error |
Hata nesnesi. |
KnowledgeBase
Bir bilgi tabanı tanımını temsil eder.
| Veri Akışı Adı | Tür | Description |
|---|---|---|
| @odata.etag |
string |
Bilgi tabanının ETag'i. |
| answerInstructions |
string |
Bilgi tabanı tarafından cevaplar oluşturulurken dikkate alınan talimatlar. |
| corsOptions |
Bilgi tabanı için Çapraz Kaynak Paylaşımı (CORS) kontrol seçenekleri sunuluyor. |
|
| description |
string |
Bilgi tabanının açıklaması. |
| encryptionKey |
Azure Key Vault'ta oluşturduğunuz bir şifreleme anahtarının açıklaması. |
|
| knowledgeSources |
Bu bilgi tabanında referans verilen bilgi kaynakları. |
|
| models | KnowledgeBaseModel[]: |
Yapay zeka modellerine nasıl bağlanılacağına ilişkin yapılandırma seçeneklerini içerir. |
| name |
string |
Bilgi bankasının adı. |
| outputMode |
Bilgi tabanı için çıkış modu. |
|
| retrievalInstructions |
string |
Bilgi tabanı tarafından sorgu planı geliştirilirken dikkate alınan talimatlar. |
| retrievalReasoningEffort | KnowledgeRetrievalReasoningEffort: |
Geri getirme amaç yürütme çabası yapılandırması. |
KnowledgeBaseAzureOpenAIModel
Sorgu planlaması yapmak için kullanılan Azure OpenAI kaynağını belirtir.
| Veri Akışı Adı | Tür | Description |
|---|---|---|
| azureOpenAIParameters |
Azure OpenAI parametreleri. |
|
| kind |
string:
azure |
Sorgu planlaması için kullanılacak yapay zeka modeli. |
KnowledgeBaseModelKind
Sorgu planlaması için kullanılacak yapay zeka modeli.
| Değer | Description |
|---|---|
| azureOpenAI |
Sorgu planlaması için Azure Open AI modellerini kullanın. |
KnowledgeRetrievalLowReasoningEffort
Düşük muhakeme çabasıyla bilgi alımını çalıştırın.
| Veri Akışı Adı | Tür | Description |
|---|---|---|
| kind |
string:
low |
Bir tür akıl yürütme çabası. |
KnowledgeRetrievalMediumReasoningEffort
Orta düzeyde akıl yürütme çabasıyla bilgi erişimini çalıştırın.
| Veri Akışı Adı | Tür | Description |
|---|---|---|
| kind |
string:
medium |
Bir tür akıl yürütme çabası. |
KnowledgeRetrievalMinimalReasoningEffort
Minimum muhakeme çabasıyla bilgi alımını çalıştırın.
| Veri Akışı Adı | Tür | Description |
|---|---|---|
| kind |
string:
minimal |
Bir tür akıl yürütme çabası. |
KnowledgeRetrievalOutputMode
Bu alma için çıkış yapılandırması.
| Değer | Description |
|---|---|
| extractiveData |
Üretimsel değişiklik yapmadan doğrudan bilgi kaynaklarından veri döndürün. |
| answerSynthesis |
Yanıt yükü için bir yanıt sentezleyin. |
KnowledgeRetrievalReasoningEffortKind
Alma sırasında kullanılacak çaba miktarı.
| Değer | Description |
|---|---|
| minimal |
Herhangi bir kaynak seçimi, sorgu planlaması veya yinelemeli arama gerçekleştirmez. |
| low |
Geri alma sırasında düşük akıl yürütme kullanın. |
| medium |
Geri alma sırasında makul miktarda akıl yürütme kullanın. |
KnowledgeSourceReference
Bilgi kaynağına referans.
| Veri Akışı Adı | Tür | Description |
|---|---|---|
| name |
string |
Bilgi kaynağının adı. |
SearchIndexerDataNoneIdentity
Veri kaynağının kimlik özelliğini temizler.
| Veri Akışı Adı | Tür | Description |
|---|---|---|
| @odata.type |
string:
#Microsoft. |
Kimlik türünü belirten bir URI parçası. |
SearchIndexerDataUserAssignedIdentity
Kullanılacak veri kaynağının kimliğini belirtir.
| Veri Akışı Adı | Tür | Description |
|---|---|---|
| @odata.type |
string:
#Microsoft. |
Kimlik türünü belirten bir URI parçası. |
| federatedIdentityClientId |
string |
Çok kiracılı User-Assigned Yönetilen Kimlik Desteği: Kullanıcı tarafından atanan yönetilen kimlik ile federasyon yapacak şekilde yapılandırılmış çoklu uygulamanın istemci kimliği. |
| userAssignedIdentity |
string |
Kullanıcı tarafından atanan yönetilen kimliğin tam Azure kaynak kimliği genellikle arama hizmetine atanması gereken "/subscriptions/12345678-1234-1234-1234-123467890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId" biçimindedir. |
SearchResourceEncryptionKey
Azure Key Vault'ta müşteri tarafından yönetilen bir şifreleme anahtarı. Oluşturduğunuz ve yönettiğiniz anahtarlar, dizinler ve eş anlamlı eşlemeler gibi bekleyen verileri şifrelemek veya şifresini çözmek için kullanılabilir.
| Veri Akışı Adı | Tür | Description |
|---|---|---|
| accessCredentials.applicationId |
string |
Bekleyen verilerinizi şifrelerken kullanılacak Azure Key Vault'a gerekli erişim izinleri verilmiş bir AAD Uygulama Kimliği. Uygulama Kimliği, AAD Uygulamanızın Nesne Kimliği ile karıştırılmamalıdır. |
| accessCredentials.applicationSecret |
string |
Belirtilen AAD uygulamasının kimlik doğrulama anahtarı. |
| identity | SearchIndexerDataIdentity: |
Bu şifreleme anahtarı için kullanılacak açık bir yönetilen kimlik. Belirtilmezse ve erişim kimlik bilgileri özelliği null ise, sistem tarafından atanan yönetilen kimlik kullanılır. Kaynağa güncelleştirildiğinde, açık kimlik belirtilmezse değişmeden kalır. "Hiçbiri" belirtilirse, bu özelliğin değeri temizlenir. |
| keyVaultKeyName |
string |
Bekleyen verilerinizi şifrelemek için kullanılacak Azure Key Vault anahtarınızın adı. |
| keyVaultKeyVersion |
string |
Bekleyen verilerinizi şifrelemek için kullanılacak Azure Key Vault anahtarınızın sürümü. |
| keyVaultUri |
string |
Bekleyen verilerinizi şifrelemek için kullanılacak anahtarı içeren, DNS adı olarak da adlandırılan Azure Key Vault URI'sidir. Örnek bir URI |