Knowledge Bases - Get
Bir bilgi tabanı tanımını alır.
GET {endpoint}/knowledgebases('{knowledgeBaseName}')?api-version=2026-11-01-preview
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
|
Search |
|
Search |
|
Search |
SearchServiceGetKnowledgeBase
Örnek isteği
GET https://typespecpreviewexampleservice.search.windows.net/knowledgebases('base-preview-test')?api-version=2026-11-01-preview
Ö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-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
},
"tools": [
{
"name": "product-search",
"description": "Search product documentation.",
"knowledgeSources": [
{
"name": "ks-preview-test",
"alwaysQuerySource": false,
"filterAddOn": "id ne null",
"maxOutputDocuments": 50,
"failOnError": true
}
],
"retrievalReasoningEffort": {
"kind": "low"
},
"retrieveDefaults": {
"maxRuntimeInSeconds": 30,
"maxOutputDocuments": 2,
"maxOutputSizeInTokens": 5000
}
}
]
}
SearchServiceGetKnowledgeBaseMicrosoftRetriever1
Örnek isteği
GET https://typespecpreviewexampleservice.search.windows.net/knowledgebases('travel-knowledgebase')?api-version=2026-11-01-preview
Örnek yanıt
{
"name": "travel-knowledgebase",
"knowledgeSources": [
{
"name": "hotels"
}
],
"models": [
{
"kind": "microsoftRetriever1"
}
],
"outputMode": "extractiveData",
"description": "Find hotels using Microsoft Retriever 1."
}
SearchServiceGetKnowledgeBaseOpenAICompatible
Örnek isteği
GET https://typespecpreviewexampleservice.search.windows.net/knowledgebases('compatible-model-preview-test')?api-version=2026-11-01-preview
Örnek yanıt
{
"@odata.etag": "0x1234568AE7E58A1",
"name": "compatible-model-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": "openAICompatible",
"openAICompatibleParameters": {
"uri": "https://model-gateway.contoso.com/teams/catalog/chat/completions?route=primary&api-version=2026-01-01",
"modelName": "gpt-4.1-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
},
"tools": [
{
"name": "product-search",
"description": "Search product documentation.",
"knowledgeSources": [
{
"name": "ks-preview-test",
"alwaysQuerySource": false,
"filterAddOn": "id ne null",
"maxOutputDocuments": 50,
"failOnError": true
}
],
"retrievalReasoningEffort": {
"kind": "low"
},
"retrieveDefaults": {
"maxRuntimeInSeconds": 30,
"maxOutputDocuments": 2,
"maxOutputSizeInTokens": 5000
}
}
]
}
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 planlama ve alma için kullanılan Microsoft Retriever 1'i belirtir. |
|
Knowledge |
Sorgu planlaması için kullanılacak yapay zeka modeli. |
|
Knowledge |
Bilgi tabanı erişimi veya Minimal mod bilgi kaynağı görüntü sözlü kullanımı için müşteri kontrollü OpenAI uyumlu bir model belirtir. Erişim için model profili Sohbet Tamamlamaları veya Yanıtlar seçer. Standard/CU çıkarımı veya Web bilgi kaynaklarına sahip bilgi tabanları için desteklenmez. |
|
Knowledge |
OpenAI uyumlu bir Sohbet Tamamlama veya Yanıtlar uç noktası için bağlantı parametreleri. Oluşturma için tam olarak boş olmayan başlıklardan veya managedIdentityAudience gereklidir. Güncellemeler, bağlantı ve model profili için kimlik bilgilerini korumak amacıyla başlıkları atlayabilir. |
|
Knowledge |
Bilgi tabanı alma istekleri için istek genelinde varsayılan varlıklar kaldı. Her değer, eşleşen alım-isteği alanı için varsayılan değeri sağlar; hizmet varsayılanları belirlenmediğinde uygulanır ve talep zamanı değerleri varsa önceliklidir. |
|
Knowledge |
Müşteri tarafından sağlanan açıklama ve bilgi tabanının kaynaklarının bir alt kümesine sahip adlandırılmış bir erişim aracı. |
|
Knowledge |
Mevcut bir bilgi kaynağına ve seçilen kalıcı erişim varsayılanlarının bir alt kümesine yapılan bir referans, tam istek-zamanı parametre modeli değil. Referans verilen kaynak türü belirler; uyumsuz varsayılanlar, bilgi tabanı kaydedildiğinde reddedilir. Açık retriev-request değerleri önceliklidir, ancak filtreler AND ile birleştirilir. |
|
Knowledge |
Geri alma sırasında otomatik olarak akıl yürütme çabasını seçin. Hizmet, her talebi en ucuz seviyeye ekliyor ve sadece ihtiyaç duyulduğu kadar, hizmetin maksimum mevcut seviyesine kadar yükseliyor. |
|
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-4o |
Gpt4o modeli. |
| gpt-4o-mini |
Gpt4oMini modeli. |
| gpt-4.1 |
Gpt41 modeli. |
| gpt-4.1-mini |
Gpt41Mini modeli. |
| gpt-4.1-nano |
Gpt41Nano modeli. |
| gpt-5 |
Gpt5 modeli. |
| gpt-5-mini |
Gpt5Mini modeli. |
| gpt-5-nano |
Gpt5Nano modeli. |
| gpt-5.1 |
Gpt51 modeli. |
| gpt-5.2 |
Gpt52 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. |
| gpt-6-astra |
Gpt6Astra modeli. |
| gpt-6-sol |
Gpt6Sol modeli. |
| gpt-6-luna |
Gpt6Luna modeli. |
| gpt-6.1-sol |
Gpt61Sol 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ı. |
| retrieveDefaults |
Bu bilgi tabanı için istek çapında varsayılan başvuru varsayımları devam etti. Bu değerler, ilgili alanları atlayan çağrı talepleri için geçerlidir; talep zamanı değerleri varsa önceliklidir. |
|
| tags |
object |
Kullanıcı tarafından tanımlanan anahtar-değer çiftleri, bilgi tabanını kategorize etmek ve kullanım ile maliyetlerini atfedek. |
| tools |
Her biri bu bilgi tabanının kaynaklarının bir alt kümesiyle sınırlı olan isimlendirilmiş erişim araçları. Yapılandırıldığında, MCP bu araçları, tam bilgi tabanından gelen yerleşik knowledge_base_retrieve aracına ek olarak tanıtır. Bu API sürümünde araçları atlamak veya boş bir dizi sağlamak mevcut araçları temizler. |
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. |
KnowledgeBaseMicrosoftRetriever1Model
Sorgu planlama ve alma için kullanılan Microsoft Retriever 1'i belirtir.
| Veri Akışı Adı | Tür | Description |
|---|---|---|
| kind |
string:
microsoft |
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. |
| openAICompatible |
Bilgi tabanı erişimi veya bilgi kaynağı görüntüsünü sözlü olarak aktarmak için müşteri kontrollü bir OpenAI uyumlu uç nokta kullanın. |
| microsoftRetriever1 |
Sorgu planlama ve geri alma için Microsoft Retriever 1'i kullanın. |
KnowledgeBaseOpenAICompatibleModel
Bilgi tabanı erişimi veya Minimal mod bilgi kaynağı görüntü sözlü kullanımı için müşteri kontrollü OpenAI uyumlu bir model belirtir. Erişim için model profili Sohbet Tamamlamaları veya Yanıtlar seçer. Standard/CU çıkarımı veya Web bilgi kaynaklarına sahip bilgi tabanları için desteklenmez.
| Veri Akışı Adı | Tür | Description |
|---|---|---|
| kind |
string:
open |
Sorgu planlaması için kullanılacak yapay zeka modeli. |
| openAICompatibleParameters |
OpenAI uyumlu uç nokta için bağlantı ve kimlik doğrulama parametreleri. |
KnowledgeBaseOpenAICompatibleParameters
OpenAI uyumlu bir Sohbet Tamamlama veya Yanıtlar uç noktası için bağlantı parametreleri. Oluşturma için tam olarak boş olmayan başlıklardan veya managedIdentityAudience gereklidir. Güncellemeler, bağlantı ve model profili için kimlik bilgilerini korumak amacıyla başlıkları atlayabilir.
| Veri Akışı Adı | Tür | Description |
|---|---|---|
| authIdentity | SearchIndexerDataIdentity: |
managedIdentityAudience için bir token elde etmek amacıyla kullanılan kullanıcı tarafından atanan yönetilen kimlik. Arama servisinin sistem tarafından atanmış kimliğini kullanmayı atlayın. Yalnızca managedIdentityAudience ile izinlidir. |
| headers |
object (password) |
Uç nokta kimlik doğrulaması için boş olmayan saklanan HTTP başlıkları. Hem isimler hem de değerler gizlidir ve yanıtlarda asla geri dönmezler. Boş haritalar geçersizdir. managedIdentityAudience ve authIdentity ile birbirini dışlamaktadır. Güncelleme sırasında, atlanan başlıklar yalnızca aynı kaynak ve model bağlamasında korunur; tam uç nokta, model profili ve kimlik doğrulama kimliği değişmediğinde; aksi takdirde, yeni kimlik bilgileri sağlanır. |
| managedIdentityAudience |
string |
Yönetilen kimlik doğrulaması için müşterinin üçüncü taraf Microsoft Entra uygulamasının temel uygulama GUID'si. api:// öneki veya /.default eki eklemeyin. Başlıklarla birbirini dışlıyor. |
| modelName |
Arama'nın yeteneklerini ve sınırlarını belirleyen desteklenen bir sohbet modeli adı. Bilgi kaynağı görüntü sözlü olarak belirtilmesi için, bu istek gövdesinde model seçici olarak gönderilir; URI yolu ise bu isimden bağımsız olarak Sohbet Tamamlamaları veya Yanıtlar seçer. Bilgi tabanı erişimi için GPT-6 model profilleri Yanıtlar kullanırken, mevcut model profilleri Sohbet Tamamlamaları kullanır; uç nokta, Yanıtlar için durumsuz araç devamı dahil olmak üzere seçilen protokolü desteklemelidir. Erişim isteği gövdesi modeli atlar; URI veya ağ geçidi gerçek modeli seçer ve gerekli sağlayıcı model tanımlayıcısını sağlar. Gömme modelleri ve rastgele sağlayıcı protokolleri desteklenmez. |
|
| uri |
string (uri) |
Yol ve sorgu parametreleri dahil olmak üzere tam HTTPS POST URL'si. Yol veya API sürümü eklenmeden değiştirilmeden gönderildi; yönlendirmeler takip edilmez. Bilgi tabanı erişimi için, uç nokta model profilinin Sohbet Tamamlama veya Yanıtlar protokolünü kabul etmelidir. Bilgi kaynağı görüntü sözlü olarak belirtilmesi için URI yolu /chat/completions veya /responses ile sonlanmalıdır; sorgu parametreleri protokolü seçmez. |
KnowledgeBaseRetrieveDefaults
Bilgi tabanı alma istekleri için istek genelinde varsayılan varlıklar kaldı. Her değer, eşleşen alım-isteği alanı için varsayılan değeri sağlar; hizmet varsayılanları belirlenmediğinde uygulanır ve talep zamanı değerleri varsa önceliklidir.
| Veri Akışı Adı | Tür | Description |
|---|---|---|
| maxOutputDocuments |
integer (int32) |
Alma çıktısındaki varsayılan maksimum belge sayısı. |
| maxOutputSizeInTokens |
integer (int32) |
Erişim çıktısındaki içeriğin varsayılan maksimum boyutu, jeton cinsinden. |
| maxRuntimeInSeconds |
integer (int32) |
Bir alma talebi için varsayılan maksimum çalışma süresi saniyeler cinsinden. |
KnowledgeBaseTool
Müşteri tarafından sağlanan açıklama ve bilgi tabanının kaynaklarının bir alt kümesine sahip adlandırılmış bir erişim aracı.
| Veri Akışı Adı | Tür | Description |
|---|---|---|
| description |
string minLength: 1maxLength: 1024 |
Aracın ne zaman kullanılacağına dair boş olmayan bir açıklama, en fazla 1024 karakter. MCP kataloğunda kelimesi kelimesine ilan edildi. |
| knowledgeSources |
Boş olmayan benzersiz kaynak referansları listesi. Her kaynak bilgi tabanına ait olmalıdır. Farklı araçlar aynı kaynağa referans verebilir. |
|
| name |
string minLength: 2maxLength: 64 pattern: ^[a-z0-9](?:[a-z0-9-]{0,62}[a-z0-9])$ |
Eşsiz, büyük/küçük harfe duyarlı araç adı. 2 ila 64 küçük harf ASCII harf, rakam veya tire içerir, başında veya sonunda tire yoktur. |
| retrievalReasoningEffort | KnowledgeRetrievalReasoningEffort: |
Bu araç için bilgi tabanının gerekçe çalışmasını geçersiz kılar. Açık retriev-request değerleri önceliklidir. |
| retrieveDefaults |
Bu araç için bilgi tabanının varsayılanlarını geçersiz kılan varsayılanları alın. Açık retriev-request değerleri önceliklidir. |
KnowledgeBaseToolKnowledgeSourceReference
Mevcut bir bilgi kaynağına ve seçilen kalıcı erişim varsayılanlarının bir alt kümesine yapılan bir referans, tam istek-zamanı parametre modeli değil. Referans verilen kaynak türü belirler; uyumsuz varsayılanlar, bilgi tabanı kaydedildiğinde reddedilir. Açık retriev-request değerleri önceliklidir, ancak filtreler AND ile birleştirilir.
| Veri Akışı Adı | Tür | Description |
|---|---|---|
| alwaysQuerySource |
boolean |
Kaynağın sorgulanması gerekip gerekmediği. MCP sunucu kaynakları için desteklenmez. Açık bir istek hariç tutma önceliklidir. |
| failOnError |
boolean |
Bu kaynak hata ile karşılaşırsa geri alma işleminin başarısız olup olmayacağı. |
| filterAddOn |
string |
Arama dizini kaynakları için ek bir OData filtresi. Bilgi tabanı kaydedildiğinde desteklenmeyen kaynak türleri için reddedilir. AND kullanılarak kaynak ve istek filtreleriyle birleştirilir. |
| maxOutputDocuments |
integer (int32) minimum: 50maximum: 200 |
Bu kaynaktan alınan maksimum belge sayısı 50 ile 200 arasındadır. |
| name |
string minLength: 1 |
Bilgi tabanındaki bilgi kaynağının adı. |
| rerankerThreshold |
number (float) |
Geri gönderilen belgeler için minimum yeniden sıralama puanı. Etkinleştirilmesi için yeniden sıralama gerektirir. |
KnowledgeRetrievalAutoReasoningEffort
Geri alma sırasında otomatik olarak akıl yürütme çabasını seçin. Hizmet, her talebi en ucuz seviyeye ekliyor ve sadece ihtiyaç duyulduğu kadar, hizmetin maksimum mevcut seviyesine kadar yükseliyor.
| Veri Akışı Adı | Tür | Description |
|---|---|---|
| kind |
string:
auto |
Bir tür akıl yürütme çabası. |
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. |
| auto |
Geri alma sırasında otomatik olarak akıl yürütme çabasını seçin, en ucuz seviyeden sadece gerektiği kadar yükseltin. |
KnowledgeSourceReference
Bilgi kaynağına referans.
| Veri Akışı Adı | Tür | Description |
|---|---|---|
| enableFreshness |
boolean |
Bu bilgi kaynağı için tazelik farkında alma etkinleştirilip etkinleştirilmeyeceğini gösterir. Doğruysa, geri alma sırasında yeni belgelere yönelik yanlışlık için tazelik puanlama profili uygulanır. |
| enableImageServing |
boolean |
Bu bilgi kaynağı için görüntü servisi etkinleştirilip etkinleştirilmeyeceğini gösterir. Doğruysa, alım sırasında çıkarılan görüntüler sorgulama zamanında aşağı akış modellerine iletilir. |
| 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 | Default value | 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. |
|
| isServiceLevelKey |
boolean |
False |
Bu anahtarın hizmet seviyesi anahtar olup olmadığını gösteren isteğe bağlı bir değer. Varsayılan değer false'tur. |
| 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 |