Knowledge Retrieval - Retrieve Stream
Yedekleme depolarından ilgili verileri alır ve ilerleme ile sonuçları sunucu tarafından gönderilen olaylar olarak aklar.
Yanıtı sunucu tarafından gönderilen olay çerçevelemesi kullanarak kademeli olarak işleyin. Her olay bir olay adı ve JSON kodlu bir veri yükü içerir. Yayın ya bir response.completed olayla ya da bir error olayla sona erer. OpenAPI 2.0, yanıt gövdesini bir dize olarak temsil eder, böylece oluşturulan istemciler ham yanıtı türlenmiş olay ayrıştırma olmadan sunabilir. Tüm yanıt gövdesini tek bir JSON belgesi olarak seri halinden çıkarmayın.
POST {endpoint}/knowledgebases('{knowledgeBaseName}')/retrieve?_overload=retrieveStream&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 |
|---|---|---|---|
| Accept | True |
Accept başlığı. |
|
| x-ms-query-source-authorization |
string (password) |
Sorgunun yürütüldüğü kullanıcıyı tanımlayan belirteç. Bu belirteç, belgelerde güvenlik kısıtlamalarını zorlamak için kullanılır. |
|
| x-ms-query-work-iq-source-authorization |
string (password) |
Müşteri sahibi Entra uygulaması kaydı için kullanıcı doğrulama belirteci, Work IQ bilgi kaynağına yapılandırılmıştır. Work IQ API'sine kimlik doğrulama için kullanılır. |
|
| 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ı. |
İstek Gövdesi
| Veri Akışı Adı | Tür | Description |
|---|---|---|
| includeActivity |
boolean |
Alma sonuçlarının etkinlik bilgilerini içermesi gerektiğini belirtir. |
| intents | KnowledgeRetrievalIntent[]: |
Model sorgu planlaması olmadan yürütülecek amaçlanan sorguların listesi. |
| knowledgeSourceParams |
KnowledgeSourceParams[]:
|
Bilgi kaynakları için çalışma zamanı parametrelerinin listesi. |
| maxOutputDocuments |
integer (int32) |
Çıktıdaki maksimum belge sayısını sınırlar. |
| maxOutputSize |
integer (int32) |
Çıktıdaki içeriğin maksimum boyutunu sınırlar. |
| maxOutputSizeInTokens |
integer (int32) |
Çıktıdaki içeriğin maksimum boyutunu sınırlar. |
| maxRuntimeInSeconds |
integer (int32) |
Saniye cinsinden maksimum çalışma zamanı. |
| messages |
Sohbet iletisi stili girişlerinin listesi. |
|
| outputMode |
Bu alma için çıkış yapılandırması. |
|
| retrievalReasoningEffort | KnowledgeRetrievalReasoningEffort: |
Geri getirme amaç yürütme çabası yapılandırması. |
| toolName |
string |
Seçilecek araç. KB genelinde geri alma için atla. |
Yanıtlar
| Veri Akışı Adı | Tür | Description |
|---|---|---|
| 200 OK |
string |
İstek başarılı oldu. Media Types: "text/event-stream", "application/json" |
| Other Status Codes |
Beklenmeyen bir hata yanıtı. Media Types: "text/event-stream", "application/json" |
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
KnowledgeBaseRetrieveStream
Örnek isteği
POST https://typespecpreviewexampleservice.search.windows.net/knowledgebases('base-preview-test')/retrieve?_overload=retrieveStream&api-version=2026-11-01-preview
{
"messages": [
{
"role": "user",
"content": [
{
"type": "text",
"text": "hello world"
}
]
}
],
"maxRuntimeInSeconds": 60,
"maxOutputSize": 100000,
"maxOutputDocuments": 50,
"retrievalReasoningEffort": {
"kind": "low"
},
"includeActivity": true,
"outputMode": "answerSynthesis",
"knowledgeSourceParams": [
{
"knowledgeSourceName": "ks-preview-test",
"includeReferences": true,
"includeReferenceSourceData": true,
"alwaysQuerySource": false,
"neverQuerySource": false,
"failOnError": false,
"rerankerThreshold": 2.1,
"resultsProcessing": "rerank",
"kind": "searchIndex",
"filterAddOn": "foo eq bar",
"queryHintOverrides": {
"filters": [
{
"field": "country",
"fieldValues": [
"United States",
"Japan",
"France",
"Germany"
],
"filterInstructions": "Country associated with the document."
}
],
"boosts": [
{
"kind": "fieldValue",
"boostInstructions": "Prefer documents matching the user's locale.",
"field": "language",
"fieldValues": [
"en-US",
"ja-JP",
"fr-FR",
"de-DE"
],
"boost": 1.5
}
]
},
"topicGraph": {
"kind": "diverse",
"diversityFactor": 0.1
}
}
],
"toolName": "product-search"
}
Örnek yanıt
"event: retrieval.started\ndata: {\"requestId\":\"00000000-0000-0000-0000-000000000000\",\"knowledgeBaseName\":\"base-preview-test\",\"outputMode\":\"answerSynthesis\",\"reasoningEffort\":{\"kind\":\"low\"}}\n\nevent: activity.started\ndata: {\"id\":0,\"type\":\"modelQueryPlanning\",\"startedAt\":\"2025-01-01T00:08:45.045Z\"}\n\nevent: activity.completed\ndata: {\"type\":\"modelQueryPlanning\",\"id\":0,\"startedAt\":\"2025-01-01T00:08:45.045Z\",\"completedAt\":\"2025-01-01T00:08:46.279Z\",\"inputTokens\":11,\"outputTokens\":22,\"elapsedMs\":1234,\"model\":{\"modelName\":\"gpt-4o\",\"deploymentId\":\"gpt-4o-deployment\"}}\n\nevent: activity.started\ndata: {\"id\":1,\"type\":\"searchIndex\",\"startedAt\":\"2025-01-01T00:08:45.045Z\",\"knowledgeSourceName\":\"ks-preview-test\"}\n\nevent: activity.completed\ndata: {\"type\":\"searchIndex\",\"id\":1,\"startedAt\":\"2025-01-01T00:08:45.045Z\",\"completedAt\":\"2025-01-01T00:08:46.279Z\",\"knowledgeSourceName\":\"ks-preview-test\",\"queryTime\":\"2025-01-01T00:08:45.045Z\",\"count\":2,\"elapsedMs\":1234,\"searchIndexArguments\":{\"search\":\"hello world\",\"filter\":\"((category eq 'news') and ((id ne null) and (foo eq bar))) and (Key eq 'myDocKey1')\",\"semanticConfigurationName\":\"testconfig\",\"queryType\":\"simple\",\"sourceDataFields\":[{\"name\":\"category\"},{\"name\":\"description\"},{\"name\":\"ownerId\"},{\"name\":\"id\"}],\"searchFields\":[]},\"queryHintProcessing\":{\"generatedFilter\":\"Key eq 'myDocKey1'\"}}\n\nevent: activity.started\ndata: {\"id\":2,\"type\":\"searchIndex\",\"startedAt\":\"2025-01-01T00:08:45.045Z\",\"knowledgeSourceName\":\"ks-preview-test\"}\n\nevent: activity.completed\ndata: {\"type\":\"searchIndex\",\"id\":2,\"startedAt\":\"2025-01-01T00:08:45.045Z\",\"completedAt\":\"2025-01-01T00:08:46.279Z\",\"knowledgeSourceName\":\"ks-preview-test\",\"queryTime\":\"2025-01-01T00:08:45.045Z\",\"count\":2,\"elapsedMs\":1234,\"searchIndexArguments\":{\"search\":\"hello world two\",\"filter\":\"((category eq 'news') and ((id ne null) and (foo eq bar))) and (Key eq 'myDocKey1')\",\"semanticConfigurationName\":\"testconfig\",\"queryType\":\"simple\",\"sourceDataFields\":[{\"name\":\"category\"},{\"name\":\"description\"},{\"name\":\"ownerId\"},{\"name\":\"id\"}],\"searchFields\":[]},\"queryHintProcessing\":{\"generatedFilter\":\"Key eq 'myDocKey1'\"}}\n\nevent: activity.started\ndata: {\"id\":3,\"type\":\"modelAnswerSynthesis\",\"startedAt\":\"2025-01-01T00:08:45.045Z\"}\n\nevent: activity.completed\ndata: {\"type\":\"modelAnswerSynthesis\",\"id\":3,\"startedAt\":\"2025-01-01T00:08:45.045Z\",\"completedAt\":\"2025-01-01T00:08:46.279Z\",\"inputTokens\":11,\"outputTokens\":22,\"elapsedMs\":1234,\"model\":{\"modelName\":\"gpt-4o\",\"deploymentId\":\"gpt-4o-deployment\"}}\n\nevent: activity.started\ndata: {\"id\":4,\"type\":\"agenticReasoning\",\"startedAt\":\"2025-01-01T00:08:45.045Z\"}\n\nevent: activity.completed\ndata: {\"type\":\"agenticReasoning\",\"id\":4,\"startedAt\":\"2025-01-01T00:08:45.045Z\",\"completedAt\":\"2025-01-01T00:08:46.279Z\",\"reasoningTokens\":78,\"retrievalReasoningEffort\":{\"kind\":\"low\"},\"logicalReasoningEffort\":{\"kind\":\"low\"}}\n\nevent: answer.completed\ndata: {\"messageIndex\":0,\"message\":{\"content\":[{\"type\":\"text\",\"text\":\"[{...}]\"}]}}\n\nevent: references.completed\ndata: [{\"type\":\"searchIndex\",\"id\":\"83dd7d40\",\"activitySource\":1,\"rerankerScore\":4,\"docKey\":\"myDocKey1\",\"citationUrl\":\"https://typespecpreviewexampleservice.search.windows.net/indexes/preview-test/docs/myDocKey1?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-11-01-preview&allowUnsafeKeys=true\",\"sourceData\":{\"id\":\"myDocKey1\",\"title\":\"high_doc\",\"content\":\"hello world\"}},{\"type\":\"searchIndex\",\"id\":\"83dd7d41\",\"activitySource\":1,\"rerankerScore\":3.9,\"docKey\":\"myDocKey2\",\"citationUrl\":\"https://typespecpreviewexampleservice.search.windows.net/indexes/preview-test/docs/myDocKey2?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-11-01-preview&allowUnsafeKeys=true\",\"sourceData\":{\"id\":\"myDocKey2\",\"title\":\"low_doc\",\"content\":\"goodbye world\"}}]\n\nevent: response.completed\ndata: {\"statusCode\":200,\"response\":{\"response\":[{\"content\":[{\"type\":\"text\",\"text\":\"[{...}]\"}]}],\"activity\":[{\"type\":\"modelQueryPlanning\",\"id\":0,\"startedAt\":\"2025-01-01T00:08:45.045Z\",\"completedAt\":\"2025-01-01T00:08:46.279Z\",\"inputTokens\":11,\"outputTokens\":22,\"elapsedMs\":1234,\"model\":{\"modelName\":\"gpt-4o\",\"deploymentId\":\"gpt-4o-deployment\"}},{\"type\":\"searchIndex\",\"id\":1,\"startedAt\":\"2025-01-01T00:08:45.045Z\",\"completedAt\":\"2025-01-01T00:08:46.279Z\",\"knowledgeSourceName\":\"ks-preview-test\",\"queryTime\":\"2025-01-01T00:08:45.045Z\",\"count\":2,\"elapsedMs\":1234,\"searchIndexArguments\":{\"search\":\"hello world\",\"filter\":\"((category eq 'news') and ((id ne null) and (foo eq bar))) and (Key eq 'myDocKey1')\",\"semanticConfigurationName\":\"testconfig\",\"queryType\":\"simple\",\"sourceDataFields\":[{\"name\":\"category\"},{\"name\":\"description\"},{\"name\":\"ownerId\"},{\"name\":\"id\"}],\"searchFields\":[]},\"queryHintProcessing\":{\"generatedFilter\":\"Key eq 'myDocKey1'\"}},{\"type\":\"searchIndex\",\"id\":2,\"startedAt\":\"2025-01-01T00:08:45.045Z\",\"completedAt\":\"2025-01-01T00:08:46.279Z\",\"knowledgeSourceName\":\"ks-preview-test\",\"queryTime\":\"2025-01-01T00:08:45.045Z\",\"count\":2,\"elapsedMs\":1234,\"searchIndexArguments\":{\"search\":\"hello world two\",\"filter\":\"((category eq 'news') and ((id ne null) and (foo eq bar))) and (Key eq 'myDocKey1')\",\"semanticConfigurationName\":\"testconfig\",\"queryType\":\"simple\",\"sourceDataFields\":[{\"name\":\"category\"},{\"name\":\"description\"},{\"name\":\"ownerId\"},{\"name\":\"id\"}],\"searchFields\":[]},\"queryHintProcessing\":{\"generatedFilter\":\"Key eq 'myDocKey1'\"}},{\"type\":\"modelAnswerSynthesis\",\"id\":3,\"startedAt\":\"2025-01-01T00:08:45.045Z\",\"completedAt\":\"2025-01-01T00:08:46.279Z\",\"inputTokens\":11,\"outputTokens\":22,\"elapsedMs\":1234,\"model\":{\"modelName\":\"gpt-4o\",\"deploymentId\":\"gpt-4o-deployment\"}},{\"type\":\"agenticReasoning\",\"id\":4,\"startedAt\":\"2025-01-01T00:08:45.045Z\",\"completedAt\":\"2025-01-01T00:08:46.279Z\",\"reasoningTokens\":78,\"retrievalReasoningEffort\":{\"kind\":\"low\"},\"logicalReasoningEffort\":{\"kind\":\"low\"}}],\"references\":[{\"type\":\"searchIndex\",\"id\":\"83dd7d40\",\"activitySource\":1,\"rerankerScore\":4,\"docKey\":\"myDocKey1\",\"citationUrl\":\"https://typespecpreviewexampleservice.search.windows.net/indexes/preview-test/docs/myDocKey1?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-11-01-preview&allowUnsafeKeys=true\",\"sourceData\":{\"id\":\"myDocKey1\",\"title\":\"high_doc\",\"content\":\"hello world\"}},{\"type\":\"searchIndex\",\"id\":\"83dd7d41\",\"activitySource\":1,\"rerankerScore\":3.9,\"docKey\":\"myDocKey2\",\"citationUrl\":\"https://typespecpreviewexampleservice.search.windows.net/indexes/preview-test/docs/myDocKey2?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-11-01-preview&allowUnsafeKeys=true\",\"sourceData\":{\"id\":\"myDocKey2\",\"title\":\"low_doc\",\"content\":\"goodbye world\"}}]}}\n\n"
Tanımlar
| Veri Akışı Adı | Description |
|---|---|
| Accept |
Accept başlığı. |
|
Agent |
Bilgi erişimiyle döndürülen hidratlı kaynak belgeler için seçim ve sayım sınırları. |
|
Agent |
Grafik etkinleştirilmiş Azure Blob bilgi kaynağı için erişim sırasında grafiğe özgü geçersiz kılar. |
|
Agent |
Bilgi erişim grafik sonuçları için kaynak belge hidrasyon politikası. |
|
Azure |
Azure blob bilgi kaynağı için çalışma zamanı parametrelerini belirtir |
|
Balanced |
Saf vektör benzerliğini çeşitlilik farkındalığına sahip geri getirme ile harmanlar. Çeşitlilik ile alaka düzeyini dengelemek için varsayılan öneriliyor. |
|
Diverse |
Konu grafiği çeşitli erişim kullanır. |
|
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.). |
|
Fabric |
Bir Fabric Data Agent bilgi kaynağı için çalışma zamanı parametrelerini belirtir |
|
Fabric |
Fabric Ontology bilgi kaynağı için çalışma zamanı parametrelerini belirtir |
|
File |
Bir Dosya bilgi kaynağı için çalışma zamanı parametrelerini belirtir |
|
Indexed |
Dizinlenmiş OneLake bilgi kaynağı için çalışma zamanı parametrelerini belirtir |
|
Indexed |
Dizine alınmış SharePoint bilgi kaynağı için çalışma zamanı parametrelerini belirtir |
|
Indexed |
İndekslenmiş SQL bilgi kaynağı için çalışma zamanı parametrelerini belirtir |
|
Knowledge |
Görsel içeriği. |
|
Knowledge |
Doğal dil ileti stili nesnesi. |
|
Knowledge |
İleti içeriğinin türü. |
|
Knowledge |
Resim mesajı türü. |
|
Knowledge |
Kısa mesaj türü. |
|
Knowledge |
Alma isteği için giriş sözleşmesi. |
|
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 |
Kullanılacak bilgi bankası yapılandırması türü. |
|
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 |
Anlamsal bir sorgulama niyeti. |
|
Knowledge |
Grafik tabanlı bilgi erişimi için kaynak belge davranışı. |
|
Knowledge |
Bilgi kaynağının türü. |
|
Knowledge |
Bir bilgi kaynağının sonuçlarının yeniden sıralanıp sıralanmadığını kontrol eder. |
|
Mcp |
MCP sunucu bilgi kaynağı için çalışma zamanı parametrelerini belirtir |
|
None |
Konu grafiği çeşitliliği olmadan normal vektör araması kullanır. |
|
Remote |
Uzak SharePoint bilgi kaynağı için çalışma zamanı parametrelerini belirtir |
|
Search |
Arama indeks bilgi kaynağı için bir teşvik ipucu. |
|
Search |
Bir alan değerine göre belgeleri güçlendiren bir ipucu. |
|
Search |
Bir alanı ve sorgu planlayıcısının filtre oluştururken kullanabileceği kapsamlı temel değerlerini tanımlayan bir ipucu. |
|
Search |
Bir filtre ipucunun topraklama değerlerinin hedef indeks yüzeylerinden otomatik çözünürlüğünü yapılandırır. |
|
Search |
Çok kelimeli bir ifade temelinde belgeleri güçlendiren bir ipucu. |
|
Search |
Arama dizini bilgi kaynağı için çalışma zamanı parametrelerini belirtir |
|
Search |
Arama indeksi bilgi kaynağı için faydalı filtreler ve güçlendirmeler için sorgu planlamasını yönlendiren ipuçları. |
|
Vector |
Kullanılacak konu grafiği vektör araması türü. |
|
Web |
Bir web bilgi kaynağı için çalışma zamanı parametrelerini belirtir |
|
Work |
WorkIQ bilgi kaynağı için çalışma zamanı parametrelerini belirtir |
Accept
Accept başlığı.
| Değer | Description |
|---|---|
| text/event-stream |
AgentRuntimeGraphHydrateDocumentsParams
Bilgi erişimiyle döndürülen hidratlı kaynak belgeler için seçim ve sayım sınırları.
| Veri Akışı Adı | Tür | Default value | Description |
|---|---|---|---|
| select |
string |
Virgülle ayrılmış geri alınabilir kaynak alanları dahil edilecektir. |
|
| top |
integer (int32) minimum: 1maximum: 100 |
50 |
Iade edilecek maksimum nemli belgeler. Varsayılan olarak 50 olur; bu, grafik satır sayısından bağımsızdır. |
AgentRuntimeGraphParams
Grafik etkinleştirilmiş Azure Blob bilgi kaynağı için erişim sırasında grafiğe özgü geçersiz kılar.
| Veri Akışı Adı | Tür | Default value | Description |
|---|---|---|---|
| includeQuery |
boolean |
False |
Oluşturulan GQL'yi graphSearchArguments.gql dosyasına dahil edin. Atlanmış veya false oluşturulan sorgu metnini açığa çıkarmaz. |
| provenance |
Grafik sonuçlarını destekleyen kaynak belgelerin de döndürülüp döndürülmeyeceğini kontrol eder. |
AgentRuntimeGraphProvenanceParams
Bilgi erişim grafik sonuçları için kaynak belge hidrasyon politikası.
| Veri Akışı Adı | Tür | Default value | Description |
|---|---|---|---|
| hydrateDocuments |
Kaynak belge seçenekleri; yalnızca tür hydrate olduğunda geçerlidir. |
||
| kind | none |
Grafik geri getirmenin sadece grafik satırlarını döndürmesi ya da kaynak belgeleri de hidratlandırıp döndürmemesinin önemi. |
AzureBlobKnowledgeSourceParams
Azure blob bilgi kaynağı için çalışma zamanı parametrelerini belirtir
| Veri Akışı Adı | Tür | Description |
|---|---|---|
| alwaysQuerySource |
boolean |
Bu bilgi kaynağının kaynak seçimini atlaması ve alma zamanında her zaman sorgulanması gerektiğini gösterir. |
| enableImageServing |
boolean |
Bu bilgi kaynağı için erişim sırasında görüntü servisi etkinleştirilip etkinleştirilmeyeceğini gösterir. Doğru olduğunda, alım sırasında çıkarılan görüntüler sonraki modellere teslim edilir. |
| failOnError |
boolean |
Bu bilgi kaynağından alınma hata ile karşılaşılırsa tüm alma talebinin başarısız olması gerektiğini gösterir. Varsayılan değer false'tur. |
| graphParameters |
Grafik destekli bir kaynak için grafik sorgusu görünürlüğü ve kaynak belge hidrasyon seçenekleri. |
|
| includeReferenceSourceData |
boolean |
Başvuruların, alma sırasında elde edilen yapılandırılmış verileri yüklerine dahil edip etmeyeceğini belirtir. |
| includeReferences |
boolean |
Bu kaynaktan alınan veriler için başvuruların dahil edilip edilmeyeceğini belirtir. |
| kind |
string:
azure |
Bilgi kaynağının türü. |
| knowledgeSourceName |
string |
Parametrelerin uygulandığı dizinin adı. |
| maxOutputDocuments |
integer (int32) |
Bu bilgi kaynağından geri dönen maksimum belge sayısını sınırlar. |
| neverQuerySource |
boolean |
Bu bilgi kaynağının, talebin aday kümesinden çıkarılması ve alma sırasında sorgulanmaması gerektiğini gösterir. Bu istisna talebe yereldir ve bilgi tabanı üyeliğini değiştirmez. Aynı bilgi kaynağında alwaysQuerySource ile birleştirilemez. |
| rerankerThreshold |
number (float) |
Yanıta dahil edilmek için alınan tüm belgelerin karşılaması gereken yeniden sıralayıcı eşiği. |
| resultsProcessing |
Bilgi kaynağının depolanmış sonuçlarını geçersiz kılar. Yalnızca bu geri alma çağrısı için işleme. Atlandığında, depolanan bilgi kaynağı değeri uygulanır. |
|
| topicGraph | VectorQueryTopicGraph: |
Bu erişim için bilgi kaynağının depolanan topicGraph değerini geçersiz kılar. Atlandığında, depolanan bilgi kaynağı değeri uygulanır. |
BalancedVectorQueryTopicGraph
Saf vektör benzerliğini çeşitlilik farkındalığına sahip geri getirme ile harmanlar. Çeşitlilik ile alaka düzeyini dengelemek için varsayılan öneriliyor.
| Veri Akışı Adı | Tür | Description |
|---|---|---|
| kind |
string:
balanced |
Kullanılacak konu grafiği vektör araması türü. |
| minDiversityPoolSize |
integer (int32) minimum: 250maximum: 10000 |
Konu grafiği örneklemeden önce alınacak minimum vektör aday sayısı. Varsayılan değer 1.000'dir. |
DiverseVectorQueryTopicGraph
Konu grafiği çeşitli erişim kullanır.
| Veri Akışı Adı | Tür | Description |
|---|---|---|
| diversityFactor |
number (float) minimum: 0maximum: 1 |
Konu grafiği çeşitlilik geri çağırmasında kullanılan çeşitlilik faktörü. Atlandıysa, konu grafiği profilinde varsayılan yapılandırılan özellik kullanılır. |
| kind |
string:
diverse |
Kullanılacak konu grafiği vektör araması türü. |
| minDiversityPoolSize |
integer (int32) minimum: 250maximum: 10000 |
Konu grafiği örneklemeden önce alınacak minimum vektör aday sayısı. Varsayılan değer 1.000'dir. |
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. |
FabricDataAgentKnowledgeSourceParams
Bir Fabric Data Agent bilgi kaynağı için çalışma zamanı parametrelerini belirtir
| Veri Akışı Adı | Tür | Description |
|---|---|---|
| alwaysQuerySource |
boolean |
Bu bilgi kaynağının kaynak seçimini atlaması ve alma zamanında her zaman sorgulanması gerektiğini gösterir. |
| enableImageServing |
boolean |
Bu bilgi kaynağı için erişim sırasında görüntü servisi etkinleştirilip etkinleştirilmeyeceğini gösterir. Doğru olduğunda, alım sırasında çıkarılan görüntüler sonraki modellere teslim edilir. |
| failOnError |
boolean |
Bu bilgi kaynağından alınma hata ile karşılaşılırsa tüm alma talebinin başarısız olması gerektiğini gösterir. Varsayılan değer false'tur. |
| includeReferenceSourceData |
boolean |
Başvuruların, alma sırasında elde edilen yapılandırılmış verileri yüklerine dahil edip etmeyeceğini belirtir. |
| includeReferences |
boolean |
Bu kaynaktan alınan veriler için başvuruların dahil edilip edilmeyeceğini belirtir. |
| kind |
string:
fabric |
Bilgi kaynağının türü. |
| knowledgeSourceName |
string |
Parametrelerin uygulandığı dizinin adı. |
| maxOutputDocuments |
integer (int32) |
Bu bilgi kaynağından geri dönen maksimum belge sayısını sınırlar. |
| neverQuerySource |
boolean |
Bu bilgi kaynağının, talebin aday kümesinden çıkarılması ve alma sırasında sorgulanmaması gerektiğini gösterir. Bu istisna talebe yereldir ve bilgi tabanı üyeliğini değiştirmez. Aynı bilgi kaynağında alwaysQuerySource ile birleştirilemez. |
| rerankerThreshold |
number (float) |
Yanıta dahil edilmek için alınan tüm belgelerin karşılaması gereken yeniden sıralayıcı eşiği. |
| resultsProcessing |
Bilgi kaynağının depolanmış sonuçlarını geçersiz kılar. Yalnızca bu geri alma çağrısı için işleme. Atlandığında, depolanan bilgi kaynağı değeri uygulanır. |
FabricOntologyKnowledgeSourceParams
Fabric Ontology bilgi kaynağı için çalışma zamanı parametrelerini belirtir
| Veri Akışı Adı | Tür | Description |
|---|---|---|
| alwaysQuerySource |
boolean |
Bu bilgi kaynağının kaynak seçimini atlaması ve alma zamanında her zaman sorgulanması gerektiğini gösterir. |
| enableImageServing |
boolean |
Bu bilgi kaynağı için erişim sırasında görüntü servisi etkinleştirilip etkinleştirilmeyeceğini gösterir. Doğru olduğunda, alım sırasında çıkarılan görüntüler sonraki modellere teslim edilir. |
| failOnError |
boolean |
Bu bilgi kaynağından alınma hata ile karşılaşılırsa tüm alma talebinin başarısız olması gerektiğini gösterir. Varsayılan değer false'tur. |
| includeReferenceSourceData |
boolean |
Başvuruların, alma sırasında elde edilen yapılandırılmış verileri yüklerine dahil edip etmeyeceğini belirtir. |
| includeReferences |
boolean |
Bu kaynaktan alınan veriler için başvuruların dahil edilip edilmeyeceğini belirtir. |
| kind |
string:
fabric |
Bilgi kaynağının türü. |
| knowledgeSourceName |
string |
Parametrelerin uygulandığı dizinin adı. |
| maxOutputDocuments |
integer (int32) |
Bu bilgi kaynağından geri dönen maksimum belge sayısını sınırlar. |
| neverQuerySource |
boolean |
Bu bilgi kaynağının, talebin aday kümesinden çıkarılması ve alma sırasında sorgulanmaması gerektiğini gösterir. Bu istisna talebe yereldir ve bilgi tabanı üyeliğini değiştirmez. Aynı bilgi kaynağında alwaysQuerySource ile birleştirilemez. |
| rerankerThreshold |
number (float) |
Yanıta dahil edilmek için alınan tüm belgelerin karşılaması gereken yeniden sıralayıcı eşiği. |
| resultsProcessing |
Bilgi kaynağının depolanmış sonuçlarını geçersiz kılar. Yalnızca bu geri alma çağrısı için işleme. Atlandığında, depolanan bilgi kaynağı değeri uygulanır. |
FileKnowledgeSourceParams
Bir Dosya bilgi kaynağı için çalışma zamanı parametrelerini belirtir
| Veri Akışı Adı | Tür | Description |
|---|---|---|
| alwaysQuerySource |
boolean |
Bu bilgi kaynağının kaynak seçimini atlaması ve alma zamanında her zaman sorgulanması gerektiğini gösterir. |
| enableImageServing |
boolean |
Bu bilgi kaynağı için erişim sırasında görüntü servisi etkinleştirilip etkinleştirilmeyeceğini gösterir. Doğru olduğunda, alım sırasında çıkarılan görüntüler sonraki modellere teslim edilir. |
| failOnError |
boolean |
Bu bilgi kaynağından alınma hata ile karşılaşılırsa tüm alma talebinin başarısız olması gerektiğini gösterir. Varsayılan değer false'tur. |
| includeReferenceSourceData |
boolean |
Başvuruların, alma sırasında elde edilen yapılandırılmış verileri yüklerine dahil edip etmeyeceğini belirtir. |
| includeReferences |
boolean |
Bu kaynaktan alınan veriler için başvuruların dahil edilip edilmeyeceğini belirtir. |
| kind |
string:
file |
Bilgi kaynağının türü. |
| knowledgeSourceName |
string |
Parametrelerin uygulandığı dizinin adı. |
| maxOutputDocuments |
integer (int32) |
Bu bilgi kaynağından geri dönen maksimum belge sayısını sınırlar. |
| neverQuerySource |
boolean |
Bu bilgi kaynağının, talebin aday kümesinden çıkarılması ve alma sırasında sorgulanmaması gerektiğini gösterir. Bu istisna talebe yereldir ve bilgi tabanı üyeliğini değiştirmez. Aynı bilgi kaynağında alwaysQuerySource ile birleştirilemez. |
| rerankerThreshold |
number (float) |
Yanıta dahil edilmek için alınan tüm belgelerin karşılaması gereken yeniden sıralayıcı eşiği. |
| resultsProcessing |
Bilgi kaynağının depolanmış sonuçlarını geçersiz kılar. Yalnızca bu geri alma çağrısı için işleme. Atlandığında, depolanan bilgi kaynağı değeri uygulanır. |
IndexedOneLakeKnowledgeSourceParams
Dizinlenmiş OneLake bilgi kaynağı için çalışma zamanı parametrelerini belirtir
| Veri Akışı Adı | Tür | Description |
|---|---|---|
| alwaysQuerySource |
boolean |
Bu bilgi kaynağının kaynak seçimini atlaması ve alma zamanında her zaman sorgulanması gerektiğini gösterir. |
| enableImageServing |
boolean |
Bu bilgi kaynağı için erişim sırasında görüntü servisi etkinleştirilip etkinleştirilmeyeceğini gösterir. Doğru olduğunda, alım sırasında çıkarılan görüntüler sonraki modellere teslim edilir. |
| failOnError |
boolean |
Bu bilgi kaynağından alınma hata ile karşılaşılırsa tüm alma talebinin başarısız olması gerektiğini gösterir. Varsayılan değer false'tur. |
| includeReferenceSourceData |
boolean |
Başvuruların, alma sırasında elde edilen yapılandırılmış verileri yüklerine dahil edip etmeyeceğini belirtir. |
| includeReferences |
boolean |
Bu kaynaktan alınan veriler için başvuruların dahil edilip edilmeyeceğini belirtir. |
| kind |
string:
indexed |
Bilgi kaynağının türü. |
| knowledgeSourceName |
string |
Parametrelerin uygulandığı dizinin adı. |
| maxOutputDocuments |
integer (int32) |
Bu bilgi kaynağından geri dönen maksimum belge sayısını sınırlar. |
| neverQuerySource |
boolean |
Bu bilgi kaynağının, talebin aday kümesinden çıkarılması ve alma sırasında sorgulanmaması gerektiğini gösterir. Bu istisna talebe yereldir ve bilgi tabanı üyeliğini değiştirmez. Aynı bilgi kaynağında alwaysQuerySource ile birleştirilemez. |
| rerankerThreshold |
number (float) |
Yanıta dahil edilmek için alınan tüm belgelerin karşılaması gereken yeniden sıralayıcı eşiği. |
| resultsProcessing |
Bilgi kaynağının depolanmış sonuçlarını geçersiz kılar. Yalnızca bu geri alma çağrısı için işleme. Atlandığında, depolanan bilgi kaynağı değeri uygulanır. |
IndexedSharePointKnowledgeSourceParams
Dizine alınmış SharePoint bilgi kaynağı için çalışma zamanı parametrelerini belirtir
| Veri Akışı Adı | Tür | Description |
|---|---|---|
| alwaysQuerySource |
boolean |
Bu bilgi kaynağının kaynak seçimini atlaması ve alma zamanında her zaman sorgulanması gerektiğini gösterir. |
| enableImageServing |
boolean |
Bu bilgi kaynağı için erişim sırasında görüntü servisi etkinleştirilip etkinleştirilmeyeceğini gösterir. Doğru olduğunda, alım sırasında çıkarılan görüntüler sonraki modellere teslim edilir. |
| failOnError |
boolean |
Bu bilgi kaynağından alınma hata ile karşılaşılırsa tüm alma talebinin başarısız olması gerektiğini gösterir. Varsayılan değer false'tur. |
| includeReferenceSourceData |
boolean |
Başvuruların, alma sırasında elde edilen yapılandırılmış verileri yüklerine dahil edip etmeyeceğini belirtir. |
| includeReferences |
boolean |
Bu kaynaktan alınan veriler için başvuruların dahil edilip edilmeyeceğini belirtir. |
| kind |
string:
indexed |
Bilgi kaynağının türü. |
| knowledgeSourceName |
string |
Parametrelerin uygulandığı dizinin adı. |
| maxOutputDocuments |
integer (int32) |
Bu bilgi kaynağından geri dönen maksimum belge sayısını sınırlar. |
| neverQuerySource |
boolean |
Bu bilgi kaynağının, talebin aday kümesinden çıkarılması ve alma sırasında sorgulanmaması gerektiğini gösterir. Bu istisna talebe yereldir ve bilgi tabanı üyeliğini değiştirmez. Aynı bilgi kaynağında alwaysQuerySource ile birleştirilemez. |
| rerankerThreshold |
number (float) |
Yanıta dahil edilmek için alınan tüm belgelerin karşılaması gereken yeniden sıralayıcı eşiği. |
| resultsProcessing |
Bilgi kaynağının depolanmış sonuçlarını geçersiz kılar. Yalnızca bu geri alma çağrısı için işleme. Atlandığında, depolanan bilgi kaynağı değeri uygulanır. |
IndexedSqlKnowledgeSourceParams
İndekslenmiş SQL bilgi kaynağı için çalışma zamanı parametrelerini belirtir
| Veri Akışı Adı | Tür | Description |
|---|---|---|
| alwaysQuerySource |
boolean |
Bu bilgi kaynağının kaynak seçimini atlaması ve alma zamanında her zaman sorgulanması gerektiğini gösterir. |
| enableImageServing |
boolean |
Bu bilgi kaynağı için erişim sırasında görüntü servisi etkinleştirilip etkinleştirilmeyeceğini gösterir. Doğru olduğunda, alım sırasında çıkarılan görüntüler sonraki modellere teslim edilir. |
| failOnError |
boolean |
Bu bilgi kaynağından alınma hata ile karşılaşılırsa tüm alma talebinin başarısız olması gerektiğini gösterir. Varsayılan değer false'tur. |
| includeReferenceSourceData |
boolean |
Başvuruların, alma sırasında elde edilen yapılandırılmış verileri yüklerine dahil edip etmeyeceğini belirtir. |
| includeReferences |
boolean |
Bu kaynaktan alınan veriler için başvuruların dahil edilip edilmeyeceğini belirtir. |
| kind |
string:
indexed |
Bilgi kaynağının türü. |
| knowledgeSourceName |
string |
Parametrelerin uygulandığı dizinin adı. |
| maxOutputDocuments |
integer (int32) |
Bu bilgi kaynağından geri dönen maksimum belge sayısını sınırlar. |
| neverQuerySource |
boolean |
Bu bilgi kaynağının, talebin aday kümesinden çıkarılması ve alma sırasında sorgulanmaması gerektiğini gösterir. Bu istisna talebe yereldir ve bilgi tabanı üyeliğini değiştirmez. Aynı bilgi kaynağında alwaysQuerySource ile birleştirilemez. |
| rerankerThreshold |
number (float) |
Yanıta dahil edilmek için alınan tüm belgelerin karşılaması gereken yeniden sıralayıcı eşiği. |
| resultsProcessing |
Bilgi kaynağının depolanmış sonuçlarını geçersiz kılar. Yalnızca bu geri alma çağrısı için işleme. Atlandığında, depolanan bilgi kaynağı değeri uygulanır. |
KnowledgeBaseImageContent
Görsel içeriği.
| Veri Akışı Adı | Tür | Description |
|---|---|---|
| url |
string (uri) |
Resmin URL'si. |
KnowledgeBaseMessage
Doğal dil ileti stili nesnesi.
| Veri Akışı Adı | Tür | Description |
|---|---|---|
| content | KnowledgeBaseMessageContent[]: |
İletinin içeriği. |
| role |
string |
Araç yanıtının rolü. |
KnowledgeBaseMessageContentType
İleti içeriğinin türü.
| Değer | Description |
|---|---|
| text |
Kısa mesaj içerik türü. |
| image |
Resimli mesaj içerik türü. |
KnowledgeBaseMessageImageContent
Resim mesajı türü.
| Veri Akışı Adı | Tür | Description |
|---|---|---|
| image |
Görüntü içeriği. |
|
| type |
string:
image |
Mesajın türü |
KnowledgeBaseMessageTextContent
Kısa mesaj türü.
| Veri Akışı Adı | Tür | Description |
|---|---|---|
| text |
string |
Metin içeriği. |
| type |
string:
text |
Mesajın türü |
KnowledgeBaseRetrievalRequest
Alma isteği için giriş sözleşmesi.
| Veri Akışı Adı | Tür | Description |
|---|---|---|
| includeActivity |
boolean |
Alma sonuçlarının etkinlik bilgilerini içermesi gerektiğini belirtir. |
| intents | KnowledgeRetrievalIntent[]: |
Model sorgu planlaması olmadan yürütülecek amaçlanan sorguların listesi. |
| knowledgeSourceParams |
KnowledgeSourceParams[]:
|
Bilgi kaynakları için çalışma zamanı parametrelerinin listesi. |
| maxOutputDocuments |
integer (int32) |
Çıktıdaki maksimum belge sayısını sınırlar. |
| maxOutputSize |
integer (int32) |
Çıktıdaki içeriğin maksimum boyutunu sınırlar. |
| maxOutputSizeInTokens |
integer (int32) |
Çıktıdaki içeriğin maksimum boyutunu sınırlar. |
| maxRuntimeInSeconds |
integer (int32) |
Saniye cinsinden maksimum çalışma zamanı. |
| messages |
Sohbet iletisi stili girişlerinin listesi. |
|
| outputMode |
Bu alma için çıkış yapılandırması. |
|
| retrievalReasoningEffort | KnowledgeRetrievalReasoningEffort: |
Geri getirme amaç yürütme çabası yapılandırması. |
| toolName |
string |
Seçilecek araç. KB genelinde geri alma için atla. |
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ı. |
KnowledgeRetrievalIntentType
Kullanılacak bilgi bankası yapılandırması türü.
| Değer | Description |
|---|---|
| semantic |
Doğal dil anlamsal sorgu amacı. |
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. |
KnowledgeRetrievalSemanticIntent
Anlamsal bir sorgulama niyeti.
| Veri Akışı Adı | Tür | Description |
|---|---|---|
| search |
string |
Yürütülecek anlamsal sorgu |
| type |
string:
semantic |
Niyetin türü. |
KnowledgeSourceGraphProvenanceKind
Grafik tabanlı bilgi erişimi için kaynak belge davranışı.
| Değer | Description |
|---|---|
| none |
Kaynak belgelerini nemlendirmeden grafik sonuçlarını döndürün. |
| hydrate |
Ayrıca yapılandırılmış kaynak indeksinden seçili kaynak belgeleri döndürün. |
KnowledgeSourceKind
Bilgi kaynağının türü.
| Değer | Description |
|---|---|
| searchIndex |
Bir Arama Dizini'nden veri okuyan bir bilgi kaynağı. |
| azureBlob |
Azure Blob Depolama'dan bir Arama Dizini'ne veri okuyan ve alan bir bilgi kaynağı. |
| indexedSharePoint |
Indekslenmiş SharePoint'ten veri okuyan bir bilgi kaynağı. |
| indexedOneLake |
Indekslenmiş OneLake'den veri okuyan bir bilgi kaynağı. |
| indexedSql |
Azure SQL Veritabanı veya SQL Yönetilen Örneği'dan bir Arama İndeksine veri alan ve alan bir bilgi kaynağı. |
| web |
Web'den veri okuyan bir bilgi kaynağı. |
| remoteSharePoint |
Uzak SharePoint'ten veri okuyan bir bilgi kaynağı. |
| workIQ |
İş IQ'sundan veri okuyan bir bilgi kaynağı |
| file |
Doğrudan dosya yükleme ve indekslemeyi destekleyen bir bilgi kaynağı. |
| mcpServer |
MCP (Model Context Protocol) sunucusu tarafından desteklenen bir bilgi kaynağı. |
| fabricDataAgent |
Fabric Veri Ajanı'ndan veri alan bir bilgi kaynağı. |
| fabricOntology |
Microsoft Fabric Ontology ontolojilerinden veri alan bir bilgi kaynağı. |
KnowledgeSourceResultsProcessing
Bir bilgi kaynağının sonuçlarının yeniden sıralanıp sıralanmadığını kontrol eder.
| Değer | Description |
|---|---|
| rerank |
Bu bilgi kaynağından elde edilen sonuçlar yeniden sıralama hattından geçer. Bu varsayılan davranıştır. |
| none |
Bu bilgi kaynağından elde edilen sonuçlar, yeniden sıralamayı atlar ve temel sıralarını korur. |
McpServerKnowledgeSourceParams
MCP sunucu bilgi kaynağı için çalışma zamanı parametrelerini belirtir
| Veri Akışı Adı | Tür | Description |
|---|---|---|
| alwaysQuerySource |
boolean |
Bu bilgi kaynağının kaynak seçimini atlaması ve alma zamanında her zaman sorgulanması gerektiğini gösterir. |
| enableImageServing |
boolean |
Bu bilgi kaynağı için erişim sırasında görüntü servisi etkinleştirilip etkinleştirilmeyeceğini gösterir. Doğru olduğunda, alım sırasında çıkarılan görüntüler sonraki modellere teslim edilir. |
| failOnError |
boolean |
Bu bilgi kaynağından alınma hata ile karşılaşılırsa tüm alma talebinin başarısız olması gerektiğini gösterir. Varsayılan değer false'tur. |
| includeReferenceSourceData |
boolean |
Başvuruların, alma sırasında elde edilen yapılandırılmış verileri yüklerine dahil edip etmeyeceğini belirtir. |
| includeReferences |
boolean |
Bu kaynaktan alınan veriler için başvuruların dahil edilip edilmeyeceğini belirtir. |
| kind |
string:
mcp |
Bilgi kaynağının türü. |
| knowledgeSourceName |
string |
Parametrelerin uygulandığı dizinin adı. |
| maxOutputDocuments |
integer (int32) |
Bu bilgi kaynağından geri dönen maksimum belge sayısını sınırlar. |
| neverQuerySource |
boolean |
Bu bilgi kaynağının, talebin aday kümesinden çıkarılması ve alma sırasında sorgulanmaması gerektiğini gösterir. Bu istisna talebe yereldir ve bilgi tabanı üyeliğini değiştirmez. Aynı bilgi kaynağında alwaysQuerySource ile birleştirilemez. |
| rerankerThreshold |
number (float) |
Yanıta dahil edilmek için alınan tüm belgelerin karşılaması gereken yeniden sıralayıcı eşiği. |
| resultsProcessing |
Bilgi kaynağının depolanmış sonuçlarını geçersiz kılar. Yalnızca bu geri alma çağrısı için işleme. Atlandığında, depolanan bilgi kaynağı değeri uygulanır. |
NoneVectorQueryTopicGraph
Konu grafiği çeşitliliği olmadan normal vektör araması kullanır.
| Veri Akışı Adı | Tür | Description |
|---|---|---|
| kind |
string:
none |
Kullanılacak konu grafiği vektör araması türü. |
RemoteSharePointKnowledgeSourceParams
Uzak SharePoint bilgi kaynağı için çalışma zamanı parametrelerini belirtir
| Veri Akışı Adı | Tür | Description |
|---|---|---|
| alwaysQuerySource |
boolean |
Bu bilgi kaynağının kaynak seçimini atlaması ve alma zamanında her zaman sorgulanması gerektiğini gösterir. |
| enableImageServing |
boolean |
Bu bilgi kaynağı için erişim sırasında görüntü servisi etkinleştirilip etkinleştirilmeyeceğini gösterir. Doğru olduğunda, alım sırasında çıkarılan görüntüler sonraki modellere teslim edilir. |
| failOnError |
boolean |
Bu bilgi kaynağından alınma hata ile karşılaşılırsa tüm alma talebinin başarısız olması gerektiğini gösterir. Varsayılan değer false'tur. |
| filterExpressionAddOn |
string |
SharePoint veri kaynağına uygulanan bir filtre koşulu. Anahtar Sözcük Sorgu Dili sözdiziminde belirtilmelidir. Bilgi kaynağı tanımında belirtilen filtre ifadesiyle birleşim olarak birleştirilir. |
| includeReferenceSourceData |
boolean |
Başvuruların, alma sırasında elde edilen yapılandırılmış verileri yüklerine dahil edip etmeyeceğini belirtir. |
| includeReferences |
boolean |
Bu kaynaktan alınan veriler için başvuruların dahil edilip edilmeyeceğini belirtir. |
| kind |
string:
remote |
Bilgi kaynağının türü. |
| knowledgeSourceName |
string |
Parametrelerin uygulandığı dizinin adı. |
| maxOutputDocuments |
integer (int32) |
Bu bilgi kaynağından geri dönen maksimum belge sayısını sınırlar. |
| neverQuerySource |
boolean |
Bu bilgi kaynağının, talebin aday kümesinden çıkarılması ve alma sırasında sorgulanmaması gerektiğini gösterir. Bu istisna talebe yereldir ve bilgi tabanı üyeliğini değiştirmez. Aynı bilgi kaynağında alwaysQuerySource ile birleştirilemez. |
| rerankerThreshold |
number (float) |
Yanıta dahil edilmek için alınan tüm belgelerin karşılaması gereken yeniden sıralayıcı eşiği. |
| resultsProcessing |
Bilgi kaynağının depolanmış sonuçlarını geçersiz kılar. Yalnızca bu geri alma çağrısı için işleme. Atlandığında, depolanan bilgi kaynağı değeri uygulanır. |
SearchIndexKnowledgeSourceBoostKind
Arama indeks bilgi kaynağı için bir teşvik ipucu.
| Değer | Description |
|---|---|
| fieldValue |
Belgeleri bir alan değerine göre güçlendirin. |
| multiWordExpression |
Çok kelimeli bir ifade temelinde belgeleri güçlendirin. |
SearchIndexKnowledgeSourceFieldValueBoost
Bir alan değerine göre belgeleri güçlendiren bir ipucu.
| Veri Akışı Adı | Tür | Description |
|---|---|---|
| boost |
number (double) |
Belge puanı için bir çarpan. 1,0'a eşit olmayan pozitif bir sayı olmalıdır. |
| boostInstructions |
string |
Boost'un ne zaman ve nasıl uygulanacağını açıklayan doğal dil talimatları. |
| field |
string minLength: 1 |
Arama dizin alanının adı. |
| fieldValues |
string[] |
Alan için temsil değerler. |
| kind |
string:
field |
Böyle bir boost ipucu. |
SearchIndexKnowledgeSourceFilterHint
Bir alanı ve sorgu planlayıcısının filtre oluştururken kullanabileceği kapsamlı temel değerlerini tanımlayan bir ipucu.
| Veri Akışı Adı | Tür | Description |
|---|---|---|
| autoConfiguration |
Servisi, alanın yüzeylerinden topraklama değerlerini çözecek şekilde yapılandırır. Varlığı otomatik yapılandırmayı mümkün kılar. Alan filtrelenebilir ve yüz yüze çevrilebilir olmalıdır. Hedef dizinde belge düzeyinde izinler veya Purview hassasiyet etiketleri etkin olduğunda desteklenmez; bu kısıtlama, bilgi kaynağı oluşturma/güncelleme ve bilgi tabanı erişim zamanında doğrulanır.
|
|
| field |
string minLength: 1 |
Filtrelenebilir arama dizin alanının adı. |
| fieldValues |
string[] |
Alan için kapsamlı değerler seti. En fazla 160 değer, her değer için maksimum 128 karakter ve toplamda 2048 karakter. Destekleyen |
| filterInstructions |
string |
Sahada ne zaman ve nasıl filtreleyeceğimizi açıklayan doğal dil talimatları. |
SearchIndexKnowledgeSourceFilterHintAutoConfiguration
Bir filtre ipucunun topraklama değerlerinin hedef indeks yüzeylerinden otomatik çözünürlüğünü yapılandırır.
| Veri Akışı Adı | Tür | Description |
|---|---|---|
| cacheTtl |
integer (int32) minimum: 60maximum: 3600 |
Çözülen yüzey değerlerinin önbelleğe alındığı saniye sayısı. İzin verilen aralık, özel hizmetlerde 60 ile 3600 arası, sunucusuz servislerde ise 60 ile 900 arasındadır. Atladığında, özel servislerde varsayılan olarak 3600 saniye, sunucusuz servislerde ise 900 saniye olur. |
| maxFacetValueCount |
integer (int32) minimum: 1maximum: 64 |
Topraklama olarak kullanılacak maksimum yüzey değeri sayısı. Varsayılan olarak 64 olur; izin verilen aralık 1'den 64'e kadardır. Değerler, manuel olarak belirtilen filtre değerleriyle aynı 2048 karakterlik birleşik uzunluk sınırı ve değer başına 128 karakter sınırına tabi olarak azalan facet sayısı sırasıyla seçilir. |
SearchIndexKnowledgeSourceMultiWordExpressionBoost
Çok kelimeli bir ifade temelinde belgeleri güçlendiren bir ipucu.
| Veri Akışı Adı | Tür | Description |
|---|---|---|
| boost |
number (double) |
Belge puanı için bir çarpan. 1,0'a eşit olmayan pozitif bir sayı olmalıdır. |
| boostInstructions |
string |
Boost'un ne zaman ve nasıl uygulanacağını açıklayan doğal dil talimatları. |
| fieldValues |
string[] |
Artış için temsili değerler. |
| kind |
string:
multi |
Böyle bir boost ipucu. |
SearchIndexKnowledgeSourceParams
Arama dizini bilgi kaynağı için çalışma zamanı parametrelerini belirtir
| Veri Akışı Adı | Tür | Description |
|---|---|---|
| alwaysQuerySource |
boolean |
Bu bilgi kaynağının kaynak seçimini atlaması ve alma zamanında her zaman sorgulanması gerektiğini gösterir. |
| enableImageServing |
boolean |
Bu bilgi kaynağı için erişim sırasında görüntü servisi etkinleştirilip etkinleştirilmeyeceğini gösterir. Doğru olduğunda, alım sırasında çıkarılan görüntüler sonraki modellere teslim edilir. |
| failOnError |
boolean |
Bu bilgi kaynağından alınma hata ile karşılaşılırsa tüm alma talebinin başarısız olması gerektiğini gösterir. Varsayılan değer false'tur. |
| filterAddOn |
string |
Dizine uygulanan bir filtre koşulu (ör. "State eq VA"). |
| includeReferenceSourceData |
boolean |
Başvuruların, alma sırasında elde edilen yapılandırılmış verileri yüklerine dahil edip etmeyeceğini belirtir. |
| includeReferences |
boolean |
Bu kaynaktan alınan veriler için başvuruların dahil edilip edilmeyeceğini belirtir. |
| kind |
string:
search |
Bilgi kaynağının türü. |
| knowledgeSourceName |
string |
Parametrelerin uygulandığı dizinin adı. |
| maxOutputDocuments |
integer (int32) |
Bu bilgi kaynağından geri dönen maksimum belge sayısını sınırlar. |
| neverQuerySource |
boolean |
Bu bilgi kaynağının, talebin aday kümesinden çıkarılması ve alma sırasında sorgulanmaması gerektiğini gösterir. Bu istisna talebe yereldir ve bilgi tabanı üyeliğini değiştirmez. Aynı bilgi kaynağında alwaysQuerySource ile birleştirilemez. |
| queryHintOverrides |
Sorgu planlamasını faydalı filtreler ve güçlendirmeler için yönlendiren ipuçları. Belirtilirse, bu nesne bilgi kaynağında yapılandırılmış tüm sorgu ipuçları setinin yerini alır. |
|
| rerankerThreshold |
number (float) |
Yanıta dahil edilmek için alınan tüm belgelerin karşılaması gereken yeniden sıralayıcı eşiği. |
| resultsProcessing |
Bilgi kaynağının depolanmış sonuçlarını geçersiz kılar. Yalnızca bu geri alma çağrısı için işleme. Atlandığında, depolanan bilgi kaynağı değeri uygulanır. |
|
| topicGraph | VectorQueryTopicGraph: |
Bu erişim için bilgi kaynağının depolanan topicGraph değerini geçersiz kılar. Atlandığında, depolanan bilgi kaynağı değeri uygulanır. |
SearchIndexKnowledgeSourceQueryHints
Arama indeksi bilgi kaynağı için faydalı filtreler ve güçlendirmeler için sorgu planlamasını yönlendiren ipuçları.
| Veri Akışı Adı | Tür | Description |
|---|---|---|
| boosts | SearchIndexKnowledgeSourceBoost[]: |
Sorgu planlayıcısının belge sıralamasını etkilemek için kullanabileceği koşulları belirleyen ipuçlarını güçlendirin. |
| filters |
Filtre ipuçları, sorgu planlayıcısının filtre oluştururken kullanabileceği alanları ve temsil eden değerleri belirler. |
VectorSearchTopicGraphKind
Kullanılacak konu grafiği vektör araması türü.
| Değer | Description |
|---|---|
| none |
Konu grafiği çeşitlilik geri kazanımı kapalıysa normal vektör araması kullanın. |
| diverse |
Konu grafiği çeşitlilik geri çağırışını kullanın. |
| balanced |
Saf vektör benzerliğini çeşitlilik farkındalığına sahip geri getirme ile harmanlar. Çeşitlilik ile alaka düzeyini dengelemek için varsayılan öneriliyor. |
WebKnowledgeSourceParams
Bir web bilgi kaynağı için çalışma zamanı parametrelerini belirtir
| Veri Akışı Adı | Tür | Description |
|---|---|---|
| alwaysQuerySource |
boolean |
Bu bilgi kaynağının kaynak seçimini atlaması ve alma zamanında her zaman sorgulanması gerektiğini gösterir. |
| count |
integer (int32) |
Döndürülecek web sonuçlarının sayısı. |
| enableImageServing |
boolean |
Bu bilgi kaynağı için erişim sırasında görüntü servisi etkinleştirilip etkinleştirilmeyeceğini gösterir. Doğru olduğunda, alım sırasında çıkarılan görüntüler sonraki modellere teslim edilir. |
| failOnError |
boolean |
Bu bilgi kaynağından alınma hata ile karşılaşılırsa tüm alma talebinin başarısız olması gerektiğini gösterir. Varsayılan değer false'tur. |
| freshness |
string |
Web sonuçlarının tazeliği. |
| includeReferenceSourceData |
boolean |
Başvuruların, alma sırasında elde edilen yapılandırılmış verileri yüklerine dahil edip etmeyeceğini belirtir. |
| includeReferences |
boolean |
Bu kaynaktan alınan veriler için başvuruların dahil edilip edilmeyeceğini belirtir. |
| kind |
string:
web |
Bilgi kaynağının türü. |
| knowledgeSourceName |
string |
Parametrelerin uygulandığı dizinin adı. |
| language |
string |
Web sonuçlarının dili. |
| market |
string |
Web sonuçlarının pazarı. |
| maxOutputDocuments |
integer (int32) |
Bu bilgi kaynağından geri dönen maksimum belge sayısını sınırlar. |
| neverQuerySource |
boolean |
Bu bilgi kaynağının, talebin aday kümesinden çıkarılması ve alma sırasında sorgulanmaması gerektiğini gösterir. Bu istisna talebe yereldir ve bilgi tabanı üyeliğini değiştirmez. Aynı bilgi kaynağında alwaysQuerySource ile birleştirilemez. |
| rerankerThreshold |
number (float) |
Yanıta dahil edilmek için alınan tüm belgelerin karşılaması gereken yeniden sıralayıcı eşiği. |
| resultsProcessing |
Bilgi kaynağının depolanmış sonuçlarını geçersiz kılar. Yalnızca bu geri alma çağrısı için işleme. Atlandığında, depolanan bilgi kaynağı değeri uygulanır. |
WorkIQKnowledgeSourceParams
WorkIQ bilgi kaynağı için çalışma zamanı parametrelerini belirtir
| Veri Akışı Adı | Tür | Description |
|---|---|---|
| alwaysQuerySource |
boolean |
Bu bilgi kaynağının kaynak seçimini atlaması ve alma zamanında her zaman sorgulanması gerektiğini gösterir. |
| enableImageServing |
boolean |
Bu bilgi kaynağı için erişim sırasında görüntü servisi etkinleştirilip etkinleştirilmeyeceğini gösterir. Doğru olduğunda, alım sırasında çıkarılan görüntüler sonraki modellere teslim edilir. |
| failOnError |
boolean |
Bu bilgi kaynağından alınma hata ile karşılaşılırsa tüm alma talebinin başarısız olması gerektiğini gösterir. Varsayılan değer false'tur. |
| includeReferenceSourceData |
boolean |
Başvuruların, alma sırasında elde edilen yapılandırılmış verileri yüklerine dahil edip etmeyeceğini belirtir. |
| includeReferences |
boolean |
Bu kaynaktan alınan veriler için başvuruların dahil edilip edilmeyeceğini belirtir. |
| kind |
string:
workIQ |
Bilgi kaynağının türü. |
| knowledgeSourceName |
string |
Parametrelerin uygulandığı dizinin adı. |
| maxOutputDocuments |
integer (int32) |
Bu bilgi kaynağından geri dönen maksimum belge sayısını sınırlar. |
| neverQuerySource |
boolean |
Bu bilgi kaynağının, talebin aday kümesinden çıkarılması ve alma sırasında sorgulanmaması gerektiğini gösterir. Bu istisna talebe yereldir ve bilgi tabanı üyeliğini değiştirmez. Aynı bilgi kaynağında alwaysQuerySource ile birleştirilemez. |
| rerankerThreshold |
number (float) |
Yanıta dahil edilmek için alınan tüm belgelerin karşılaması gereken yeniden sıralayıcı eşiği. |
| resultsProcessing |
Bilgi kaynağının depolanmış sonuçlarını geçersiz kılar. Yalnızca bu geri alma çağrısı için işleme. Atlandığında, depolanan bilgi kaynağı değeri uygulanır. |