Knowledge Retrieval - Retrieve
Die KnowledgeBase ruft relevante Daten aus Sicherungsspeichern ab.
POST {endpoint}/knowledgebases('{knowledgeBaseName}')/retrieve?api-version=2026-08-01-preview
URI-Parameter
| Name | In | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
endpoint
|
path | True |
string (uri) |
Die Endpunkt-URL des Suchdiensts. |
|
knowledge
|
path | True |
string |
Der Name der Wissensbasis. |
|
api-version
|
query | True |
string minLength: 1 |
Die API-Version, die für diesen Vorgang verwendet werden soll. |
Anforderungsheader
| Name | Erforderlich | Typ | Beschreibung |
|---|---|---|---|
| Accept |
Die Überschrift "Annehmen". |
||
| x-ms-query-source-authorization |
string |
Token, das den Benutzer identifiziert, für den die Abfrage ausgeführt wird. Dieses Token wird verwendet, um Sicherheitseinschränkungen für Dokumente durchzusetzen. |
|
| x-ms-query-work-iq-source-authorization |
string (password) |
Benutzer-Assertions-Token für eine kundeneigene Entra-App-Registrierung, die auf einer Work IQ-Wissensquelle konfiguriert ist. Wird für die On-Be-of-Authentifizierung der Work IQ API verwendet. |
|
| x-ms-client-request-id |
string (uuid) |
Ein undurchsichtiger, global eindeutiger, clientgenerierter Zeichenfolgenbezeichner für die Anforderung. |
Anforderungstext
| Name | Typ | Beschreibung |
|---|---|---|
| includeActivity |
boolean |
Gibt an, dass die Abrufergebnisse Aktivitätsinformationen enthalten sollten. |
| intents | KnowledgeRetrievalIntent[]: |
Eine Liste der beabsichtigten Abfragen, die ohne Modellabfrageplanung ausgeführt werden sollen. |
| knowledgeSourceParams |
KnowledgeSourceParams[]:
|
Eine Liste von Laufzeitparametern für die Wissensquellen. |
| maxOutputDocuments |
integer (int32) |
Begrenzt die maximale Anzahl der Dokumente im Output. |
| maxOutputSize |
integer (int32) |
Begrenzt die maximale Größe des Inhalts in der Ausgabe. |
| maxOutputSizeInTokens |
integer (int32) |
Begrenzt die maximale Größe des Inhalts in der Ausgabe. |
| maxRuntimeInSeconds |
integer (int32) |
Die maximale Laufzeit in Sekunden. |
| messages |
Eine Liste von Eingaben im Stil von Chatnachrichten. |
|
| outputMode |
Die Ausgabekonfiguration für diesen Abruf. |
|
| retrievalReasoningEffort | KnowledgeRetrievalReasoningEffort: |
Die Konfiguration des Wiederholungs-Denkens. |
Antworten
| Name | Typ | Beschreibung |
|---|---|---|
| 200 OK |
Erfolgreiche Rücknahmereaktion. |
|
| Other Status Codes |
Partielle Entnahmereaktion. |
|
| Other Status Codes |
Unerwartete Fehlerantwort. |
Sicherheit
api-key
Typ:
apiKey
In:
header
OAuth2Auth
Typ:
oauth2
Ablauf:
implicit
Autorisierungs-URL:
https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Bereiche
| Name | Beschreibung |
|---|---|
| https://search.azure.com/.default |
Beispiele
|
Knowledge |
|
Knowledge |
|
Knowledge |
|
Knowledge |
KnowledgeBaseRetrieve
Beispielanforderung
POST https://typespecpreviewexampleservice.search.windows.net/knowledgebases('base-preview-test')/retrieve?api-version=2026-08-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
}
]
}
}
]
}
Beispiel für eine Antwort
{
"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": 10,
"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 (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 (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": 10,
"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-08-01-preview",
"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-08-01-preview",
"sourceData": {
"id": "myDocKey2",
"title": "low_doc",
"content": "goodbye world"
}
}
]
}
{
"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": 10,
"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 (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 (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": 10,
"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-08-01-preview",
"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-08-01-preview",
"sourceData": {
"id": "myDocKey2",
"title": "low_doc",
"content": "goodbye world"
}
}
]
}
KnowledgeBaseRetrieveAzureBlobImageServing
Beispielanforderung
POST https://typespecpreviewexampleservice.search.windows.net/knowledgebases('base-azureblob-preview-test')/retrieve?api-version=2026-08-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": "azureblob-ks-preview-test",
"includeReferences": true,
"includeReferenceSourceData": true,
"alwaysQuerySource": false,
"failOnError": false,
"rerankerThreshold": 2.1,
"kind": "azureBlob",
"enableImageServing": true
}
]
}
Beispiel für eine Antwort
{
"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": 10,
"model": {
"modelName": "gpt-4o",
"deploymentId": "gpt-4o-deployment"
}
},
{
"type": "azureBlob",
"id": 1,
"startedAt": "2025-01-01T00:08:45.045Z",
"completedAt": "2025-01-01T00:08:46.279Z",
"knowledgeSourceName": "azureblob-ks-preview-test",
"queryTime": "2025-01-01T00:08:45.045Z",
"count": 2,
"elapsedMs": 1234,
"azureBlobArguments": {
"search": "hello world"
},
"imageServing": {
"imagesRetrieved": 2,
"imagesSentToModel": 1,
"totalImageSizeBytes": 3,
"verbalizationUsed": true,
"servedImages": [
{
"imageId": "1.1",
"imagePath": "doc/normalized_images_0.jpg",
"sizeBytes": 3
}
]
}
},
{
"type": "azureBlob",
"id": 2,
"startedAt": "2025-01-01T00:08:45.045Z",
"completedAt": "2025-01-01T00:08:46.279Z",
"knowledgeSourceName": "azureblob-ks-preview-test",
"queryTime": "2025-01-01T00:08:45.045Z",
"count": 2,
"elapsedMs": 1234,
"azureBlobArguments": {
"search": "hello world two"
}
},
{
"type": "modelAnswerSynthesis",
"id": 3,
"startedAt": "2025-01-01T00:08:45.045Z",
"completedAt": "2025-01-01T00:08:46.279Z",
"inputTokens": 11,
"outputTokens": 22,
"elapsedMs": 10,
"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": "azureBlob",
"id": "83dd7d40",
"activitySource": 1,
"rerankerScore": 4,
"citationUrl": "https://typespecpreviewexampleservice.search.windows.net/indexes/azureblob-ks-preview-test-index/docs/myDocKey1?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-08-01-preview",
"sourceData": {
"id": "myDocKey1",
"title": "high_doc",
"content": "hello world",
"image_path": "1.1:doc/normalized_images_0.jpg"
}
},
{
"type": "azureBlob",
"id": "83dd7d41",
"activitySource": 1,
"rerankerScore": 3.9,
"citationUrl": "https://typespecpreviewexampleservice.search.windows.net/indexes/azureblob-ks-preview-test-index/docs/myDocKey2?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-08-01-preview",
"sourceData": {
"id": "myDocKey2",
"title": "low_doc",
"content": "goodbye world",
"image_path": "3.2:doc/normalized_images_1.jpg"
}
}
]
}
{
"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": 10,
"model": {
"modelName": "gpt-4o",
"deploymentId": "gpt-4o-deployment"
}
},
{
"type": "azureBlob",
"id": 1,
"startedAt": "2025-01-01T00:08:45.045Z",
"completedAt": "2025-01-01T00:08:46.279Z",
"knowledgeSourceName": "azureblob-ks-preview-test",
"queryTime": "2025-01-01T00:08:45.045Z",
"count": 2,
"elapsedMs": 1234,
"azureBlobArguments": {
"search": "hello world"
},
"imageServing": {
"imagesRetrieved": 2,
"imagesSentToModel": 1,
"totalImageSizeBytes": 3,
"verbalizationUsed": true,
"servedImages": [
{
"imageId": "1.1",
"imagePath": "doc/normalized_images_0.jpg",
"sizeBytes": 3
}
]
}
},
{
"type": "azureBlob",
"id": 2,
"startedAt": "2025-01-01T00:08:45.045Z",
"completedAt": "2025-01-01T00:08:46.279Z",
"knowledgeSourceName": "azureblob-ks-preview-test",
"queryTime": "2025-01-01T00:08:45.045Z",
"count": 2,
"elapsedMs": 1234,
"azureBlobArguments": {
"search": "hello world two"
}
},
{
"type": "modelAnswerSynthesis",
"id": 3,
"startedAt": "2025-01-01T00:08:45.045Z",
"completedAt": "2025-01-01T00:08:46.279Z",
"inputTokens": 11,
"outputTokens": 22,
"elapsedMs": 10,
"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": "azureBlob",
"id": "83dd7d40",
"activitySource": 1,
"rerankerScore": 4,
"citationUrl": "https://typespecpreviewexampleservice.search.windows.net/indexes/azureblob-ks-preview-test-index/docs/myDocKey1?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-08-01-preview",
"sourceData": {
"id": "myDocKey1",
"title": "high_doc",
"content": "hello world",
"image_path": "1.1:doc/normalized_images_0.jpg"
}
},
{
"type": "azureBlob",
"id": "83dd7d41",
"activitySource": 1,
"rerankerScore": 3.9,
"citationUrl": "https://typespecpreviewexampleservice.search.windows.net/indexes/azureblob-ks-preview-test-index/docs/myDocKey2?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-08-01-preview",
"sourceData": {
"id": "myDocKey2",
"title": "low_doc",
"content": "goodbye world",
"image_path": "3.2:doc/normalized_images_1.jpg"
}
}
]
}
KnowledgeBaseRetrieveWithIntents
Beispielanforderung
POST https://typespecpreviewexampleservice.search.windows.net/knowledgebases('base-preview-test')/retrieve?api-version=2026-08-01-preview
{
"intents": [
{
"type": "semantic",
"search": "foo"
}
],
"maxRuntimeInSeconds": 60,
"maxOutputSize": 100000,
"maxOutputDocuments": 50,
"retrievalReasoningEffort": {
"kind": "minimal"
},
"includeActivity": true,
"outputMode": "extractiveData",
"knowledgeSourceParams": [
{
"knowledgeSourceName": "ks-preview-test",
"includeReferences": true,
"includeReferenceSourceData": true,
"alwaysQuerySource": true,
"failOnError": true,
"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
}
]
}
}
]
}
Beispiel für eine Antwort
{
"response": [
{
"content": [
{
"type": "text",
"text": "[{...}]"
}
]
}
],
"activity": [
{
"type": "searchIndex",
"id": 0,
"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": "foo",
"filter": "(category eq 'news') and (foo eq bar)",
"semanticConfigurationName": "testconfig",
"sourceDataFields": [
{
"name": "category"
},
{
"name": "description"
},
{
"name": "ownerId"
},
{
"name": "id"
}
],
"searchFields": []
}
},
{
"type": "agenticReasoning",
"id": 1,
"startedAt": "2025-01-01T00:08:45.045Z",
"completedAt": "2025-01-01T00:08:46.279Z",
"reasoningTokens": 39,
"retrievalReasoningEffort": {
"kind": "minimal"
},
"logicalReasoningEffort": {
"kind": "minimal"
}
}
],
"references": [
{
"type": "searchIndex",
"id": "83dd7d40",
"activitySource": 0,
"rerankerScore": 4,
"docKey": "myDocKey1",
"citationUrl": "https://typespecpreviewexampleservice.search.windows.net/indexes/preview-test/docs/myDocKey1?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-08-01-preview",
"sourceData": {
"id": "myDocKey1",
"title": "high_doc",
"content": "hello world"
}
},
{
"type": "searchIndex",
"id": "83dd7d41",
"activitySource": 0,
"rerankerScore": 3.9,
"docKey": "myDocKey2",
"citationUrl": "https://typespecpreviewexampleservice.search.windows.net/indexes/preview-test/docs/myDocKey2?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-08-01-preview",
"sourceData": {
"id": "myDocKey2",
"title": "low_doc",
"content": "goodbye world"
}
}
]
}
{
"response": [
{
"content": [
{
"type": "text",
"text": "[{...}]"
}
]
}
],
"activity": [
{
"type": "searchIndex",
"id": 0,
"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": "foo",
"filter": "(category eq 'news') and (foo eq bar)",
"semanticConfigurationName": "testconfig",
"sourceDataFields": [
{
"name": "category"
},
{
"name": "description"
},
{
"name": "ownerId"
},
{
"name": "id"
}
],
"searchFields": []
}
},
{
"type": "agenticReasoning",
"id": 1,
"startedAt": "2025-01-01T00:08:45.045Z",
"completedAt": "2025-01-01T00:08:46.279Z",
"reasoningTokens": 39,
"retrievalReasoningEffort": {
"kind": "minimal"
},
"logicalReasoningEffort": {
"kind": "minimal"
}
}
],
"references": [
{
"type": "searchIndex",
"id": "83dd7d40",
"activitySource": 0,
"rerankerScore": 4,
"docKey": "myDocKey1",
"citationUrl": "https://typespecpreviewexampleservice.search.windows.net/indexes/preview-test/docs/myDocKey1?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-08-01-preview",
"sourceData": {
"id": "myDocKey1",
"title": "high_doc",
"content": "hello world"
}
},
{
"type": "searchIndex",
"id": "83dd7d41",
"activitySource": 0,
"rerankerScore": 3.9,
"docKey": "myDocKey2",
"citationUrl": "https://typespecpreviewexampleservice.search.windows.net/indexes/preview-test/docs/myDocKey2?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-08-01-preview",
"sourceData": {
"id": "myDocKey2",
"title": "low_doc",
"content": "goodbye world"
}
}
]
}
KnowledgeBaseRetrieveWithSourceExclusion
Beispielanforderung
POST https://previewexampleservice.search.windows.net/knowledgebases('support-kb')/retrieve?api-version=2026-08-01-preview
{
"messages": [
{
"role": "user",
"content": [
{
"text": "Explain the SSO provisioning steps from the product documentation only.",
"type": "text"
}
]
}
],
"includeActivity": true,
"outputMode": "answerSynthesis",
"knowledgeSourceParams": [
{
"knowledgeSourceName": "product-docs-ks",
"includeReferences": true,
"includeReferenceSourceData": true,
"kind": "searchIndex"
},
{
"knowledgeSourceName": "troubleshooting-ks",
"neverQuerySource": true,
"kind": "searchIndex"
},
{
"knowledgeSourceName": "release-notes-web",
"neverQuerySource": true,
"kind": "web"
}
]
}
Beispiel für eine Antwort
{
"response": [
{
"content": [
{
"type": "text",
"text": "To provision SSO, register the enterprise application, configure the redirect URI, upload the signing certificate, and complete the tenant-specific identity settings described in the product documentation."
}
]
}
],
"activity": [
{
"type": "modelQueryPlanning",
"id": 0,
"inputTokens": 11,
"outputTokens": 22,
"elapsedMs": 10
},
{
"type": "searchIndex",
"id": 1,
"knowledgeSourceName": "product-docs-ks",
"queryTime": "2025-01-01T00:08:45.045Z",
"count": 4,
"elapsedMs": 64,
"searchIndexArguments": {
"search": "SSO provisioning steps",
"sourceDataFields": [
{
"name": "title"
},
{
"name": "content"
},
{
"name": "id"
}
],
"searchFields": [],
"semanticConfigurationName": "testconfig"
}
},
{
"type": "agenticReasoning",
"id": 2,
"retrievalReasoningEffort": {
"kind": "low"
},
"reasoningTokens": 74
},
{
"type": "modelAnswerSynthesis",
"id": 3,
"inputTokens": 664,
"outputTokens": 1328,
"elapsedMs": 10
}
],
"references": [
{
"type": "searchIndex",
"id": "83dd7d40",
"activitySource": 1,
"sourceData": {
"id": "sso-provisioning-guide",
"title": "SSO provisioning guide",
"content": "Register the enterprise application and configure the redirect URI."
},
"rerankerScore": 3.5,
"docKey": "sso-provisioning-guide"
}
]
}
{
"response": [
{
"content": [
{
"type": "text",
"text": "Partial results were returned before the retrieval completed."
}
]
}
],
"activity": [
{
"type": "modelQueryPlanning",
"id": 0,
"inputTokens": 11,
"outputTokens": 22,
"elapsedMs": 10
},
{
"type": "searchIndex",
"id": 1,
"knowledgeSourceName": "product-docs-ks",
"queryTime": "2025-01-01T00:08:45.045Z",
"count": 1,
"elapsedMs": 64,
"searchIndexArguments": {
"search": "SSO provisioning steps",
"sourceDataFields": [
{
"name": "title"
},
{
"name": "content"
},
{
"name": "id"
}
],
"searchFields": [],
"semanticConfigurationName": "testconfig"
}
}
],
"references": [
{
"type": "searchIndex",
"id": "83dd7d40",
"activitySource": 1,
"sourceData": {
"id": "sso-provisioning-guide",
"title": "SSO provisioning guide",
"content": "Register the enterprise application and configure the redirect URI."
},
"rerankerScore": 3.5,
"docKey": "sso-provisioning-guide"
}
]
}
Definitionen
| Name | Beschreibung |
|---|---|
| Accept |
Die Überschrift "Annehmen". |
|
Azure |
Gibt Laufzeitparameter für eine Azure Blob-Wissensquelle an |
|
Error |
Zusätzliche Informationen zum Fehler bei der Ressourcenverwaltung. |
|
Error |
Die Fehlerdetails. |
|
Error |
Häufige Fehlerantwort für alle Azure Resource Manager-APIs, um Fehlerdetails für fehlgeschlagene Vorgänge zurückzugeben. (Dies folgt auch dem OData-Fehlerantwortformat.) |
|
Fabric |
Spezifiziert Laufzeitparameter für eine Fabric Data Agent-Wissensquelle |
|
Fabric |
Spezifiziert Laufzeitparameter für eine Fabric-Ontologie-Wissensquelle |
|
File |
Spezifiziert Laufzeitparameter für eine Datei-Wissensquelle |
|
Image |
Statistiken zum Bildservieren während einer Abrufaktivität. |
|
Indexed |
Gibt Laufzeitparameter für eine indizierte OneLake-Wissensquelle an. |
|
Indexed |
Gibt Laufzeitparameter für eine indizierte SharePoint-Wissensquelle an. |
|
Indexed |
Spezifiziert Laufzeitparameter für eine indexierte SQL-Wissensquelle |
|
Knowledge |
Repräsentiert das Modell, das für eine Knowledge Base-LLM-Aktivität verwendet wird, einschließlich des Modellnamens und der Bereitstellungskennung. |
|
Knowledge |
Die Art der Aktivitätsaufzeichnung. |
|
Knowledge |
Stellt einen Aktivitätsdatensatz für agentisches Denken dar. |
|
Knowledge |
Stellt die Argumente dar, mit denen die Azure Blob-Abrufaktivität ausgeführt wurde. |
|
Knowledge |
Stellt einen Azure-Blob-Abrufaktivitätsdatensatz dar. |
|
Knowledge |
Stellt eine Azure Blob Storage-Dokumentreferenz dar. |
|
Knowledge |
Zusätzliche Informationen zum Fehler bei der Ressourcenverwaltung. |
|
Knowledge |
Die Fehlerdetails. |
|
Knowledge |
Repräsentiert die Argumente, mit denen die Fabric Data Agent-Abrufaktivität ausgeführt wurde. |
|
Knowledge |
Repräsentiert einen Fabric Data Agent-Abrufaktivitätseintrag. |
|
Knowledge |
Repräsentiert eine Dokumentreferenz des Fabric Data Agent. |
|
Knowledge |
Repräsentiert die Argumente, mit denen die Fabric Ontology Retrieval-Aktivität durchgeführt wurde. |
|
Knowledge |
Stellt einen Fabric-Ontology-Abrufaktivitätsdatensatz dar. |
|
Knowledge |
Stellt eine Fabric Ontology Dokumentreferenz dar. |
|
Knowledge |
Repräsentiert die Argumente, mit denen die Dateiabrufaktivität ausgeführt wurde. |
|
Knowledge |
Stellt einen Datensatz für die Dateiabrufaktivität dar. |
|
Knowledge |
Stellt eine Dateidokumentreferenz dar. |
|
Knowledge |
Bildinhalt. |
|
Knowledge |
Repräsentiert die Argumente, mit denen die indexierte OneLake-Abrufaktivität ausgeführt wurde. |
|
Knowledge |
Stellt einen indexierten OneLake-Abrufaktivitätsrekord dar. |
|
Knowledge |
Stellt eine indexierte OneLake-Dokumentreferenz dar. |
|
Knowledge |
Repräsentiert die Argumente, mit denen die indexierte SharePoint-Abrufaktivität ausgeführt wurde. |
|
Knowledge |
Stellt einen indexierten SharePoint-Abrufaktivitätseintrag dar. |
|
Knowledge |
Stellt eine indexierte SharePoint-Dokumentreferenz dar. |
|
Knowledge |
Repräsentiert die Argumente, mit denen die indexierte SQL-Abrufaktivität ausgeführt wurde. |
|
Knowledge |
Stellt einen indexierten SQL-Abrufaktivitätseintrag dar. |
|
Knowledge |
Stellt eine Azure SQL-Dokumentreferenz dar. |
|
Knowledge |
Repräsentiert die Argumente, mit denen die MCP-Serverabrufaktivität ausgeführt wurde. |
|
Knowledge |
Repräsentiert einen MCP-Server-Abrufaktivitätseintrag. |
|
Knowledge |
Stellt eine MCP-Server-Dokumentreferenz dar. |
|
Knowledge |
Das Nachrichtenstilobjekt in natürlicher Sprache. |
|
Knowledge |
Die Art des Nachrichteninhalts. |
|
Knowledge |
Typ der Bildnachricht. |
|
Knowledge |
Art der Textnachricht. |
|
Knowledge |
Stellt einen Aktivitätsdatensatz für die LLM-Antwortsynthese dar. |
|
Knowledge |
Stellt einen Datensatz für die LLM-Abfrageplanungsaktivität dar. |
|
Knowledge |
Repräsentiert einen LLM-Webzusammenfassungsaktivitätseintrag. |
|
Knowledge |
Details zu den Ausdrücken, die aus Abfragehinweisen für eine Abrufaktivität generiert werden. |
|
Knowledge |
Der Typ des Bezugs. |
|
Knowledge |
Repräsentiert die Argumente, mit denen die entfernte SharePoint-Abrufaktivität ausgeführt wurde. |
|
Knowledge |
Repräsentiert einen Remote-SharePoint-Abrufaktivitätseintrag. |
|
Knowledge |
Stellt eine entfernte SharePoint-Dokumentreferenz dar. |
|
Knowledge |
Der Eingabevertrag für den Abrufauftrag. |
|
Knowledge |
Der Ausgabevertrag für die Abrufantwort. |
|
Knowledge |
Stellt die Argumente dar, mit denen die Aktivität zum Abrufen des Suchindex ausgeführt wurde. |
|
Knowledge |
Stellt einen Aktivitätsdatensatz für den Suchindexabruf dar. |
|
Knowledge |
Stellt eine Azure Search-Dokumentreferenz dar. |
|
Knowledge |
Repräsentiert die Argumente, mit denen die Webabrufaktivität ausgeführt wurde. |
|
Knowledge |
Stellt einen Datensatz für Webabrufaktivitäten dar. |
|
Knowledge |
Stellt einen Verweis auf ein Webdokument dar. |
|
Knowledge |
Repräsentiert die Argumente, mit denen die WorkIQ-Abrufaktivität ausgeführt wurde. |
|
Knowledge |
Stellt einen WorkIQ-Abrufaktivitätsrekord dar. |
|
Knowledge |
Stellt eine WorkIQ-Dokumentreferenz dar. |
|
Knowledge |
Wählen Sie automatisch den Schlussaufwand während des Abrufs aus. Der Service setzt jede Anfrage auf die günstigste Stufe und eskaliert nur so weit, wie nötig, bis zur maximal verfügbaren Stufe des Services. |
|
Knowledge |
Die Art von Wissensdatenbank-Konfiguration, die man verwenden sollte. |
|
Knowledge |
Führen Sie das Abrufen von Wissen mit geringem Argumentationsaufwand durch. |
|
Knowledge |
Führen Sie den Wissensabruf mit mittlerem Argumentationsaufwand durch. |
|
Knowledge |
Führen Sie den Wissensabruf mit minimalem Argumentationsaufwand durch. |
|
Knowledge |
Die Ausgabekonfiguration für diesen Abruf. |
|
Knowledge |
Der Aufwand, der beim Abrufen verwendet werden soll. |
|
Knowledge |
Eine semantische Abfrageabsicht. |
|
Knowledge |
Die Art der Wissensquelle. |
|
Knowledge |
Kontrolliert, ob die Ergebnisse einer Wissensquelle neu bewertet werden. |
|
Mcp |
Spezifiziert Laufzeitparameter für eine MCP-Server-Wissensquelle |
|
Purview |
Informationen über das auf ein Dokument angewandte Sensitivitätsetikett |
|
Query |
Gibt die Syntax der Suchabfrage an. Der Standardwert ist "einfach". Verwenden Sie 'full', wenn Ihre Abfrage die Lucene-Abfragesyntax verwendet, und 'semantic', wenn die Abfragesyntax nicht benötigt wird. |
|
Remote |
Gibt Laufzeitparameter für eine SharePoint-Remotewissensquelle an. |
|
Search |
Feldreferenz für einen Suchindex. |
|
Search |
Die Art von Boost-Hinweis für eine Suchindex-Informationsquelle. |
|
Search |
Ein Hinweis, der Dokumente basierend auf einem Feldwert verbessert. |
|
Search |
Ein Hinweis, der ein Feld und repräsentative Werte identifiziert, die der Abfrageplaner beim Erstellen eines Filters verwenden kann. |
|
Search |
Ein Hinweis, der Dokumente basierend auf einem mehrsprachigen Ausdruck verbessert. |
|
Search |
Gibt Laufzeitparameter für eine Wissensquelle für Suchindex an |
|
Search |
Hinweise, die die Abfrageplanung zu nützlichen Filtern und Verbesserungen für eine Suchindex-Wissensquelle führen. |
|
Served |
Beschreibt ein einzelnes Bild, das das Modell während einer Abrufaktivität ausgewählt hat. |
|
Web |
Gibt Laufzeitparameter für eine Webwissensquelle an |
|
Work |
Spezifiziert Laufzeitparameter für eine WorkIQ-Wissensquelle |
Accept
Die Überschrift "Annehmen".
| Wert | Beschreibung |
|---|---|
| application/json;odata.metadata=minimal |
AzureBlobKnowledgeSourceParams
Gibt Laufzeitparameter für eine Azure Blob-Wissensquelle an
| Name | Typ | Beschreibung |
|---|---|---|
| alwaysQuerySource |
boolean |
Gibt an, dass diese Wissensquelle die Quellenauswahl umgehen und immer zum Zeitpunkt des Abrufs abgefragt werden soll. |
| enableImageServing |
boolean |
Gibt an, ob die Bildbereitstellung für diese Wissensquelle zum Abruf aktiviert werden sollte. Wenn sie zutreffen, werden während der Aufnahme extrahierte Bilder an nachgelagerte Modelle geliefert. |
| failOnError |
boolean |
Zeigt an, dass die gesamte Abrufanfrage fehlschlagen sollte, wenn die Abruf aus dieser Wissensquelle auf einen Fehler stößt. Der Standardwert ist „false“. |
| includeReferenceSourceData |
boolean |
Gibt an, ob Verweise die strukturierten Daten, die während des Abrufs abgerufen wurden, in ihre Nutzlast aufnehmen sollen. |
| includeReferences |
boolean |
Gibt an, ob Verweise für Daten enthalten sein sollen, die aus dieser Quelle abgerufen werden. |
| kind |
string:
azure |
Der Typ der Wissensquelle. |
| knowledgeSourceName |
string |
Der Name des Indexes, auf den die Parameter angewendet werden. |
| maxOutputDocuments |
integer (int32) |
Begrenzt die maximale Anzahl der aus dieser Wissensquelle zurückgegebenen Dokumente. |
| neverQuerySource |
boolean |
Gibt an, dass diese Wissensquelle aus dem Kandidatenset der Anfrage ausgeschlossen und beim Abruf niemals abgefragt werden sollte. Der Ausschluss ist request-lokal und ändert die Mitgliedschaft in der Wissensdatenbank nicht. Kann nicht mit alwaysQuerySource auf derselben Wissensquelle kombiniert werden. |
| queryHintOverrides |
Tipps, die die Abfrageplanung zu nützlichen Filtern und Boosts führen. Falls angegeben, ersetzt dieses Objekt die vollständige Menge an Abfragehinweisen, die auf der Wissensquelle konfiguriert sind. |
|
| rerankerThreshold |
number (float) |
Der Reranker-Schwellenwert, den alle abgerufenen Dokumente erfüllen müssen, um in die Antwort aufgenommen zu werden. |
| resultsProcessing |
Überschreibt die gespeicherten Ergebnisse der Wissensquelle. Bearbeitung nur für diesen Abruf. Wenn dieser weggelassen wird, gilt der Wert der gespeicherten Wissensquelle. |
ErrorAdditionalInfo
Zusätzliche Informationen zum Fehler bei der Ressourcenverwaltung.
| Name | Typ | Beschreibung |
|---|---|---|
| info |
Zusätzliche Informationen. |
|
| type |
string |
Typ der Zusatzinformationen. |
ErrorDetail
Die Fehlerdetails.
| Name | Typ | Beschreibung |
|---|---|---|
| additionalInfo |
Die Zusatzinformationen zum Fehler. |
|
| code |
string |
Der Fehlercode. |
| details |
Die Fehlerdetails. |
|
| message |
string |
Die Fehlermeldung. |
| target |
string |
Der Fehlerzielwert. |
ErrorResponse
Häufige Fehlerantwort für alle Azure Resource Manager-APIs, um Fehlerdetails für fehlgeschlagene Vorgänge zurückzugeben. (Dies folgt auch dem OData-Fehlerantwortformat.)
| Name | Typ | Beschreibung |
|---|---|---|
| error |
Das Fehlerobjekt. |
FabricDataAgentKnowledgeSourceParams
Spezifiziert Laufzeitparameter für eine Fabric Data Agent-Wissensquelle
| Name | Typ | Beschreibung |
|---|---|---|
| alwaysQuerySource |
boolean |
Gibt an, dass diese Wissensquelle die Quellenauswahl umgehen und immer zum Zeitpunkt des Abrufs abgefragt werden soll. |
| enableImageServing |
boolean |
Gibt an, ob die Bildbereitstellung für diese Wissensquelle zum Abruf aktiviert werden sollte. Wenn sie zutreffen, werden während der Aufnahme extrahierte Bilder an nachgelagerte Modelle geliefert. |
| failOnError |
boolean |
Zeigt an, dass die gesamte Abrufanfrage fehlschlagen sollte, wenn die Abruf aus dieser Wissensquelle auf einen Fehler stößt. Der Standardwert ist „false“. |
| includeReferenceSourceData |
boolean |
Gibt an, ob Verweise die strukturierten Daten, die während des Abrufs abgerufen wurden, in ihre Nutzlast aufnehmen sollen. |
| includeReferences |
boolean |
Gibt an, ob Verweise für Daten enthalten sein sollen, die aus dieser Quelle abgerufen werden. |
| kind |
string:
fabric |
Der Typ der Wissensquelle. |
| knowledgeSourceName |
string |
Der Name des Indexes, auf den die Parameter angewendet werden. |
| maxOutputDocuments |
integer (int32) |
Begrenzt die maximale Anzahl der aus dieser Wissensquelle zurückgegebenen Dokumente. |
| neverQuerySource |
boolean |
Gibt an, dass diese Wissensquelle aus dem Kandidatenset der Anfrage ausgeschlossen und beim Abruf niemals abgefragt werden sollte. Der Ausschluss ist request-lokal und ändert die Mitgliedschaft in der Wissensdatenbank nicht. Kann nicht mit alwaysQuerySource auf derselben Wissensquelle kombiniert werden. |
| rerankerThreshold |
number (float) |
Der Reranker-Schwellenwert, den alle abgerufenen Dokumente erfüllen müssen, um in die Antwort aufgenommen zu werden. |
| resultsProcessing |
Überschreibt die gespeicherten Ergebnisse der Wissensquelle. Bearbeitung nur für diesen Abruf. Wenn dieser weggelassen wird, gilt der Wert der gespeicherten Wissensquelle. |
FabricOntologyKnowledgeSourceParams
Spezifiziert Laufzeitparameter für eine Fabric-Ontologie-Wissensquelle
| Name | Typ | Beschreibung |
|---|---|---|
| alwaysQuerySource |
boolean |
Gibt an, dass diese Wissensquelle die Quellenauswahl umgehen und immer zum Zeitpunkt des Abrufs abgefragt werden soll. |
| enableImageServing |
boolean |
Gibt an, ob die Bildbereitstellung für diese Wissensquelle zum Abruf aktiviert werden sollte. Wenn sie zutreffen, werden während der Aufnahme extrahierte Bilder an nachgelagerte Modelle geliefert. |
| failOnError |
boolean |
Zeigt an, dass die gesamte Abrufanfrage fehlschlagen sollte, wenn die Abruf aus dieser Wissensquelle auf einen Fehler stößt. Der Standardwert ist „false“. |
| includeReferenceSourceData |
boolean |
Gibt an, ob Verweise die strukturierten Daten, die während des Abrufs abgerufen wurden, in ihre Nutzlast aufnehmen sollen. |
| includeReferences |
boolean |
Gibt an, ob Verweise für Daten enthalten sein sollen, die aus dieser Quelle abgerufen werden. |
| kind |
string:
fabric |
Der Typ der Wissensquelle. |
| knowledgeSourceName |
string |
Der Name des Indexes, auf den die Parameter angewendet werden. |
| maxOutputDocuments |
integer (int32) |
Begrenzt die maximale Anzahl der aus dieser Wissensquelle zurückgegebenen Dokumente. |
| neverQuerySource |
boolean |
Gibt an, dass diese Wissensquelle aus dem Kandidatenset der Anfrage ausgeschlossen und beim Abruf niemals abgefragt werden sollte. Der Ausschluss ist request-lokal und ändert die Mitgliedschaft in der Wissensdatenbank nicht. Kann nicht mit alwaysQuerySource auf derselben Wissensquelle kombiniert werden. |
| rerankerThreshold |
number (float) |
Der Reranker-Schwellenwert, den alle abgerufenen Dokumente erfüllen müssen, um in die Antwort aufgenommen zu werden. |
| resultsProcessing |
Überschreibt die gespeicherten Ergebnisse der Wissensquelle. Bearbeitung nur für diesen Abruf. Wenn dieser weggelassen wird, gilt der Wert der gespeicherten Wissensquelle. |
FileKnowledgeSourceParams
Spezifiziert Laufzeitparameter für eine Datei-Wissensquelle
| Name | Typ | Beschreibung |
|---|---|---|
| alwaysQuerySource |
boolean |
Gibt an, dass diese Wissensquelle die Quellenauswahl umgehen und immer zum Zeitpunkt des Abrufs abgefragt werden soll. |
| enableImageServing |
boolean |
Gibt an, ob die Bildbereitstellung für diese Wissensquelle zum Abruf aktiviert werden sollte. Wenn sie zutreffen, werden während der Aufnahme extrahierte Bilder an nachgelagerte Modelle geliefert. |
| failOnError |
boolean |
Zeigt an, dass die gesamte Abrufanfrage fehlschlagen sollte, wenn die Abruf aus dieser Wissensquelle auf einen Fehler stößt. Der Standardwert ist „false“. |
| includeReferenceSourceData |
boolean |
Gibt an, ob Verweise die strukturierten Daten, die während des Abrufs abgerufen wurden, in ihre Nutzlast aufnehmen sollen. |
| includeReferences |
boolean |
Gibt an, ob Verweise für Daten enthalten sein sollen, die aus dieser Quelle abgerufen werden. |
| kind |
string:
file |
Der Typ der Wissensquelle. |
| knowledgeSourceName |
string |
Der Name des Indexes, auf den die Parameter angewendet werden. |
| maxOutputDocuments |
integer (int32) |
Begrenzt die maximale Anzahl der aus dieser Wissensquelle zurückgegebenen Dokumente. |
| neverQuerySource |
boolean |
Gibt an, dass diese Wissensquelle aus dem Kandidatenset der Anfrage ausgeschlossen und beim Abruf niemals abgefragt werden sollte. Der Ausschluss ist request-lokal und ändert die Mitgliedschaft in der Wissensdatenbank nicht. Kann nicht mit alwaysQuerySource auf derselben Wissensquelle kombiniert werden. |
| queryHintOverrides |
Tipps, die die Abfrageplanung zu nützlichen Filtern und Boosts führen. Falls angegeben, ersetzt dieses Objekt die vollständige Menge an Abfragehinweisen, die auf der Wissensquelle konfiguriert sind. |
|
| rerankerThreshold |
number (float) |
Der Reranker-Schwellenwert, den alle abgerufenen Dokumente erfüllen müssen, um in die Antwort aufgenommen zu werden. |
| resultsProcessing |
Überschreibt die gespeicherten Ergebnisse der Wissensquelle. Bearbeitung nur für diesen Abruf. Wenn dieser weggelassen wird, gilt der Wert der gespeicherten Wissensquelle. |
ImageServingStatistics
Statistiken zum Bildservieren während einer Abrufaktivität.
| Name | Typ | Beschreibung |
|---|---|---|
| imagesRetrieved |
integer (int32) |
Die Anzahl der aus dem Asset-Store abgerufenen Bilder. |
| imagesSentToModel |
integer (int32) |
Die Anzahl der Bilder, die an das nachgelagerte Modell gesendet werden. |
| servedImages |
Die Menge an Bildern, die das Modell ausgewählt hat, um dem nachgelagerten Modell für diese Abrufaktivität zugeteilt zu werden. |
|
| totalImageSizeBytes |
integer (int64) |
Die Gesamtgröße in Bytes von Bildern, die an das Modell gesendet werden. |
| verbalizationUsed |
boolean |
Gibt an, ob Bildverbalisierung statt direkter Bildserverstellung verwendet wurde. |
IndexedOneLakeKnowledgeSourceParams
Gibt Laufzeitparameter für eine indizierte OneLake-Wissensquelle an.
| Name | Typ | Beschreibung |
|---|---|---|
| alwaysQuerySource |
boolean |
Gibt an, dass diese Wissensquelle die Quellenauswahl umgehen und immer zum Zeitpunkt des Abrufs abgefragt werden soll. |
| enableImageServing |
boolean |
Gibt an, ob die Bildbereitstellung für diese Wissensquelle zum Abruf aktiviert werden sollte. Wenn sie zutreffen, werden während der Aufnahme extrahierte Bilder an nachgelagerte Modelle geliefert. |
| failOnError |
boolean |
Zeigt an, dass die gesamte Abrufanfrage fehlschlagen sollte, wenn die Abruf aus dieser Wissensquelle auf einen Fehler stößt. Der Standardwert ist „false“. |
| includeReferenceSourceData |
boolean |
Gibt an, ob Verweise die strukturierten Daten, die während des Abrufs abgerufen wurden, in ihre Nutzlast aufnehmen sollen. |
| includeReferences |
boolean |
Gibt an, ob Verweise für Daten enthalten sein sollen, die aus dieser Quelle abgerufen werden. |
| kind |
string:
indexed |
Der Typ der Wissensquelle. |
| knowledgeSourceName |
string |
Der Name des Indexes, auf den die Parameter angewendet werden. |
| maxOutputDocuments |
integer (int32) |
Begrenzt die maximale Anzahl der aus dieser Wissensquelle zurückgegebenen Dokumente. |
| neverQuerySource |
boolean |
Gibt an, dass diese Wissensquelle aus dem Kandidatenset der Anfrage ausgeschlossen und beim Abruf niemals abgefragt werden sollte. Der Ausschluss ist request-lokal und ändert die Mitgliedschaft in der Wissensdatenbank nicht. Kann nicht mit alwaysQuerySource auf derselben Wissensquelle kombiniert werden. |
| queryHintOverrides |
Tipps, die die Abfrageplanung zu nützlichen Filtern und Boosts führen. Falls angegeben, ersetzt dieses Objekt die vollständige Menge an Abfragehinweisen, die auf der Wissensquelle konfiguriert sind. |
|
| rerankerThreshold |
number (float) |
Der Reranker-Schwellenwert, den alle abgerufenen Dokumente erfüllen müssen, um in die Antwort aufgenommen zu werden. |
| resultsProcessing |
Überschreibt die gespeicherten Ergebnisse der Wissensquelle. Bearbeitung nur für diesen Abruf. Wenn dieser weggelassen wird, gilt der Wert der gespeicherten Wissensquelle. |
IndexedSharePointKnowledgeSourceParams
Gibt Laufzeitparameter für eine indizierte SharePoint-Wissensquelle an.
| Name | Typ | Beschreibung |
|---|---|---|
| alwaysQuerySource |
boolean |
Gibt an, dass diese Wissensquelle die Quellenauswahl umgehen und immer zum Zeitpunkt des Abrufs abgefragt werden soll. |
| enableImageServing |
boolean |
Gibt an, ob die Bildbereitstellung für diese Wissensquelle zum Abruf aktiviert werden sollte. Wenn sie zutreffen, werden während der Aufnahme extrahierte Bilder an nachgelagerte Modelle geliefert. |
| failOnError |
boolean |
Zeigt an, dass die gesamte Abrufanfrage fehlschlagen sollte, wenn die Abruf aus dieser Wissensquelle auf einen Fehler stößt. Der Standardwert ist „false“. |
| includeReferenceSourceData |
boolean |
Gibt an, ob Verweise die strukturierten Daten, die während des Abrufs abgerufen wurden, in ihre Nutzlast aufnehmen sollen. |
| includeReferences |
boolean |
Gibt an, ob Verweise für Daten enthalten sein sollen, die aus dieser Quelle abgerufen werden. |
| kind |
string:
indexed |
Der Typ der Wissensquelle. |
| knowledgeSourceName |
string |
Der Name des Indexes, auf den die Parameter angewendet werden. |
| maxOutputDocuments |
integer (int32) |
Begrenzt die maximale Anzahl der aus dieser Wissensquelle zurückgegebenen Dokumente. |
| neverQuerySource |
boolean |
Gibt an, dass diese Wissensquelle aus dem Kandidatenset der Anfrage ausgeschlossen und beim Abruf niemals abgefragt werden sollte. Der Ausschluss ist request-lokal und ändert die Mitgliedschaft in der Wissensdatenbank nicht. Kann nicht mit alwaysQuerySource auf derselben Wissensquelle kombiniert werden. |
| queryHintOverrides |
Tipps, die die Abfrageplanung zu nützlichen Filtern und Boosts führen. Falls angegeben, ersetzt dieses Objekt die vollständige Menge an Abfragehinweisen, die auf der Wissensquelle konfiguriert sind. |
|
| rerankerThreshold |
number (float) |
Der Reranker-Schwellenwert, den alle abgerufenen Dokumente erfüllen müssen, um in die Antwort aufgenommen zu werden. |
| resultsProcessing |
Überschreibt die gespeicherten Ergebnisse der Wissensquelle. Bearbeitung nur für diesen Abruf. Wenn dieser weggelassen wird, gilt der Wert der gespeicherten Wissensquelle. |
IndexedSqlKnowledgeSourceParams
Spezifiziert Laufzeitparameter für eine indexierte SQL-Wissensquelle
| Name | Typ | Beschreibung |
|---|---|---|
| alwaysQuerySource |
boolean |
Gibt an, dass diese Wissensquelle die Quellenauswahl umgehen und immer zum Zeitpunkt des Abrufs abgefragt werden soll. |
| enableImageServing |
boolean |
Gibt an, ob die Bildbereitstellung für diese Wissensquelle zum Abruf aktiviert werden sollte. Wenn sie zutreffen, werden während der Aufnahme extrahierte Bilder an nachgelagerte Modelle geliefert. |
| failOnError |
boolean |
Zeigt an, dass die gesamte Abrufanfrage fehlschlagen sollte, wenn die Abruf aus dieser Wissensquelle auf einen Fehler stößt. Der Standardwert ist „false“. |
| includeReferenceSourceData |
boolean |
Gibt an, ob Verweise die strukturierten Daten, die während des Abrufs abgerufen wurden, in ihre Nutzlast aufnehmen sollen. |
| includeReferences |
boolean |
Gibt an, ob Verweise für Daten enthalten sein sollen, die aus dieser Quelle abgerufen werden. |
| kind |
string:
indexed |
Der Typ der Wissensquelle. |
| knowledgeSourceName |
string |
Der Name des Indexes, auf den die Parameter angewendet werden. |
| maxOutputDocuments |
integer (int32) |
Begrenzt die maximale Anzahl der aus dieser Wissensquelle zurückgegebenen Dokumente. |
| neverQuerySource |
boolean |
Gibt an, dass diese Wissensquelle aus dem Kandidatenset der Anfrage ausgeschlossen und beim Abruf niemals abgefragt werden sollte. Der Ausschluss ist request-lokal und ändert die Mitgliedschaft in der Wissensdatenbank nicht. Kann nicht mit alwaysQuerySource auf derselben Wissensquelle kombiniert werden. |
| queryHintOverrides |
Tipps, die die Abfrageplanung zu nützlichen Filtern und Boosts führen. Falls angegeben, ersetzt dieses Objekt die vollständige Menge an Abfragehinweisen, die auf der Wissensquelle konfiguriert sind. |
|
| rerankerThreshold |
number (float) |
Der Reranker-Schwellenwert, den alle abgerufenen Dokumente erfüllen müssen, um in die Antwort aufgenommen zu werden. |
| resultsProcessing |
Überschreibt die gespeicherten Ergebnisse der Wissensquelle. Bearbeitung nur für diesen Abruf. Wenn dieser weggelassen wird, gilt der Wert der gespeicherten Wissensquelle. |
KnowledgeBaseActivityRecordModel
Repräsentiert das Modell, das für eine Knowledge Base-LLM-Aktivität verwendet wird, einschließlich des Modellnamens und der Bereitstellungskennung.
| Name | Typ | Beschreibung |
|---|---|---|
| deploymentId |
string |
Die Bereitstellungskennung des für die Aktivität verwendeten Modells. |
| modelName |
string |
Der Name des Modells, das für die Aktivität verwendet wurde. |
KnowledgeBaseActivityRecordType
Die Art der Aktivitätsaufzeichnung.
| Wert | Beschreibung |
|---|---|
| searchIndex |
Suche nach Index-Abrufaktivität. |
| azureBlob |
Azure Blob Retrieval Activity. |
| indexedSharePoint |
Indexierte SharePoint-Abrufaktivität. |
| indexedOneLake |
Indexierte OneLake-Rückholaktivität. |
| web |
Web-Abruf-Aktivität. |
| remoteSharePoint |
Remote-SharePoint-Abrufaktivität. |
| workIQ |
WorkIQ-Abrufaktivität. |
| fabricDataAgent |
Fabric Data Agent-Abrufaktivität. |
| fabricOntology |
Fabric Ontology Retrieval-Aktivität. |
| mcpServer |
MCP-Serverabrufaktivität. |
| file |
Dateiabruf-Aktivität. |
| indexedSql |
Indexierte SQL-Abrufaktivität. |
| modelQueryPlanning |
LLM-Abfrageplanungsaktivität. |
| modelAnswerSynthesis |
LLM-Antwort-Synthese-Aktivität. |
| modelWebSummarization |
LLM-Webzusammenfassungsaktivität. |
| agenticReasoning |
Agentisches Denken. |
KnowledgeBaseAgenticReasoningActivityRecord
Stellt einen Aktivitätsdatensatz für agentisches Denken dar.
| Name | Typ | Beschreibung |
|---|---|---|
| completedAt |
string (date-time) |
Die Zeit, zu der die Aktivität abgeschlossen wurde. |
| elapsedMs |
integer (int32) |
Die verstrichene Zeit in Millisekunden für die Abrufaktivität. |
| error |
Das Fehler-Detail, das erklärt, warum die Operation fehlgeschlagen ist. Diese Eigenschaft ist nur dann enthalten, wenn die Aktivität nicht erfolgreich ist. |
|
| id |
integer (int32) |
Die ID des Aktivitätsdatensatzes. |
| logicalReasoningEffort | KnowledgeRetrievalReasoningEffort: |
Der logische Schlussgrundversuch, den der Kunde verlangt. Dies unterscheidet sich von |
| reasoningTokens |
integer (int32) |
Die Anzahl der Eingabetoken für agentisches Denken. |
| retrievalReasoningEffort | KnowledgeRetrievalReasoningEffort: |
Die Konfiguration des Wiederholungs-Denkens. |
| startedAt |
string (date-time) |
Die Zeit, zu der die Aktivität begann. |
| type |
string:
agentic |
Der Typ des Aktivitätsdatensatzes. |
| warning |
string |
Eine Warnmeldung, die potenzielle Konfigurationsprobleme aufzeigt, die während der Aktivität beobachtet wurden, wie Dokumente, die durch Score-Thresholding, Token-Limit-Kürzung oder Timeout-Bedingungen verloren gehen. |
KnowledgeBaseAzureBlobActivityArguments
Stellt die Argumente dar, mit denen die Azure Blob-Abrufaktivität ausgeführt wurde.
| Name | Typ | Beschreibung |
|---|---|---|
| search |
string |
Die Suchzeichenfolge, die zum Abfragen von Blobinhalten verwendet wird. |
KnowledgeBaseAzureBlobActivityRecord
Stellt einen Azure-Blob-Abrufaktivitätsdatensatz dar.
| Name | Typ | Beschreibung |
|---|---|---|
| azureBlobArguments |
Das azure-Blob argumentiert für die Abrufaktivität. |
|
| completedAt |
string (date-time) |
Die Zeit, zu der die Aktivität abgeschlossen wurde. |
| count |
integer (int32) |
Die Anzahl der abgerufenen Dokumente, die ausreichend relevant waren, um den Reranker-Schwellenwert zu überschreiten. |
| elapsedMs |
integer (int32) |
Die verstrichene Zeit in Millisekunden für die Abrufaktivität. |
| error |
Das Fehler-Detail, das erklärt, warum die Operation fehlgeschlagen ist. Diese Eigenschaft ist nur dann enthalten, wenn die Aktivität nicht erfolgreich ist. |
|
| id |
integer (int32) |
Die ID des Aktivitätsdatensatzes. |
| imageServing |
Statistiken zum Bilddienst für diese Abrufaktivität |
|
| knowledgeSourceName |
string |
Die Wissensquelle für die Abrufaktivität. |
| queryHintProcessing |
Details zu den Ausdrücken, die aus Anfragehinweisen für diese Aktivität generiert werden. |
|
| queryTime |
string (date-time) |
Die Abfragezeit für diese Abrufaktivität. |
| startedAt |
string (date-time) |
Die Zeit, zu der die Aktivität begann. |
| type |
string:
azure |
Der Typ des Aktivitätsdatensatzes. |
| warning |
string |
Eine Warnmeldung, die potenzielle Konfigurationsprobleme aufzeigt, die während der Aktivität beobachtet wurden, wie Dokumente, die durch Score-Thresholding, Token-Limit-Kürzung oder Timeout-Bedingungen verloren gehen. |
KnowledgeBaseAzureBlobReference
Stellt eine Azure Blob Storage-Dokumentreferenz dar.
| Name | Typ | Beschreibung |
|---|---|---|
| activitySource |
integer (int32) |
Die Quellaktivitäts-ID für die Referenz. |
| blobUrl |
string |
Die Blob-URL für die Referenz. |
| citationUrl |
string (uri) |
Eine Search-eigene URL, die auf das Backing-Dokument für diese Referenz verweist und als Zitationsziel verwendet werden kann. |
| id |
string |
Die ID der Referenz. |
| rerankerScore |
number (float) |
Die Reranker-Bewertung für die Dokumentreferenz. |
| searchSensitivityLabelInfo |
Die Informationen zum Sensitivitätsetikett für die Referenz. |
|
| sourceData |
Die Quelldaten für die Referenz. |
|
| type |
string:
azure |
Der Typ der Referenz. |
KnowledgeBaseErrorAdditionalInfo
Zusätzliche Informationen zum Fehler bei der Ressourcenverwaltung.
| Name | Typ | Beschreibung |
|---|---|---|
| info |
Zusätzliche Informationen. |
|
| type |
string |
Typ der Zusatzinformationen. |
KnowledgeBaseErrorDetail
Die Fehlerdetails.
| Name | Typ | Beschreibung |
|---|---|---|
| additionalInfo |
Die Zusatzinformationen zum Fehler. |
|
| code |
string |
Der Fehlercode. |
| details |
Die Fehlerdetails. |
|
| message |
string |
Die Fehlermeldung. |
| target |
string |
Der Fehlerzielwert. |
KnowledgeBaseFabricDataAgentActivityArguments
Repräsentiert die Argumente, mit denen die Fabric Data Agent-Abrufaktivität ausgeführt wurde.
| Name | Typ | Beschreibung |
|---|---|---|
| search |
string |
Die Suchkette, die zur Abfrage der Fabric Data Agent-Wissensquelle verwendet wird. |
KnowledgeBaseFabricDataAgentActivityRecord
Repräsentiert einen Fabric Data Agent-Abrufaktivitätseintrag.
| Name | Typ | Beschreibung |
|---|---|---|
| completedAt |
string (date-time) |
Die Zeit, zu der die Aktivität abgeschlossen wurde. |
| count |
integer (int32) |
Die Anzahl der abgerufenen Dokumente, die ausreichend relevant waren, um den Reranker-Schwellenwert zu überschreiten. |
| elapsedMs |
integer (int32) |
Die verstrichene Zeit in Millisekunden für die Abrufaktivität. |
| error |
Das Fehler-Detail, das erklärt, warum die Operation fehlgeschlagen ist. Diese Eigenschaft ist nur dann enthalten, wenn die Aktivität nicht erfolgreich ist. |
|
| fabricDataAgentArguments |
Der Fabric Data Agent argumentiert für die Abrufaktivität. |
|
| id |
integer (int32) |
Die ID des Aktivitätsdatensatzes. |
| imageServing |
Statistiken zum Bilddienst für diese Abrufaktivität |
|
| knowledgeSourceName |
string |
Die Wissensquelle für die Abrufaktivität. |
| queryTime |
string (date-time) |
Die Abfragezeit für diese Abrufaktivität. |
| startedAt |
string (date-time) |
Die Zeit, zu der die Aktivität begann. |
| type |
string:
fabric |
Der Typ des Aktivitätsdatensatzes. |
| warning |
string |
Eine Warnmeldung, die potenzielle Konfigurationsprobleme aufzeigt, die während der Aktivität beobachtet wurden, wie Dokumente, die durch Score-Thresholding, Token-Limit-Kürzung oder Timeout-Bedingungen verloren gehen. |
KnowledgeBaseFabricDataAgentReference
Repräsentiert eine Dokumentreferenz des Fabric Data Agent.
| Name | Typ | Beschreibung |
|---|---|---|
| activitySource |
integer (int32) |
Die Quellaktivitäts-ID für die Referenz. |
| dataAgentId |
string |
Die Fabric Data Agent ID. |
| id |
string |
Die ID der Referenz. |
| rerankerScore |
number (float) |
Die Reranker-Bewertung für die Dokumentreferenz. |
| sourceData |
Die Quelldaten für die Referenz. |
|
| type |
string:
fabric |
Der Typ der Referenz. |
| workspaceId |
string |
Die ID des Fabric-Arbeitsbereichs. |
KnowledgeBaseFabricOntologyActivityArguments
Repräsentiert die Argumente, mit denen die Fabric Ontology Retrieval-Aktivität durchgeführt wurde.
| Name | Typ | Beschreibung |
|---|---|---|
| search |
string |
Der Suchstring, der zur Abfrage der Fabric Ontology Wissensquelle verwendet wird. |
KnowledgeBaseFabricOntologyActivityRecord
Stellt einen Fabric-Ontology-Abrufaktivitätsdatensatz dar.
| Name | Typ | Beschreibung |
|---|---|---|
| completedAt |
string (date-time) |
Die Zeit, zu der die Aktivität abgeschlossen wurde. |
| count |
integer (int32) |
Die Anzahl der abgerufenen Dokumente, die ausreichend relevant waren, um den Reranker-Schwellenwert zu überschreiten. |
| elapsedMs |
integer (int32) |
Die verstrichene Zeit in Millisekunden für die Abrufaktivität. |
| error |
Das Fehler-Detail, das erklärt, warum die Operation fehlgeschlagen ist. Diese Eigenschaft ist nur dann enthalten, wenn die Aktivität nicht erfolgreich ist. |
|
| fabricOntologyArguments |
Die Fabric Ontology-Argumente für die Abrufaktivität. |
|
| id |
integer (int32) |
Die ID des Aktivitätsdatensatzes. |
| imageServing |
Statistiken zum Bilddienst für diese Abrufaktivität |
|
| knowledgeSourceName |
string |
Die Wissensquelle für die Abrufaktivität. |
| queryTime |
string (date-time) |
Die Abfragezeit für diese Abrufaktivität. |
| startedAt |
string (date-time) |
Die Zeit, zu der die Aktivität begann. |
| type |
string:
fabric |
Der Typ des Aktivitätsdatensatzes. |
| warning |
string |
Eine Warnmeldung, die potenzielle Konfigurationsprobleme aufzeigt, die während der Aktivität beobachtet wurden, wie Dokumente, die durch Score-Thresholding, Token-Limit-Kürzung oder Timeout-Bedingungen verloren gehen. |
KnowledgeBaseFabricOntologyReference
Stellt eine Fabric Ontology Dokumentreferenz dar.
| Name | Typ | Beschreibung |
|---|---|---|
| activitySource |
integer (int32) |
Die Quellaktivitäts-ID für die Referenz. |
| id |
string |
Die ID der Referenz. |
| ontologyId |
string |
Die Ontologie-ID im Arbeitsbereich. |
| rerankerScore |
number (float) |
Die Reranker-Bewertung für die Dokumentreferenz. |
| sourceData |
Die Quelldaten für die Referenz. |
|
| type |
string:
fabric |
Der Typ der Referenz. |
| workspaceId |
string |
Die ID des Fabric-Arbeitsbereichs. |
KnowledgeBaseFileActivityArguments
Repräsentiert die Argumente, mit denen die Dateiabrufaktivität ausgeführt wurde.
| Name | Typ | Beschreibung |
|---|---|---|
| search |
string |
Die Suchfolge, die zur Abfrage von Dateiinhalten verwendet wird. |
KnowledgeBaseFileActivityRecord
Stellt einen Datensatz für die Dateiabrufaktivität dar.
| Name | Typ | Beschreibung |
|---|---|---|
| completedAt |
string (date-time) |
Die Zeit, zu der die Aktivität abgeschlossen wurde. |
| count |
integer (int32) |
Die Anzahl der abgerufenen Dokumente, die ausreichend relevant waren, um den Reranker-Schwellenwert zu überschreiten. |
| elapsedMs |
integer (int32) |
Die verstrichene Zeit in Millisekunden für die Abrufaktivität. |
| error |
Das Fehler-Detail, das erklärt, warum die Operation fehlgeschlagen ist. Diese Eigenschaft ist nur dann enthalten, wenn die Aktivität nicht erfolgreich ist. |
|
| fileArguments |
Die Datei-Argumente für die Abrufaktivität. |
|
| id |
integer (int32) |
Die ID des Aktivitätsdatensatzes. |
| imageServing |
Statistiken zum Bilddienst für diese Abrufaktivität |
|
| knowledgeSourceName |
string |
Die Wissensquelle für die Abrufaktivität. |
| queryHintProcessing |
Details zu den Ausdrücken, die aus Anfragehinweisen für diese Aktivität generiert werden. |
|
| queryTime |
string (date-time) |
Die Abfragezeit für diese Abrufaktivität. |
| startedAt |
string (date-time) |
Die Zeit, zu der die Aktivität begann. |
| type |
string:
file |
Der Typ des Aktivitätsdatensatzes. |
| warning |
string |
Eine Warnmeldung, die potenzielle Konfigurationsprobleme aufzeigt, die während der Aktivität beobachtet wurden, wie Dokumente, die durch Score-Thresholding, Token-Limit-Kürzung oder Timeout-Bedingungen verloren gehen. |
KnowledgeBaseFileReference
Stellt eine Dateidokumentreferenz dar.
| Name | Typ | Beschreibung |
|---|---|---|
| activitySource |
integer (int32) |
Die Quellaktivitäts-ID für die Referenz. |
| citationUrl |
string (uri) |
Eine Search-eigene URL, die auf das Backing-Dokument für diese Referenz verweist und als Zitationsziel verwendet werden kann. |
| docName |
string |
Der Dokumentname für die Referenz. |
| id |
string |
Die ID der Referenz. |
| rerankerScore |
number (float) |
Die Reranker-Bewertung für die Dokumentreferenz. |
| sourceData |
Die Quelldaten für die Referenz. |
|
| type |
string:
file |
Der Typ der Referenz. |
KnowledgeBaseImageContent
Bildinhalt.
| Name | Typ | Beschreibung |
|---|---|---|
| url |
string (uri) |
Die URL des Bildes. |
KnowledgeBaseIndexedOneLakeActivityArguments
Repräsentiert die Argumente, mit denen die indexierte OneLake-Abrufaktivität ausgeführt wurde.
| Name | Typ | Beschreibung |
|---|---|---|
| search |
string |
Der Suchstring zur Abfrage von OneLake-Inhalten wurde indexiert. |
KnowledgeBaseIndexedOneLakeActivityRecord
Stellt einen indexierten OneLake-Abrufaktivitätsrekord dar.
| Name | Typ | Beschreibung |
|---|---|---|
| completedAt |
string (date-time) |
Die Zeit, zu der die Aktivität abgeschlossen wurde. |
| count |
integer (int32) |
Die Anzahl der abgerufenen Dokumente, die ausreichend relevant waren, um den Reranker-Schwellenwert zu überschreiten. |
| elapsedMs |
integer (int32) |
Die verstrichene Zeit in Millisekunden für die Abrufaktivität. |
| error |
Das Fehler-Detail, das erklärt, warum die Operation fehlgeschlagen ist. Diese Eigenschaft ist nur dann enthalten, wenn die Aktivität nicht erfolgreich ist. |
|
| id |
integer (int32) |
Die ID des Aktivitätsdatensatzes. |
| imageServing |
Statistiken zum Bilddienst für diese Abrufaktivität |
|
| indexedOneLakeArguments |
Die indexierten OneLake-Argumente für die Abrufaktivität. |
|
| knowledgeSourceName |
string |
Die Wissensquelle für die Abrufaktivität. |
| queryHintProcessing |
Details zu den Ausdrücken, die aus Anfragehinweisen für diese Aktivität generiert werden. |
|
| queryTime |
string (date-time) |
Die Abfragezeit für diese Abrufaktivität. |
| startedAt |
string (date-time) |
Die Zeit, zu der die Aktivität begann. |
| type |
string:
indexed |
Der Typ des Aktivitätsdatensatzes. |
| warning |
string |
Eine Warnmeldung, die potenzielle Konfigurationsprobleme aufzeigt, die während der Aktivität beobachtet wurden, wie Dokumente, die durch Score-Thresholding, Token-Limit-Kürzung oder Timeout-Bedingungen verloren gehen. |
KnowledgeBaseIndexedOneLakeReference
Stellt eine indexierte OneLake-Dokumentreferenz dar.
| Name | Typ | Beschreibung |
|---|---|---|
| activitySource |
integer (int32) |
Die Quellaktivitäts-ID für die Referenz. |
| citationUrl |
string (uri) |
Eine Search-eigene URL, die auf das Backing-Dokument für diese Referenz verweist und als Zitationsziel verwendet werden kann. |
| docUrl |
string |
Die Dokument-URL für die Referenz. |
| id |
string |
Die ID der Referenz. |
| rerankerScore |
number (float) |
Die Reranker-Bewertung für die Dokumentreferenz. |
| searchSensitivityLabelInfo |
Die Informationen zum Sensitivitätsetikett für die Referenz. |
|
| sourceData |
Die Quelldaten für die Referenz. |
|
| type |
string:
indexed |
Der Typ der Referenz. |
KnowledgeBaseIndexedSharePointActivityArguments
Repräsentiert die Argumente, mit denen die indexierte SharePoint-Abrufaktivität ausgeführt wurde.
| Name | Typ | Beschreibung |
|---|---|---|
| search |
string |
Die Suchzeichenkette, die zur Abfrage indexierter SharePoint-Inhalte verwendet wird. |
KnowledgeBaseIndexedSharePointActivityRecord
Stellt einen indexierten SharePoint-Abrufaktivitätseintrag dar.
| Name | Typ | Beschreibung |
|---|---|---|
| completedAt |
string (date-time) |
Die Zeit, zu der die Aktivität abgeschlossen wurde. |
| count |
integer (int32) |
Die Anzahl der abgerufenen Dokumente, die ausreichend relevant waren, um den Reranker-Schwellenwert zu überschreiten. |
| elapsedMs |
integer (int32) |
Die verstrichene Zeit in Millisekunden für die Abrufaktivität. |
| error |
Das Fehler-Detail, das erklärt, warum die Operation fehlgeschlagen ist. Diese Eigenschaft ist nur dann enthalten, wenn die Aktivität nicht erfolgreich ist. |
|
| id |
integer (int32) |
Die ID des Aktivitätsdatensatzes. |
| imageServing |
Statistiken zum Bilddienst für diese Abrufaktivität |
|
| indexedSharePointArguments |
Die indexierten SharePoint-Argumente für die Abrufaktivität. |
|
| knowledgeSourceName |
string |
Die Wissensquelle für die Abrufaktivität. |
| queryHintProcessing |
Details zu den Ausdrücken, die aus Anfragehinweisen für diese Aktivität generiert werden. |
|
| queryTime |
string (date-time) |
Die Abfragezeit für diese Abrufaktivität. |
| startedAt |
string (date-time) |
Die Zeit, zu der die Aktivität begann. |
| type |
string:
indexed |
Der Typ des Aktivitätsdatensatzes. |
| warning |
string |
Eine Warnmeldung, die potenzielle Konfigurationsprobleme aufzeigt, die während der Aktivität beobachtet wurden, wie Dokumente, die durch Score-Thresholding, Token-Limit-Kürzung oder Timeout-Bedingungen verloren gehen. |
KnowledgeBaseIndexedSharePointReference
Stellt eine indexierte SharePoint-Dokumentreferenz dar.
| Name | Typ | Beschreibung |
|---|---|---|
| activitySource |
integer (int32) |
Die Quellaktivitäts-ID für die Referenz. |
| citationUrl |
string (uri) |
Eine Search-eigene URL, die auf das Backing-Dokument für diese Referenz verweist und als Zitationsziel verwendet werden kann. |
| docUrl |
string |
Die Dokument-URL für die Referenz. |
| id |
string |
Die ID der Referenz. |
| rerankerScore |
number (float) |
Die Reranker-Bewertung für die Dokumentreferenz. |
| searchSensitivityLabelInfo |
Die Informationen zum Sensitivitätsetikett für die Referenz. |
|
| sourceData |
Die Quelldaten für die Referenz. |
|
| type |
string:
indexed |
Der Typ der Referenz. |
KnowledgeBaseIndexedSqlActivityArguments
Repräsentiert die Argumente, mit denen die indexierte SQL-Abrufaktivität ausgeführt wurde.
| Name | Typ | Beschreibung |
|---|---|---|
| search |
string |
Die Suchzeichenkette, die zur Abfrage indexierter SQL-Inhalte verwendet wird. |
KnowledgeBaseIndexedSqlActivityRecord
Stellt einen indexierten SQL-Abrufaktivitätseintrag dar.
| Name | Typ | Beschreibung |
|---|---|---|
| completedAt |
string (date-time) |
Die Zeit, zu der die Aktivität abgeschlossen wurde. |
| count |
integer (int32) |
Die Anzahl der abgerufenen Dokumente, die ausreichend relevant waren, um den Reranker-Schwellenwert zu überschreiten. |
| elapsedMs |
integer (int32) |
Die verstrichene Zeit in Millisekunden für die Abrufaktivität. |
| error |
Das Fehler-Detail, das erklärt, warum die Operation fehlgeschlagen ist. Diese Eigenschaft ist nur dann enthalten, wenn die Aktivität nicht erfolgreich ist. |
|
| id |
integer (int32) |
Die ID des Aktivitätsdatensatzes. |
| imageServing |
Statistiken zum Bilddienst für diese Abrufaktivität |
|
| indexedSqlArguments |
Die indizierten SQL-Argumente für die Abrufaktivität. |
|
| knowledgeSourceName |
string |
Die Wissensquelle für die Abrufaktivität. |
| queryHintProcessing |
Details zu den Ausdrücken, die aus Anfragehinweisen für diese Aktivität generiert werden. |
|
| queryTime |
string (date-time) |
Die Abfragezeit für diese Abrufaktivität. |
| startedAt |
string (date-time) |
Die Zeit, zu der die Aktivität begann. |
| type |
string:
indexed |
Der Typ des Aktivitätsdatensatzes. |
| warning |
string |
Eine Warnmeldung, die potenzielle Konfigurationsprobleme aufzeigt, die während der Aktivität beobachtet wurden, wie Dokumente, die durch Score-Thresholding, Token-Limit-Kürzung oder Timeout-Bedingungen verloren gehen. |
KnowledgeBaseIndexedSqlReference
Stellt eine Azure SQL-Dokumentreferenz dar.
| Name | Typ | Beschreibung |
|---|---|---|
| activitySource |
integer (int32) |
Die Quellaktivitäts-ID für die Referenz. |
| citationUrl |
string (uri) |
Eine Search-eigene URL, die auf das Backing-Dokument für diese Referenz verweist und als Zitationsziel verwendet werden kann. |
| docUrl |
string |
Die Dokument-URL für die Referenz. |
| id |
string |
Die ID der Referenz. |
| rerankerScore |
number (float) |
Die Reranker-Bewertung für die Dokumentreferenz. |
| sourceData |
Die Quelldaten für die Referenz. |
|
| type |
string:
indexed |
Der Typ der Referenz. |
KnowledgeBaseMcpServerActivityArguments
Repräsentiert die Argumente, mit denen die MCP-Serverabrufaktivität ausgeführt wurde.
| Name | Typ | Beschreibung |
|---|---|---|
| toolArguments |
Die Argumente wurden an das MCP-Server-Tool weitergeleitet. |
|
| toolName |
string |
Der Name des MCP-Server-Tools, das für die Abrufaktivität verwendet wird. |
KnowledgeBaseMcpServerActivityRecord
Repräsentiert einen MCP-Server-Abrufaktivitätseintrag.
| Name | Typ | Beschreibung |
|---|---|---|
| completedAt |
string (date-time) |
Die Zeit, zu der die Aktivität abgeschlossen wurde. |
| count |
integer (int32) |
Die Anzahl der abgerufenen Dokumente, die ausreichend relevant waren, um den Reranker-Schwellenwert zu überschreiten. |
| elapsedMs |
integer (int32) |
Die verstrichene Zeit in Millisekunden für die Abrufaktivität. |
| error |
Das Fehler-Detail, das erklärt, warum die Operation fehlgeschlagen ist. Diese Eigenschaft ist nur dann enthalten, wenn die Aktivität nicht erfolgreich ist. |
|
| id |
integer (int32) |
Die ID des Aktivitätsdatensatzes. |
| imageServing |
Statistiken zum Bilddienst für diese Abrufaktivität |
|
| knowledgeSourceName |
string |
Die Wissensquelle für die Abrufaktivität. |
| mcpServerArguments |
Der MCP-Server argumentiert für die Abrufaktivität. |
|
| queryTime |
string (date-time) |
Die Abfragezeit für diese Abrufaktivität. |
| startedAt |
string (date-time) |
Die Zeit, zu der die Aktivität begann. |
| type |
string:
mcp |
Der Typ des Aktivitätsdatensatzes. |
| warning |
string |
Eine Warnmeldung, die potenzielle Konfigurationsprobleme aufzeigt, die während der Aktivität beobachtet wurden, wie Dokumente, die durch Score-Thresholding, Token-Limit-Kürzung oder Timeout-Bedingungen verloren gehen. |
KnowledgeBaseMcpServerReference
Stellt eine MCP-Server-Dokumentreferenz dar.
| Name | Typ | Beschreibung |
|---|---|---|
| activitySource |
integer (int32) |
Die Quellaktivitäts-ID für die Referenz. |
| id |
string |
Die ID der Referenz. |
| rerankerScore |
number (float) |
Die Reranker-Bewertung für die Dokumentreferenz. |
| sourceData |
Die Quelldaten für die Referenz. |
|
| title |
string |
Der Titel des MCP-Servertools ist das Ergebnis. |
| toolName |
string |
Der Name des MCP-Server-Tools, das die Referenz erzeugt hat. |
| type |
string:
mcp |
Der Typ der Referenz. |
KnowledgeBaseMessage
Das Nachrichtenstilobjekt in natürlicher Sprache.
| Name | Typ | Beschreibung |
|---|---|---|
| content | KnowledgeBaseMessageContent[]: |
Der Inhalt der Nachricht. |
| role |
string |
Die Rolle der Tool-Reaktion. |
KnowledgeBaseMessageContentType
Die Art des Nachrichteninhalts.
| Wert | Beschreibung |
|---|---|
| text |
Art des Inhalts von Textnachrichten. |
| image |
Art des Inhalts von Bildnachrichten. |
KnowledgeBaseMessageImageContent
Typ der Bildnachricht.
| Name | Typ | Beschreibung |
|---|---|---|
| image |
Der Bildinhalt. |
|
| type |
string:
image |
Der Typ der Nachricht |
KnowledgeBaseMessageTextContent
Art der Textnachricht.
| Name | Typ | Beschreibung |
|---|---|---|
| text |
string |
Der Textinhalt. |
| type |
string:
text |
Der Typ der Nachricht |
KnowledgeBaseModelAnswerSynthesisActivityRecord
Stellt einen Aktivitätsdatensatz für die LLM-Antwortsynthese dar.
| Name | Typ | Beschreibung |
|---|---|---|
| completedAt |
string (date-time) |
Die Zeit, zu der die Aktivität abgeschlossen wurde. |
| elapsedMs |
integer (int32) |
Die verstrichene Zeit in Millisekunden für die Abrufaktivität. |
| error |
Das Fehler-Detail, das erklärt, warum die Operation fehlgeschlagen ist. Diese Eigenschaft ist nur dann enthalten, wenn die Aktivität nicht erfolgreich ist. |
|
| id |
integer (int32) |
Die ID des Aktivitätsdatensatzes. |
| inputTokens |
integer (int32) |
Die Anzahl der Eingabetoken für die LLM-Antwortsyntheseaktivität. |
| model |
Das Modell, das für die LLM-Antwortsynthese-Aktivität verwendet wird. |
|
| outputTokens |
integer (int32) |
Die Anzahl der Ausgabetoken für die LLM-Antwortsyntheseaktivität. |
| startedAt |
string (date-time) |
Die Zeit, zu der die Aktivität begann. |
| type |
string:
model |
Der Typ des Aktivitätsdatensatzes. |
| warning |
string |
Eine Warnmeldung, die potenzielle Konfigurationsprobleme aufzeigt, die während der Aktivität beobachtet wurden, wie Dokumente, die durch Score-Thresholding, Token-Limit-Kürzung oder Timeout-Bedingungen verloren gehen. |
KnowledgeBaseModelQueryPlanningActivityRecord
Stellt einen Datensatz für die LLM-Abfrageplanungsaktivität dar.
| Name | Typ | Beschreibung |
|---|---|---|
| completedAt |
string (date-time) |
Die Zeit, zu der die Aktivität abgeschlossen wurde. |
| elapsedMs |
integer (int32) |
Die verstrichene Zeit in Millisekunden für die Abrufaktivität. |
| error |
Das Fehler-Detail, das erklärt, warum die Operation fehlgeschlagen ist. Diese Eigenschaft ist nur dann enthalten, wenn die Aktivität nicht erfolgreich ist. |
|
| id |
integer (int32) |
Die ID des Aktivitätsdatensatzes. |
| inputTokens |
integer (int32) |
Die Anzahl der Eingabetoken für die LLM-Abfrageplanungsaktivität. |
| model |
Das Modell, das für die LLM-Abfrageplanung verwendet wird. |
|
| outputTokens |
integer (int32) |
Die Anzahl der Ausgabetoken für die LLM-Abfrageplanungsaktivität. |
| startedAt |
string (date-time) |
Die Zeit, zu der die Aktivität begann. |
| type |
string:
model |
Der Typ des Aktivitätsdatensatzes. |
| warning |
string |
Eine Warnmeldung, die potenzielle Konfigurationsprobleme aufzeigt, die während der Aktivität beobachtet wurden, wie Dokumente, die durch Score-Thresholding, Token-Limit-Kürzung oder Timeout-Bedingungen verloren gehen. |
KnowledgeBaseModelWebSummarizationActivityRecord
Repräsentiert einen LLM-Webzusammenfassungsaktivitätseintrag.
| Name | Typ | Beschreibung |
|---|---|---|
| completedAt |
string (date-time) |
Die Zeit, zu der die Aktivität abgeschlossen wurde. |
| elapsedMs |
integer (int32) |
Die verstrichene Zeit in Millisekunden für die Abrufaktivität. |
| error |
Das Fehler-Detail, das erklärt, warum die Operation fehlgeschlagen ist. Diese Eigenschaft ist nur dann enthalten, wenn die Aktivität nicht erfolgreich ist. |
|
| id |
integer (int32) |
Die ID des Aktivitätsdatensatzes. |
| inputTokens |
integer (int32) |
Die Anzahl der Eingabetoken für die LLM-Webzusammenfassungsaktivität. |
| model |
Das Modell, das für die LLM-Webzusammenfassungsaktivität verwendet wird. |
|
| outputTokens |
integer (int32) |
Die Anzahl der Ausgabetoken für die LLM-Webzusammenfassungs-Aktivität. |
| startedAt |
string (date-time) |
Die Zeit, zu der die Aktivität begann. |
| type |
string:
model |
Der Typ des Aktivitätsdatensatzes. |
| warning |
string |
Eine Warnmeldung, die potenzielle Konfigurationsprobleme aufzeigt, die während der Aktivität beobachtet wurden, wie Dokumente, die durch Score-Thresholding, Token-Limit-Kürzung oder Timeout-Bedingungen verloren gehen. |
KnowledgeBaseQueryHintProcessing
Details zu den Ausdrücken, die aus Abfragehinweisen für eine Abrufaktivität generiert werden.
| Name | Typ | Beschreibung |
|---|---|---|
| generatedBoost |
string |
Die Suchklausel generiert aus Boost-Hinweisen für diese Aktivität. |
| generatedFilter |
string |
Der Filterausdruck, der aus Filtern erzeugt wird, gibt Hinweise für diese Aktivität an. |
KnowledgeBaseReferenceType
Der Typ des Bezugs.
| Wert | Beschreibung |
|---|---|
| searchIndex |
Suche nach Dokumentenreferenz im Index. |
| azureBlob |
Azure Blob document reference. |
| indexedSharePoint |
Indexierte SharePoint-Dokumentreferenz. |
| indexedOneLake |
Indexierte OneLake-Dokumentreferenz. |
| web |
Web-Dokumentenreferenz. |
| remoteSharePoint |
Remote-SharePoint-Dokumentreferenz. |
| workIQ |
Arbeits-IQ-Dokumentreferenz. |
| fabricDataAgent |
Fabric Data Agent Dokumentreferenz. |
| fabricOntology |
Fabric Ontology Dokumentreferenz. |
| mcpServer |
MCP-Server-Dokumentenreferenz. |
| file |
Dokumentenreferenz einreichen. |
| indexedSql |
Indexierte SQL-Dokumentreferenz. |
KnowledgeBaseRemoteSharePointActivityArguments
Repräsentiert die Argumente, mit denen die entfernte SharePoint-Abrufaktivität ausgeführt wurde.
| Name | Typ | Beschreibung |
|---|---|---|
| filterExpressionAddOn |
string |
Das Filterexpression-Add-on für die Abrufaktivität. |
| search |
string |
Die Suchzeichenkette, die zur Abfrage der entfernten SharePoint-Wissensquelle verwendet wird. |
KnowledgeBaseRemoteSharePointActivityRecord
Repräsentiert einen Remote-SharePoint-Abrufaktivitätseintrag.
| Name | Typ | Beschreibung |
|---|---|---|
| completedAt |
string (date-time) |
Die Zeit, zu der die Aktivität abgeschlossen wurde. |
| count |
integer (int32) |
Die Anzahl der abgerufenen Dokumente, die ausreichend relevant waren, um den Reranker-Schwellenwert zu überschreiten. |
| elapsedMs |
integer (int32) |
Die verstrichene Zeit in Millisekunden für die Abrufaktivität. |
| error |
Das Fehler-Detail, das erklärt, warum die Operation fehlgeschlagen ist. Diese Eigenschaft ist nur dann enthalten, wenn die Aktivität nicht erfolgreich ist. |
|
| id |
integer (int32) |
Die ID des Aktivitätsdatensatzes. |
| imageServing |
Statistiken zum Bilddienst für diese Abrufaktivität |
|
| knowledgeSourceName |
string |
Die Wissensquelle für die Abrufaktivität. |
| queryTime |
string (date-time) |
Die Abfragezeit für diese Abrufaktivität. |
| remoteSharePointArguments |
Die entfernten SharePoint-Argumente für die Abrufaktivität. |
|
| startedAt |
string (date-time) |
Die Zeit, zu der die Aktivität begann. |
| type |
string:
remote |
Der Typ des Aktivitätsdatensatzes. |
| warning |
string |
Eine Warnmeldung, die potenzielle Konfigurationsprobleme aufzeigt, die während der Aktivität beobachtet wurden, wie Dokumente, die durch Score-Thresholding, Token-Limit-Kürzung oder Timeout-Bedingungen verloren gehen. |
KnowledgeBaseRemoteSharePointReference
Stellt eine entfernte SharePoint-Dokumentreferenz dar.
| Name | Typ | Beschreibung |
|---|---|---|
| activitySource |
integer (int32) |
Die Quellaktivitäts-ID für die Referenz. |
| id |
string |
Die ID der Referenz. |
| rerankerScore |
number (float) |
Die Reranker-Bewertung für die Dokumentreferenz. |
| searchSensitivityLabelInfo |
Die Informationen zum Sensitivitätsetikett für die Referenz. |
|
| sourceData |
Die Quelldaten für die Referenz. |
|
| type |
string:
remote |
Der Typ der Referenz. |
| webUrl |
string (uri) |
Die URL, von der die Referenzdaten stammen. |
KnowledgeBaseRetrievalRequest
Der Eingabevertrag für den Abrufauftrag.
| Name | Typ | Beschreibung |
|---|---|---|
| includeActivity |
boolean |
Gibt an, dass die Abrufergebnisse Aktivitätsinformationen enthalten sollten. |
| intents | KnowledgeRetrievalIntent[]: |
Eine Liste der beabsichtigten Abfragen, die ohne Modellabfrageplanung ausgeführt werden sollen. |
| knowledgeSourceParams |
KnowledgeSourceParams[]:
|
Eine Liste von Laufzeitparametern für die Wissensquellen. |
| maxOutputDocuments |
integer (int32) |
Begrenzt die maximale Anzahl der Dokumente im Output. |
| maxOutputSize |
integer (int32) |
Begrenzt die maximale Größe des Inhalts in der Ausgabe. |
| maxOutputSizeInTokens |
integer (int32) |
Begrenzt die maximale Größe des Inhalts in der Ausgabe. |
| maxRuntimeInSeconds |
integer (int32) |
Die maximale Laufzeit in Sekunden. |
| messages |
Eine Liste von Eingaben im Stil von Chatnachrichten. |
|
| outputMode |
Die Ausgabekonfiguration für diesen Abruf. |
|
| retrievalReasoningEffort | KnowledgeRetrievalReasoningEffort: |
Die Konfiguration des Wiederholungs-Denkens. |
KnowledgeBaseRetrievalResponse
Der Ausgabevertrag für die Abrufantwort.
KnowledgeBaseSearchIndexActivityArguments
Stellt die Argumente dar, mit denen die Aktivität zum Abrufen des Suchindex ausgeführt wurde.
| Name | Typ | Beschreibung |
|---|---|---|
| filter |
string |
Die Filterzeichenfolge. |
| queryType |
Die Abfragesyntax, die zur Ausführung der Suche verwendet wird. Abfragehinweise können dazu führen, dass semantische Abfragen eine vollständige Abfragesyntax verwenden. |
|
| search |
string |
Die Suchzeichenfolge, die zum Abfragen des Suchindex verwendet wird. |
| searchFields |
Gegen welche Felder wurde gesucht. |
|
| semanticConfigurationName |
string |
Welche semantische Konfiguration wurde aus dem Suchindex verwendet? |
| sourceDataFields |
Welche Felder wurden für die Suche ausgewählt? |
KnowledgeBaseSearchIndexActivityRecord
Stellt einen Aktivitätsdatensatz für den Suchindexabruf dar.
| Name | Typ | Beschreibung |
|---|---|---|
| completedAt |
string (date-time) |
Die Zeit, zu der die Aktivität abgeschlossen wurde. |
| count |
integer (int32) |
Die Anzahl der abgerufenen Dokumente, die ausreichend relevant waren, um den Reranker-Schwellenwert zu überschreiten. |
| elapsedMs |
integer (int32) |
Die verstrichene Zeit in Millisekunden für die Abrufaktivität. |
| error |
Das Fehler-Detail, das erklärt, warum die Operation fehlgeschlagen ist. Diese Eigenschaft ist nur dann enthalten, wenn die Aktivität nicht erfolgreich ist. |
|
| id |
integer (int32) |
Die ID des Aktivitätsdatensatzes. |
| imageServing |
Statistiken zum Bilddienst für diese Abrufaktivität |
|
| knowledgeSourceName |
string |
Die Wissensquelle für die Abrufaktivität. |
| queryHintProcessing |
Details zu den Ausdrücken, die aus Anfragehinweisen für diese Aktivität generiert werden. |
|
| queryTime |
string (date-time) |
Die Abfragezeit für diese Abrufaktivität. |
| searchIndexArguments |
Die Suchindexargumente für die Abrufaktivität. |
|
| startedAt |
string (date-time) |
Die Zeit, zu der die Aktivität begann. |
| type |
string:
search |
Der Typ des Aktivitätsdatensatzes. |
| warning |
string |
Eine Warnmeldung, die potenzielle Konfigurationsprobleme aufzeigt, die während der Aktivität beobachtet wurden, wie Dokumente, die durch Score-Thresholding, Token-Limit-Kürzung oder Timeout-Bedingungen verloren gehen. |
KnowledgeBaseSearchIndexReference
Stellt eine Azure Search-Dokumentreferenz dar.
| Name | Typ | Beschreibung |
|---|---|---|
| activitySource |
integer (int32) |
Die Quellaktivitäts-ID für die Referenz. |
| citationUrl |
string (uri) |
Eine Search-eigene URL, die auf das Backing-Dokument für diese Referenz verweist und als Zitationsziel verwendet werden kann. |
| docKey |
string |
Der Dokumentschlüssel für die Referenz. |
| id |
string |
Die ID der Referenz. |
| rerankerScore |
number (float) |
Die Reranker-Bewertung für die Dokumentreferenz. |
| searchSensitivityLabelInfo |
Die Informationen zum Sensitivitätsetikett für die Referenz. |
|
| sourceData |
Die Quelldaten für die Referenz. |
|
| type |
string:
search |
Der Typ der Referenz. |
KnowledgeBaseWebActivityArguments
Repräsentiert die Argumente, mit denen die Webabrufaktivität ausgeführt wurde.
| Name | Typ | Beschreibung |
|---|---|---|
| count |
integer (int32) |
Die Anzahl der Webergebnisse wurde zurückgegeben. |
| freshness |
string |
Die Frische für die Apportationsaktivität. |
| language |
string |
Die Sprache für die Abrufaktivität. |
| market |
string |
Der Markt für die Abrufaktivität. |
| search |
string |
Die Suchsequenz, die zur Abfrage des Webs verwendet wird. |
KnowledgeBaseWebActivityRecord
Stellt einen Datensatz für Webabrufaktivitäten dar.
| Name | Typ | Beschreibung |
|---|---|---|
| completedAt |
string (date-time) |
Die Zeit, zu der die Aktivität abgeschlossen wurde. |
| count |
integer (int32) |
Die Anzahl der abgerufenen Dokumente, die ausreichend relevant waren, um den Reranker-Schwellenwert zu überschreiten. |
| elapsedMs |
integer (int32) |
Die verstrichene Zeit in Millisekunden für die Abrufaktivität. |
| error |
Das Fehler-Detail, das erklärt, warum die Operation fehlgeschlagen ist. Diese Eigenschaft ist nur dann enthalten, wenn die Aktivität nicht erfolgreich ist. |
|
| id |
integer (int32) |
Die ID des Aktivitätsdatensatzes. |
| imageServing |
Statistiken zum Bilddienst für diese Abrufaktivität |
|
| knowledgeSourceName |
string |
Die Wissensquelle für die Abrufaktivität. |
| queryTime |
string (date-time) |
Die Abfragezeit für diese Abrufaktivität. |
| startedAt |
string (date-time) |
Die Zeit, zu der die Aktivität begann. |
| type |
string:
web |
Der Typ des Aktivitätsdatensatzes. |
| warning |
string |
Eine Warnmeldung, die potenzielle Konfigurationsprobleme aufzeigt, die während der Aktivität beobachtet wurden, wie Dokumente, die durch Score-Thresholding, Token-Limit-Kürzung oder Timeout-Bedingungen verloren gehen. |
| webArguments |
Die Webargumente für die Abrufaktivität. |
KnowledgeBaseWebReference
Stellt einen Verweis auf ein Webdokument dar.
| Name | Typ | Beschreibung |
|---|---|---|
| activitySource |
integer (int32) |
Die Quellaktivitäts-ID für die Referenz. |
| id |
string |
Die ID der Referenz. |
| rerankerScore |
number (float) |
Die Reranker-Bewertung für die Dokumentreferenz. |
| sourceData |
Die Quelldaten für die Referenz. |
|
| title |
string |
Der Titel des Webdokuments. |
| type |
string:
web |
Der Typ der Referenz. |
| url |
string (uri) |
Die URL, von der die Referenzdaten stammen. |
KnowledgeBaseWorkIQActivityArguments
Repräsentiert die Argumente, mit denen die WorkIQ-Abrufaktivität ausgeführt wurde.
| Name | Typ | Beschreibung |
|---|---|---|
| search |
string |
Die Suchkette, die zur Abfrage der WorkIQ-Wissensquelle verwendet wird. |
KnowledgeBaseWorkIQActivityRecord
Stellt einen WorkIQ-Abrufaktivitätsrekord dar.
| Name | Typ | Beschreibung |
|---|---|---|
| completedAt |
string (date-time) |
Die Zeit, zu der die Aktivität abgeschlossen wurde. |
| count |
integer (int32) |
Die Anzahl der abgerufenen Dokumente, die ausreichend relevant waren, um den Reranker-Schwellenwert zu überschreiten. |
| elapsedMs |
integer (int32) |
Die verstrichene Zeit in Millisekunden für die Abrufaktivität. |
| error |
Das Fehler-Detail, das erklärt, warum die Operation fehlgeschlagen ist. Diese Eigenschaft ist nur dann enthalten, wenn die Aktivität nicht erfolgreich ist. |
|
| id |
integer (int32) |
Die ID des Aktivitätsdatensatzes. |
| imageServing |
Statistiken zum Bilddienst für diese Abrufaktivität |
|
| knowledgeSourceName |
string |
Die Wissensquelle für die Abrufaktivität. |
| queryTime |
string (date-time) |
Die Abfragezeit für diese Abrufaktivität. |
| startedAt |
string (date-time) |
Die Zeit, zu der die Aktivität begann. |
| type |
string:
workIQ |
Der Typ des Aktivitätsdatensatzes. |
| warning |
string |
Eine Warnmeldung, die potenzielle Konfigurationsprobleme aufzeigt, die während der Aktivität beobachtet wurden, wie Dokumente, die durch Score-Thresholding, Token-Limit-Kürzung oder Timeout-Bedingungen verloren gehen. |
| workIQArguments |
Die WorkIQ-Argumente für die Abrufaktivität. |
KnowledgeBaseWorkIQReference
Stellt eine WorkIQ-Dokumentreferenz dar.
| Name | Typ | Beschreibung |
|---|---|---|
| activitySource |
integer (int32) |
Die Quellaktivitäts-ID für die Referenz. |
| id |
string |
Die ID der Referenz. |
| rerankerScore |
number (float) |
Die Reranker-Bewertung für die Dokumentreferenz. |
| searchSensitivityLabelInfo |
Die Informationen zum Sensitivitätsetikett für die Referenz. |
|
| sourceData |
Die Quelldaten für die Referenz. |
|
| type |
string:
workIQ |
Der Typ der Referenz. |
KnowledgeRetrievalAutoReasoningEffort
Wählen Sie automatisch den Schlussaufwand während des Abrufs aus. Der Service setzt jede Anfrage auf die günstigste Stufe und eskaliert nur so weit, wie nötig, bis zur maximal verfügbaren Stufe des Services.
| Name | Typ | Beschreibung |
|---|---|---|
| kind |
string:
auto |
Die Art des Argumentationsaufwands. |
KnowledgeRetrievalIntentType
Die Art von Wissensdatenbank-Konfiguration, die man verwenden sollte.
| Wert | Beschreibung |
|---|---|
| semantic |
Eine semantische Abfrageabsicht in natürlicher Sprache. |
KnowledgeRetrievalLowReasoningEffort
Führen Sie das Abrufen von Wissen mit geringem Argumentationsaufwand durch.
| Name | Typ | Beschreibung |
|---|---|---|
| kind |
string:
low |
Die Art des Argumentationsaufwands. |
KnowledgeRetrievalMediumReasoningEffort
Führen Sie den Wissensabruf mit mittlerem Argumentationsaufwand durch.
| Name | Typ | Beschreibung |
|---|---|---|
| kind |
string:
medium |
Die Art des Argumentationsaufwands. |
KnowledgeRetrievalMinimalReasoningEffort
Führen Sie den Wissensabruf mit minimalem Argumentationsaufwand durch.
| Name | Typ | Beschreibung |
|---|---|---|
| kind |
string:
minimal |
Die Art des Argumentationsaufwands. |
KnowledgeRetrievalOutputMode
Die Ausgabekonfiguration für diesen Abruf.
| Wert | Beschreibung |
|---|---|
| extractiveData |
Geben Sie Daten aus den Wissensquellen direkt und ohne generative Änderung zurück. |
| answerSynthesis |
Synthetisieren Sie eine Antwort für die Antwortnutzlast. |
KnowledgeRetrievalReasoningEffortKind
Der Aufwand, der beim Abrufen verwendet werden soll.
| Wert | Beschreibung |
|---|---|
| minimal |
Führt keine Quellenauswahl, Abfrageplanung oder iterative Suche durch. |
| low |
Verwenden Sie beim Abrufen eine geringe Argumentation. |
| medium |
Verwenden Sie beim Abrufen ein moderates Maß an Argumentation. |
| auto |
Wähle automatisch den Argumentationsaufwand während des Abrufs aus und eskaliere nur so weit wie nötig von der günstigsten Stufe. |
KnowledgeRetrievalSemanticIntent
Eine semantische Abfrageabsicht.
| Name | Typ | Beschreibung |
|---|---|---|
| search |
string |
Die semantische Abfrage, die ausgeführt werden soll |
| type |
string:
semantic |
Der Typ der Absicht. |
KnowledgeSourceKind
Die Art der Wissensquelle.
| Wert | Beschreibung |
|---|---|
| searchIndex |
Eine Wissensquelle, die Daten aus einem Suchindex liest. |
| azureBlob |
Eine Wissensquelle, die Daten aus Azure Blob Storage liest und in einem Suchindex erfasst. |
| indexedSharePoint |
Eine Wissensquelle, die Daten von indexiertem SharePoint liest. |
| indexedOneLake |
Eine Wissensquelle, die Daten von indexierten OneLake ausliest. |
| indexedSql |
Eine Wissensquelle, die Daten aus der Azure SQL-Datenbank oder der SQL Managed Instance in einen Search Index abruft und aufnimmt. |
| web |
Eine Wissensquelle, die Daten aus dem Web liest. |
| remoteSharePoint |
Eine Wissensquelle, die Daten von entferntem SharePoint liest. |
| workIQ |
Eine Wissensquelle, die Daten aus dem Arbeits-IQ liest |
| file |
Eine Wissensquelle, die das direkte Uploaden und Indexieren von Dateien unterstützt. |
| mcpServer |
Eine Wissensquelle, die von einem MCP-Server (Model Context Protocol) unterstützt wird. |
| fabricDataAgent |
Eine Wissensquelle, die Daten von einem Fabric Data Agent abruft. |
| fabricOntology |
Eine Wissensquelle, die Daten aus Microsoft Fabric Ontology-Ontologien abruft. |
KnowledgeSourceResultsProcessing
Kontrolliert, ob die Ergebnisse einer Wissensquelle neu bewertet werden.
| Wert | Beschreibung |
|---|---|
| rerank |
Ergebnisse aus dieser Wissensquelle durchlaufen die Reranking-Pipeline. Dies ist das Standardverhalten. |
| none |
Die Ergebnisse dieser Wissensquelle umgehen das Reranking und behalten ihre zugrundeliegende Ordnung bei. |
McpServerKnowledgeSourceParams
Spezifiziert Laufzeitparameter für eine MCP-Server-Wissensquelle
| Name | Typ | Beschreibung |
|---|---|---|
| alwaysQuerySource |
boolean |
Gibt an, dass diese Wissensquelle die Quellenauswahl umgehen und immer zum Zeitpunkt des Abrufs abgefragt werden soll. |
| enableImageServing |
boolean |
Gibt an, ob die Bildbereitstellung für diese Wissensquelle zum Abruf aktiviert werden sollte. Wenn sie zutreffen, werden während der Aufnahme extrahierte Bilder an nachgelagerte Modelle geliefert. |
| failOnError |
boolean |
Zeigt an, dass die gesamte Abrufanfrage fehlschlagen sollte, wenn die Abruf aus dieser Wissensquelle auf einen Fehler stößt. Der Standardwert ist „false“. |
| includeReferenceSourceData |
boolean |
Gibt an, ob Verweise die strukturierten Daten, die während des Abrufs abgerufen wurden, in ihre Nutzlast aufnehmen sollen. |
| includeReferences |
boolean |
Gibt an, ob Verweise für Daten enthalten sein sollen, die aus dieser Quelle abgerufen werden. |
| kind |
string:
mcp |
Der Typ der Wissensquelle. |
| knowledgeSourceName |
string |
Der Name des Indexes, auf den die Parameter angewendet werden. |
| maxOutputDocuments |
integer (int32) |
Begrenzt die maximale Anzahl der aus dieser Wissensquelle zurückgegebenen Dokumente. |
| neverQuerySource |
boolean |
Gibt an, dass diese Wissensquelle aus dem Kandidatenset der Anfrage ausgeschlossen und beim Abruf niemals abgefragt werden sollte. Der Ausschluss ist request-lokal und ändert die Mitgliedschaft in der Wissensdatenbank nicht. Kann nicht mit alwaysQuerySource auf derselben Wissensquelle kombiniert werden. |
| rerankerThreshold |
number (float) |
Der Reranker-Schwellenwert, den alle abgerufenen Dokumente erfüllen müssen, um in die Antwort aufgenommen zu werden. |
| resultsProcessing |
Überschreibt die gespeicherten Ergebnisse der Wissensquelle. Bearbeitung nur für diesen Abruf. Wenn dieser weggelassen wird, gilt der Wert der gespeicherten Wissensquelle. |
PurviewSensitivityLabelInfo
Informationen über das auf ein Dokument angewandte Sensitivitätsetikett
| Name | Typ | Beschreibung |
|---|---|---|
| color |
string |
Die Farbe, die die Benutzeroberfläche für die Bezeichnung anzeigen soll, falls konfiguriert. |
| displayName |
string |
Der Anzeigename für das Empfindlichkeitslabel. |
| isEncrypted |
boolean |
Gibt an, ob die Vertraulichkeitsbezeichnung die Verschlüsselung erzwingt. |
| priority |
integer (int32) |
Die Priorität, in der die Vertraulichkeitsbezeichnung angewendet wird. |
| sensitivityLabelId |
string |
Die ID der Vertraulichkeitsbezeichnung. |
| toolTip |
string |
Die QuickInfo, die für die Bezeichnung in einer Benutzeroberfläche angezeigt werden soll. |
QueryType
Gibt die Syntax der Suchabfrage an. Der Standardwert ist "einfach". Verwenden Sie 'full', wenn Ihre Abfrage die Lucene-Abfragesyntax verwendet, und 'semantic', wenn die Abfragesyntax nicht benötigt wird.
| Wert | Beschreibung |
|---|---|
| simple |
Verwendet die einfache Abfragesyntax für Suchvorgänge. Der Suchtext wird mit einer einfachen Abfragesprache interpretiert, die Symbole wie +, * und "" zulässt. Abfragen werden standardmäßig über alle durchsuchbaren Felder ausgewertet, es sei denn, der Parameter searchFields ist angegeben. |
| full |
Verwendet die vollständige Lucene-Abfragesyntax für Suchvorgänge. Der Suchtext wird mit der Abfragesprache Lucene interpretiert, die feldspezifische und gewichtete Suchen sowie andere erweiterte Funktionen ermöglicht. |
| semantic |
Am besten geeignet für Abfragen, die in natürlicher Sprache im Gegensatz zu Schlüsselwörtern ausgedrückt werden. Verbessert die Genauigkeit der Suchergebnisse, indem die Top-Suchergebnisse mithilfe eines im Webkorpus trainierten Rangfolgemodells neu eingestuft werden. |
RemoteSharePointKnowledgeSourceParams
Gibt Laufzeitparameter für eine SharePoint-Remotewissensquelle an.
| Name | Typ | Beschreibung |
|---|---|---|
| alwaysQuerySource |
boolean |
Gibt an, dass diese Wissensquelle die Quellenauswahl umgehen und immer zum Zeitpunkt des Abrufs abgefragt werden soll. |
| enableImageServing |
boolean |
Gibt an, ob die Bildbereitstellung für diese Wissensquelle zum Abruf aktiviert werden sollte. Wenn sie zutreffen, werden während der Aufnahme extrahierte Bilder an nachgelagerte Modelle geliefert. |
| failOnError |
boolean |
Zeigt an, dass die gesamte Abrufanfrage fehlschlagen sollte, wenn die Abruf aus dieser Wissensquelle auf einen Fehler stößt. Der Standardwert ist „false“. |
| filterExpressionAddOn |
string |
Eine Filterbedingung, die auf die SharePoint-Datenquelle angewendet wird. Sie muss in der Syntax der Keyword Query Language angegeben werden. Sie wird als Konjunktion mit dem in der Knowledge Source Definition angegebenen Filterausdruck kombiniert. |
| includeReferenceSourceData |
boolean |
Gibt an, ob Verweise die strukturierten Daten, die während des Abrufs abgerufen wurden, in ihre Nutzlast aufnehmen sollen. |
| includeReferences |
boolean |
Gibt an, ob Verweise für Daten enthalten sein sollen, die aus dieser Quelle abgerufen werden. |
| kind |
string:
remote |
Der Typ der Wissensquelle. |
| knowledgeSourceName |
string |
Der Name des Indexes, auf den die Parameter angewendet werden. |
| maxOutputDocuments |
integer (int32) |
Begrenzt die maximale Anzahl der aus dieser Wissensquelle zurückgegebenen Dokumente. |
| neverQuerySource |
boolean |
Gibt an, dass diese Wissensquelle aus dem Kandidatenset der Anfrage ausgeschlossen und beim Abruf niemals abgefragt werden sollte. Der Ausschluss ist request-lokal und ändert die Mitgliedschaft in der Wissensdatenbank nicht. Kann nicht mit alwaysQuerySource auf derselben Wissensquelle kombiniert werden. |
| rerankerThreshold |
number (float) |
Der Reranker-Schwellenwert, den alle abgerufenen Dokumente erfüllen müssen, um in die Antwort aufgenommen zu werden. |
| resultsProcessing |
Überschreibt die gespeicherten Ergebnisse der Wissensquelle. Bearbeitung nur für diesen Abruf. Wenn dieser weggelassen wird, gilt der Wert der gespeicherten Wissensquelle. |
SearchIndexFieldReference
Feldreferenz für einen Suchindex.
| Name | Typ | Beschreibung |
|---|---|---|
| name |
string |
Der Name des Felds. |
SearchIndexKnowledgeSourceBoostKind
Die Art von Boost-Hinweis für eine Suchindex-Informationsquelle.
| Wert | Beschreibung |
|---|---|
| fieldValue |
Verbessern Sie Dokumente basierend auf einem Feldwert. |
| multiWordExpression |
Booste Dokumente basierend auf einem mehrsprachigen Ausdruck. |
SearchIndexKnowledgeSourceFieldValueBoost
Ein Hinweis, der Dokumente basierend auf einem Feldwert verbessert.
| Name | Typ | Beschreibung |
|---|---|---|
| boost |
number (double) |
Ein Multiplikator für die Dokumentenbewertung. Muss eine positive Zahl sein, die nicht gleich 1,0 ist. |
| boostInstructions |
string |
Anweisungen in natürlicher Sprache, die erklären, wann und wie der Boost angewendet werden soll. |
| field |
string minLength: 1 |
Der Name des Suchindexfeldes. |
| fieldValues |
string[] |
Repräsentative Werte für das Feld. |
| kind |
string:
field |
So eine Art Boost-Hinweis. |
SearchIndexKnowledgeSourceFilterHint
Ein Hinweis, der ein Feld und repräsentative Werte identifiziert, die der Abfrageplaner beim Erstellen eines Filters verwenden kann.
| Name | Typ | Beschreibung |
|---|---|---|
| field |
string minLength: 1 |
Der Name des filterbaren Suchindexfeldes. |
| fieldValues |
string[] |
Repräsentative Werte für das Feld. |
| filterInstructions |
string |
Anweisungen in natürlicher Sprache, die erklären, wann und wie man auf dem Feld filtert. |
SearchIndexKnowledgeSourceMultiWordExpressionBoost
Ein Hinweis, der Dokumente basierend auf einem mehrsprachigen Ausdruck verbessert.
| Name | Typ | Beschreibung |
|---|---|---|
| boost |
number (double) |
Ein Multiplikator für die Dokumentenbewertung. Muss eine positive Zahl sein, die nicht gleich 1,0 ist. |
| boostInstructions |
string |
Anweisungen in natürlicher Sprache, die erklären, wann und wie der Boost angewendet werden soll. |
| fieldValues |
string[] |
Repräsentative Werte für den Schub. |
| kind |
string:
multi |
So eine Art Boost-Hinweis. |
SearchIndexKnowledgeSourceParams
Gibt Laufzeitparameter für eine Wissensquelle für Suchindex an
| Name | Typ | Beschreibung |
|---|---|---|
| alwaysQuerySource |
boolean |
Gibt an, dass diese Wissensquelle die Quellenauswahl umgehen und immer zum Zeitpunkt des Abrufs abgefragt werden soll. |
| enableImageServing |
boolean |
Gibt an, ob die Bildbereitstellung für diese Wissensquelle zum Abruf aktiviert werden sollte. Wenn sie zutreffen, werden während der Aufnahme extrahierte Bilder an nachgelagerte Modelle geliefert. |
| failOnError |
boolean |
Zeigt an, dass die gesamte Abrufanfrage fehlschlagen sollte, wenn die Abruf aus dieser Wissensquelle auf einen Fehler stößt. Der Standardwert ist „false“. |
| filterAddOn |
string |
Eine Filterbedingung, die auf den Index angewendet wird (z. B. "State eq VA"). |
| includeReferenceSourceData |
boolean |
Gibt an, ob Verweise die strukturierten Daten, die während des Abrufs abgerufen wurden, in ihre Nutzlast aufnehmen sollen. |
| includeReferences |
boolean |
Gibt an, ob Verweise für Daten enthalten sein sollen, die aus dieser Quelle abgerufen werden. |
| kind |
string:
search |
Der Typ der Wissensquelle. |
| knowledgeSourceName |
string |
Der Name des Indexes, auf den die Parameter angewendet werden. |
| maxOutputDocuments |
integer (int32) |
Begrenzt die maximale Anzahl der aus dieser Wissensquelle zurückgegebenen Dokumente. |
| neverQuerySource |
boolean |
Gibt an, dass diese Wissensquelle aus dem Kandidatenset der Anfrage ausgeschlossen und beim Abruf niemals abgefragt werden sollte. Der Ausschluss ist request-lokal und ändert die Mitgliedschaft in der Wissensdatenbank nicht. Kann nicht mit alwaysQuerySource auf derselben Wissensquelle kombiniert werden. |
| queryHintOverrides |
Tipps, die die Abfrageplanung zu nützlichen Filtern und Boosts führen. Falls angegeben, ersetzt dieses Objekt die vollständige Menge an Abfragehinweisen, die auf der Wissensquelle konfiguriert sind. |
|
| rerankerThreshold |
number (float) |
Der Reranker-Schwellenwert, den alle abgerufenen Dokumente erfüllen müssen, um in die Antwort aufgenommen zu werden. |
| resultsProcessing |
Überschreibt die gespeicherten Ergebnisse der Wissensquelle. Bearbeitung nur für diesen Abruf. Wenn dieser weggelassen wird, gilt der Wert der gespeicherten Wissensquelle. |
SearchIndexKnowledgeSourceQueryHints
Hinweise, die die Abfrageplanung zu nützlichen Filtern und Verbesserungen für eine Suchindex-Wissensquelle führen.
| Name | Typ | Beschreibung |
|---|---|---|
| boosts | SearchIndexKnowledgeSourceBoost[]: |
Verbessern Sie Hinweise, die Bedingungen identifizieren, die der Abfrageplaner nutzen kann, um das Dokumentranking zu beeinflussen. |
| filters |
Filterhinweise, die Felder und repräsentative Werte identifizieren, die der Abfrageplaner beim Erstellen von Filtern verwenden kann. |
ServedImage
Beschreibt ein einzelnes Bild, das das Modell während einer Abrufaktivität ausgewählt hat.
| Name | Typ | Beschreibung |
|---|---|---|
| imageId |
string |
Das Bildlabel wurde aus dem Quelldokument durch Content Understanding Enrichment extrahiert. Entspricht der Abbildungsnummerierung im Originaldokument. |
| imagePath |
string |
Der relative Pfad zum Bild im Asset-Store. |
| sizeBytes |
integer (int64) |
Die Größe in Bytes dieses Bildes, wie es an das Modell gesendet wird. |
WebKnowledgeSourceParams
Gibt Laufzeitparameter für eine Webwissensquelle an
| Name | Typ | Beschreibung |
|---|---|---|
| alwaysQuerySource |
boolean |
Gibt an, dass diese Wissensquelle die Quellenauswahl umgehen und immer zum Zeitpunkt des Abrufs abgefragt werden soll. |
| count |
integer (int32) |
Die Anzahl der Webergebnisse, die zurückgegeben werden müssen. |
| enableImageServing |
boolean |
Gibt an, ob die Bildbereitstellung für diese Wissensquelle zum Abruf aktiviert werden sollte. Wenn sie zutreffen, werden während der Aufnahme extrahierte Bilder an nachgelagerte Modelle geliefert. |
| failOnError |
boolean |
Zeigt an, dass die gesamte Abrufanfrage fehlschlagen sollte, wenn die Abruf aus dieser Wissensquelle auf einen Fehler stößt. Der Standardwert ist „false“. |
| freshness |
string |
Die Frische der Webergebnisse. |
| includeReferenceSourceData |
boolean |
Gibt an, ob Verweise die strukturierten Daten, die während des Abrufs abgerufen wurden, in ihre Nutzlast aufnehmen sollen. |
| includeReferences |
boolean |
Gibt an, ob Verweise für Daten enthalten sein sollen, die aus dieser Quelle abgerufen werden. |
| kind |
string:
web |
Der Typ der Wissensquelle. |
| knowledgeSourceName |
string |
Der Name des Indexes, auf den die Parameter angewendet werden. |
| language |
string |
Die Sprache des Webs ergibt sich. |
| market |
string |
Der Markt des Internets ist Ergebnis. |
| maxOutputDocuments |
integer (int32) |
Begrenzt die maximale Anzahl der aus dieser Wissensquelle zurückgegebenen Dokumente. |
| neverQuerySource |
boolean |
Gibt an, dass diese Wissensquelle aus dem Kandidatenset der Anfrage ausgeschlossen und beim Abruf niemals abgefragt werden sollte. Der Ausschluss ist request-lokal und ändert die Mitgliedschaft in der Wissensdatenbank nicht. Kann nicht mit alwaysQuerySource auf derselben Wissensquelle kombiniert werden. |
| rerankerThreshold |
number (float) |
Der Reranker-Schwellenwert, den alle abgerufenen Dokumente erfüllen müssen, um in die Antwort aufgenommen zu werden. |
| resultsProcessing |
Überschreibt die gespeicherten Ergebnisse der Wissensquelle. Bearbeitung nur für diesen Abruf. Wenn dieser weggelassen wird, gilt der Wert der gespeicherten Wissensquelle. |
WorkIQKnowledgeSourceParams
Spezifiziert Laufzeitparameter für eine WorkIQ-Wissensquelle
| Name | Typ | Beschreibung |
|---|---|---|
| alwaysQuerySource |
boolean |
Gibt an, dass diese Wissensquelle die Quellenauswahl umgehen und immer zum Zeitpunkt des Abrufs abgefragt werden soll. |
| enableImageServing |
boolean |
Gibt an, ob die Bildbereitstellung für diese Wissensquelle zum Abruf aktiviert werden sollte. Wenn sie zutreffen, werden während der Aufnahme extrahierte Bilder an nachgelagerte Modelle geliefert. |
| failOnError |
boolean |
Zeigt an, dass die gesamte Abrufanfrage fehlschlagen sollte, wenn die Abruf aus dieser Wissensquelle auf einen Fehler stößt. Der Standardwert ist „false“. |
| includeReferenceSourceData |
boolean |
Gibt an, ob Verweise die strukturierten Daten, die während des Abrufs abgerufen wurden, in ihre Nutzlast aufnehmen sollen. |
| includeReferences |
boolean |
Gibt an, ob Verweise für Daten enthalten sein sollen, die aus dieser Quelle abgerufen werden. |
| kind |
string:
workIQ |
Der Typ der Wissensquelle. |
| knowledgeSourceName |
string |
Der Name des Indexes, auf den die Parameter angewendet werden. |
| maxOutputDocuments |
integer (int32) |
Begrenzt die maximale Anzahl der aus dieser Wissensquelle zurückgegebenen Dokumente. |
| neverQuerySource |
boolean |
Gibt an, dass diese Wissensquelle aus dem Kandidatenset der Anfrage ausgeschlossen und beim Abruf niemals abgefragt werden sollte. Der Ausschluss ist request-lokal und ändert die Mitgliedschaft in der Wissensdatenbank nicht. Kann nicht mit alwaysQuerySource auf derselben Wissensquelle kombiniert werden. |
| rerankerThreshold |
number (float) |
Der Reranker-Schwellenwert, den alle abgerufenen Dokumente erfüllen müssen, um in die Antwort aufgenommen zu werden. |
| resultsProcessing |
Überschreibt die gespeicherten Ergebnisse der Wissensquelle. Bearbeitung nur für diesen Abruf. Wenn dieser weggelassen wird, gilt der Wert der gespeicherten Wissensquelle. |