Knowledge Retrieval - Retrieve
Znalostní báze získává relevantní data ze záložních skladů.
POST {endpoint}/knowledgebases('{knowledgeBaseName}')/retrieve?api-version=2026-08-01-preview
Parametry identifikátoru URI
| Name | V | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
endpoint
|
path | True |
string (uri) |
Adresa URL koncového bodu vyhledávací služby. |
|
knowledge
|
path | True |
string |
Název znalostní báze. |
|
api-version
|
query | True |
string minLength: 1 |
Verze rozhraní API, která se má použít pro tuto operaci. |
Hlavička požadavku
| Name | Vyžadováno | Typ | Description |
|---|---|---|---|
| Accept |
Hlavička Accept. |
||
| x-ms-query-source-authorization |
string |
Token identifikující uživatele, pro kterého je dotaz prováděn. Tento token se používá k vynucení bezpečnostních omezení dokumentů. |
|
| x-ms-query-work-iq-source-authorization |
string (password) |
Uživatelský asertivní token pro registraci aplikace Entra vlastněné zákazníkem konfigurovaný na zdroji znalostí Work IQ. Používá se pro autentizaci přímo na Work IQ API. |
|
| x-ms-client-request-id |
string (uuid) |
Neprůzrný globálně jedinečný identifikátor řetězce vygenerovaný klientem pro požadavek. |
Text požadavku
| Name | Typ | Description |
|---|---|---|
| includeActivity |
boolean |
Označuje, že výsledky načítání by měly obsahovat informace o aktivitě. |
| intents | KnowledgeRetrievalIntent[]: |
Seznam zamýšlených dotazů, které mají být provedeny bez plánování dotazů na model. |
| knowledgeSourceParams |
KnowledgeSourceParams[]:
|
Seznam běhových parametrů pro znalostní zdroje. |
| maxOutputDocuments |
integer (int32) |
Omezuje maximální počet dokumentů ve výstupu. |
| maxOutputSize |
integer (int32) |
Omezuje maximální velikost obsahu ve výstupu. |
| maxOutputSizeInTokens |
integer (int32) |
Omezuje maximální velikost obsahu ve výstupu. |
| maxRuntimeInSeconds |
integer (int32) |
Maximální doba běhu v sekundách. |
| messages |
Seznam vstupů ve stylu chatových zpráv. |
|
| outputMode |
Výstupní konfigurace pro toto načtení. |
|
| retrievalReasoningEffort | KnowledgeRetrievalReasoningEffort: |
Konfigurace úsilí o vyhledávání a uvažování. |
Odpovědi
| Name | Typ | Description |
|---|---|---|
| 200 OK |
Úspěšná reakce při odběru. |
|
| Other Status Codes |
Částečná reakce na odběr. |
|
| Other Status Codes |
Neočekávaná chybová odpověď |
Zabezpečení
api-key
Typ:
apiKey
V:
header
OAuth2Auth
Typ:
oauth2
Tok:
implicit
URL autorizace:
https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Rozsahy
| Name | Description |
|---|---|
| https://search.azure.com/.default |
Příklady
|
Knowledge |
|
Knowledge |
|
Knowledge |
|
Knowledge |
KnowledgeBaseRetrieve
Ukázkový požadavek
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
}
]
}
}
]
}
Ukázková odpověď
{
"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
Ukázkový požadavek
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
}
]
}
Ukázková odpověď
{
"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
Ukázkový požadavek
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
}
]
}
}
]
}
Ukázková odpověď
{
"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
Ukázkový požadavek
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"
}
]
}
Ukázková odpověď
{
"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"
}
]
}
Definice
| Name | Description |
|---|---|
| Accept |
Hlavička Accept. |
|
Azure |
Určuje parametry běhového prostředí pro zdroj znalostí o objektech blob v Azure |
|
Error |
Další informace o chybě při správě prostředků |
|
Error |
Podrobnosti o chybě. |
|
Error |
Běžná chybová odpověď pro všechna rozhraní API Azure Resource Manageru pro vrácení podrobností o chybě pro neúspěšné operace (To se také řídí formátem odpovědi na chybu OData.) |
|
Fabric |
Specifikuje parametry běhu pro zdroj znalostí Fabric Data Agenta |
|
Fabric |
Specifikuje parametry běhu pro zdroj znalostí Fabric Ontology |
|
File |
Specifikuje parametry běhu pro zdroj znalostí souboru |
|
Image |
Statistiky o podávání obrazu během obnovovací činnosti. |
|
Indexed |
Určuje parametry běhového prostředí pro indexovaný zdroj znalostí OneLake |
|
Indexed |
Určuje parametry běhového prostředí pro indexovaný zdroj znalostí služby SharePoint |
|
Indexed |
Specifikuje parametry běhu pro indexovaný zdroj znalostí SQL |
|
Knowledge |
Představuje model používaný pro aktivitu LLM znalostní báze, včetně názvu modelu a identifikátoru nasazení. |
|
Knowledge |
Typ záznamu o aktivitě. |
|
Knowledge |
Představuje záznam aktivity agentického uvažování. |
|
Knowledge |
Představuje argumenty, se kterými byla spuštěna aktivita načítání objektů blob Azure. |
|
Knowledge |
Představuje záznam aktivity načítání objektů blob v Azure. |
|
Knowledge |
Představuje referenční informace k dokumentu služby Azure Blob Storage. |
|
Knowledge |
Další informace o chybě při správě prostředků |
|
Knowledge |
Podrobnosti o chybě. |
|
Knowledge |
Reprezentuje argumenty, se kterými byla aktivnost při získávání Fabric Data Agent spuštěna. |
|
Knowledge |
Představuje záznam aktivity pro získání Fabric Data Agent. |
|
Knowledge |
Představuje referenci dokumentu Fabric Data Agent. |
|
Knowledge |
Představuje argumenty, se kterými byla provedena aktivita vyhledávání Fabric Ontology. |
|
Knowledge |
Představuje záznam aktivity vyhledávání Fabric Ontology. |
|
Knowledge |
Představuje referenci dokumentu Fabric Ontology. |
|
Knowledge |
Reprezentuje argumenty, se kterými byla aktivnost načtení souboru provedena. |
|
Knowledge |
Představuje záznam aktivity při získávání souboru. |
|
Knowledge |
Představuje odkaz na dokument souboru. |
|
Knowledge |
Obsah. |
|
Knowledge |
Reprezentuje argumenty, se kterými byla spuštěna indexovaná aktivita vyhledávání OneLake. |
|
Knowledge |
Představuje indexovaný záznam o vyhledání OneLake. |
|
Knowledge |
Představuje indexovaný odkaz na dokument OneLake. |
|
Knowledge |
Představuje argumenty, se kterými byla spuštěna indexovaná aktivita vyhledávání SharePointu. |
|
Knowledge |
Představuje indexovaný záznam aktivity vyhledávání v SharePointu. |
|
Knowledge |
Představuje indexovaný odkaz na dokument SharePoint. |
|
Knowledge |
Reprezentuje argumenty, se kterými byla spuštěna aktivita indexovaného vyhledávání SQL. |
|
Knowledge |
Představuje indexovaný záznam SQL retrieval aktivity. |
|
Knowledge |
Představuje referenční dokument Azure SQL. |
|
Knowledge |
Představuje argumenty, se kterými byla aktivnost načítání MCP serveru provedena. |
|
Knowledge |
Představuje záznam o načítání MCP serveru. |
|
Knowledge |
Představuje referenci dokumentu MCP serveru. |
|
Knowledge |
Objekt stylu zprávy v přirozeném jazyce. |
|
Knowledge |
Typ obsahu zprávy. |
|
Knowledge |
Typ obrazové zprávy. |
|
Knowledge |
Typ textové zprávy. |
|
Knowledge |
Představuje záznam aktivity syntézy odpovědí LLM. |
|
Knowledge |
Představuje záznam aktivity plánování dotazu LLM. |
|
Knowledge |
Představuje záznam aktivity webové sumarizace LLM. |
|
Knowledge |
Podrobnosti o výrazech generovaných z dotazovacích nápověd pro aktivnost vyhledávání. |
|
Knowledge |
Typ odkazu. |
|
Knowledge |
Představuje argumenty, se kterými byla aktivnost vzdáleného vyhledávání SharePointu spuštěna. |
|
Knowledge |
Představuje záznam vzdálené aktivity pro vyhledávání SharePointu. |
|
Knowledge |
Představuje odkaz na vzdálený dokument služby SharePoint. |
|
Knowledge |
Vstupní kontrakt pro požadavek na načtení. |
|
Knowledge |
Výstupní kontrakt pro odpověď na načtení. |
|
Knowledge |
Představuje argumenty, se kterými byla spuštěna aktivita načítání vyhledávacího indexu. |
|
Knowledge |
Představuje záznam aktivity načítání indexu vyhledávání. |
|
Knowledge |
Představuje referenční dokument Azure Search. |
|
Knowledge |
Představuje argumenty, se kterými byla aktivita webového vyhledávání spuštěna. |
|
Knowledge |
Představuje záznam o aktivitách vyhledávání na webu. |
|
Knowledge |
Představuje odkaz na webový dokument. |
|
Knowledge |
Představuje argumenty, se kterými byla aktivnost vyhledávání WorkIQ spuštěna. |
|
Knowledge |
Představuje záznam aktivity vyhledávání ve WorkIQ. |
|
Knowledge |
Představuje referenci na dokument WorkIQ. |
|
Knowledge |
Automaticky vyberte úsilí při vyhledání uvažování. Služba zase zasílá každou žádost na nejlevnější úrovni a eskaluje pouze do míry potřeba, až do maximální dostupné úrovně služby. |
|
Knowledge |
Druh konfigurace znalostní báze, který se má použít. |
|
Knowledge |
Provádějte načítání znalostí s nízkým úsilím při uvažování. |
|
Knowledge |
Spusťte získávání znalostí se středním úsilím při uvažování. |
|
Knowledge |
Spouštějte načítání znalostí s minimálním úsilím při uvažování. |
|
Knowledge |
Výstupní konfigurace pro toto načtení. |
|
Knowledge |
Množství úsilí, které je třeba vynaložit při načítání. |
|
Knowledge |
Záměr sémantického dotazu. |
|
Knowledge |
Druh zdroje znalostí. |
|
Knowledge |
Ovládá, zda jsou výsledky zdroje znalostí přeřazeny. |
|
Mcp |
Specifikuje parametry běhu pro zdroj znalostí MCP serveru |
|
Purview |
Informace o citlivém štítku aplikovaném na dokument |
|
Query |
Určuje syntaxi vyhledávacího dotazu. Výchozí hodnota je 'simple'. Pokud dotaz používá syntaxi dotazu Lucene, použijte hodnotu "úplná", pokud syntaxi dotazu nepotřebujete, použijte hodnotu "sémantická". |
|
Remote |
Určuje parametry běhového prostředí pro vzdálený zdroj znalostí služby SharePoint |
|
Search |
Referenční pole pro vyhledávací index. |
|
Search |
Typ nápovědy pro zdroj znalostí ve vyhledávacím indexu. |
|
Search |
Nápověda, která posílí dokumenty na základě hodnoty pole. |
|
Search |
Nápověda, která identifikuje pole a reprezentativní hodnoty, kterou může plánovač dotazů použít při vytváření filtru. |
|
Search |
Nápověda, která posílí dokumenty založené na víceslovném výrazu. |
|
Search |
Určuje parametry běhového prostředí pro zdroj znalostí o indexu vyhledávání |
|
Search |
Tipy, které vedou plánování dotazů k užitečným filtrům a vylepšením pro zdroj znalostí ve vyhledávacím indexu. |
|
Served |
Popisuje jeden obrázek, který model vybral k podání během aktivity vyhledávání. |
|
Web |
Určuje parametry běhového prostředí pro webový zdroj znalostí |
|
Work |
Specifikuje parametry běhu pro zdroj znalostí WorkIQ |
Accept
Hlavička Accept.
| Hodnota | Description |
|---|---|
| application/json;odata.metadata=minimal |
AzureBlobKnowledgeSourceParams
Určuje parametry běhového prostředí pro zdroj znalostí o objektech blob v Azure
| Name | Typ | Description |
|---|---|---|
| alwaysQuerySource |
boolean |
Označuje, že tento zdroj znalostí by měl obejít výběr zdroje a vždy se na něj dotazovat při načítání. |
| enableImageServing |
boolean |
Uvádí, zda by mělo být při vyhledávání pro tento zdroj znalostí povoleno servisování obrazů. Pokud je to pravda, jsou obrázky extrahované při pojetí doručeny do modelů za nimi. |
| failOnError |
boolean |
Označuje, že celý požadavek na vyhledání by měl selhat, pokud načtení z tohoto zdroje znalostí narazí na chybu. Výchozí nastavení je „false“. |
| includeReferenceSourceData |
boolean |
Označuje, zda mají odkazy ve své datové části obsahovat strukturovaná data získaná během načítání. |
| includeReferences |
boolean |
Označuje, zda mají být zahrnuty odkazy pro data načtená z tohoto zdroje. |
| kind |
string:
azure |
Typ zdroje znalostí. |
| knowledgeSourceName |
string |
Název indexu, na který se parametry vztahují. |
| maxOutputDocuments |
integer (int32) |
Omezuje maximální počet dokumentů vrácených z tohoto zdroje znalostí. |
| neverQuerySource |
boolean |
Označuje, že tento zdroj znalostí by měl být vyloučen z kandidátní sady požadavku a nikdy by neměl být dotazován při vyhledání. Vyloučení je na žádost lokální a nemění členství ve znalostní báze. Nelze jej kombinovat s alwaysQuerySource na stejném zdroji znalostí. |
| queryHintOverrides |
Tipy, které vedou plánování dotazů k užitečným filtrům a vylepšením. Pokud je tento objekt specifikován, nahrazuje kompletní sadu dotazovacích hintů nakonfigurovaných ve zdroji znalostí. |
|
| rerankerThreshold |
number (float) |
Prahová hodnota opětovného pořadí, kterou musí splňovat všechny načtené dokumenty, aby mohly být zahrnuty do odpovědi. |
| resultsProcessing |
Přepisuje uložené výsledky zdroje znalostí Zpracování pouze pro tento vyvolávací volání. Pokud je vynechán, platí hodnota zdrojového zdroje uložených znalostí. |
ErrorAdditionalInfo
Další informace o chybě při správě prostředků
| Name | Typ | Description |
|---|---|---|
| info |
Další informace. |
|
| type |
string |
Další typ informací. |
ErrorDetail
Podrobnosti o chybě.
| Name | Typ | Description |
|---|---|---|
| additionalInfo |
Další informace o chybě. |
|
| code |
string |
Kód chyby. |
| details |
Podrobnosti o chybě. |
|
| message |
string |
Chybová zpráva. |
| target |
string |
Cíl chyby. |
ErrorResponse
Běžná chybová odpověď pro všechna rozhraní API Azure Resource Manageru pro vrácení podrobností o chybě pro neúspěšné operace (To se také řídí formátem odpovědi na chybu OData.)
| Name | Typ | Description |
|---|---|---|
| error |
Objekt chyby. |
FabricDataAgentKnowledgeSourceParams
Specifikuje parametry běhu pro zdroj znalostí Fabric Data Agenta
| Name | Typ | Description |
|---|---|---|
| alwaysQuerySource |
boolean |
Označuje, že tento zdroj znalostí by měl obejít výběr zdroje a vždy se na něj dotazovat při načítání. |
| enableImageServing |
boolean |
Uvádí, zda by mělo být při vyhledávání pro tento zdroj znalostí povoleno servisování obrazů. Pokud je to pravda, jsou obrázky extrahované při pojetí doručeny do modelů za nimi. |
| failOnError |
boolean |
Označuje, že celý požadavek na vyhledání by měl selhat, pokud načtení z tohoto zdroje znalostí narazí na chybu. Výchozí nastavení je „false“. |
| includeReferenceSourceData |
boolean |
Označuje, zda mají odkazy ve své datové části obsahovat strukturovaná data získaná během načítání. |
| includeReferences |
boolean |
Označuje, zda mají být zahrnuty odkazy pro data načtená z tohoto zdroje. |
| kind |
string:
fabric |
Typ zdroje znalostí. |
| knowledgeSourceName |
string |
Název indexu, na který se parametry vztahují. |
| maxOutputDocuments |
integer (int32) |
Omezuje maximální počet dokumentů vrácených z tohoto zdroje znalostí. |
| neverQuerySource |
boolean |
Označuje, že tento zdroj znalostí by měl být vyloučen z kandidátní sady požadavku a nikdy by neměl být dotazován při vyhledání. Vyloučení je na žádost lokální a nemění členství ve znalostní báze. Nelze jej kombinovat s alwaysQuerySource na stejném zdroji znalostí. |
| rerankerThreshold |
number (float) |
Prahová hodnota opětovného pořadí, kterou musí splňovat všechny načtené dokumenty, aby mohly být zahrnuty do odpovědi. |
| resultsProcessing |
Přepisuje uložené výsledky zdroje znalostí Zpracování pouze pro tento vyvolávací volání. Pokud je vynechán, platí hodnota zdrojového zdroje uložených znalostí. |
FabricOntologyKnowledgeSourceParams
Specifikuje parametry běhu pro zdroj znalostí Fabric Ontology
| Name | Typ | Description |
|---|---|---|
| alwaysQuerySource |
boolean |
Označuje, že tento zdroj znalostí by měl obejít výběr zdroje a vždy se na něj dotazovat při načítání. |
| enableImageServing |
boolean |
Uvádí, zda by mělo být při vyhledávání pro tento zdroj znalostí povoleno servisování obrazů. Pokud je to pravda, jsou obrázky extrahované při pojetí doručeny do modelů za nimi. |
| failOnError |
boolean |
Označuje, že celý požadavek na vyhledání by měl selhat, pokud načtení z tohoto zdroje znalostí narazí na chybu. Výchozí nastavení je „false“. |
| includeReferenceSourceData |
boolean |
Označuje, zda mají odkazy ve své datové části obsahovat strukturovaná data získaná během načítání. |
| includeReferences |
boolean |
Označuje, zda mají být zahrnuty odkazy pro data načtená z tohoto zdroje. |
| kind |
string:
fabric |
Typ zdroje znalostí. |
| knowledgeSourceName |
string |
Název indexu, na který se parametry vztahují. |
| maxOutputDocuments |
integer (int32) |
Omezuje maximální počet dokumentů vrácených z tohoto zdroje znalostí. |
| neverQuerySource |
boolean |
Označuje, že tento zdroj znalostí by měl být vyloučen z kandidátní sady požadavku a nikdy by neměl být dotazován při vyhledání. Vyloučení je na žádost lokální a nemění členství ve znalostní báze. Nelze jej kombinovat s alwaysQuerySource na stejném zdroji znalostí. |
| rerankerThreshold |
number (float) |
Prahová hodnota opětovného pořadí, kterou musí splňovat všechny načtené dokumenty, aby mohly být zahrnuty do odpovědi. |
| resultsProcessing |
Přepisuje uložené výsledky zdroje znalostí Zpracování pouze pro tento vyvolávací volání. Pokud je vynechán, platí hodnota zdrojového zdroje uložených znalostí. |
FileKnowledgeSourceParams
Specifikuje parametry běhu pro zdroj znalostí souboru
| Name | Typ | Description |
|---|---|---|
| alwaysQuerySource |
boolean |
Označuje, že tento zdroj znalostí by měl obejít výběr zdroje a vždy se na něj dotazovat při načítání. |
| enableImageServing |
boolean |
Uvádí, zda by mělo být při vyhledávání pro tento zdroj znalostí povoleno servisování obrazů. Pokud je to pravda, jsou obrázky extrahované při pojetí doručeny do modelů za nimi. |
| failOnError |
boolean |
Označuje, že celý požadavek na vyhledání by měl selhat, pokud načtení z tohoto zdroje znalostí narazí na chybu. Výchozí nastavení je „false“. |
| includeReferenceSourceData |
boolean |
Označuje, zda mají odkazy ve své datové části obsahovat strukturovaná data získaná během načítání. |
| includeReferences |
boolean |
Označuje, zda mají být zahrnuty odkazy pro data načtená z tohoto zdroje. |
| kind |
string:
file |
Typ zdroje znalostí. |
| knowledgeSourceName |
string |
Název indexu, na který se parametry vztahují. |
| maxOutputDocuments |
integer (int32) |
Omezuje maximální počet dokumentů vrácených z tohoto zdroje znalostí. |
| neverQuerySource |
boolean |
Označuje, že tento zdroj znalostí by měl být vyloučen z kandidátní sady požadavku a nikdy by neměl být dotazován při vyhledání. Vyloučení je na žádost lokální a nemění členství ve znalostní báze. Nelze jej kombinovat s alwaysQuerySource na stejném zdroji znalostí. |
| queryHintOverrides |
Tipy, které vedou plánování dotazů k užitečným filtrům a vylepšením. Pokud je tento objekt specifikován, nahrazuje kompletní sadu dotazovacích hintů nakonfigurovaných ve zdroji znalostí. |
|
| rerankerThreshold |
number (float) |
Prahová hodnota opětovného pořadí, kterou musí splňovat všechny načtené dokumenty, aby mohly být zahrnuty do odpovědi. |
| resultsProcessing |
Přepisuje uložené výsledky zdroje znalostí Zpracování pouze pro tento vyvolávací volání. Pokud je vynechán, platí hodnota zdrojového zdroje uložených znalostí. |
ImageServingStatistics
Statistiky o podávání obrazu během obnovovací činnosti.
| Name | Typ | Description |
|---|---|---|
| imagesRetrieved |
integer (int32) |
Počet obrázků získaných z asset store. |
| imagesSentToModel |
integer (int32) |
Počet obrázků odeslaných do downstream modelu. |
| servedImages |
Sada obrazů, které model vybral k doručení do následného modelu pro tuto aktivnost vyhledávání. |
|
| totalImageSizeBytes |
integer (int64) |
Celková velikost obrázků zaslaných modelu v bajtech. |
| verbalizationUsed |
boolean |
Označuje, zda byla použita verbální formace obrázků místo přímého podávání obrázků. |
IndexedOneLakeKnowledgeSourceParams
Určuje parametry běhového prostředí pro indexovaný zdroj znalostí OneLake
| Name | Typ | Description |
|---|---|---|
| alwaysQuerySource |
boolean |
Označuje, že tento zdroj znalostí by měl obejít výběr zdroje a vždy se na něj dotazovat při načítání. |
| enableImageServing |
boolean |
Uvádí, zda by mělo být při vyhledávání pro tento zdroj znalostí povoleno servisování obrazů. Pokud je to pravda, jsou obrázky extrahované při pojetí doručeny do modelů za nimi. |
| failOnError |
boolean |
Označuje, že celý požadavek na vyhledání by měl selhat, pokud načtení z tohoto zdroje znalostí narazí na chybu. Výchozí nastavení je „false“. |
| includeReferenceSourceData |
boolean |
Označuje, zda mají odkazy ve své datové části obsahovat strukturovaná data získaná během načítání. |
| includeReferences |
boolean |
Označuje, zda mají být zahrnuty odkazy pro data načtená z tohoto zdroje. |
| kind |
string:
indexed |
Typ zdroje znalostí. |
| knowledgeSourceName |
string |
Název indexu, na který se parametry vztahují. |
| maxOutputDocuments |
integer (int32) |
Omezuje maximální počet dokumentů vrácených z tohoto zdroje znalostí. |
| neverQuerySource |
boolean |
Označuje, že tento zdroj znalostí by měl být vyloučen z kandidátní sady požadavku a nikdy by neměl být dotazován při vyhledání. Vyloučení je na žádost lokální a nemění členství ve znalostní báze. Nelze jej kombinovat s alwaysQuerySource na stejném zdroji znalostí. |
| queryHintOverrides |
Tipy, které vedou plánování dotazů k užitečným filtrům a vylepšením. Pokud je tento objekt specifikován, nahrazuje kompletní sadu dotazovacích hintů nakonfigurovaných ve zdroji znalostí. |
|
| rerankerThreshold |
number (float) |
Prahová hodnota opětovného pořadí, kterou musí splňovat všechny načtené dokumenty, aby mohly být zahrnuty do odpovědi. |
| resultsProcessing |
Přepisuje uložené výsledky zdroje znalostí Zpracování pouze pro tento vyvolávací volání. Pokud je vynechán, platí hodnota zdrojového zdroje uložených znalostí. |
IndexedSharePointKnowledgeSourceParams
Určuje parametry běhového prostředí pro indexovaný zdroj znalostí služby SharePoint
| Name | Typ | Description |
|---|---|---|
| alwaysQuerySource |
boolean |
Označuje, že tento zdroj znalostí by měl obejít výběr zdroje a vždy se na něj dotazovat při načítání. |
| enableImageServing |
boolean |
Uvádí, zda by mělo být při vyhledávání pro tento zdroj znalostí povoleno servisování obrazů. Pokud je to pravda, jsou obrázky extrahované při pojetí doručeny do modelů za nimi. |
| failOnError |
boolean |
Označuje, že celý požadavek na vyhledání by měl selhat, pokud načtení z tohoto zdroje znalostí narazí na chybu. Výchozí nastavení je „false“. |
| includeReferenceSourceData |
boolean |
Označuje, zda mají odkazy ve své datové části obsahovat strukturovaná data získaná během načítání. |
| includeReferences |
boolean |
Označuje, zda mají být zahrnuty odkazy pro data načtená z tohoto zdroje. |
| kind |
string:
indexed |
Typ zdroje znalostí. |
| knowledgeSourceName |
string |
Název indexu, na který se parametry vztahují. |
| maxOutputDocuments |
integer (int32) |
Omezuje maximální počet dokumentů vrácených z tohoto zdroje znalostí. |
| neverQuerySource |
boolean |
Označuje, že tento zdroj znalostí by měl být vyloučen z kandidátní sady požadavku a nikdy by neměl být dotazován při vyhledání. Vyloučení je na žádost lokální a nemění členství ve znalostní báze. Nelze jej kombinovat s alwaysQuerySource na stejném zdroji znalostí. |
| queryHintOverrides |
Tipy, které vedou plánování dotazů k užitečným filtrům a vylepšením. Pokud je tento objekt specifikován, nahrazuje kompletní sadu dotazovacích hintů nakonfigurovaných ve zdroji znalostí. |
|
| rerankerThreshold |
number (float) |
Prahová hodnota opětovného pořadí, kterou musí splňovat všechny načtené dokumenty, aby mohly být zahrnuty do odpovědi. |
| resultsProcessing |
Přepisuje uložené výsledky zdroje znalostí Zpracování pouze pro tento vyvolávací volání. Pokud je vynechán, platí hodnota zdrojového zdroje uložených znalostí. |
IndexedSqlKnowledgeSourceParams
Specifikuje parametry běhu pro indexovaný zdroj znalostí SQL
| Name | Typ | Description |
|---|---|---|
| alwaysQuerySource |
boolean |
Označuje, že tento zdroj znalostí by měl obejít výběr zdroje a vždy se na něj dotazovat při načítání. |
| enableImageServing |
boolean |
Uvádí, zda by mělo být při vyhledávání pro tento zdroj znalostí povoleno servisování obrazů. Pokud je to pravda, jsou obrázky extrahované při pojetí doručeny do modelů za nimi. |
| failOnError |
boolean |
Označuje, že celý požadavek na vyhledání by měl selhat, pokud načtení z tohoto zdroje znalostí narazí na chybu. Výchozí nastavení je „false“. |
| includeReferenceSourceData |
boolean |
Označuje, zda mají odkazy ve své datové části obsahovat strukturovaná data získaná během načítání. |
| includeReferences |
boolean |
Označuje, zda mají být zahrnuty odkazy pro data načtená z tohoto zdroje. |
| kind |
string:
indexed |
Typ zdroje znalostí. |
| knowledgeSourceName |
string |
Název indexu, na který se parametry vztahují. |
| maxOutputDocuments |
integer (int32) |
Omezuje maximální počet dokumentů vrácených z tohoto zdroje znalostí. |
| neverQuerySource |
boolean |
Označuje, že tento zdroj znalostí by měl být vyloučen z kandidátní sady požadavku a nikdy by neměl být dotazován při vyhledání. Vyloučení je na žádost lokální a nemění členství ve znalostní báze. Nelze jej kombinovat s alwaysQuerySource na stejném zdroji znalostí. |
| queryHintOverrides |
Tipy, které vedou plánování dotazů k užitečným filtrům a vylepšením. Pokud je tento objekt specifikován, nahrazuje kompletní sadu dotazovacích hintů nakonfigurovaných ve zdroji znalostí. |
|
| rerankerThreshold |
number (float) |
Prahová hodnota opětovného pořadí, kterou musí splňovat všechny načtené dokumenty, aby mohly být zahrnuty do odpovědi. |
| resultsProcessing |
Přepisuje uložené výsledky zdroje znalostí Zpracování pouze pro tento vyvolávací volání. Pokud je vynechán, platí hodnota zdrojového zdroje uložených znalostí. |
KnowledgeBaseActivityRecordModel
Představuje model používaný pro aktivitu LLM znalostní báze, včetně názvu modelu a identifikátoru nasazení.
| Name | Typ | Description |
|---|---|---|
| deploymentId |
string |
Identifikátor nasazení modelu použitého pro danou aktivitu. |
| modelName |
string |
Název modelu použitého pro tuto aktivitu. |
KnowledgeBaseActivityRecordType
Typ záznamu o aktivitě.
| Hodnota | Description |
|---|---|
| searchIndex |
Vyhledávání indexové aktivity. |
| azureBlob |
Azure Blob retrieval activity. |
| indexedSharePoint |
Indexovaná aktivita vyhledávání SharePointu. |
| indexedOneLake |
Indexovaná aktivita vyhledávání OneLake. |
| web |
Aktivita vyhledávání webu. |
| remoteSharePoint |
Aktivita vzdáleného vyhledávání SharePointu. |
| workIQ |
Aktivita na obnovu WorkIQ. |
| fabricDataAgent |
Aktivita získávání Fabric Data Agent. |
| fabricOntology |
Aktivita vyhledávání Fabric Ontology. |
| mcpServer |
Aktivita načítání MCP serveru. |
| file |
Aktivita vyhledávání souborů. |
| indexedSql |
Indexovaná aktivita vyhledávání SQL. |
| modelQueryPlanning |
Aktivita plánování dotazů pro LLM. |
| modelAnswerSynthesis |
Aktivita syntézy odpovědí LLM. |
| modelWebSummarization |
Aktivita shrnutí webu LLM. |
| agenticReasoning |
Činnost agentického uvažování. |
KnowledgeBaseAgenticReasoningActivityRecord
Představuje záznam aktivity agentického uvažování.
| Name | Typ | Description |
|---|---|---|
| completedAt |
string (date-time) |
Čas, kdy byla aktivita dokončena. |
| elapsedMs |
integer (int32) |
Čas, který uplynul v milisekundách pro aktivitu načítání. |
| error |
Chyba podrobně vysvětluje, proč se operace nezdařila. Tato vlastnost je zahrnuta pouze v případě, že aktivita není úspěšná. |
|
| id |
integer (int32) |
ID záznamu aktivity. |
| logicalReasoningEffort | KnowledgeRetrievalReasoningEffort: |
Logická úvaha, kterou zákazník požaduje. To se liší od |
| reasoningTokens |
integer (int32) |
Počet vstupních tokenů pro agentické uvažování. |
| retrievalReasoningEffort | KnowledgeRetrievalReasoningEffort: |
Konfigurace úsilí o vyhledávání a uvažování. |
| startedAt |
string (date-time) |
Čas, kdy aktivita začala. |
| type |
string:
agentic |
Typ záznamu aktivity. |
| warning |
string |
Varovná zpráva odhalující možné konfigurační problémy pozorované během aktivity, například dokumenty ztracené kvůli prahovému skórování, zkrácení limitu tokenů nebo podmínkám časového limitu. |
KnowledgeBaseAzureBlobActivityArguments
Představuje argumenty, se kterými byla spuštěna aktivita načítání objektů blob Azure.
| Name | Typ | Description |
|---|---|---|
| search |
string |
Vyhledávací řetězec používaný k dotazování na obsah objektů blob. |
KnowledgeBaseAzureBlobActivityRecord
Představuje záznam aktivity načítání objektů blob v Azure.
| Name | Typ | Description |
|---|---|---|
| azureBlobArguments |
Argumenty objektu blob azure pro aktivitu načítání. |
|
| completedAt |
string (date-time) |
Čas, kdy byla aktivita dokončena. |
| count |
integer (int32) |
Počet načtených dokumentů, které byly dostatečně relevantní pro překročení prahové hodnoty pro opětovné pořadí. |
| elapsedMs |
integer (int32) |
Čas, který uplynul v milisekundách pro aktivitu načítání. |
| error |
Chyba podrobně vysvětluje, proč se operace nezdařila. Tato vlastnost je zahrnuta pouze v případě, že aktivita není úspěšná. |
|
| id |
integer (int32) |
ID záznamu aktivity. |
| imageServing |
Statistiky o službě obrazů pro tuto obnovovací aktivitu |
|
| knowledgeSourceName |
string |
Zdroj znalostí pro vyhledávací aktivitu. |
| queryHintProcessing |
Podrobnosti o výrazech generovaných z dotazovacích nápověd pro tuto aktivitu. |
|
| queryTime |
string (date-time) |
Čas dotazu pro tuto aktivitu načítání. |
| startedAt |
string (date-time) |
Čas, kdy aktivita začala. |
| type |
string:
azure |
Typ záznamu aktivity. |
| warning |
string |
Varovná zpráva odhalující možné konfigurační problémy pozorované během aktivity, například dokumenty ztracené kvůli prahovému skórování, zkrácení limitu tokenů nebo podmínkám časového limitu. |
KnowledgeBaseAzureBlobReference
Představuje referenční informace k dokumentu služby Azure Blob Storage.
| Name | Typ | Description |
|---|---|---|
| activitySource |
integer (int32) |
ID zdrojové aktivity odkazu. |
| blobUrl |
string |
Adresa URL objektu blob pro referenci. |
| citationUrl |
string (uri) |
URL vlastněná Searchem, která ukazuje na podkladový dokument pro tuto referenci, použitelnou jako cílovou citaci. |
| id |
string |
ID odkazu. |
| rerankerScore |
number (float) |
Skóre opětovného hodnocení pro odkaz na dokument. |
| searchSensitivityLabelInfo |
Informace o citlivosti pro referenci. |
|
| sourceData |
Zdrojová data pro referenci. |
|
| type |
string:
azure |
Typ odkazu. |
KnowledgeBaseErrorAdditionalInfo
Další informace o chybě při správě prostředků
| Name | Typ | Description |
|---|---|---|
| info |
Další informace. |
|
| type |
string |
Další typ informací. |
KnowledgeBaseErrorDetail
Podrobnosti o chybě.
| Name | Typ | Description |
|---|---|---|
| additionalInfo |
Další informace o chybě. |
|
| code |
string |
Kód chyby. |
| details |
Podrobnosti o chybě. |
|
| message |
string |
Chybová zpráva. |
| target |
string |
Cíl chyby. |
KnowledgeBaseFabricDataAgentActivityArguments
Reprezentuje argumenty, se kterými byla aktivnost při získávání Fabric Data Agent spuštěna.
| Name | Typ | Description |
|---|---|---|
| search |
string |
Vyhledávací řetězec používaný k dotazování na zdroj znalostí Fabric Data Agent. |
KnowledgeBaseFabricDataAgentActivityRecord
Představuje záznam aktivity pro získání Fabric Data Agent.
| Name | Typ | Description |
|---|---|---|
| completedAt |
string (date-time) |
Čas, kdy byla aktivita dokončena. |
| count |
integer (int32) |
Počet načtených dokumentů, které byly dostatečně relevantní pro překročení prahové hodnoty pro opětovné pořadí. |
| elapsedMs |
integer (int32) |
Čas, který uplynul v milisekundách pro aktivitu načítání. |
| error |
Chyba podrobně vysvětluje, proč se operace nezdařila. Tato vlastnost je zahrnuta pouze v případě, že aktivita není úspěšná. |
|
| fabricDataAgentArguments |
Argumenty Fabric Data Agent pro aktivnost vyhledávání. |
|
| id |
integer (int32) |
ID záznamu aktivity. |
| imageServing |
Statistiky o službě obrazů pro tuto obnovovací aktivitu |
|
| knowledgeSourceName |
string |
Zdroj znalostí pro vyhledávací aktivitu. |
| queryTime |
string (date-time) |
Čas dotazu pro tuto aktivitu načítání. |
| startedAt |
string (date-time) |
Čas, kdy aktivita začala. |
| type |
string:
fabric |
Typ záznamu aktivity. |
| warning |
string |
Varovná zpráva odhalující možné konfigurační problémy pozorované během aktivity, například dokumenty ztracené kvůli prahovému skórování, zkrácení limitu tokenů nebo podmínkám časového limitu. |
KnowledgeBaseFabricDataAgentReference
Představuje referenci dokumentu Fabric Data Agent.
| Name | Typ | Description |
|---|---|---|
| activitySource |
integer (int32) |
ID zdrojové aktivity odkazu. |
| dataAgentId |
string |
ID Fabric Data Agent. |
| id |
string |
ID odkazu. |
| rerankerScore |
number (float) |
Skóre opětovného hodnocení pro odkaz na dokument. |
| sourceData |
Zdrojová data pro referenci. |
|
| type |
string:
fabric |
Typ odkazu. |
| workspaceId |
string |
ID pracovního prostoru Fabric. |
KnowledgeBaseFabricOntologyActivityArguments
Představuje argumenty, se kterými byla provedena aktivita vyhledávání Fabric Ontology.
| Name | Typ | Description |
|---|---|---|
| search |
string |
Vyhledávací řetězec používaný k dotazování na zdroj znalostí Fabric Ontology. |
KnowledgeBaseFabricOntologyActivityRecord
Představuje záznam aktivity vyhledávání Fabric Ontology.
| Name | Typ | Description |
|---|---|---|
| completedAt |
string (date-time) |
Čas, kdy byla aktivita dokončena. |
| count |
integer (int32) |
Počet načtených dokumentů, které byly dostatečně relevantní pro překročení prahové hodnoty pro opětovné pořadí. |
| elapsedMs |
integer (int32) |
Čas, který uplynul v milisekundách pro aktivitu načítání. |
| error |
Chyba podrobně vysvětluje, proč se operace nezdařila. Tato vlastnost je zahrnuta pouze v případě, že aktivita není úspěšná. |
|
| fabricOntologyArguments |
Argumenty Fabric Ontology podporují aktivitu vyhledávání. |
|
| id |
integer (int32) |
ID záznamu aktivity. |
| imageServing |
Statistiky o službě obrazů pro tuto obnovovací aktivitu |
|
| knowledgeSourceName |
string |
Zdroj znalostí pro vyhledávací aktivitu. |
| queryTime |
string (date-time) |
Čas dotazu pro tuto aktivitu načítání. |
| startedAt |
string (date-time) |
Čas, kdy aktivita začala. |
| type |
string:
fabric |
Typ záznamu aktivity. |
| warning |
string |
Varovná zpráva odhalující možné konfigurační problémy pozorované během aktivity, například dokumenty ztracené kvůli prahovému skórování, zkrácení limitu tokenů nebo podmínkám časového limitu. |
KnowledgeBaseFabricOntologyReference
Představuje referenci dokumentu Fabric Ontology.
| Name | Typ | Description |
|---|---|---|
| activitySource |
integer (int32) |
ID zdrojové aktivity odkazu. |
| id |
string |
ID odkazu. |
| ontologyId |
string |
Ontology ID v rámci pracovního prostoru. |
| rerankerScore |
number (float) |
Skóre opětovného hodnocení pro odkaz na dokument. |
| sourceData |
Zdrojová data pro referenci. |
|
| type |
string:
fabric |
Typ odkazu. |
| workspaceId |
string |
ID pracovního prostoru Fabric. |
KnowledgeBaseFileActivityArguments
Reprezentuje argumenty, se kterými byla aktivnost načtení souboru provedena.
| Name | Typ | Description |
|---|---|---|
| search |
string |
Vyhledávací řetězec používaný k dotazování obsahu souboru. |
KnowledgeBaseFileActivityRecord
Představuje záznam aktivity při získávání souboru.
| Name | Typ | Description |
|---|---|---|
| completedAt |
string (date-time) |
Čas, kdy byla aktivita dokončena. |
| count |
integer (int32) |
Počet načtených dokumentů, které byly dostatečně relevantní pro překročení prahové hodnoty pro opětovné pořadí. |
| elapsedMs |
integer (int32) |
Čas, který uplynul v milisekundách pro aktivitu načítání. |
| error |
Chyba podrobně vysvětluje, proč se operace nezdařila. Tato vlastnost je zahrnuta pouze v případě, že aktivita není úspěšná. |
|
| fileArguments |
Argumenty souboru pro aktivnost vyhledávání. |
|
| id |
integer (int32) |
ID záznamu aktivity. |
| imageServing |
Statistiky o službě obrazů pro tuto obnovovací aktivitu |
|
| knowledgeSourceName |
string |
Zdroj znalostí pro vyhledávací aktivitu. |
| queryHintProcessing |
Podrobnosti o výrazech generovaných z dotazovacích nápověd pro tuto aktivitu. |
|
| queryTime |
string (date-time) |
Čas dotazu pro tuto aktivitu načítání. |
| startedAt |
string (date-time) |
Čas, kdy aktivita začala. |
| type |
string:
file |
Typ záznamu aktivity. |
| warning |
string |
Varovná zpráva odhalující možné konfigurační problémy pozorované během aktivity, například dokumenty ztracené kvůli prahovému skórování, zkrácení limitu tokenů nebo podmínkám časového limitu. |
KnowledgeBaseFileReference
Představuje odkaz na dokument souboru.
| Name | Typ | Description |
|---|---|---|
| activitySource |
integer (int32) |
ID zdrojové aktivity odkazu. |
| citationUrl |
string (uri) |
URL vlastněná Searchem, která ukazuje na podkladový dokument pro tuto referenci, použitelnou jako cílovou citaci. |
| docName |
string |
Název dokumentu pro referenci. |
| id |
string |
ID odkazu. |
| rerankerScore |
number (float) |
Skóre opětovného hodnocení pro odkaz na dokument. |
| sourceData |
Zdrojová data pro referenci. |
|
| type |
string:
file |
Typ odkazu. |
KnowledgeBaseImageContent
Obsah.
| Name | Typ | Description |
|---|---|---|
| url |
string (uri) |
Adresa URL obrázku. |
KnowledgeBaseIndexedOneLakeActivityArguments
Reprezentuje argumenty, se kterými byla spuštěna indexovaná aktivita vyhledávání OneLake.
| Name | Typ | Description |
|---|---|---|
| search |
string |
Vyhledávací řetězec používaný k dotazování na obsah indexovaného OneLake. |
KnowledgeBaseIndexedOneLakeActivityRecord
Představuje indexovaný záznam o vyhledání OneLake.
| Name | Typ | Description |
|---|---|---|
| completedAt |
string (date-time) |
Čas, kdy byla aktivita dokončena. |
| count |
integer (int32) |
Počet načtených dokumentů, které byly dostatečně relevantní pro překročení prahové hodnoty pro opětovné pořadí. |
| elapsedMs |
integer (int32) |
Čas, který uplynul v milisekundách pro aktivitu načítání. |
| error |
Chyba podrobně vysvětluje, proč se operace nezdařila. Tato vlastnost je zahrnuta pouze v případě, že aktivita není úspěšná. |
|
| id |
integer (int32) |
ID záznamu aktivity. |
| imageServing |
Statistiky o službě obrazů pro tuto obnovovací aktivitu |
|
| indexedOneLakeArguments |
Indexované OneLake argumenty pro aktivnost vyhledávání. |
|
| knowledgeSourceName |
string |
Zdroj znalostí pro vyhledávací aktivitu. |
| queryHintProcessing |
Podrobnosti o výrazech generovaných z dotazovacích nápověd pro tuto aktivitu. |
|
| queryTime |
string (date-time) |
Čas dotazu pro tuto aktivitu načítání. |
| startedAt |
string (date-time) |
Čas, kdy aktivita začala. |
| type |
string:
indexed |
Typ záznamu aktivity. |
| warning |
string |
Varovná zpráva odhalující možné konfigurační problémy pozorované během aktivity, například dokumenty ztracené kvůli prahovému skórování, zkrácení limitu tokenů nebo podmínkám časového limitu. |
KnowledgeBaseIndexedOneLakeReference
Představuje indexovaný odkaz na dokument OneLake.
| Name | Typ | Description |
|---|---|---|
| activitySource |
integer (int32) |
ID zdrojové aktivity odkazu. |
| citationUrl |
string (uri) |
URL vlastněná Searchem, která ukazuje na podkladový dokument pro tuto referenci, použitelnou jako cílovou citaci. |
| docUrl |
string |
Adresa URL dokumentu pro referenci. |
| id |
string |
ID odkazu. |
| rerankerScore |
number (float) |
Skóre opětovného hodnocení pro odkaz na dokument. |
| searchSensitivityLabelInfo |
Informace o citlivosti pro referenci. |
|
| sourceData |
Zdrojová data pro referenci. |
|
| type |
string:
indexed |
Typ odkazu. |
KnowledgeBaseIndexedSharePointActivityArguments
Představuje argumenty, se kterými byla spuštěna indexovaná aktivita vyhledávání SharePointu.
| Name | Typ | Description |
|---|---|---|
| search |
string |
Vyhledávací řetězec používaný k dotazování indexovaného obsahu SharePointu. |
KnowledgeBaseIndexedSharePointActivityRecord
Představuje indexovaný záznam aktivity vyhledávání v SharePointu.
| Name | Typ | Description |
|---|---|---|
| completedAt |
string (date-time) |
Čas, kdy byla aktivita dokončena. |
| count |
integer (int32) |
Počet načtených dokumentů, které byly dostatečně relevantní pro překročení prahové hodnoty pro opětovné pořadí. |
| elapsedMs |
integer (int32) |
Čas, který uplynul v milisekundách pro aktivitu načítání. |
| error |
Chyba podrobně vysvětluje, proč se operace nezdařila. Tato vlastnost je zahrnuta pouze v případě, že aktivita není úspěšná. |
|
| id |
integer (int32) |
ID záznamu aktivity. |
| imageServing |
Statistiky o službě obrazů pro tuto obnovovací aktivitu |
|
| indexedSharePointArguments |
Indexované argumenty SharePointu pro aktivnost vyhledávání. |
|
| knowledgeSourceName |
string |
Zdroj znalostí pro vyhledávací aktivitu. |
| queryHintProcessing |
Podrobnosti o výrazech generovaných z dotazovacích nápověd pro tuto aktivitu. |
|
| queryTime |
string (date-time) |
Čas dotazu pro tuto aktivitu načítání. |
| startedAt |
string (date-time) |
Čas, kdy aktivita začala. |
| type |
string:
indexed |
Typ záznamu aktivity. |
| warning |
string |
Varovná zpráva odhalující možné konfigurační problémy pozorované během aktivity, například dokumenty ztracené kvůli prahovému skórování, zkrácení limitu tokenů nebo podmínkám časového limitu. |
KnowledgeBaseIndexedSharePointReference
Představuje indexovaný odkaz na dokument SharePoint.
| Name | Typ | Description |
|---|---|---|
| activitySource |
integer (int32) |
ID zdrojové aktivity odkazu. |
| citationUrl |
string (uri) |
URL vlastněná Searchem, která ukazuje na podkladový dokument pro tuto referenci, použitelnou jako cílovou citaci. |
| docUrl |
string |
Adresa URL dokumentu pro referenci. |
| id |
string |
ID odkazu. |
| rerankerScore |
number (float) |
Skóre opětovného hodnocení pro odkaz na dokument. |
| searchSensitivityLabelInfo |
Informace o citlivosti pro referenci. |
|
| sourceData |
Zdrojová data pro referenci. |
|
| type |
string:
indexed |
Typ odkazu. |
KnowledgeBaseIndexedSqlActivityArguments
Reprezentuje argumenty, se kterými byla spuštěna aktivita indexovaného vyhledávání SQL.
| Name | Typ | Description |
|---|---|---|
| search |
string |
Vyhledávací řetězec používaný k dotazování indexovaného obsahu SQL. |
KnowledgeBaseIndexedSqlActivityRecord
Představuje indexovaný záznam SQL retrieval aktivity.
| Name | Typ | Description |
|---|---|---|
| completedAt |
string (date-time) |
Čas, kdy byla aktivita dokončena. |
| count |
integer (int32) |
Počet načtených dokumentů, které byly dostatečně relevantní pro překročení prahové hodnoty pro opětovné pořadí. |
| elapsedMs |
integer (int32) |
Čas, který uplynul v milisekundách pro aktivitu načítání. |
| error |
Chyba podrobně vysvětluje, proč se operace nezdařila. Tato vlastnost je zahrnuta pouze v případě, že aktivita není úspěšná. |
|
| id |
integer (int32) |
ID záznamu aktivity. |
| imageServing |
Statistiky o službě obrazů pro tuto obnovovací aktivitu |
|
| indexedSqlArguments |
Indexované SQL argumenty pro aktivitu vyhledávání. |
|
| knowledgeSourceName |
string |
Zdroj znalostí pro vyhledávací aktivitu. |
| queryHintProcessing |
Podrobnosti o výrazech generovaných z dotazovacích nápověd pro tuto aktivitu. |
|
| queryTime |
string (date-time) |
Čas dotazu pro tuto aktivitu načítání. |
| startedAt |
string (date-time) |
Čas, kdy aktivita začala. |
| type |
string:
indexed |
Typ záznamu aktivity. |
| warning |
string |
Varovná zpráva odhalující možné konfigurační problémy pozorované během aktivity, například dokumenty ztracené kvůli prahovému skórování, zkrácení limitu tokenů nebo podmínkám časového limitu. |
KnowledgeBaseIndexedSqlReference
Představuje referenční dokument Azure SQL.
| Name | Typ | Description |
|---|---|---|
| activitySource |
integer (int32) |
ID zdrojové aktivity odkazu. |
| citationUrl |
string (uri) |
URL vlastněná Searchem, která ukazuje na podkladový dokument pro tuto referenci, použitelnou jako cílovou citaci. |
| docUrl |
string |
Adresa URL dokumentu pro referenci. |
| id |
string |
ID odkazu. |
| rerankerScore |
number (float) |
Skóre opětovného hodnocení pro odkaz na dokument. |
| sourceData |
Zdrojová data pro referenci. |
|
| type |
string:
indexed |
Typ odkazu. |
KnowledgeBaseMcpServerActivityArguments
Představuje argumenty, se kterými byla aktivnost načítání MCP serveru provedena.
| Name | Typ | Description |
|---|---|---|
| toolArguments |
Argumenty byly předávány nástroji MCP serveru. |
|
| toolName |
string |
Název nástroje MCP serveru používaného pro tuto aktivitu vyhledávání. |
KnowledgeBaseMcpServerActivityRecord
Představuje záznam o načítání MCP serveru.
| Name | Typ | Description |
|---|---|---|
| completedAt |
string (date-time) |
Čas, kdy byla aktivita dokončena. |
| count |
integer (int32) |
Počet načtených dokumentů, které byly dostatečně relevantní pro překročení prahové hodnoty pro opětovné pořadí. |
| elapsedMs |
integer (int32) |
Čas, který uplynul v milisekundách pro aktivitu načítání. |
| error |
Chyba podrobně vysvětluje, proč se operace nezdařila. Tato vlastnost je zahrnuta pouze v případě, že aktivita není úspěšná. |
|
| id |
integer (int32) |
ID záznamu aktivity. |
| imageServing |
Statistiky o službě obrazů pro tuto obnovovací aktivitu |
|
| knowledgeSourceName |
string |
Zdroj znalostí pro vyhledávací aktivitu. |
| mcpServerArguments |
Argumenty MCP serveru pro aktivnost získávání. |
|
| queryTime |
string (date-time) |
Čas dotazu pro tuto aktivitu načítání. |
| startedAt |
string (date-time) |
Čas, kdy aktivita začala. |
| type |
string:
mcp |
Typ záznamu aktivity. |
| warning |
string |
Varovná zpráva odhalující možné konfigurační problémy pozorované během aktivity, například dokumenty ztracené kvůli prahovému skórování, zkrácení limitu tokenů nebo podmínkám časového limitu. |
KnowledgeBaseMcpServerReference
Představuje referenci dokumentu MCP serveru.
| Name | Typ | Description |
|---|---|---|
| activitySource |
integer (int32) |
ID zdrojové aktivity odkazu. |
| id |
string |
ID odkazu. |
| rerankerScore |
number (float) |
Skóre opětovného hodnocení pro odkaz na dokument. |
| sourceData |
Zdrojová data pro referenci. |
|
| title |
string |
Název výsledku nástroje MCP server. |
| toolName |
string |
Název MCP serverového nástroje, který generoval tuto referenci. |
| type |
string:
mcp |
Typ odkazu. |
KnowledgeBaseMessage
Objekt stylu zprávy v přirozeném jazyce.
| Name | Typ | Description |
|---|---|---|
| content | KnowledgeBaseMessageContent[]: |
Obsah zprávy. |
| role |
string |
Role odezvy nástroje. |
KnowledgeBaseMessageContentType
Typ obsahu zprávy.
| Hodnota | Description |
|---|---|
| text |
Druh obsahu textové zprávy. |
| image |
Druh obsahu obrazové zprávy. |
KnowledgeBaseMessageImageContent
Typ obrazové zprávy.
| Name | Typ | Description |
|---|---|---|
| image |
Obsah obrázků. |
|
| type |
string:
image |
Typ zprávy |
KnowledgeBaseMessageTextContent
Typ textové zprávy.
| Name | Typ | Description |
|---|---|---|
| text |
string |
Textový obsah. |
| type |
string:
text |
Typ zprávy |
KnowledgeBaseModelAnswerSynthesisActivityRecord
Představuje záznam aktivity syntézy odpovědí LLM.
| Name | Typ | Description |
|---|---|---|
| completedAt |
string (date-time) |
Čas, kdy byla aktivita dokončena. |
| elapsedMs |
integer (int32) |
Čas, který uplynul v milisekundách pro aktivitu načítání. |
| error |
Chyba podrobně vysvětluje, proč se operace nezdařila. Tato vlastnost je zahrnuta pouze v případě, že aktivita není úspěšná. |
|
| id |
integer (int32) |
ID záznamu aktivity. |
| inputTokens |
integer (int32) |
Počet vstupních tokenů pro aktivitu syntézy odpovědí LLM. |
| model |
Model používaný pro aktivitu syntézy odpovědí v LLM. |
|
| outputTokens |
integer (int32) |
Počet výstupních tokenů pro aktivitu syntézy odpovědí LLM. |
| startedAt |
string (date-time) |
Čas, kdy aktivita začala. |
| type |
string:
model |
Typ záznamu aktivity. |
| warning |
string |
Varovná zpráva odhalující možné konfigurační problémy pozorované během aktivity, například dokumenty ztracené kvůli prahovému skórování, zkrácení limitu tokenů nebo podmínkám časového limitu. |
KnowledgeBaseModelQueryPlanningActivityRecord
Představuje záznam aktivity plánování dotazu LLM.
| Name | Typ | Description |
|---|---|---|
| completedAt |
string (date-time) |
Čas, kdy byla aktivita dokončena. |
| elapsedMs |
integer (int32) |
Čas, který uplynul v milisekundách pro aktivitu načítání. |
| error |
Chyba podrobně vysvětluje, proč se operace nezdařila. Tato vlastnost je zahrnuta pouze v případě, že aktivita není úspěšná. |
|
| id |
integer (int32) |
ID záznamu aktivity. |
| inputTokens |
integer (int32) |
Počet vstupních tokenů pro aktivitu plánování dotazů LLM. |
| model |
Model používaný pro plánování dotazů v LLM. |
|
| outputTokens |
integer (int32) |
Počet výstupních tokenů pro aktivitu plánování dotazů LLM. |
| startedAt |
string (date-time) |
Čas, kdy aktivita začala. |
| type |
string:
model |
Typ záznamu aktivity. |
| warning |
string |
Varovná zpráva odhalující možné konfigurační problémy pozorované během aktivity, například dokumenty ztracené kvůli prahovému skórování, zkrácení limitu tokenů nebo podmínkám časového limitu. |
KnowledgeBaseModelWebSummarizationActivityRecord
Představuje záznam aktivity webové sumarizace LLM.
| Name | Typ | Description |
|---|---|---|
| completedAt |
string (date-time) |
Čas, kdy byla aktivita dokončena. |
| elapsedMs |
integer (int32) |
Čas, který uplynul v milisekundách pro aktivitu načítání. |
| error |
Chyba podrobně vysvětluje, proč se operace nezdařila. Tato vlastnost je zahrnuta pouze v případě, že aktivita není úspěšná. |
|
| id |
integer (int32) |
ID záznamu aktivity. |
| inputTokens |
integer (int32) |
Počet vstupních tokenů pro aktivitu webové sumarizace LLM. |
| model |
Model použitý pro aktivitu shrnutí webu LLM. |
|
| outputTokens |
integer (int32) |
Počet výstupních tokenů pro aktivitu shrnutí webu LLM. |
| startedAt |
string (date-time) |
Čas, kdy aktivita začala. |
| type |
string:
model |
Typ záznamu aktivity. |
| warning |
string |
Varovná zpráva odhalující možné konfigurační problémy pozorované během aktivity, například dokumenty ztracené kvůli prahovému skórování, zkrácení limitu tokenů nebo podmínkám časového limitu. |
KnowledgeBaseQueryHintProcessing
Podrobnosti o výrazech generovaných z dotazovacích nápověd pro aktivnost vyhledávání.
| Name | Typ | Description |
|---|---|---|
| generatedBoost |
string |
Vyhledávací klauzule vytvořená z boost nápověd pro tuto aktivitu. |
| generatedFilter |
string |
Filtrační výraz generovaný z filtračních nápověd pro tuto aktivitu. |
KnowledgeBaseReferenceType
Typ odkazu.
| Hodnota | Description |
|---|---|
| searchIndex |
Vyhledejte index, reference dokumentu. |
| azureBlob |
Azure Blob document reference. |
| indexedSharePoint |
Indexovaná reference na dokumenty SharePoint. |
| indexedOneLake |
Indexovaný dokument OneLake. |
| web |
Odkaz na webový dokument. |
| remoteSharePoint |
Reference dokumentů v Remote SharePoint. |
| workIQ |
Reference na dokument o pracovním IQ. |
| fabricDataAgent |
Reference dokumentu Fabric Data Agent. |
| fabricOntology |
Reference dokumentu Fabric Ontology. |
| mcpServer |
Reference na dokument MCP serveru. |
| file |
Odkaz na dokument. |
| indexedSql |
Indexovaný SQL dokument. |
KnowledgeBaseRemoteSharePointActivityArguments
Představuje argumenty, se kterými byla aktivnost vzdáleného vyhledávání SharePointu spuštěna.
| Name | Typ | Description |
|---|---|---|
| filterExpressionAddOn |
string |
Filtrační výrazový doplněk pro retrievalní aktivitu. |
| search |
string |
Vyhledávací řetězec používaný k dotazování vzdáleného zdroje znalostí SharePointu. |
KnowledgeBaseRemoteSharePointActivityRecord
Představuje záznam vzdálené aktivity pro vyhledávání SharePointu.
| Name | Typ | Description |
|---|---|---|
| completedAt |
string (date-time) |
Čas, kdy byla aktivita dokončena. |
| count |
integer (int32) |
Počet načtených dokumentů, které byly dostatečně relevantní pro překročení prahové hodnoty pro opětovné pořadí. |
| elapsedMs |
integer (int32) |
Čas, který uplynul v milisekundách pro aktivitu načítání. |
| error |
Chyba podrobně vysvětluje, proč se operace nezdařila. Tato vlastnost je zahrnuta pouze v případě, že aktivita není úspěšná. |
|
| id |
integer (int32) |
ID záznamu aktivity. |
| imageServing |
Statistiky o službě obrazů pro tuto obnovovací aktivitu |
|
| knowledgeSourceName |
string |
Zdroj znalostí pro vyhledávací aktivitu. |
| queryTime |
string (date-time) |
Čas dotazu pro tuto aktivitu načítání. |
| remoteSharePointArguments |
Argumenty vzdáleného SharePointu pro aktivnost vyhledávání. |
|
| startedAt |
string (date-time) |
Čas, kdy aktivita začala. |
| type |
string:
remote |
Typ záznamu aktivity. |
| warning |
string |
Varovná zpráva odhalující možné konfigurační problémy pozorované během aktivity, například dokumenty ztracené kvůli prahovému skórování, zkrácení limitu tokenů nebo podmínkám časového limitu. |
KnowledgeBaseRemoteSharePointReference
Představuje odkaz na vzdálený dokument služby SharePoint.
| Name | Typ | Description |
|---|---|---|
| activitySource |
integer (int32) |
ID zdrojové aktivity odkazu. |
| id |
string |
ID odkazu. |
| rerankerScore |
number (float) |
Skóre opětovného hodnocení pro odkaz na dokument. |
| searchSensitivityLabelInfo |
Informace o citlivosti pro referenci. |
|
| sourceData |
Zdrojová data pro referenci. |
|
| type |
string:
remote |
Typ odkazu. |
| webUrl |
string (uri) |
Adresa URL, ze které pocházejí referenční data. |
KnowledgeBaseRetrievalRequest
Vstupní kontrakt pro požadavek na načtení.
| Name | Typ | Description |
|---|---|---|
| includeActivity |
boolean |
Označuje, že výsledky načítání by měly obsahovat informace o aktivitě. |
| intents | KnowledgeRetrievalIntent[]: |
Seznam zamýšlených dotazů, které mají být provedeny bez plánování dotazů na model. |
| knowledgeSourceParams |
KnowledgeSourceParams[]:
|
Seznam běhových parametrů pro znalostní zdroje. |
| maxOutputDocuments |
integer (int32) |
Omezuje maximální počet dokumentů ve výstupu. |
| maxOutputSize |
integer (int32) |
Omezuje maximální velikost obsahu ve výstupu. |
| maxOutputSizeInTokens |
integer (int32) |
Omezuje maximální velikost obsahu ve výstupu. |
| maxRuntimeInSeconds |
integer (int32) |
Maximální doba běhu v sekundách. |
| messages |
Seznam vstupů ve stylu chatových zpráv. |
|
| outputMode |
Výstupní konfigurace pro toto načtení. |
|
| retrievalReasoningEffort | KnowledgeRetrievalReasoningEffort: |
Konfigurace úsilí o vyhledávání a uvažování. |
KnowledgeBaseRetrievalResponse
Výstupní kontrakt pro odpověď na načtení.
KnowledgeBaseSearchIndexActivityArguments
Představuje argumenty, se kterými byla spuštěna aktivita načítání vyhledávacího indexu.
| Name | Typ | Description |
|---|---|---|
| filter |
string |
Řetězec filtru. |
| queryType |
Syntax dotazu použitá k provedení vyhledávání. Query hints mohou způsobit, že sémantické dotazy používají plnou syntaxi dotazu. |
|
| search |
string |
Hledaný řetězec použitý k dotazování na vyhledávací index. |
| searchFields |
Na jakých polích se prohledávalo. |
|
| semanticConfigurationName |
string |
Jaká sémantická konfigurace byla použita z vyhledávacího indexu. |
| sourceDataFields |
Jaká pole byla vybrána pro vyhledávání. |
KnowledgeBaseSearchIndexActivityRecord
Představuje záznam aktivity načítání indexu vyhledávání.
| Name | Typ | Description |
|---|---|---|
| completedAt |
string (date-time) |
Čas, kdy byla aktivita dokončena. |
| count |
integer (int32) |
Počet načtených dokumentů, které byly dostatečně relevantní pro překročení prahové hodnoty pro opětovné pořadí. |
| elapsedMs |
integer (int32) |
Čas, který uplynul v milisekundách pro aktivitu načítání. |
| error |
Chyba podrobně vysvětluje, proč se operace nezdařila. Tato vlastnost je zahrnuta pouze v případě, že aktivita není úspěšná. |
|
| id |
integer (int32) |
ID záznamu aktivity. |
| imageServing |
Statistiky o službě obrazů pro tuto obnovovací aktivitu |
|
| knowledgeSourceName |
string |
Zdroj znalostí pro vyhledávací aktivitu. |
| queryHintProcessing |
Podrobnosti o výrazech generovaných z dotazovacích nápověd pro tuto aktivitu. |
|
| queryTime |
string (date-time) |
Čas dotazu pro tuto aktivitu načítání. |
| searchIndexArguments |
Argumenty indexu vyhledávání pro aktivnost vyhledávání. |
|
| startedAt |
string (date-time) |
Čas, kdy aktivita začala. |
| type |
string:
search |
Typ záznamu aktivity. |
| warning |
string |
Varovná zpráva odhalující možné konfigurační problémy pozorované během aktivity, například dokumenty ztracené kvůli prahovému skórování, zkrácení limitu tokenů nebo podmínkám časového limitu. |
KnowledgeBaseSearchIndexReference
Představuje referenční dokument Azure Search.
| Name | Typ | Description |
|---|---|---|
| activitySource |
integer (int32) |
ID zdrojové aktivity odkazu. |
| citationUrl |
string (uri) |
URL vlastněná Searchem, která ukazuje na podkladový dokument pro tuto referenci, použitelnou jako cílovou citaci. |
| docKey |
string |
Klíč dokumentu pro odkaz. |
| id |
string |
ID odkazu. |
| rerankerScore |
number (float) |
Skóre opětovného hodnocení pro odkaz na dokument. |
| searchSensitivityLabelInfo |
Informace o citlivosti pro referenci. |
|
| sourceData |
Zdrojová data pro referenci. |
|
| type |
string:
search |
Typ odkazu. |
KnowledgeBaseWebActivityArguments
Představuje argumenty, se kterými byla aktivita webového vyhledávání spuštěna.
| Name | Typ | Description |
|---|---|---|
| count |
integer (int32) |
Počet vrácených webových výsledků. |
| freshness |
string |
Čerstvost pro vynášení. |
| language |
string |
Jazyk pro vyhledávací aktivitu. |
| market |
string |
Trh pro aktivitu získávání. |
| search |
string |
Vyhledávací řetězec používaný k dotazování na webu. |
KnowledgeBaseWebActivityRecord
Představuje záznam o aktivitách vyhledávání na webu.
| Name | Typ | Description |
|---|---|---|
| completedAt |
string (date-time) |
Čas, kdy byla aktivita dokončena. |
| count |
integer (int32) |
Počet načtených dokumentů, které byly dostatečně relevantní pro překročení prahové hodnoty pro opětovné pořadí. |
| elapsedMs |
integer (int32) |
Čas, který uplynul v milisekundách pro aktivitu načítání. |
| error |
Chyba podrobně vysvětluje, proč se operace nezdařila. Tato vlastnost je zahrnuta pouze v případě, že aktivita není úspěšná. |
|
| id |
integer (int32) |
ID záznamu aktivity. |
| imageServing |
Statistiky o službě obrazů pro tuto obnovovací aktivitu |
|
| knowledgeSourceName |
string |
Zdroj znalostí pro vyhledávací aktivitu. |
| queryTime |
string (date-time) |
Čas dotazu pro tuto aktivitu načítání. |
| startedAt |
string (date-time) |
Čas, kdy aktivita začala. |
| type |
string:
web |
Typ záznamu aktivity. |
| warning |
string |
Varovná zpráva odhalující možné konfigurační problémy pozorované během aktivity, například dokumenty ztracené kvůli prahovému skórování, zkrácení limitu tokenů nebo podmínkám časového limitu. |
| webArguments |
Web argumentuje pro aktivitu vyhledávání. |
KnowledgeBaseWebReference
Představuje odkaz na webový dokument.
| Name | Typ | Description |
|---|---|---|
| activitySource |
integer (int32) |
ID zdrojové aktivity odkazu. |
| id |
string |
ID odkazu. |
| rerankerScore |
number (float) |
Skóre opětovného hodnocení pro odkaz na dokument. |
| sourceData |
Zdrojová data pro referenci. |
|
| title |
string |
Název webového dokumentu. |
| type |
string:
web |
Typ odkazu. |
| url |
string (uri) |
Adresa URL, ze které pocházejí referenční data. |
KnowledgeBaseWorkIQActivityArguments
Představuje argumenty, se kterými byla aktivnost vyhledávání WorkIQ spuštěna.
| Name | Typ | Description |
|---|---|---|
| search |
string |
Vyhledávací řetězec používaný k dotazování na zdroj znalostí WorkIQ. |
KnowledgeBaseWorkIQActivityRecord
Představuje záznam aktivity vyhledávání ve WorkIQ.
| Name | Typ | Description |
|---|---|---|
| completedAt |
string (date-time) |
Čas, kdy byla aktivita dokončena. |
| count |
integer (int32) |
Počet načtených dokumentů, které byly dostatečně relevantní pro překročení prahové hodnoty pro opětovné pořadí. |
| elapsedMs |
integer (int32) |
Čas, který uplynul v milisekundách pro aktivitu načítání. |
| error |
Chyba podrobně vysvětluje, proč se operace nezdařila. Tato vlastnost je zahrnuta pouze v případě, že aktivita není úspěšná. |
|
| id |
integer (int32) |
ID záznamu aktivity. |
| imageServing |
Statistiky o službě obrazů pro tuto obnovovací aktivitu |
|
| knowledgeSourceName |
string |
Zdroj znalostí pro vyhledávací aktivitu. |
| queryTime |
string (date-time) |
Čas dotazu pro tuto aktivitu načítání. |
| startedAt |
string (date-time) |
Čas, kdy aktivita začala. |
| type |
string:
workIQ |
Typ záznamu aktivity. |
| warning |
string |
Varovná zpráva odhalující možné konfigurační problémy pozorované během aktivity, například dokumenty ztracené kvůli prahovému skórování, zkrácení limitu tokenů nebo podmínkám časového limitu. |
| workIQArguments |
WorkIQ argumenty pro aktivnost vyhledávání. |
KnowledgeBaseWorkIQReference
Představuje referenci na dokument WorkIQ.
| Name | Typ | Description |
|---|---|---|
| activitySource |
integer (int32) |
ID zdrojové aktivity odkazu. |
| id |
string |
ID odkazu. |
| rerankerScore |
number (float) |
Skóre opětovného hodnocení pro odkaz na dokument. |
| searchSensitivityLabelInfo |
Informace o citlivosti pro referenci. |
|
| sourceData |
Zdrojová data pro referenci. |
|
| type |
string:
workIQ |
Typ odkazu. |
KnowledgeRetrievalAutoReasoningEffort
Automaticky vyberte úsilí při vyhledání uvažování. Služba zase zasílá každou žádost na nejlevnější úrovni a eskaluje pouze do míry potřeba, až do maximální dostupné úrovně služby.
| Name | Typ | Description |
|---|---|---|
| kind |
string:
auto |
Druh úsilí o uvažování. |
KnowledgeRetrievalIntentType
Druh konfigurace znalostní báze, který se má použít.
| Hodnota | Description |
|---|---|
| semantic |
Záměr sémantického dotazu v přirozeném jazyce. |
KnowledgeRetrievalLowReasoningEffort
Provádějte načítání znalostí s nízkým úsilím při uvažování.
| Name | Typ | Description |
|---|---|---|
| kind |
string:
low |
Druh úsilí o uvažování. |
KnowledgeRetrievalMediumReasoningEffort
Spusťte získávání znalostí se středním úsilím při uvažování.
| Name | Typ | Description |
|---|---|---|
| kind |
string:
medium |
Druh úsilí o uvažování. |
KnowledgeRetrievalMinimalReasoningEffort
Spouštějte načítání znalostí s minimálním úsilím při uvažování.
| Name | Typ | Description |
|---|---|---|
| kind |
string:
minimal |
Druh úsilí o uvažování. |
KnowledgeRetrievalOutputMode
Výstupní konfigurace pro toto načtení.
| Hodnota | Description |
|---|---|
| extractiveData |
Vraťte data ze zdrojů znalostí přímo bez generativních změn. |
| answerSynthesis |
Syntetizuje odpověď pro datovou část odpovědi. |
KnowledgeRetrievalReasoningEffortKind
Množství úsilí, které je třeba vynaložit při načítání.
| Hodnota | Description |
|---|---|
| minimal |
Neprovádí žádné výběry zdrojů, plánování dotazů ani iterativní vyhledávání. |
| low |
Při načítání používejte nízké uvažování. |
| medium |
Při načítání používejte mírné množství uvažování. |
| auto |
Automaticky zvolte úsilí o uvažování při získávání, postupně postupujte od nejlevnější úrovně jen tak daleko, jak je potřeba. |
KnowledgeRetrievalSemanticIntent
Záměr sémantického dotazu.
| Name | Typ | Description |
|---|---|---|
| search |
string |
Sémantický dotaz ke spuštění |
| type |
string:
semantic |
Typ záměru. |
KnowledgeSourceKind
Druh zdroje znalostí.
| Hodnota | Description |
|---|---|
| searchIndex |
Zdroj znalostí, který čte data z indexu vyhledávání. |
| azureBlob |
Zdroj znalostí, který čte a ingestuje data z Azure Blob Storage do indexu vyhledávání. |
| indexedSharePoint |
Zdroj znalostí, který čte data z indexovaného SharePointu. |
| indexedOneLake |
Zdroj znalostí, který čte data z indexovaného OneLake. |
| indexedSql |
Zdroj znalostí, který získává a zpracovává data z Azure SQL Database nebo SQL Managed Instance do vyhledávacího indexu. |
| web |
Zdroj znalostí, který čte data z webu. |
| remoteSharePoint |
Zdroj znalostí, který čte data z vzdáleného SharePointu. |
| workIQ |
Zdroj znalostí, který čte data z pracovního IQ |
| file |
Zdroj znalostí, který podporuje přímé nahrávání a indexování souborů. |
| mcpServer |
Zdroj znalostí podporovaný serverem MCP (Model Context Protocol). |
| fabricDataAgent |
Zdroj znalostí, který získává data z Fabric Data Agent. |
| fabricOntology |
Zdroj znalostí, který získává data z ontologií Microsoft Fabric Ontology. |
KnowledgeSourceResultsProcessing
Ovládá, zda jsou výsledky zdroje znalostí přeřazeny.
| Hodnota | Description |
|---|---|
| rerank |
Výsledky z tohoto zdroje znalostí procházejí procesem přeřazení. Toto je výchozí chování. |
| none |
Výsledky z tohoto zdroje znalostí obcházejí přeřazení a zachovávají jejich základní pořadí. |
McpServerKnowledgeSourceParams
Specifikuje parametry běhu pro zdroj znalostí MCP serveru
| Name | Typ | Description |
|---|---|---|
| alwaysQuerySource |
boolean |
Označuje, že tento zdroj znalostí by měl obejít výběr zdroje a vždy se na něj dotazovat při načítání. |
| enableImageServing |
boolean |
Uvádí, zda by mělo být při vyhledávání pro tento zdroj znalostí povoleno servisování obrazů. Pokud je to pravda, jsou obrázky extrahované při pojetí doručeny do modelů za nimi. |
| failOnError |
boolean |
Označuje, že celý požadavek na vyhledání by měl selhat, pokud načtení z tohoto zdroje znalostí narazí na chybu. Výchozí nastavení je „false“. |
| includeReferenceSourceData |
boolean |
Označuje, zda mají odkazy ve své datové části obsahovat strukturovaná data získaná během načítání. |
| includeReferences |
boolean |
Označuje, zda mají být zahrnuty odkazy pro data načtená z tohoto zdroje. |
| kind |
string:
mcp |
Typ zdroje znalostí. |
| knowledgeSourceName |
string |
Název indexu, na který se parametry vztahují. |
| maxOutputDocuments |
integer (int32) |
Omezuje maximální počet dokumentů vrácených z tohoto zdroje znalostí. |
| neverQuerySource |
boolean |
Označuje, že tento zdroj znalostí by měl být vyloučen z kandidátní sady požadavku a nikdy by neměl být dotazován při vyhledání. Vyloučení je na žádost lokální a nemění členství ve znalostní báze. Nelze jej kombinovat s alwaysQuerySource na stejném zdroji znalostí. |
| rerankerThreshold |
number (float) |
Prahová hodnota opětovného pořadí, kterou musí splňovat všechny načtené dokumenty, aby mohly být zahrnuty do odpovědi. |
| resultsProcessing |
Přepisuje uložené výsledky zdroje znalostí Zpracování pouze pro tento vyvolávací volání. Pokud je vynechán, platí hodnota zdrojového zdroje uložených znalostí. |
PurviewSensitivityLabelInfo
Informace o citlivém štítku aplikovaném na dokument
| Name | Typ | Description |
|---|---|---|
| color |
string |
Barva, kterou má uživatelské rozhraní zobrazit pro popisek, pokud je nakonfigurováno. |
| displayName |
string |
Zobrazovaný název popisku citlivosti. |
| isEncrypted |
boolean |
Označuje, jestli popisek citlivosti vynucuje šifrování. |
| priority |
integer (int32) |
Priorita, ve které se popisek citlivosti použije. |
| sensitivityLabelId |
string |
ID popisku citlivosti. |
| toolTip |
string |
Popisek nástroje, který by se měl zobrazit pro popisek v uživatelském rozhraní. |
QueryType
Určuje syntaxi vyhledávacího dotazu. Výchozí hodnota je 'simple'. Pokud dotaz používá syntaxi dotazu Lucene, použijte hodnotu "úplná", pokud syntaxi dotazu nepotřebujete, použijte hodnotu "sémantická".
| Hodnota | Description |
|---|---|
| simple |
Pro vyhledávání používá jednoduchou syntaxi dotazu. Hledaný text je interpretován pomocí jednoduchého dotazovacího jazyka, který umožňuje symboly jako +, * a "". Dotazy jsou ve výchozím nastavení vyhodnocovány ve všech prohledávatelných polích, pokud není zadán parametr searchFields. |
| full |
Pro vyhledávání používá úplnou syntaxi dotazu Lucene. Hledaný text je interpretován pomocí dotazovacího jazyka Lucene, který umožňuje vyhledávání specifické pro dané pole a vážené a další pokročilé funkce. |
| semantic |
Nejvhodnější pro dotazy vyjádřené v přirozeném jazyce na rozdíl od klíčových slov. Zlepšuje přesnost výsledků vyhledávání změnou pořadí nejlepších výsledků vyhledávání pomocí modelu hodnocení natrénovaného na webovém korpusu. |
RemoteSharePointKnowledgeSourceParams
Určuje parametry běhového prostředí pro vzdálený zdroj znalostí služby SharePoint
| Name | Typ | Description |
|---|---|---|
| alwaysQuerySource |
boolean |
Označuje, že tento zdroj znalostí by měl obejít výběr zdroje a vždy se na něj dotazovat při načítání. |
| enableImageServing |
boolean |
Uvádí, zda by mělo být při vyhledávání pro tento zdroj znalostí povoleno servisování obrazů. Pokud je to pravda, jsou obrázky extrahované při pojetí doručeny do modelů za nimi. |
| failOnError |
boolean |
Označuje, že celý požadavek na vyhledání by měl selhat, pokud načtení z tohoto zdroje znalostí narazí na chybu. Výchozí nastavení je „false“. |
| filterExpressionAddOn |
string |
Podmínka filtru použitá na zdroj dat SharePoint. Musí být zadán v syntaxi jazyka dotazu na klíčové slovo. Bude kombinován jako spojení s výrazem filtru uvedeným v definici zdroje znalostí. |
| includeReferenceSourceData |
boolean |
Označuje, zda mají odkazy ve své datové části obsahovat strukturovaná data získaná během načítání. |
| includeReferences |
boolean |
Označuje, zda mají být zahrnuty odkazy pro data načtená z tohoto zdroje. |
| kind |
string:
remote |
Typ zdroje znalostí. |
| knowledgeSourceName |
string |
Název indexu, na který se parametry vztahují. |
| maxOutputDocuments |
integer (int32) |
Omezuje maximální počet dokumentů vrácených z tohoto zdroje znalostí. |
| neverQuerySource |
boolean |
Označuje, že tento zdroj znalostí by měl být vyloučen z kandidátní sady požadavku a nikdy by neměl být dotazován při vyhledání. Vyloučení je na žádost lokální a nemění členství ve znalostní báze. Nelze jej kombinovat s alwaysQuerySource na stejném zdroji znalostí. |
| rerankerThreshold |
number (float) |
Prahová hodnota opětovného pořadí, kterou musí splňovat všechny načtené dokumenty, aby mohly být zahrnuty do odpovědi. |
| resultsProcessing |
Přepisuje uložené výsledky zdroje znalostí Zpracování pouze pro tento vyvolávací volání. Pokud je vynechán, platí hodnota zdrojového zdroje uložených znalostí. |
SearchIndexFieldReference
Referenční pole pro vyhledávací index.
| Name | Typ | Description |
|---|---|---|
| name |
string |
Název pole. |
SearchIndexKnowledgeSourceBoostKind
Typ nápovědy pro zdroj znalostí ve vyhledávacím indexu.
| Hodnota | Description |
|---|---|
| fieldValue |
Vylepšujte dokumenty podle hodnoty pole. |
| multiWordExpression |
Vylepšujte dokumenty založené na víceslovném výrazu. |
SearchIndexKnowledgeSourceFieldValueBoost
Nápověda, která posílí dokumenty na základě hodnoty pole.
| Name | Typ | Description |
|---|---|---|
| boost |
number (double) |
Násobitel dokumentového skóre. Musí to být kladné číslo, které se nerovná 1,0. |
| boostInstructions |
string |
Instrukce v přirozeném jazyce, které vysvětlují, kdy a jak aplikovat boost. |
| field |
string minLength: 1 |
Název indexového pole vyhledávání. |
| fieldValues |
string[] |
Reprezentativní hodnoty pro dané pole. |
| kind |
string:
field |
Takový boost tip. |
SearchIndexKnowledgeSourceFilterHint
Nápověda, která identifikuje pole a reprezentativní hodnoty, kterou může plánovač dotazů použít při vytváření filtru.
| Name | Typ | Description |
|---|---|---|
| field |
string minLength: 1 |
Název filtrovatelného vyhledávacího indexového pole. |
| fieldValues |
string[] |
Reprezentativní hodnoty pro dané pole. |
| filterInstructions |
string |
Instrukce v přirozeném jazyce, které vysvětlují, kdy a jak filtrovat na poli. |
SearchIndexKnowledgeSourceMultiWordExpressionBoost
Nápověda, která posílí dokumenty založené na víceslovném výrazu.
| Name | Typ | Description |
|---|---|---|
| boost |
number (double) |
Násobitel dokumentového skóre. Musí to být kladné číslo, které se nerovná 1,0. |
| boostInstructions |
string |
Instrukce v přirozeném jazyce, které vysvětlují, kdy a jak aplikovat boost. |
| fieldValues |
string[] |
Reprezentativní hodnoty pro boost. |
| kind |
string:
multi |
Takový boost tip. |
SearchIndexKnowledgeSourceParams
Určuje parametry běhového prostředí pro zdroj znalostí o indexu vyhledávání
| Name | Typ | Description |
|---|---|---|
| alwaysQuerySource |
boolean |
Označuje, že tento zdroj znalostí by měl obejít výběr zdroje a vždy se na něj dotazovat při načítání. |
| enableImageServing |
boolean |
Uvádí, zda by mělo být při vyhledávání pro tento zdroj znalostí povoleno servisování obrazů. Pokud je to pravda, jsou obrázky extrahované při pojetí doručeny do modelů za nimi. |
| failOnError |
boolean |
Označuje, že celý požadavek na vyhledání by měl selhat, pokud načtení z tohoto zdroje znalostí narazí na chybu. Výchozí nastavení je „false“. |
| filterAddOn |
string |
Podmínka filtru aplikovaná na index (např. 'State eq VA'). |
| includeReferenceSourceData |
boolean |
Označuje, zda mají odkazy ve své datové části obsahovat strukturovaná data získaná během načítání. |
| includeReferences |
boolean |
Označuje, zda mají být zahrnuty odkazy pro data načtená z tohoto zdroje. |
| kind |
string:
search |
Typ zdroje znalostí. |
| knowledgeSourceName |
string |
Název indexu, na který se parametry vztahují. |
| maxOutputDocuments |
integer (int32) |
Omezuje maximální počet dokumentů vrácených z tohoto zdroje znalostí. |
| neverQuerySource |
boolean |
Označuje, že tento zdroj znalostí by měl být vyloučen z kandidátní sady požadavku a nikdy by neměl být dotazován při vyhledání. Vyloučení je na žádost lokální a nemění členství ve znalostní báze. Nelze jej kombinovat s alwaysQuerySource na stejném zdroji znalostí. |
| queryHintOverrides |
Tipy, které vedou plánování dotazů k užitečným filtrům a vylepšením. Pokud je tento objekt specifikován, nahrazuje kompletní sadu dotazovacích hintů nakonfigurovaných ve zdroji znalostí. |
|
| rerankerThreshold |
number (float) |
Prahová hodnota opětovného pořadí, kterou musí splňovat všechny načtené dokumenty, aby mohly být zahrnuty do odpovědi. |
| resultsProcessing |
Přepisuje uložené výsledky zdroje znalostí Zpracování pouze pro tento vyvolávací volání. Pokud je vynechán, platí hodnota zdrojového zdroje uložených znalostí. |
SearchIndexKnowledgeSourceQueryHints
Tipy, které vedou plánování dotazů k užitečným filtrům a vylepšením pro zdroj znalostí ve vyhledávacím indexu.
| Name | Typ | Description |
|---|---|---|
| boosts | SearchIndexKnowledgeSourceBoost[]: |
Podporujte tipy, které identifikují podmínky, které může plánovač dotazů použít k ovlivnění hodnocení dokumentu. |
| filters |
Filtrační nápovědy, které identifikují pole a reprezentativní hodnoty, které může plánovač dotazů použít při vytváření filtrů. |
ServedImage
Popisuje jeden obrázek, který model vybral k podání během aktivity vyhledávání.
| Name | Typ | Description |
|---|---|---|
| imageId |
string |
Obrázek je extrahován ze zdrojového dokumentu pomocí Content Understanding enrichment. Odpovídá číslování čísel v původním dokumentu. |
| imagePath |
string |
Relativní cesta k obrázku v asset store. |
| sizeBytes |
integer (int64) |
Velikost tohoto obrazu v bajtech zaslaná modelu. |
WebKnowledgeSourceParams
Určuje parametry běhového prostředí pro webový zdroj znalostí
| Name | Typ | Description |
|---|---|---|
| alwaysQuerySource |
boolean |
Označuje, že tento zdroj znalostí by měl obejít výběr zdroje a vždy se na něj dotazovat při načítání. |
| count |
integer (int32) |
Počet webových výsledků, které se mají vrátit. |
| enableImageServing |
boolean |
Uvádí, zda by mělo být při vyhledávání pro tento zdroj znalostí povoleno servisování obrazů. Pokud je to pravda, jsou obrázky extrahované při pojetí doručeny do modelů za nimi. |
| failOnError |
boolean |
Označuje, že celý požadavek na vyhledání by měl selhat, pokud načtení z tohoto zdroje znalostí narazí na chybu. Výchozí nastavení je „false“. |
| freshness |
string |
Svěžest webových výsledků. |
| includeReferenceSourceData |
boolean |
Označuje, zda mají odkazy ve své datové části obsahovat strukturovaná data získaná během načítání. |
| includeReferences |
boolean |
Označuje, zda mají být zahrnuty odkazy pro data načtená z tohoto zdroje. |
| kind |
string:
web |
Typ zdroje znalostí. |
| knowledgeSourceName |
string |
Název indexu, na který se parametry vztahují. |
| language |
string |
Výsledkem je jazyk webu. |
| market |
string |
Trh webových výsledků. |
| maxOutputDocuments |
integer (int32) |
Omezuje maximální počet dokumentů vrácených z tohoto zdroje znalostí. |
| neverQuerySource |
boolean |
Označuje, že tento zdroj znalostí by měl být vyloučen z kandidátní sady požadavku a nikdy by neměl být dotazován při vyhledání. Vyloučení je na žádost lokální a nemění členství ve znalostní báze. Nelze jej kombinovat s alwaysQuerySource na stejném zdroji znalostí. |
| rerankerThreshold |
number (float) |
Prahová hodnota opětovného pořadí, kterou musí splňovat všechny načtené dokumenty, aby mohly být zahrnuty do odpovědi. |
| resultsProcessing |
Přepisuje uložené výsledky zdroje znalostí Zpracování pouze pro tento vyvolávací volání. Pokud je vynechán, platí hodnota zdrojového zdroje uložených znalostí. |
WorkIQKnowledgeSourceParams
Specifikuje parametry běhu pro zdroj znalostí WorkIQ
| Name | Typ | Description |
|---|---|---|
| alwaysQuerySource |
boolean |
Označuje, že tento zdroj znalostí by měl obejít výběr zdroje a vždy se na něj dotazovat při načítání. |
| enableImageServing |
boolean |
Uvádí, zda by mělo být při vyhledávání pro tento zdroj znalostí povoleno servisování obrazů. Pokud je to pravda, jsou obrázky extrahované při pojetí doručeny do modelů za nimi. |
| failOnError |
boolean |
Označuje, že celý požadavek na vyhledání by měl selhat, pokud načtení z tohoto zdroje znalostí narazí na chybu. Výchozí nastavení je „false“. |
| includeReferenceSourceData |
boolean |
Označuje, zda mají odkazy ve své datové části obsahovat strukturovaná data získaná během načítání. |
| includeReferences |
boolean |
Označuje, zda mají být zahrnuty odkazy pro data načtená z tohoto zdroje. |
| kind |
string:
workIQ |
Typ zdroje znalostí. |
| knowledgeSourceName |
string |
Název indexu, na který se parametry vztahují. |
| maxOutputDocuments |
integer (int32) |
Omezuje maximální počet dokumentů vrácených z tohoto zdroje znalostí. |
| neverQuerySource |
boolean |
Označuje, že tento zdroj znalostí by měl být vyloučen z kandidátní sady požadavku a nikdy by neměl být dotazován při vyhledání. Vyloučení je na žádost lokální a nemění členství ve znalostní báze. Nelze jej kombinovat s alwaysQuerySource na stejném zdroji znalostí. |
| rerankerThreshold |
number (float) |
Prahová hodnota opětovného pořadí, kterou musí splňovat všechny načtené dokumenty, aby mohly být zahrnuty do odpovědi. |
| resultsProcessing |
Přepisuje uložené výsledky zdroje znalostí Zpracování pouze pro tento vyvolávací volání. Pokud je vynechán, platí hodnota zdrojového zdroje uložených znalostí. |