Knowledge Retrieval - Retrieve
A Tudásbázis lekéri a releváns adatokat a háttértárakból.
POST {endpoint}/knowledgebases('{knowledgeBaseName}')/retrieve?api-version=2026-08-01-preview
URI-paraméterek
| Name | In | Kötelező | Típus | Description |
|---|---|---|---|---|
|
endpoint
|
path | True |
string (uri) |
A keresési szolgáltatás végpontjának URL-címe. |
|
knowledge
|
path | True |
string |
A tudásbázis neve. |
|
api-version
|
query | True |
string minLength: 1 |
A művelethez használni kívánt API-verzió. |
Kérelem fejléce
| Name | Kötelező | Típus | Description |
|---|---|---|---|
| Accept |
Az Elfogadás fejléce. |
||
| x-ms-query-source-authorization |
string |
A lekérdezés végrehajtásához használt felhasználót azonosító jogkivonat. Ez a jogkivonat a dokumentumokra vonatkozó biztonsági korlátozások érvényesítésére szolgál. |
|
| x-ms-query-work-iq-source-authorization |
string (password) |
Felhasználói állítási token egy ügyfél tulajdonában lévő Entra alkalmazás regisztrációjához, amely egy Work IQ tudásforráson van konfigurálva. A Work IQ API nevében történő hitelesítésre használják. |
|
| x-ms-client-request-id |
string (uuid) |
A kérés átlátszatlan, globálisan egyedi, ügyfél által generált sztringazonosítója. |
Kérelem törzse
| Name | Típus | Description |
|---|---|---|
| includeActivity |
boolean |
Azt jelzi, hogy a lekérési eredményeknek tartalmazniuk kell a tevékenység adatait. |
| intents | KnowledgeRetrievalIntent[]: |
A modelllekérdezés-tervezés nélkül végrehajtandó tervezett lekérdezések listája. |
| knowledgeSourceParams |
KnowledgeSourceParams[]:
|
A tudásforrások futásidejű paramétereinek listája. |
| maxOutputDocuments |
integer (int32) |
Korlátozza a kimenetben lévő dokumentumok maximális számát. |
| maxOutputSize |
integer (int32) |
Korlátozza a kimenet tartalmának maximális méretét. |
| maxOutputSizeInTokens |
integer (int32) |
Korlátozza a kimenet tartalmának maximális méretét. |
| maxRuntimeInSeconds |
integer (int32) |
A maximális futási idő másodpercben. |
| messages |
A csevegőüzenetek stílusának listája. |
|
| outputMode |
A lekérés kimeneti konfigurációja. |
|
| retrievalReasoningEffort | KnowledgeRetrievalReasoningEffort: |
A visszakeresés, érvelési erőfeszítés konfigurációja. |
Válaszok
| Name | Típus | Description |
|---|---|---|
| 200 OK |
Sikeres visszaszerzési válasz. |
|
| Other Status Codes |
Részleges visszanyerési válasz. |
|
| Other Status Codes |
Váratlan hibaválasz. |
Biztonság
api-key
Típus:
apiKey
In:
header
OAuth2Auth
Típus:
oauth2
Folyamat:
implicit
Engedélyezési URL:
https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Hatókörök
| Name | Description |
|---|---|
| https://search.azure.com/.default |
Példák
|
Knowledge |
|
Knowledge |
|
Knowledge |
|
Knowledge |
KnowledgeBaseRetrieve
Mintakérelem
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
}
]
}
}
]
}
Mintaválasz
{
"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
Mintakérelem
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
}
]
}
Mintaválasz
{
"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
Mintakérelem
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
}
]
}
}
]
}
Mintaválasz
{
"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
Mintakérelem
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"
}
]
}
Mintaválasz
{
"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"
}
]
}
Definíciók
| Name | Description |
|---|---|
| Accept |
Az Elfogadás fejléce. |
|
Azure |
Futásidejű paramétereket ad meg egy Azure Blob tudásforráshoz |
|
Error |
Az erőforrás-kezelési hiba további információi. |
|
Error |
A hiba részletei. |
|
Error |
Az Összes Azure Resource Manager API gyakori hibaválasza a sikertelen műveletek hibaadatainak visszaadásához. (Ez az OData hibaválasz formátumát is követi.) |
|
Fabric |
Megadja a Fabric Data Agent tudásforrás futási idejű paramétereit |
|
Fabric |
Megadja a futási idejű paramétereket egy Fabric Ontology tudásforráshoz |
|
File |
Meghatározza a futási idejű paramétereket egy fájltudásforráshoz |
|
Image |
Statisztikák a kép kiszolgálásáról egy visszakeresési tevékenység során. |
|
Indexed |
Megadja az indexelt OneLake tudásforrás futásidejű paramétereit |
|
Indexed |
Futásidejű paramétereket ad meg egy indexelt SharePoint-tudásforráshoz |
|
Indexed |
Meghatározza az indexelt SQL tudásforráshoz futási idejű paramétereket |
|
Knowledge |
A tudásbázis LLM tevékenységhez használt modellt képviseli, beleértve a modell nevét és telepítési azonosítóját. |
|
Knowledge |
A tevékenységi nyilvántartás típusa. |
|
Knowledge |
Ügynöki érvelési tevékenységrekordot képvisel. |
|
Knowledge |
Az Azure Blob lekérési tevékenység argumentumait jelöli. |
|
Knowledge |
Egy Azure Blob lekérési tevékenységrekordot jelöl. |
|
Knowledge |
Egy Azure Blob Storage-dokumentumhivatkozást jelöl. |
|
Knowledge |
Az erőforrás-kezelési hiba további információi. |
|
Knowledge |
A hiba részletei. |
|
Knowledge |
Képviseli azokat az argumentumokat, amelyekkel a Fabric Data Agent lekérdezési tevékenysége futott. |
|
Knowledge |
Egy Fabric Data Agent lekérdezési tevékenységi rekordot képvisel. |
|
Knowledge |
Egy Fabric Data Agent dokumentumhivatkozást képvisel. |
|
Knowledge |
Képviseli azokat az érveket, amelyekkel a Fabric Ontology visszakeresési tevékenység működött. |
|
Knowledge |
Egy Fabric Ontology visszakeresési tevékenységi rekordot képvisel. |
|
Knowledge |
Egy Fabric Ontology dokumentumhivatkozást képvisel. |
|
Knowledge |
Képviseli azokat az argumentumokat, amelyekkel a fájlkeresési tevékenység futott. |
|
Knowledge |
Fájl lekérdezési tevékenységi rekordot képvisel. |
|
Knowledge |
Egy fájldokumentum-hivatkozást képvisel. |
|
Knowledge |
Képtartalom. |
|
Knowledge |
Képviseli azokat az argumentokat, amelyekkel az indexelt OneLake-keresési tevékenység futott. |
|
Knowledge |
Egy indexelt OneLake lekérdezési tevékenységi rekordot képvisel. |
|
Knowledge |
Egy indexelt OneLake dokumentumhivatkozást képvisel. |
|
Knowledge |
Képviseli azokat az argumentumokat, amelyekkel az indexelt SharePoint lekérdezési tevékenység futott. |
|
Knowledge |
Egy indexelt SharePoint lekérési tevékenységi rekordot képvisel. |
|
Knowledge |
Egy indexelt SharePoint dokumentumhivatkozást képvisel. |
|
Knowledge |
Képviseli azokat az argumentumokat, amelyekkel az indexelt SQL lekérdezési tevékenység futott. |
|
Knowledge |
Egy indexelt SQL lekérdezési tevékenységi rekordot képvisel. |
|
Knowledge |
Egy Azure SQL dokumentumhivatkozást képvisel. |
|
Knowledge |
Az MCP szerver lekérdezési tevékenységét futtató argumentumokat képviseli. |
|
Knowledge |
Egy MCP szerver lekérdezési tevékenységi rekordot képvisel. |
|
Knowledge |
Egy MCP szerver dokumentumhivatkozást képvisel. |
|
Knowledge |
A természetes nyelvű üzenetstílus-objektum. |
|
Knowledge |
Az üzenet tartalmának típusa. |
|
Knowledge |
Kép üzenet típusa. |
|
Knowledge |
Szöveges üzenet típusa. |
|
Knowledge |
Egy LLM-válaszszintézis tevékenységrekordot jelöl. |
|
Knowledge |
Egy LLM-lekérdezéstervezési tevékenységrekordot jelöl. |
|
Knowledge |
Egy LLM webes összefoglaló tevékenységi rekordot képvisel. |
|
Knowledge |
Részletek a lekérdezési tippekből generált kifejezésekről egy lekérdezési tevékenységhez. |
|
Knowledge |
A hivatkozás típusa. |
|
Knowledge |
Képviseli azokat az argumentumokat, amelyekkel a távoli SharePoint-lekérési tevékenység futott. |
|
Knowledge |
Egy távoli SharePoint lekérdezési tevékenységi rekordot képvisel. |
|
Knowledge |
Távoli SharePoint-dokumentumhivatkozást jelöl. |
|
Knowledge |
A lekérési kérelem bemeneti szerződése. |
|
Knowledge |
A lekérési válasz kimeneti szerződése. |
|
Knowledge |
A keresési index lekérési tevékenységét futtató argumentumokat jelöli. |
|
Knowledge |
A keresési index lekérési tevékenységrekordját jelöli. |
|
Knowledge |
Egy Azure Search-dokumentumhivatkozást jelöl. |
|
Knowledge |
Képviseli azokat az argumentokat, amelyekkel a web-visszakeresési tevékenység futott. |
|
Knowledge |
Egy web-visszakeresési tevékenységi rekordot képvisel. |
|
Knowledge |
Webes dokumentumhivatkozást jelöl. |
|
Knowledge |
Képviseli azokat az argumentumokat, amelyekkel a WorkIQ lekérdezési tevékenységet futtatták. |
|
Knowledge |
A WorkIQ visszakeresési tevékenységi rekordot képviseli. |
|
Knowledge |
WorkIQ dokumentumhivatkozást képvisel. |
|
Knowledge |
Automatikusan válassza ki az érvelési erőfeszítést a visszakeresés során. A szolgáltatás minden kérést a legolcsóbb szintre vet, és csak annyira eszkalál, amennyire szükséges, egészen a szolgáltatás maximálisan elérhető szintjéig. |
|
Knowledge |
A használni kívánt tudásbázis-konfiguráció típusa. |
|
Knowledge |
Futtassa a tudás visszakeresését alacsony érvelési erőfeszítéssel. |
|
Knowledge |
Futtassa a tudás visszakeresését közepes érvelési erőfeszítéssel. |
|
Knowledge |
Futtassa a tudás visszakeresését minimális érvelési erőfeszítéssel. |
|
Knowledge |
A lekérés kimeneti konfigurációja. |
|
Knowledge |
A visszakeresés során felhasználandó erőfeszítés mértéke. |
|
Knowledge |
Egy szemantikai lekérdezési szándék. |
|
Knowledge |
A tudásforrás fajtája. |
|
Knowledge |
Szabályozza, hogy egy tudásforrás eredményei újrarangsorolódnak-e. |
|
Mcp |
Meghatározza a futási idejű paramétereket egy MCP szerver tudásforrásához |
|
Purview |
Információ a dokumentumra alkalmazott érzékenységi címkéről |
|
Query |
Megadja a keresési lekérdezés szintaxisát. Az alapértelmezett érték az "egyszerű". Használja a "teljes" szót, ha a lekérdezés a Lucene-lekérdezés szintaxisát használja, és a "szemantikai" szót, ha nincs szükség lekérdezési szintaxisra. |
|
Remote |
Távoli SharePoint-tudásforrás futásidejű paramétereit adja meg |
|
Search |
Mezőreferenciát a keresési indexhez. |
|
Search |
Ez a fajta boost tipp egy keresőindex-forráshoz. |
|
Search |
Egy tipp, amely a dokumentumokat egy mezőérték alapján növeli. |
|
Search |
Egy tipp, amely azonosít egy mezőt és azokat a reprezentív értékeket, amelyeket a lekérdezéstervező használhat szűrő építésekor. |
|
Search |
Egy tipp, amely több szavas kifejezés alapján erősíti a dokumentumokat. |
|
Search |
Futásidejű paramétereket ad meg egy keresési index tudásforráshoz |
|
Search |
Tippek, amelyek segítenek a lekérdezési tervezésben hasznos szűrők és bónuszok felé keresési index tudásforráshoz. |
|
Served |
Egyetlen képet ír le, amelyet a modell kiválasztott, hogy szolgáljon egy visszakeresési tevékenység során. |
|
Web |
Futásidejű paramétereket ad meg egy webes tudásforráshoz |
|
Work |
Meghatározza a WorkIQ tudásforrás futási idejű paramétereit |
Accept
Az Elfogadás fejléce.
| Érték | Description |
|---|---|
| application/json;odata.metadata=minimal |
AzureBlobKnowledgeSourceParams
Futásidejű paramétereket ad meg egy Azure Blob tudásforráshoz
| Name | Típus | Description |
|---|---|---|
| alwaysQuerySource |
boolean |
Azt jelzi, hogy ennek a tudásforrásnak meg kell kerülnie a forrás kiválasztását, és mindig le kell kérdeznie a lekéréskor. |
| enableImageServing |
boolean |
Jelzi, hogy a képszolgáltatást engedélyezni kell-e ezen a tudásforrásnak a lekérdezés idején. Ha igaz, a felvétel során kinyert képek a következő modellekhez jutnak. |
| failOnError |
boolean |
Jelzi, hogy az egész lekérdezési kérelemnek meghibásodnia kell, ha a tudásforrásból történő visszakeresés hibával találkozik. Alapértelmezés szerint hamis. |
| includeReferenceSourceData |
boolean |
Azt jelzi, hogy a hivatkozásoknak tartalmazniuk kell-e a lekérés során kapott strukturált adatokat a hasznos adatokban. |
| includeReferences |
boolean |
Azt jelzi, hogy a forrásból beolvasott adatokhoz kell-e hivatkozásokat is belefoglalni. |
| kind |
string:
azure |
A tudásforrás típusa. |
| knowledgeSourceName |
string |
Annak az indexnek a neve, amelyre a paraméterek vonatkoznak. |
| maxOutputDocuments |
integer (int32) |
Korlátozza a dokumentumok maximális számát ebből a tudásforrásból. |
| neverQuerySource |
boolean |
Jelzi, hogy ezt a tudásforrást ki kell zárni a kérelem jelöltkészletéből, és soha nem kell lekérdezni a lekérdezés idején. A kizárás helyi kérés, és nem módosítja a tudásbázis tagságát. Nem lehet összevonni alwaysQuerySource-val ugyanazon a tudásforráson. |
| queryHintOverrides |
Tippek, amelyek segítenek a lekérdezési tervezésben hasznos szűrők és bónuszok felé. Ha ez a tárgy megadja a tudásforráson konfigurált teljes lekérdezési tippkészletet. |
|
| rerankerThreshold |
number (float) |
Az újrarangsoroló küszöbértéke, amelyet minden lekért dokumentumnak meg kell felelnie ahhoz, hogy szerepeljen a válaszban. |
| resultsProcessing |
Felülírja a tudásforrás tárolt eredményeitFeldolgozás csak ehhez a híváshoz. Ha kihagyják, a tárolt tudásforrás értéke érvényes. |
ErrorAdditionalInfo
Az erőforrás-kezelési hiba további információi.
| Name | Típus | Description |
|---|---|---|
| info |
A további információk. |
|
| type |
string |
A további információtípus. |
ErrorDetail
A hiba részletei.
| Name | Típus | Description |
|---|---|---|
| additionalInfo |
A hiba további információi. |
|
| code |
string |
A hibakód. |
| details |
A hiba részletei. |
|
| message |
string |
A hibaüzenet. |
| target |
string |
A hiba célpontja. |
ErrorResponse
Az Összes Azure Resource Manager API gyakori hibaválasza a sikertelen műveletek hibaadatainak visszaadásához. (Ez az OData hibaválasz formátumát is követi.)
| Name | Típus | Description |
|---|---|---|
| error |
A hibaobjektum. |
FabricDataAgentKnowledgeSourceParams
Megadja a Fabric Data Agent tudásforrás futási idejű paramétereit
| Name | Típus | Description |
|---|---|---|
| alwaysQuerySource |
boolean |
Azt jelzi, hogy ennek a tudásforrásnak meg kell kerülnie a forrás kiválasztását, és mindig le kell kérdeznie a lekéréskor. |
| enableImageServing |
boolean |
Jelzi, hogy a képszolgáltatást engedélyezni kell-e ezen a tudásforrásnak a lekérdezés idején. Ha igaz, a felvétel során kinyert képek a következő modellekhez jutnak. |
| failOnError |
boolean |
Jelzi, hogy az egész lekérdezési kérelemnek meghibásodnia kell, ha a tudásforrásból történő visszakeresés hibával találkozik. Alapértelmezés szerint hamis. |
| includeReferenceSourceData |
boolean |
Azt jelzi, hogy a hivatkozásoknak tartalmazniuk kell-e a lekérés során kapott strukturált adatokat a hasznos adatokban. |
| includeReferences |
boolean |
Azt jelzi, hogy a forrásból beolvasott adatokhoz kell-e hivatkozásokat is belefoglalni. |
| kind |
string:
fabric |
A tudásforrás típusa. |
| knowledgeSourceName |
string |
Annak az indexnek a neve, amelyre a paraméterek vonatkoznak. |
| maxOutputDocuments |
integer (int32) |
Korlátozza a dokumentumok maximális számát ebből a tudásforrásból. |
| neverQuerySource |
boolean |
Jelzi, hogy ezt a tudásforrást ki kell zárni a kérelem jelöltkészletéből, és soha nem kell lekérdezni a lekérdezés idején. A kizárás helyi kérés, és nem módosítja a tudásbázis tagságát. Nem lehet összevonni alwaysQuerySource-val ugyanazon a tudásforráson. |
| rerankerThreshold |
number (float) |
Az újrarangsoroló küszöbértéke, amelyet minden lekért dokumentumnak meg kell felelnie ahhoz, hogy szerepeljen a válaszban. |
| resultsProcessing |
Felülírja a tudásforrás tárolt eredményeitFeldolgozás csak ehhez a híváshoz. Ha kihagyják, a tárolt tudásforrás értéke érvényes. |
FabricOntologyKnowledgeSourceParams
Megadja a futási idejű paramétereket egy Fabric Ontology tudásforráshoz
| Name | Típus | Description |
|---|---|---|
| alwaysQuerySource |
boolean |
Azt jelzi, hogy ennek a tudásforrásnak meg kell kerülnie a forrás kiválasztását, és mindig le kell kérdeznie a lekéréskor. |
| enableImageServing |
boolean |
Jelzi, hogy a képszolgáltatást engedélyezni kell-e ezen a tudásforrásnak a lekérdezés idején. Ha igaz, a felvétel során kinyert képek a következő modellekhez jutnak. |
| failOnError |
boolean |
Jelzi, hogy az egész lekérdezési kérelemnek meghibásodnia kell, ha a tudásforrásból történő visszakeresés hibával találkozik. Alapértelmezés szerint hamis. |
| includeReferenceSourceData |
boolean |
Azt jelzi, hogy a hivatkozásoknak tartalmazniuk kell-e a lekérés során kapott strukturált adatokat a hasznos adatokban. |
| includeReferences |
boolean |
Azt jelzi, hogy a forrásból beolvasott adatokhoz kell-e hivatkozásokat is belefoglalni. |
| kind |
string:
fabric |
A tudásforrás típusa. |
| knowledgeSourceName |
string |
Annak az indexnek a neve, amelyre a paraméterek vonatkoznak. |
| maxOutputDocuments |
integer (int32) |
Korlátozza a dokumentumok maximális számát ebből a tudásforrásból. |
| neverQuerySource |
boolean |
Jelzi, hogy ezt a tudásforrást ki kell zárni a kérelem jelöltkészletéből, és soha nem kell lekérdezni a lekérdezés idején. A kizárás helyi kérés, és nem módosítja a tudásbázis tagságát. Nem lehet összevonni alwaysQuerySource-val ugyanazon a tudásforráson. |
| rerankerThreshold |
number (float) |
Az újrarangsoroló küszöbértéke, amelyet minden lekért dokumentumnak meg kell felelnie ahhoz, hogy szerepeljen a válaszban. |
| resultsProcessing |
Felülírja a tudásforrás tárolt eredményeitFeldolgozás csak ehhez a híváshoz. Ha kihagyják, a tárolt tudásforrás értéke érvényes. |
FileKnowledgeSourceParams
Meghatározza a futási idejű paramétereket egy fájltudásforráshoz
| Name | Típus | Description |
|---|---|---|
| alwaysQuerySource |
boolean |
Azt jelzi, hogy ennek a tudásforrásnak meg kell kerülnie a forrás kiválasztását, és mindig le kell kérdeznie a lekéréskor. |
| enableImageServing |
boolean |
Jelzi, hogy a képszolgáltatást engedélyezni kell-e ezen a tudásforrásnak a lekérdezés idején. Ha igaz, a felvétel során kinyert képek a következő modellekhez jutnak. |
| failOnError |
boolean |
Jelzi, hogy az egész lekérdezési kérelemnek meghibásodnia kell, ha a tudásforrásból történő visszakeresés hibával találkozik. Alapértelmezés szerint hamis. |
| includeReferenceSourceData |
boolean |
Azt jelzi, hogy a hivatkozásoknak tartalmazniuk kell-e a lekérés során kapott strukturált adatokat a hasznos adatokban. |
| includeReferences |
boolean |
Azt jelzi, hogy a forrásból beolvasott adatokhoz kell-e hivatkozásokat is belefoglalni. |
| kind |
string:
file |
A tudásforrás típusa. |
| knowledgeSourceName |
string |
Annak az indexnek a neve, amelyre a paraméterek vonatkoznak. |
| maxOutputDocuments |
integer (int32) |
Korlátozza a dokumentumok maximális számát ebből a tudásforrásból. |
| neverQuerySource |
boolean |
Jelzi, hogy ezt a tudásforrást ki kell zárni a kérelem jelöltkészletéből, és soha nem kell lekérdezni a lekérdezés idején. A kizárás helyi kérés, és nem módosítja a tudásbázis tagságát. Nem lehet összevonni alwaysQuerySource-val ugyanazon a tudásforráson. |
| queryHintOverrides |
Tippek, amelyek segítenek a lekérdezési tervezésben hasznos szűrők és bónuszok felé. Ha ez a tárgy megadja a tudásforráson konfigurált teljes lekérdezési tippkészletet. |
|
| rerankerThreshold |
number (float) |
Az újrarangsoroló küszöbértéke, amelyet minden lekért dokumentumnak meg kell felelnie ahhoz, hogy szerepeljen a válaszban. |
| resultsProcessing |
Felülírja a tudásforrás tárolt eredményeitFeldolgozás csak ehhez a híváshoz. Ha kihagyják, a tárolt tudásforrás értéke érvényes. |
ImageServingStatistics
Statisztikák a kép kiszolgálásáról egy visszakeresési tevékenység során.
| Name | Típus | Description |
|---|---|---|
| imagesRetrieved |
integer (int32) |
Az asset store-ból letöltött képek száma. |
| imagesSentToModel |
integer (int32) |
A következő modellhez küldött képek száma. |
| servedImages |
Az a képkészlet, amelyet a modell választott, hogy a lefelé vezető modellnek szolgáljon ehhez a visszakeresési tevékenységhez. |
|
| totalImageSizeBytes |
integer (int64) |
A modellhez küldött képek teljes mérete bájtokban. |
| verbalizationUsed |
boolean |
Jelzi, hogy a kép verbalizálását használták-e közvetlen képszolgáltatás helyett. |
IndexedOneLakeKnowledgeSourceParams
Megadja az indexelt OneLake tudásforrás futásidejű paramétereit
| Name | Típus | Description |
|---|---|---|
| alwaysQuerySource |
boolean |
Azt jelzi, hogy ennek a tudásforrásnak meg kell kerülnie a forrás kiválasztását, és mindig le kell kérdeznie a lekéréskor. |
| enableImageServing |
boolean |
Jelzi, hogy a képszolgáltatást engedélyezni kell-e ezen a tudásforrásnak a lekérdezés idején. Ha igaz, a felvétel során kinyert képek a következő modellekhez jutnak. |
| failOnError |
boolean |
Jelzi, hogy az egész lekérdezési kérelemnek meghibásodnia kell, ha a tudásforrásból történő visszakeresés hibával találkozik. Alapértelmezés szerint hamis. |
| includeReferenceSourceData |
boolean |
Azt jelzi, hogy a hivatkozásoknak tartalmazniuk kell-e a lekérés során kapott strukturált adatokat a hasznos adatokban. |
| includeReferences |
boolean |
Azt jelzi, hogy a forrásból beolvasott adatokhoz kell-e hivatkozásokat is belefoglalni. |
| kind |
string:
indexed |
A tudásforrás típusa. |
| knowledgeSourceName |
string |
Annak az indexnek a neve, amelyre a paraméterek vonatkoznak. |
| maxOutputDocuments |
integer (int32) |
Korlátozza a dokumentumok maximális számát ebből a tudásforrásból. |
| neverQuerySource |
boolean |
Jelzi, hogy ezt a tudásforrást ki kell zárni a kérelem jelöltkészletéből, és soha nem kell lekérdezni a lekérdezés idején. A kizárás helyi kérés, és nem módosítja a tudásbázis tagságát. Nem lehet összevonni alwaysQuerySource-val ugyanazon a tudásforráson. |
| queryHintOverrides |
Tippek, amelyek segítenek a lekérdezési tervezésben hasznos szűrők és bónuszok felé. Ha ez a tárgy megadja a tudásforráson konfigurált teljes lekérdezési tippkészletet. |
|
| rerankerThreshold |
number (float) |
Az újrarangsoroló küszöbértéke, amelyet minden lekért dokumentumnak meg kell felelnie ahhoz, hogy szerepeljen a válaszban. |
| resultsProcessing |
Felülírja a tudásforrás tárolt eredményeitFeldolgozás csak ehhez a híváshoz. Ha kihagyják, a tárolt tudásforrás értéke érvényes. |
IndexedSharePointKnowledgeSourceParams
Futásidejű paramétereket ad meg egy indexelt SharePoint-tudásforráshoz
| Name | Típus | Description |
|---|---|---|
| alwaysQuerySource |
boolean |
Azt jelzi, hogy ennek a tudásforrásnak meg kell kerülnie a forrás kiválasztását, és mindig le kell kérdeznie a lekéréskor. |
| enableImageServing |
boolean |
Jelzi, hogy a képszolgáltatást engedélyezni kell-e ezen a tudásforrásnak a lekérdezés idején. Ha igaz, a felvétel során kinyert képek a következő modellekhez jutnak. |
| failOnError |
boolean |
Jelzi, hogy az egész lekérdezési kérelemnek meghibásodnia kell, ha a tudásforrásból történő visszakeresés hibával találkozik. Alapértelmezés szerint hamis. |
| includeReferenceSourceData |
boolean |
Azt jelzi, hogy a hivatkozásoknak tartalmazniuk kell-e a lekérés során kapott strukturált adatokat a hasznos adatokban. |
| includeReferences |
boolean |
Azt jelzi, hogy a forrásból beolvasott adatokhoz kell-e hivatkozásokat is belefoglalni. |
| kind |
string:
indexed |
A tudásforrás típusa. |
| knowledgeSourceName |
string |
Annak az indexnek a neve, amelyre a paraméterek vonatkoznak. |
| maxOutputDocuments |
integer (int32) |
Korlátozza a dokumentumok maximális számát ebből a tudásforrásból. |
| neverQuerySource |
boolean |
Jelzi, hogy ezt a tudásforrást ki kell zárni a kérelem jelöltkészletéből, és soha nem kell lekérdezni a lekérdezés idején. A kizárás helyi kérés, és nem módosítja a tudásbázis tagságát. Nem lehet összevonni alwaysQuerySource-val ugyanazon a tudásforráson. |
| queryHintOverrides |
Tippek, amelyek segítenek a lekérdezési tervezésben hasznos szűrők és bónuszok felé. Ha ez a tárgy megadja a tudásforráson konfigurált teljes lekérdezési tippkészletet. |
|
| rerankerThreshold |
number (float) |
Az újrarangsoroló küszöbértéke, amelyet minden lekért dokumentumnak meg kell felelnie ahhoz, hogy szerepeljen a válaszban. |
| resultsProcessing |
Felülírja a tudásforrás tárolt eredményeitFeldolgozás csak ehhez a híváshoz. Ha kihagyják, a tárolt tudásforrás értéke érvényes. |
IndexedSqlKnowledgeSourceParams
Meghatározza az indexelt SQL tudásforráshoz futási idejű paramétereket
| Name | Típus | Description |
|---|---|---|
| alwaysQuerySource |
boolean |
Azt jelzi, hogy ennek a tudásforrásnak meg kell kerülnie a forrás kiválasztását, és mindig le kell kérdeznie a lekéréskor. |
| enableImageServing |
boolean |
Jelzi, hogy a képszolgáltatást engedélyezni kell-e ezen a tudásforrásnak a lekérdezés idején. Ha igaz, a felvétel során kinyert képek a következő modellekhez jutnak. |
| failOnError |
boolean |
Jelzi, hogy az egész lekérdezési kérelemnek meghibásodnia kell, ha a tudásforrásból történő visszakeresés hibával találkozik. Alapértelmezés szerint hamis. |
| includeReferenceSourceData |
boolean |
Azt jelzi, hogy a hivatkozásoknak tartalmazniuk kell-e a lekérés során kapott strukturált adatokat a hasznos adatokban. |
| includeReferences |
boolean |
Azt jelzi, hogy a forrásból beolvasott adatokhoz kell-e hivatkozásokat is belefoglalni. |
| kind |
string:
indexed |
A tudásforrás típusa. |
| knowledgeSourceName |
string |
Annak az indexnek a neve, amelyre a paraméterek vonatkoznak. |
| maxOutputDocuments |
integer (int32) |
Korlátozza a dokumentumok maximális számát ebből a tudásforrásból. |
| neverQuerySource |
boolean |
Jelzi, hogy ezt a tudásforrást ki kell zárni a kérelem jelöltkészletéből, és soha nem kell lekérdezni a lekérdezés idején. A kizárás helyi kérés, és nem módosítja a tudásbázis tagságát. Nem lehet összevonni alwaysQuerySource-val ugyanazon a tudásforráson. |
| queryHintOverrides |
Tippek, amelyek segítenek a lekérdezési tervezésben hasznos szűrők és bónuszok felé. Ha ez a tárgy megadja a tudásforráson konfigurált teljes lekérdezési tippkészletet. |
|
| rerankerThreshold |
number (float) |
Az újrarangsoroló küszöbértéke, amelyet minden lekért dokumentumnak meg kell felelnie ahhoz, hogy szerepeljen a válaszban. |
| resultsProcessing |
Felülírja a tudásforrás tárolt eredményeitFeldolgozás csak ehhez a híváshoz. Ha kihagyják, a tárolt tudásforrás értéke érvényes. |
KnowledgeBaseActivityRecordModel
A tudásbázis LLM tevékenységhez használt modellt képviseli, beleértve a modell nevét és telepítési azonosítóját.
| Name | Típus | Description |
|---|---|---|
| deploymentId |
string |
A tevékenységhez használt modell telepítési azonosítója. |
| modelName |
string |
A tevékenységhez használt modell neve. |
KnowledgeBaseActivityRecordType
A tevékenységi nyilvántartás típusa.
| Érték | Description |
|---|---|
| searchIndex |
Keresési index keresési tevékenység. |
| azureBlob |
Azure Blob retrieval activity. |
| indexedSharePoint |
Indexelt SharePoint lekérdezési tevékenység. |
| indexedOneLake |
Indexelt OneLake visszakeresési tevékenység. |
| web |
Webes keresési tevékenység. |
| remoteSharePoint |
Távoli SharePoint lekérdezési tevékenység. |
| workIQ |
WorkIQ visszakeresési tevékenység. |
| fabricDataAgent |
Fabric Data Agent lekérdezési tevékenység. |
| fabricOntology |
Fabric Ontology retrieval activity. |
| mcpServer |
MCP szerver lekérdezési tevékenység. |
| file |
Fájlkeresési tevékenység. |
| indexedSql |
Indexelt SQL lekérdezési tevékenység. |
| modelQueryPlanning |
LLM lekérdezés tervezési tevékenység. |
| modelAnswerSynthesis |
LLM válasz szintézis aktivitás. |
| modelWebSummarization |
LLM webes összefoglaló tevékenység. |
| agenticReasoning |
Ügynöki gondolkodási tevékenység. |
KnowledgeBaseAgenticReasoningActivityRecord
Ügynöki érvelési tevékenységrekordot képvisel.
| Name | Típus | Description |
|---|---|---|
| completedAt |
string (date-time) |
Az idő, amikor a tevékenység befejeződött. |
| elapsedMs |
integer (int32) |
A lekérési tevékenység eltelt ideje ezredmásodpercben. |
| error |
A hiba részletei, amelyek megmagyarázzák, hogy miért nem sikerült a művelet. Ez a tulajdonság csak akkor szerepel, ha a tevékenység nem sikeres. |
|
| id |
integer (int32) |
A tevékenységrekord azonosítója. |
| logicalReasoningEffort | KnowledgeRetrievalReasoningEffort: |
Az ügyfél által kért logikus érvelési erőfeszítés. Ez eltér attól, |
| reasoningTokens |
integer (int32) |
Az ügynöki érveléshez szükséges bemeneti tokenek száma. |
| retrievalReasoningEffort | KnowledgeRetrievalReasoningEffort: |
A visszakeresés, érvelési erőfeszítés konfigurációja. |
| startedAt |
string (date-time) |
Az az időszak, amikor az esemény elkezdődött. |
| type |
string:
agentic |
A tevékenységrekord típusa. |
| warning |
string |
Egy figyelmeztető üzenet, amely a tevékenység során megfigyelhető esetleges konfigurációs problémákat mutatja fel, például a dokumentumok elvesztését pontszámozás, token korlátozás levágása vagy időkorlát miatt. |
KnowledgeBaseAzureBlobActivityArguments
Az Azure Blob lekérési tevékenység argumentumait jelöli.
| Name | Típus | Description |
|---|---|---|
| search |
string |
A blob tartalmának lekérdezéséhez használt keresési sztring. |
KnowledgeBaseAzureBlobActivityRecord
Egy Azure Blob lekérési tevékenységrekordot jelöl.
| Name | Típus | Description |
|---|---|---|
| azureBlobArguments |
A lekérési tevékenység Azure Blob-argumentumai. |
|
| completedAt |
string (date-time) |
Az idő, amikor a tevékenység befejeződött. |
| count |
integer (int32) |
A visszakeresett dokumentumok száma, amelyek kellően relevánsak voltak ahhoz, hogy átlépjék a reranker küszöbértéket. |
| elapsedMs |
integer (int32) |
A lekérési tevékenység eltelt ideje ezredmásodpercben. |
| error |
A hiba részletei, amelyek megmagyarázzák, hogy miért nem sikerült a művelet. Ez a tulajdonság csak akkor szerepel, ha a tevékenység nem sikeres. |
|
| id |
integer (int32) |
A tevékenységrekord azonosítója. |
| imageServing |
Statisztikák a képek alkalmazásáról ehhez a visszakeresési tevékenységhez |
|
| knowledgeSourceName |
string |
A lekérési tevékenység tudásforrása. |
| queryHintProcessing |
Részletek a keresési tippekből generált kifejezésekről ehhez a tevékenységhez. |
|
| queryTime |
string (date-time) |
A lekérési tevékenység lekérdezési ideje. |
| startedAt |
string (date-time) |
Az az időszak, amikor az esemény elkezdődött. |
| type |
string:
azure |
A tevékenységrekord típusa. |
| warning |
string |
Egy figyelmeztető üzenet, amely a tevékenység során megfigyelhető esetleges konfigurációs problémákat mutatja fel, például a dokumentumok elvesztését pontszámozás, token korlátozás levágása vagy időkorlát miatt. |
KnowledgeBaseAzureBlobReference
Egy Azure Blob Storage-dokumentumhivatkozást jelöl.
| Name | Típus | Description |
|---|---|---|
| activitySource |
integer (int32) |
A hivatkozás forrástevékenység-azonosítója. |
| blobUrl |
string |
A referencia blob URL-címe. |
| citationUrl |
string (uri) |
Egy kereséshez tartozó URL, amely a hivatkozás mögötti dokumentumára mutat, és hivatkozási célpontként használható. |
| id |
string |
A hivatkozás azonosítója. |
| rerankerScore |
number (float) |
A dokumentumhivatkozás reranker pontszáma. |
| searchSensitivityLabelInfo |
Az érzékenységi címkék adatai a hivatkozáshoz. |
|
| sourceData |
A hivatkozás forrásadatai. |
|
| type |
string:
azure |
A hivatkozás típusa. |
KnowledgeBaseErrorAdditionalInfo
Az erőforrás-kezelési hiba további információi.
| Name | Típus | Description |
|---|---|---|
| info |
A további információk. |
|
| type |
string |
A további információtípus. |
KnowledgeBaseErrorDetail
A hiba részletei.
| Name | Típus | Description |
|---|---|---|
| additionalInfo |
A hiba további információi. |
|
| code |
string |
A hibakód. |
| details |
A hiba részletei. |
|
| message |
string |
A hibaüzenet. |
| target |
string |
A hiba célpontja. |
KnowledgeBaseFabricDataAgentActivityArguments
Képviseli azokat az argumentumokat, amelyekkel a Fabric Data Agent lekérdezési tevékenysége futott.
| Name | Típus | Description |
|---|---|---|
| search |
string |
A keresési lánc, amelyet a Fabric Data Agent tudásforrásának lekérdezésére használnak. |
KnowledgeBaseFabricDataAgentActivityRecord
Egy Fabric Data Agent lekérdezési tevékenységi rekordot képvisel.
| Name | Típus | Description |
|---|---|---|
| completedAt |
string (date-time) |
Az idő, amikor a tevékenység befejeződött. |
| count |
integer (int32) |
A visszakeresett dokumentumok száma, amelyek kellően relevánsak voltak ahhoz, hogy átlépjék a reranker küszöbértéket. |
| elapsedMs |
integer (int32) |
A lekérési tevékenység eltelt ideje ezredmásodpercben. |
| error |
A hiba részletei, amelyek megmagyarázzák, hogy miért nem sikerült a művelet. Ez a tulajdonság csak akkor szerepel, ha a tevékenység nem sikeres. |
|
| fabricDataAgentArguments |
A Fabric Data Agent argumentumokat ad a lekérdezési tevékenységre. |
|
| id |
integer (int32) |
A tevékenységrekord azonosítója. |
| imageServing |
Statisztikák a képek alkalmazásáról ehhez a visszakeresési tevékenységhez |
|
| knowledgeSourceName |
string |
A lekérési tevékenység tudásforrása. |
| queryTime |
string (date-time) |
A lekérési tevékenység lekérdezési ideje. |
| startedAt |
string (date-time) |
Az az időszak, amikor az esemény elkezdődött. |
| type |
string:
fabric |
A tevékenységrekord típusa. |
| warning |
string |
Egy figyelmeztető üzenet, amely a tevékenység során megfigyelhető esetleges konfigurációs problémákat mutatja fel, például a dokumentumok elvesztését pontszámozás, token korlátozás levágása vagy időkorlát miatt. |
KnowledgeBaseFabricDataAgentReference
Egy Fabric Data Agent dokumentumhivatkozást képvisel.
| Name | Típus | Description |
|---|---|---|
| activitySource |
integer (int32) |
A hivatkozás forrástevékenység-azonosítója. |
| dataAgentId |
string |
A Fabric Data Agent ID. |
| id |
string |
A hivatkozás azonosítója. |
| rerankerScore |
number (float) |
A dokumentumhivatkozás reranker pontszáma. |
| sourceData |
A hivatkozás forrásadatai. |
|
| type |
string:
fabric |
A hivatkozás típusa. |
| workspaceId |
string |
A Fabric munkaterület azonosítója. |
KnowledgeBaseFabricOntologyActivityArguments
Képviseli azokat az érveket, amelyekkel a Fabric Ontology visszakeresési tevékenység működött.
| Name | Típus | Description |
|---|---|---|
| search |
string |
A keresési lánc, amelyet a Fabric Ontology tudásforrásának lekérdezésére használnak. |
KnowledgeBaseFabricOntologyActivityRecord
Egy Fabric Ontology visszakeresési tevékenységi rekordot képvisel.
| Name | Típus | Description |
|---|---|---|
| completedAt |
string (date-time) |
Az idő, amikor a tevékenység befejeződött. |
| count |
integer (int32) |
A visszakeresett dokumentumok száma, amelyek kellően relevánsak voltak ahhoz, hogy átlépjék a reranker küszöbértéket. |
| elapsedMs |
integer (int32) |
A lekérési tevékenység eltelt ideje ezredmásodpercben. |
| error |
A hiba részletei, amelyek megmagyarázzák, hogy miért nem sikerült a művelet. Ez a tulajdonság csak akkor szerepel, ha a tevékenység nem sikeres. |
|
| fabricOntologyArguments |
A Fabric Ontológia érvei a retrieval activity mellett. |
|
| id |
integer (int32) |
A tevékenységrekord azonosítója. |
| imageServing |
Statisztikák a képek alkalmazásáról ehhez a visszakeresési tevékenységhez |
|
| knowledgeSourceName |
string |
A lekérési tevékenység tudásforrása. |
| queryTime |
string (date-time) |
A lekérési tevékenység lekérdezési ideje. |
| startedAt |
string (date-time) |
Az az időszak, amikor az esemény elkezdődött. |
| type |
string:
fabric |
A tevékenységrekord típusa. |
| warning |
string |
Egy figyelmeztető üzenet, amely a tevékenység során megfigyelhető esetleges konfigurációs problémákat mutatja fel, például a dokumentumok elvesztését pontszámozás, token korlátozás levágása vagy időkorlát miatt. |
KnowledgeBaseFabricOntologyReference
Egy Fabric Ontology dokumentumhivatkozást képvisel.
| Name | Típus | Description |
|---|---|---|
| activitySource |
integer (int32) |
A hivatkozás forrástevékenység-azonosítója. |
| id |
string |
A hivatkozás azonosítója. |
| ontologyId |
string |
Az ontológiai azonosító a munkatéren belül. |
| rerankerScore |
number (float) |
A dokumentumhivatkozás reranker pontszáma. |
| sourceData |
A hivatkozás forrásadatai. |
|
| type |
string:
fabric |
A hivatkozás típusa. |
| workspaceId |
string |
A Fabric munkaterület azonosítója. |
KnowledgeBaseFileActivityArguments
Képviseli azokat az argumentumokat, amelyekkel a fájlkeresési tevékenység futott.
| Name | Típus | Description |
|---|---|---|
| search |
string |
A kereső string fájltartalmának lekérdezésére szolgált. |
KnowledgeBaseFileActivityRecord
Fájl lekérdezési tevékenységi rekordot képvisel.
| Name | Típus | Description |
|---|---|---|
| completedAt |
string (date-time) |
Az idő, amikor a tevékenység befejeződött. |
| count |
integer (int32) |
A visszakeresett dokumentumok száma, amelyek kellően relevánsak voltak ahhoz, hogy átlépjék a reranker küszöbértéket. |
| elapsedMs |
integer (int32) |
A lekérési tevékenység eltelt ideje ezredmásodpercben. |
| error |
A hiba részletei, amelyek megmagyarázzák, hogy miért nem sikerült a művelet. Ez a tulajdonság csak akkor szerepel, ha a tevékenység nem sikeres. |
|
| fileArguments |
A fájl argumentumokat tartalmaz a lekérdezési tevékenységre. |
|
| id |
integer (int32) |
A tevékenységrekord azonosítója. |
| imageServing |
Statisztikák a képek alkalmazásáról ehhez a visszakeresési tevékenységhez |
|
| knowledgeSourceName |
string |
A lekérési tevékenység tudásforrása. |
| queryHintProcessing |
Részletek a keresési tippekből generált kifejezésekről ehhez a tevékenységhez. |
|
| queryTime |
string (date-time) |
A lekérési tevékenység lekérdezési ideje. |
| startedAt |
string (date-time) |
Az az időszak, amikor az esemény elkezdődött. |
| type |
string:
file |
A tevékenységrekord típusa. |
| warning |
string |
Egy figyelmeztető üzenet, amely a tevékenység során megfigyelhető esetleges konfigurációs problémákat mutatja fel, például a dokumentumok elvesztését pontszámozás, token korlátozás levágása vagy időkorlát miatt. |
KnowledgeBaseFileReference
Egy fájldokumentum-hivatkozást képvisel.
| Name | Típus | Description |
|---|---|---|
| activitySource |
integer (int32) |
A hivatkozás forrástevékenység-azonosítója. |
| citationUrl |
string (uri) |
Egy kereséshez tartozó URL, amely a hivatkozás mögötti dokumentumára mutat, és hivatkozási célpontként használható. |
| docName |
string |
A hivatkozás dokumentum neve. |
| id |
string |
A hivatkozás azonosítója. |
| rerankerScore |
number (float) |
A dokumentumhivatkozás reranker pontszáma. |
| sourceData |
A hivatkozás forrásadatai. |
|
| type |
string:
file |
A hivatkozás típusa. |
KnowledgeBaseImageContent
Képtartalom.
| Name | Típus | Description |
|---|---|---|
| url |
string (uri) |
A kép URL-címe. |
KnowledgeBaseIndexedOneLakeActivityArguments
Képviseli azokat az argumentokat, amelyekkel az indexelt OneLake-keresési tevékenység futott.
| Name | Típus | Description |
|---|---|---|
| search |
string |
A kereső string indexelt OneLake tartalmának lekérdezésére szolgált. |
KnowledgeBaseIndexedOneLakeActivityRecord
Egy indexelt OneLake lekérdezési tevékenységi rekordot képvisel.
| Name | Típus | Description |
|---|---|---|
| completedAt |
string (date-time) |
Az idő, amikor a tevékenység befejeződött. |
| count |
integer (int32) |
A visszakeresett dokumentumok száma, amelyek kellően relevánsak voltak ahhoz, hogy átlépjék a reranker küszöbértéket. |
| elapsedMs |
integer (int32) |
A lekérési tevékenység eltelt ideje ezredmásodpercben. |
| error |
A hiba részletei, amelyek megmagyarázzák, hogy miért nem sikerült a művelet. Ez a tulajdonság csak akkor szerepel, ha a tevékenység nem sikeres. |
|
| id |
integer (int32) |
A tevékenységrekord azonosítója. |
| imageServing |
Statisztikák a képek alkalmazásáról ehhez a visszakeresési tevékenységhez |
|
| indexedOneLakeArguments |
Az indexelt OneLake argumentumok a visszakeresési tevékenységhez. |
|
| knowledgeSourceName |
string |
A lekérési tevékenység tudásforrása. |
| queryHintProcessing |
Részletek a keresési tippekből generált kifejezésekről ehhez a tevékenységhez. |
|
| queryTime |
string (date-time) |
A lekérési tevékenység lekérdezési ideje. |
| startedAt |
string (date-time) |
Az az időszak, amikor az esemény elkezdődött. |
| type |
string:
indexed |
A tevékenységrekord típusa. |
| warning |
string |
Egy figyelmeztető üzenet, amely a tevékenység során megfigyelhető esetleges konfigurációs problémákat mutatja fel, például a dokumentumok elvesztését pontszámozás, token korlátozás levágása vagy időkorlát miatt. |
KnowledgeBaseIndexedOneLakeReference
Egy indexelt OneLake dokumentumhivatkozást képvisel.
| Name | Típus | Description |
|---|---|---|
| activitySource |
integer (int32) |
A hivatkozás forrástevékenység-azonosítója. |
| citationUrl |
string (uri) |
Egy kereséshez tartozó URL, amely a hivatkozás mögötti dokumentumára mutat, és hivatkozási célpontként használható. |
| docUrl |
string |
A hivatkozás dokumentumának URL-címe. |
| id |
string |
A hivatkozás azonosítója. |
| rerankerScore |
number (float) |
A dokumentumhivatkozás reranker pontszáma. |
| searchSensitivityLabelInfo |
Az érzékenységi címkék adatai a hivatkozáshoz. |
|
| sourceData |
A hivatkozás forrásadatai. |
|
| type |
string:
indexed |
A hivatkozás típusa. |
KnowledgeBaseIndexedSharePointActivityArguments
Képviseli azokat az argumentumokat, amelyekkel az indexelt SharePoint lekérdezési tevékenység futott.
| Name | Típus | Description |
|---|---|---|
| search |
string |
A kereső string indexelt SharePoint tartalmak lekérdezésére szolgált. |
KnowledgeBaseIndexedSharePointActivityRecord
Egy indexelt SharePoint lekérési tevékenységi rekordot képvisel.
| Name | Típus | Description |
|---|---|---|
| completedAt |
string (date-time) |
Az idő, amikor a tevékenység befejeződött. |
| count |
integer (int32) |
A visszakeresett dokumentumok száma, amelyek kellően relevánsak voltak ahhoz, hogy átlépjék a reranker küszöbértéket. |
| elapsedMs |
integer (int32) |
A lekérési tevékenység eltelt ideje ezredmásodpercben. |
| error |
A hiba részletei, amelyek megmagyarázzák, hogy miért nem sikerült a művelet. Ez a tulajdonság csak akkor szerepel, ha a tevékenység nem sikeres. |
|
| id |
integer (int32) |
A tevékenységrekord azonosítója. |
| imageServing |
Statisztikák a képek alkalmazásáról ehhez a visszakeresési tevékenységhez |
|
| indexedSharePointArguments |
Az indexelt SharePoint argumentumok a lekérdezési tevékenységhez. |
|
| knowledgeSourceName |
string |
A lekérési tevékenység tudásforrása. |
| queryHintProcessing |
Részletek a keresési tippekből generált kifejezésekről ehhez a tevékenységhez. |
|
| queryTime |
string (date-time) |
A lekérési tevékenység lekérdezési ideje. |
| startedAt |
string (date-time) |
Az az időszak, amikor az esemény elkezdődött. |
| type |
string:
indexed |
A tevékenységrekord típusa. |
| warning |
string |
Egy figyelmeztető üzenet, amely a tevékenység során megfigyelhető esetleges konfigurációs problémákat mutatja fel, például a dokumentumok elvesztését pontszámozás, token korlátozás levágása vagy időkorlát miatt. |
KnowledgeBaseIndexedSharePointReference
Egy indexelt SharePoint dokumentumhivatkozást képvisel.
| Name | Típus | Description |
|---|---|---|
| activitySource |
integer (int32) |
A hivatkozás forrástevékenység-azonosítója. |
| citationUrl |
string (uri) |
Egy kereséshez tartozó URL, amely a hivatkozás mögötti dokumentumára mutat, és hivatkozási célpontként használható. |
| docUrl |
string |
A hivatkozás dokumentumának URL-címe. |
| id |
string |
A hivatkozás azonosítója. |
| rerankerScore |
number (float) |
A dokumentumhivatkozás reranker pontszáma. |
| searchSensitivityLabelInfo |
Az érzékenységi címkék adatai a hivatkozáshoz. |
|
| sourceData |
A hivatkozás forrásadatai. |
|
| type |
string:
indexed |
A hivatkozás típusa. |
KnowledgeBaseIndexedSqlActivityArguments
Képviseli azokat az argumentumokat, amelyekkel az indexelt SQL lekérdezési tevékenység futott.
| Name | Típus | Description |
|---|---|---|
| search |
string |
A keresési láncsor, amelyet indexelt SQL tartalmak lekérdezésére használnak. |
KnowledgeBaseIndexedSqlActivityRecord
Egy indexelt SQL lekérdezési tevékenységi rekordot képvisel.
| Name | Típus | Description |
|---|---|---|
| completedAt |
string (date-time) |
Az idő, amikor a tevékenység befejeződött. |
| count |
integer (int32) |
A visszakeresett dokumentumok száma, amelyek kellően relevánsak voltak ahhoz, hogy átlépjék a reranker küszöbértéket. |
| elapsedMs |
integer (int32) |
A lekérési tevékenység eltelt ideje ezredmásodpercben. |
| error |
A hiba részletei, amelyek megmagyarázzák, hogy miért nem sikerült a művelet. Ez a tulajdonság csak akkor szerepel, ha a tevékenység nem sikeres. |
|
| id |
integer (int32) |
A tevékenységrekord azonosítója. |
| imageServing |
Statisztikák a képek alkalmazásáról ehhez a visszakeresési tevékenységhez |
|
| indexedSqlArguments |
Az indexelt SQL argumentumok a lekérdezési tevékenységhez. |
|
| knowledgeSourceName |
string |
A lekérési tevékenység tudásforrása. |
| queryHintProcessing |
Részletek a keresési tippekből generált kifejezésekről ehhez a tevékenységhez. |
|
| queryTime |
string (date-time) |
A lekérési tevékenység lekérdezési ideje. |
| startedAt |
string (date-time) |
Az az időszak, amikor az esemény elkezdődött. |
| type |
string:
indexed |
A tevékenységrekord típusa. |
| warning |
string |
Egy figyelmeztető üzenet, amely a tevékenység során megfigyelhető esetleges konfigurációs problémákat mutatja fel, például a dokumentumok elvesztését pontszámozás, token korlátozás levágása vagy időkorlát miatt. |
KnowledgeBaseIndexedSqlReference
Egy Azure SQL dokumentumhivatkozást képvisel.
| Name | Típus | Description |
|---|---|---|
| activitySource |
integer (int32) |
A hivatkozás forrástevékenység-azonosítója. |
| citationUrl |
string (uri) |
Egy kereséshez tartozó URL, amely a hivatkozás mögötti dokumentumára mutat, és hivatkozási célpontként használható. |
| docUrl |
string |
A hivatkozás dokumentumának URL-címe. |
| id |
string |
A hivatkozás azonosítója. |
| rerankerScore |
number (float) |
A dokumentumhivatkozás reranker pontszáma. |
| sourceData |
A hivatkozás forrásadatai. |
|
| type |
string:
indexed |
A hivatkozás típusa. |
KnowledgeBaseMcpServerActivityArguments
Az MCP szerver lekérdezési tevékenységét futtató argumentumokat képviseli.
| Name | Típus | Description |
|---|---|---|
| toolArguments |
Az érvek továbbították az MCP szerver eszköznek. |
|
| toolName |
string |
Az MCP szervereszköz neve, amelyet a lekérdezési tevékenységhez használnak. |
KnowledgeBaseMcpServerActivityRecord
Egy MCP szerver lekérdezési tevékenységi rekordot képvisel.
| Name | Típus | Description |
|---|---|---|
| completedAt |
string (date-time) |
Az idő, amikor a tevékenység befejeződött. |
| count |
integer (int32) |
A visszakeresett dokumentumok száma, amelyek kellően relevánsak voltak ahhoz, hogy átlépjék a reranker küszöbértéket. |
| elapsedMs |
integer (int32) |
A lekérési tevékenység eltelt ideje ezredmásodpercben. |
| error |
A hiba részletei, amelyek megmagyarázzák, hogy miért nem sikerült a művelet. Ez a tulajdonság csak akkor szerepel, ha a tevékenység nem sikeres. |
|
| id |
integer (int32) |
A tevékenységrekord azonosítója. |
| imageServing |
Statisztikák a képek alkalmazásáról ehhez a visszakeresési tevékenységhez |
|
| knowledgeSourceName |
string |
A lekérési tevékenység tudásforrása. |
| mcpServerArguments |
Az MCP szerver argumentálja a visszakeresési tevékenységet. |
|
| queryTime |
string (date-time) |
A lekérési tevékenység lekérdezési ideje. |
| startedAt |
string (date-time) |
Az az időszak, amikor az esemény elkezdődött. |
| type |
string:
mcp |
A tevékenységrekord típusa. |
| warning |
string |
Egy figyelmeztető üzenet, amely a tevékenység során megfigyelhető esetleges konfigurációs problémákat mutatja fel, például a dokumentumok elvesztését pontszámozás, token korlátozás levágása vagy időkorlát miatt. |
KnowledgeBaseMcpServerReference
Egy MCP szerver dokumentumhivatkozást képvisel.
| Name | Típus | Description |
|---|---|---|
| activitySource |
integer (int32) |
A hivatkozás forrástevékenység-azonosítója. |
| id |
string |
A hivatkozás azonosítója. |
| rerankerScore |
number (float) |
A dokumentumhivatkozás reranker pontszáma. |
| sourceData |
A hivatkozás forrásadatai. |
|
| title |
string |
Az MCP szerver eszköz eredményének címe. |
| toolName |
string |
Az MCP szerver eszköz neve, amely a hivatkozást létrehozta. |
| type |
string:
mcp |
A hivatkozás típusa. |
KnowledgeBaseMessage
A természetes nyelvű üzenetstílus-objektum.
| Name | Típus | Description |
|---|---|---|
| content | KnowledgeBaseMessageContent[]: |
Az üzenet tartalma. |
| role |
string |
Az eszközválasz szerepe. |
KnowledgeBaseMessageContentType
Az üzenet tartalmának típusa.
| Érték | Description |
|---|---|
| text |
Szöveges üzenet tartalomtípusa. |
| image |
Képüzenet tartalma típus. |
KnowledgeBaseMessageImageContent
Kép üzenet típusa.
| Name | Típus | Description |
|---|---|---|
| image |
A kép tartalma. |
|
| type |
string:
image |
Az üzenet típusa |
KnowledgeBaseMessageTextContent
Szöveges üzenet típusa.
| Name | Típus | Description |
|---|---|---|
| text |
string |
A szöveges tartalom. |
| type |
string:
text |
Az üzenet típusa |
KnowledgeBaseModelAnswerSynthesisActivityRecord
Egy LLM-válaszszintézis tevékenységrekordot jelöl.
| Name | Típus | Description |
|---|---|---|
| completedAt |
string (date-time) |
Az idő, amikor a tevékenység befejeződött. |
| elapsedMs |
integer (int32) |
A lekérési tevékenység eltelt ideje ezredmásodpercben. |
| error |
A hiba részletei, amelyek megmagyarázzák, hogy miért nem sikerült a művelet. Ez a tulajdonság csak akkor szerepel, ha a tevékenység nem sikeres. |
|
| id |
integer (int32) |
A tevékenységrekord azonosítója. |
| inputTokens |
integer (int32) |
Az LLM-válaszszintézis tevékenység bemeneti tokenjeinek száma. |
| model |
Az LLM válasz szintézistevékenységéhez használt modell. |
|
| outputTokens |
integer (int32) |
Az LLM-válaszszintézis tevékenység kimeneti jogkivonatainak száma. |
| startedAt |
string (date-time) |
Az az időszak, amikor az esemény elkezdődött. |
| type |
string:
model |
A tevékenységrekord típusa. |
| warning |
string |
Egy figyelmeztető üzenet, amely a tevékenység során megfigyelhető esetleges konfigurációs problémákat mutatja fel, például a dokumentumok elvesztését pontszámozás, token korlátozás levágása vagy időkorlát miatt. |
KnowledgeBaseModelQueryPlanningActivityRecord
Egy LLM-lekérdezéstervezési tevékenységrekordot jelöl.
| Name | Típus | Description |
|---|---|---|
| completedAt |
string (date-time) |
Az idő, amikor a tevékenység befejeződött. |
| elapsedMs |
integer (int32) |
A lekérési tevékenység eltelt ideje ezredmásodpercben. |
| error |
A hiba részletei, amelyek megmagyarázzák, hogy miért nem sikerült a művelet. Ez a tulajdonság csak akkor szerepel, ha a tevékenység nem sikeres. |
|
| id |
integer (int32) |
A tevékenységrekord azonosítója. |
| inputTokens |
integer (int32) |
Az LLM-lekérdezés tervezési tevékenységének bemeneti jogkivonatainak száma. |
| model |
Az LLM lekérdezés-tervezési tevékenységhez használt modell. |
|
| outputTokens |
integer (int32) |
Az LLM-lekérdezés tervezési tevékenységének kimeneti jogkivonatainak száma. |
| startedAt |
string (date-time) |
Az az időszak, amikor az esemény elkezdődött. |
| type |
string:
model |
A tevékenységrekord típusa. |
| warning |
string |
Egy figyelmeztető üzenet, amely a tevékenység során megfigyelhető esetleges konfigurációs problémákat mutatja fel, például a dokumentumok elvesztését pontszámozás, token korlátozás levágása vagy időkorlát miatt. |
KnowledgeBaseModelWebSummarizationActivityRecord
Egy LLM webes összefoglaló tevékenységi rekordot képvisel.
| Name | Típus | Description |
|---|---|---|
| completedAt |
string (date-time) |
Az idő, amikor a tevékenység befejeződött. |
| elapsedMs |
integer (int32) |
A lekérési tevékenység eltelt ideje ezredmásodpercben. |
| error |
A hiba részletei, amelyek megmagyarázzák, hogy miért nem sikerült a művelet. Ez a tulajdonság csak akkor szerepel, ha a tevékenység nem sikeres. |
|
| id |
integer (int32) |
A tevékenységrekord azonosítója. |
| inputTokens |
integer (int32) |
Az LLM webes összefoglaló tevékenységhez bemeneti tokenek száma. |
| model |
Az LLM webes összefoglaló tevékenységéhez használt modell. |
|
| outputTokens |
integer (int32) |
Az LLM webes összefoglaló tevékenységhez tartozó kimeneti tokenek száma. |
| startedAt |
string (date-time) |
Az az időszak, amikor az esemény elkezdődött. |
| type |
string:
model |
A tevékenységrekord típusa. |
| warning |
string |
Egy figyelmeztető üzenet, amely a tevékenység során megfigyelhető esetleges konfigurációs problémákat mutatja fel, például a dokumentumok elvesztését pontszámozás, token korlátozás levágása vagy időkorlát miatt. |
KnowledgeBaseQueryHintProcessing
Részletek a lekérdezési tippekből generált kifejezésekről egy lekérdezési tevékenységhez.
| Name | Típus | Description |
|---|---|---|
| generatedBoost |
string |
A keresési záradék, amely a funkció bónusz tippjéből származik. |
| generatedFilter |
string |
A szűrőből generált szűrőkifejezés tippeket ad ehhez az aktivitáshoz. |
KnowledgeBaseReferenceType
A hivatkozás típusa.
| Érték | Description |
|---|---|
| searchIndex |
Keress index dokumentum hivatkozást. |
| azureBlob |
Azure Blob document reference. |
| indexedSharePoint |
Indexelt SharePoint dokumentumhivatkozás. |
| indexedOneLake |
Indexelt OneLake dokumentumhivatkozás. |
| web |
Webes dokumentum hivatkozás. |
| remoteSharePoint |
Távoli SharePoint dokumentumhivatkozás. |
| workIQ |
Munka IQ dokumentum hivatkozás. |
| fabricDataAgent |
Fabric Data Agent dokumentumhivatkozás. |
| fabricOntology |
Fabric Ontology dokumentum hivatkozás. |
| mcpServer |
MCP szerver dokumentum hivatkozás. |
| file |
Fájl dokumentum hivatkozás. |
| indexedSql |
Indexelt SQL dokumentum hivatkozás. |
KnowledgeBaseRemoteSharePointActivityArguments
Képviseli azokat az argumentumokat, amelyekkel a távoli SharePoint-lekérési tevékenység futott.
| Name | Típus | Description |
|---|---|---|
| filterExpressionAddOn |
string |
A szűrő kifejezés kiegészítője a visszakeresési tevékenységhez. |
| search |
string |
A keresési string a távoli SharePoint tudásforrás lekérdezésére szolgált. |
KnowledgeBaseRemoteSharePointActivityRecord
Egy távoli SharePoint lekérdezési tevékenységi rekordot képvisel.
| Name | Típus | Description |
|---|---|---|
| completedAt |
string (date-time) |
Az idő, amikor a tevékenység befejeződött. |
| count |
integer (int32) |
A visszakeresett dokumentumok száma, amelyek kellően relevánsak voltak ahhoz, hogy átlépjék a reranker küszöbértéket. |
| elapsedMs |
integer (int32) |
A lekérési tevékenység eltelt ideje ezredmásodpercben. |
| error |
A hiba részletei, amelyek megmagyarázzák, hogy miért nem sikerült a művelet. Ez a tulajdonság csak akkor szerepel, ha a tevékenység nem sikeres. |
|
| id |
integer (int32) |
A tevékenységrekord azonosítója. |
| imageServing |
Statisztikák a képek alkalmazásáról ehhez a visszakeresési tevékenységhez |
|
| knowledgeSourceName |
string |
A lekérési tevékenység tudásforrása. |
| queryTime |
string (date-time) |
A lekérési tevékenység lekérdezési ideje. |
| remoteSharePointArguments |
A távoli SharePoint argumentumok a lekérdezési tevékenységhez. |
|
| startedAt |
string (date-time) |
Az az időszak, amikor az esemény elkezdődött. |
| type |
string:
remote |
A tevékenységrekord típusa. |
| warning |
string |
Egy figyelmeztető üzenet, amely a tevékenység során megfigyelhető esetleges konfigurációs problémákat mutatja fel, például a dokumentumok elvesztését pontszámozás, token korlátozás levágása vagy időkorlát miatt. |
KnowledgeBaseRemoteSharePointReference
Távoli SharePoint-dokumentumhivatkozást jelöl.
| Name | Típus | Description |
|---|---|---|
| activitySource |
integer (int32) |
A hivatkozás forrástevékenység-azonosítója. |
| id |
string |
A hivatkozás azonosítója. |
| rerankerScore |
number (float) |
A dokumentumhivatkozás reranker pontszáma. |
| searchSensitivityLabelInfo |
Az érzékenységi címkék adatai a hivatkozáshoz. |
|
| sourceData |
A hivatkozás forrásadatai. |
|
| type |
string:
remote |
A hivatkozás típusa. |
| webUrl |
string (uri) |
Az az URL, ahonnan a referenciaadatok származnak. |
KnowledgeBaseRetrievalRequest
A lekérési kérelem bemeneti szerződése.
| Name | Típus | Description |
|---|---|---|
| includeActivity |
boolean |
Azt jelzi, hogy a lekérési eredményeknek tartalmazniuk kell a tevékenység adatait. |
| intents | KnowledgeRetrievalIntent[]: |
A modelllekérdezés-tervezés nélkül végrehajtandó tervezett lekérdezések listája. |
| knowledgeSourceParams |
KnowledgeSourceParams[]:
|
A tudásforrások futásidejű paramétereinek listája. |
| maxOutputDocuments |
integer (int32) |
Korlátozza a kimenetben lévő dokumentumok maximális számát. |
| maxOutputSize |
integer (int32) |
Korlátozza a kimenet tartalmának maximális méretét. |
| maxOutputSizeInTokens |
integer (int32) |
Korlátozza a kimenet tartalmának maximális méretét. |
| maxRuntimeInSeconds |
integer (int32) |
A maximális futási idő másodpercben. |
| messages |
A csevegőüzenetek stílusának listája. |
|
| outputMode |
A lekérés kimeneti konfigurációja. |
|
| retrievalReasoningEffort | KnowledgeRetrievalReasoningEffort: |
A visszakeresés, érvelési erőfeszítés konfigurációja. |
KnowledgeBaseRetrievalResponse
A lekérési válasz kimeneti szerződése.
KnowledgeBaseSearchIndexActivityArguments
A keresési index lekérési tevékenységét futtató argumentumokat jelöli.
| Name | Típus | Description |
|---|---|---|
| filter |
string |
A szűrősztring. |
| queryType |
A lekérdezési szintaxis, amelyet a keresés végrehajtásához használtak. A lekérdezési tippek miatt a szemantikai lekérdezések teljes lekérdezési szintaxisát alkalmaznak. |
|
| search |
string |
A keresési index lekérdezéséhez használt keresési sztring. |
| searchFields |
Milyen területekre kerestek. |
|
| semanticConfigurationName |
string |
Milyen szemantikai konfigurációt használtak a keresési indexből. |
| sourceDataFields |
Milyen mezőket választottak ki a kereséshez. |
KnowledgeBaseSearchIndexActivityRecord
A keresési index lekérési tevékenységrekordját jelöli.
| Name | Típus | Description |
|---|---|---|
| completedAt |
string (date-time) |
Az idő, amikor a tevékenység befejeződött. |
| count |
integer (int32) |
A visszakeresett dokumentumok száma, amelyek kellően relevánsak voltak ahhoz, hogy átlépjék a reranker küszöbértéket. |
| elapsedMs |
integer (int32) |
A lekérési tevékenység eltelt ideje ezredmásodpercben. |
| error |
A hiba részletei, amelyek megmagyarázzák, hogy miért nem sikerült a művelet. Ez a tulajdonság csak akkor szerepel, ha a tevékenység nem sikeres. |
|
| id |
integer (int32) |
A tevékenységrekord azonosítója. |
| imageServing |
Statisztikák a képek alkalmazásáról ehhez a visszakeresési tevékenységhez |
|
| knowledgeSourceName |
string |
A lekérési tevékenység tudásforrása. |
| queryHintProcessing |
Részletek a keresési tippekből generált kifejezésekről ehhez a tevékenységhez. |
|
| queryTime |
string (date-time) |
A lekérési tevékenység lekérdezési ideje. |
| searchIndexArguments |
A lekérési tevékenység keresési indexargumentumai. |
|
| startedAt |
string (date-time) |
Az az időszak, amikor az esemény elkezdődött. |
| type |
string:
search |
A tevékenységrekord típusa. |
| warning |
string |
Egy figyelmeztető üzenet, amely a tevékenység során megfigyelhető esetleges konfigurációs problémákat mutatja fel, például a dokumentumok elvesztését pontszámozás, token korlátozás levágása vagy időkorlát miatt. |
KnowledgeBaseSearchIndexReference
Egy Azure Search-dokumentumhivatkozást jelöl.
| Name | Típus | Description |
|---|---|---|
| activitySource |
integer (int32) |
A hivatkozás forrástevékenység-azonosítója. |
| citationUrl |
string (uri) |
Egy kereséshez tartozó URL, amely a hivatkozás mögötti dokumentumára mutat, és hivatkozási célpontként használható. |
| docKey |
string |
A hivatkozás dokumentumkulcsa. |
| id |
string |
A hivatkozás azonosítója. |
| rerankerScore |
number (float) |
A dokumentumhivatkozás reranker pontszáma. |
| searchSensitivityLabelInfo |
Az érzékenységi címkék adatai a hivatkozáshoz. |
|
| sourceData |
A hivatkozás forrásadatai. |
|
| type |
string:
search |
A hivatkozás típusa. |
KnowledgeBaseWebActivityArguments
Képviseli azokat az argumentokat, amelyekkel a web-visszakeresési tevékenység futott.
| Name | Típus | Description |
|---|---|---|
| count |
integer (int32) |
A visszanyert webes eredmények száma. |
| freshness |
string |
A frissesség a visszaszerzési tevékenységhez. |
| language |
string |
A visszahívási tevékenység nyelve. |
| market |
string |
A visszanyerési tevékenység piaca. |
| search |
string |
A keresőlánc, amelyet a weben lekérdezésre használtak. |
KnowledgeBaseWebActivityRecord
Egy web-visszakeresési tevékenységi rekordot képvisel.
| Name | Típus | Description |
|---|---|---|
| completedAt |
string (date-time) |
Az idő, amikor a tevékenység befejeződött. |
| count |
integer (int32) |
A visszakeresett dokumentumok száma, amelyek kellően relevánsak voltak ahhoz, hogy átlépjék a reranker küszöbértéket. |
| elapsedMs |
integer (int32) |
A lekérési tevékenység eltelt ideje ezredmásodpercben. |
| error |
A hiba részletei, amelyek megmagyarázzák, hogy miért nem sikerült a művelet. Ez a tulajdonság csak akkor szerepel, ha a tevékenység nem sikeres. |
|
| id |
integer (int32) |
A tevékenységrekord azonosítója. |
| imageServing |
Statisztikák a képek alkalmazásáról ehhez a visszakeresési tevékenységhez |
|
| knowledgeSourceName |
string |
A lekérési tevékenység tudásforrása. |
| queryTime |
string (date-time) |
A lekérési tevékenység lekérdezési ideje. |
| startedAt |
string (date-time) |
Az az időszak, amikor az esemény elkezdődött. |
| type |
string:
web |
A tevékenységrekord típusa. |
| warning |
string |
Egy figyelmeztető üzenet, amely a tevékenység során megfigyelhető esetleges konfigurációs problémákat mutatja fel, például a dokumentumok elvesztését pontszámozás, token korlátozás levágása vagy időkorlát miatt. |
| webArguments |
A webes érvek a visszakeresési tevékenységre. |
KnowledgeBaseWebReference
Webes dokumentumhivatkozást jelöl.
| Name | Típus | Description |
|---|---|---|
| activitySource |
integer (int32) |
A hivatkozás forrástevékenység-azonosítója. |
| id |
string |
A hivatkozás azonosítója. |
| rerankerScore |
number (float) |
A dokumentumhivatkozás reranker pontszáma. |
| sourceData |
A hivatkozás forrásadatai. |
|
| title |
string |
A webes dokumentum címe. |
| type |
string:
web |
A hivatkozás típusa. |
| url |
string (uri) |
Az az URL, ahonnan a referenciaadatok származnak. |
KnowledgeBaseWorkIQActivityArguments
Képviseli azokat az argumentumokat, amelyekkel a WorkIQ lekérdezési tevékenységet futtatták.
| Name | Típus | Description |
|---|---|---|
| search |
string |
A kereső string a WorkIQ tudásforrásának lekérdezésére szolgált. |
KnowledgeBaseWorkIQActivityRecord
A WorkIQ visszakeresési tevékenységi rekordot képviseli.
| Name | Típus | Description |
|---|---|---|
| completedAt |
string (date-time) |
Az idő, amikor a tevékenység befejeződött. |
| count |
integer (int32) |
A visszakeresett dokumentumok száma, amelyek kellően relevánsak voltak ahhoz, hogy átlépjék a reranker küszöbértéket. |
| elapsedMs |
integer (int32) |
A lekérési tevékenység eltelt ideje ezredmásodpercben. |
| error |
A hiba részletei, amelyek megmagyarázzák, hogy miért nem sikerült a művelet. Ez a tulajdonság csak akkor szerepel, ha a tevékenység nem sikeres. |
|
| id |
integer (int32) |
A tevékenységrekord azonosítója. |
| imageServing |
Statisztikák a képek alkalmazásáról ehhez a visszakeresési tevékenységhez |
|
| knowledgeSourceName |
string |
A lekérési tevékenység tudásforrása. |
| queryTime |
string (date-time) |
A lekérési tevékenység lekérdezési ideje. |
| startedAt |
string (date-time) |
Az az időszak, amikor az esemény elkezdődött. |
| type |
string:
workIQ |
A tevékenységrekord típusa. |
| warning |
string |
Egy figyelmeztető üzenet, amely a tevékenység során megfigyelhető esetleges konfigurációs problémákat mutatja fel, például a dokumentumok elvesztését pontszámozás, token korlátozás levágása vagy időkorlát miatt. |
| workIQArguments |
A WorkIQ argumentumok a visszakeresési tevékenységre. |
KnowledgeBaseWorkIQReference
WorkIQ dokumentumhivatkozást képvisel.
| Name | Típus | Description |
|---|---|---|
| activitySource |
integer (int32) |
A hivatkozás forrástevékenység-azonosítója. |
| id |
string |
A hivatkozás azonosítója. |
| rerankerScore |
number (float) |
A dokumentumhivatkozás reranker pontszáma. |
| searchSensitivityLabelInfo |
Az érzékenységi címkék adatai a hivatkozáshoz. |
|
| sourceData |
A hivatkozás forrásadatai. |
|
| type |
string:
workIQ |
A hivatkozás típusa. |
KnowledgeRetrievalAutoReasoningEffort
Automatikusan válassza ki az érvelési erőfeszítést a visszakeresés során. A szolgáltatás minden kérést a legolcsóbb szintre vet, és csak annyira eszkalál, amennyire szükséges, egészen a szolgáltatás maximálisan elérhető szintjéig.
| Name | Típus | Description |
|---|---|---|
| kind |
string:
auto |
Az a fajta érvelési erőfeszítés. |
KnowledgeRetrievalIntentType
A használni kívánt tudásbázis-konfiguráció típusa.
| Érték | Description |
|---|---|
| semantic |
Természetes nyelvi szemantikai lekérdezési szándék. |
KnowledgeRetrievalLowReasoningEffort
Futtassa a tudás visszakeresését alacsony érvelési erőfeszítéssel.
| Name | Típus | Description |
|---|---|---|
| kind |
string:
low |
Az a fajta érvelési erőfeszítés. |
KnowledgeRetrievalMediumReasoningEffort
Futtassa a tudás visszakeresését közepes érvelési erőfeszítéssel.
| Name | Típus | Description |
|---|---|---|
| kind |
string:
medium |
Az a fajta érvelési erőfeszítés. |
KnowledgeRetrievalMinimalReasoningEffort
Futtassa a tudás visszakeresését minimális érvelési erőfeszítéssel.
| Name | Típus | Description |
|---|---|---|
| kind |
string:
minimal |
Az a fajta érvelési erőfeszítés. |
KnowledgeRetrievalOutputMode
A lekérés kimeneti konfigurációja.
| Érték | Description |
|---|---|
| extractiveData |
Adatok visszaadása a tudásforrásokból közvetlenül, generatív módosítás nélkül. |
| answerSynthesis |
Szintetizáljon egy választ a válasz hasznos adataira. |
KnowledgeRetrievalReasoningEffortKind
A visszakeresés során felhasználandó erőfeszítés mértéke.
| Érték | Description |
|---|---|
| minimal |
Nem végez forrásválasztást, lekérdezéstervezést vagy iteratív keresést. |
| low |
Használjon alacsony érvelést a lekérés során. |
| medium |
Használjon mérsékelt érvelést a visszakeresés során. |
| auto |
Automatikusan válassza ki az érvelési erőfeszítést a visszakeresés során, csak a legolcsóbb szinttől csak annyira emeljenek, amennyire szükséges. |
KnowledgeRetrievalSemanticIntent
Egy szemantikai lekérdezési szándék.
| Name | Típus | Description |
|---|---|---|
| search |
string |
A végrehajtandó szemantikai lekérdezés |
| type |
string:
semantic |
A szándék típusa. |
KnowledgeSourceKind
A tudásforrás fajtája.
| Érték | Description |
|---|---|
| searchIndex |
Olyan tudásforrás, amely adatokat olvas be egy keresési indexből. |
| azureBlob |
Olyan tudásforrás, amely adatokat olvas és tölt be az Azure Blob Storage-ból egy keresési indexbe. |
| indexedSharePoint |
Egy tudásforrás, amely adatokat olvas az indexelt SharePoint-ről. |
| indexedOneLake |
Egy tudásforrás, amely adatokat olvas az indexelt OneLake-ből. |
| indexedSql |
Egy tudásforrás, amely adatokat keres és fogad be Azure SQL Database-ből vagy SQL Managed Instance-ból egy Search Indexbe. |
| web |
Egy tudásforrás, amely adatokat olvas a webről. |
| remoteSharePoint |
Egy tudásforrás, amely adatokat olvas a távoli SharePoint-ról. |
| workIQ |
Egy tudásforrás, amely a munkahelyi IQ-ból olvas adatokat. |
| file |
Egy tudásforrás, amely támogatja a közvetlen fájlfeltöltést és indexelést. |
| mcpServer |
Egy MCP (Model Context Protocol) szerver által támogatott tudásforrás. |
| fabricDataAgent |
Egy tudásforrás, amely adatokat gyűjt egy Fabric Data Agent-ből. |
| fabricOntology |
Egy tudásforrás, amely adatokat keres a Microsoft Fabric Ontology ontológiaiból. |
KnowledgeSourceResultsProcessing
Szabályozza, hogy egy tudásforrás eredményei újrarangsorolódnak-e.
| Érték | Description |
|---|---|
| rerank |
A tudásforrásból származó eredmények átmennek az újrarangsorolási folyamaton. Ez az alapértelmezett viselkedés. |
| none |
Ennek a tudásforrásnak az eredményei megkerülik az újrarangolást, és megőrzik az alapvető sorrendet. |
McpServerKnowledgeSourceParams
Meghatározza a futási idejű paramétereket egy MCP szerver tudásforrásához
| Name | Típus | Description |
|---|---|---|
| alwaysQuerySource |
boolean |
Azt jelzi, hogy ennek a tudásforrásnak meg kell kerülnie a forrás kiválasztását, és mindig le kell kérdeznie a lekéréskor. |
| enableImageServing |
boolean |
Jelzi, hogy a képszolgáltatást engedélyezni kell-e ezen a tudásforrásnak a lekérdezés idején. Ha igaz, a felvétel során kinyert képek a következő modellekhez jutnak. |
| failOnError |
boolean |
Jelzi, hogy az egész lekérdezési kérelemnek meghibásodnia kell, ha a tudásforrásból történő visszakeresés hibával találkozik. Alapértelmezés szerint hamis. |
| includeReferenceSourceData |
boolean |
Azt jelzi, hogy a hivatkozásoknak tartalmazniuk kell-e a lekérés során kapott strukturált adatokat a hasznos adatokban. |
| includeReferences |
boolean |
Azt jelzi, hogy a forrásból beolvasott adatokhoz kell-e hivatkozásokat is belefoglalni. |
| kind |
string:
mcp |
A tudásforrás típusa. |
| knowledgeSourceName |
string |
Annak az indexnek a neve, amelyre a paraméterek vonatkoznak. |
| maxOutputDocuments |
integer (int32) |
Korlátozza a dokumentumok maximális számát ebből a tudásforrásból. |
| neverQuerySource |
boolean |
Jelzi, hogy ezt a tudásforrást ki kell zárni a kérelem jelöltkészletéből, és soha nem kell lekérdezni a lekérdezés idején. A kizárás helyi kérés, és nem módosítja a tudásbázis tagságát. Nem lehet összevonni alwaysQuerySource-val ugyanazon a tudásforráson. |
| rerankerThreshold |
number (float) |
Az újrarangsoroló küszöbértéke, amelyet minden lekért dokumentumnak meg kell felelnie ahhoz, hogy szerepeljen a válaszban. |
| resultsProcessing |
Felülírja a tudásforrás tárolt eredményeitFeldolgozás csak ehhez a híváshoz. Ha kihagyják, a tárolt tudásforrás értéke érvényes. |
PurviewSensitivityLabelInfo
Információ a dokumentumra alkalmazott érzékenységi címkéről
| Name | Típus | Description |
|---|---|---|
| color |
string |
A felhasználói felület által megjelenítendő szín a címkénél, ha konfigurálva van. |
| displayName |
string |
A bizalmassági címke megjelenítendő neve. |
| isEncrypted |
boolean |
Azt jelzi, hogy a bizalmassági címke kényszeríti-e a titkosítást. |
| priority |
integer (int32) |
A bizalmassági címke alkalmazásának prioritása. |
| sensitivityLabelId |
string |
A bizalmassági címke azonosítója. |
| toolTip |
string |
A felhasználói felületen a címkéhez megjelenítendő elemleírás. |
QueryType
Megadja a keresési lekérdezés szintaxisát. Az alapértelmezett érték az "egyszerű". Használja a "teljes" szót, ha a lekérdezés a Lucene-lekérdezés szintaxisát használja, és a "szemantikai" szót, ha nincs szükség lekérdezési szintaxisra.
| Érték | Description |
|---|---|
| simple |
Az egyszerű lekérdezési szintaxist használja a keresésekhez. A keresési szöveg értelmezése egy egyszerű lekérdezési nyelvvel történik, amely lehetővé teszi az olyan szimbólumok használatát, mint a +, * és "". A lekérdezések kiértékelése alapértelmezés szerint az összes kereshető mezőben megtörténik, kivéve, ha a searchFields paraméter meg van adva. |
| full |
A keresésekhez a teljes Lucene-lekérdezési szintaxist használja. A keresési szöveg értelmezése a Lucene lekérdezési nyelven történik, amely lehetővé teszi a mezőspecifikus és súlyozott keresést, valamint más speciális funkciókat. |
| semantic |
A legalkalmasabb a természetes nyelven kifejezett lekérdezésekhez, nem pedig a kulcsszavakhoz. Javítja a keresési eredmények pontosságát azáltal, hogy a webes korpuszon betanított rangsorolási modell segítségével újrarangsorolja a legjobb keresési eredményeket. |
RemoteSharePointKnowledgeSourceParams
Távoli SharePoint-tudásforrás futásidejű paramétereit adja meg
| Name | Típus | Description |
|---|---|---|
| alwaysQuerySource |
boolean |
Azt jelzi, hogy ennek a tudásforrásnak meg kell kerülnie a forrás kiválasztását, és mindig le kell kérdeznie a lekéréskor. |
| enableImageServing |
boolean |
Jelzi, hogy a képszolgáltatást engedélyezni kell-e ezen a tudásforrásnak a lekérdezés idején. Ha igaz, a felvétel során kinyert képek a következő modellekhez jutnak. |
| failOnError |
boolean |
Jelzi, hogy az egész lekérdezési kérelemnek meghibásodnia kell, ha a tudásforrásból történő visszakeresés hibával találkozik. Alapértelmezés szerint hamis. |
| filterExpressionAddOn |
string |
A SharePoint-adatforrásra alkalmazott szűrési feltétel. Ezt meg kell adni a Kulcsszó lekérdezési nyelve szintaxisban. A rendszer a tudásforrás definíciójában megadott szűrőkifejezéssel együttesen kombinálja. |
| includeReferenceSourceData |
boolean |
Azt jelzi, hogy a hivatkozásoknak tartalmazniuk kell-e a lekérés során kapott strukturált adatokat a hasznos adatokban. |
| includeReferences |
boolean |
Azt jelzi, hogy a forrásból beolvasott adatokhoz kell-e hivatkozásokat is belefoglalni. |
| kind |
string:
remote |
A tudásforrás típusa. |
| knowledgeSourceName |
string |
Annak az indexnek a neve, amelyre a paraméterek vonatkoznak. |
| maxOutputDocuments |
integer (int32) |
Korlátozza a dokumentumok maximális számát ebből a tudásforrásból. |
| neverQuerySource |
boolean |
Jelzi, hogy ezt a tudásforrást ki kell zárni a kérelem jelöltkészletéből, és soha nem kell lekérdezni a lekérdezés idején. A kizárás helyi kérés, és nem módosítja a tudásbázis tagságát. Nem lehet összevonni alwaysQuerySource-val ugyanazon a tudásforráson. |
| rerankerThreshold |
number (float) |
Az újrarangsoroló küszöbértéke, amelyet minden lekért dokumentumnak meg kell felelnie ahhoz, hogy szerepeljen a válaszban. |
| resultsProcessing |
Felülírja a tudásforrás tárolt eredményeitFeldolgozás csak ehhez a híváshoz. Ha kihagyják, a tárolt tudásforrás értéke érvényes. |
SearchIndexFieldReference
Mezőreferenciát a keresési indexhez.
| Name | Típus | Description |
|---|---|---|
| name |
string |
A mező neve. |
SearchIndexKnowledgeSourceBoostKind
Ez a fajta boost tipp egy keresőindex-forráshoz.
| Érték | Description |
|---|---|
| fieldValue |
Boostolj dokumentumokat egy mezőérték alapján. |
| multiWordExpression |
A dokumentumok fejlesztése egy többszavas kifejezés alapján. |
SearchIndexKnowledgeSourceFieldValueBoost
Egy tipp, amely a dokumentumokat egy mezőérték alapján növeli.
| Name | Típus | Description |
|---|---|---|
| boost |
number (double) |
A dokumentumpontszám szorzója. Pozitív számnak kell lennie, amely nem egyenlő 1,0-sal. |
| boostInstructions |
string |
Természetes nyelvű utasítások, amelyek elmagyarázzák, mikor és hogyan kell alkalmazni a boostot. |
| field |
string minLength: 1 |
A keresőindex mező neve. |
| fieldValues |
string[] |
A mező reprezentatív értékei. |
| kind |
string:
field |
Olyan erősítő tipp. |
SearchIndexKnowledgeSourceFilterHint
Egy tipp, amely azonosít egy mezőt és azokat a reprezentív értékeket, amelyeket a lekérdezéstervező használhat szűrő építésekor.
| Name | Típus | Description |
|---|---|---|
| field |
string minLength: 1 |
A szűrhető keresési index mező neve. |
| fieldValues |
string[] |
A mező reprezentatív értékei. |
| filterInstructions |
string |
Természetes nyelvű utasítások, amelyek elmagyarázzák, mikor és hogyan kell szűrni a mezőn. |
SearchIndexKnowledgeSourceMultiWordExpressionBoost
Egy tipp, amely több szavas kifejezés alapján erősíti a dokumentumokat.
| Name | Típus | Description |
|---|---|---|
| boost |
number (double) |
A dokumentumpontszám szorzója. Pozitív számnak kell lennie, amely nem egyenlő 1,0-sal. |
| boostInstructions |
string |
Természetes nyelvű utasítások, amelyek elmagyarázzák, mikor és hogyan kell alkalmazni a boostot. |
| fieldValues |
string[] |
Reprezentatív értékek a bónuszhoz. |
| kind |
string:
multi |
Olyan erősítő tipp. |
SearchIndexKnowledgeSourceParams
Futásidejű paramétereket ad meg egy keresési index tudásforráshoz
| Name | Típus | Description |
|---|---|---|
| alwaysQuerySource |
boolean |
Azt jelzi, hogy ennek a tudásforrásnak meg kell kerülnie a forrás kiválasztását, és mindig le kell kérdeznie a lekéréskor. |
| enableImageServing |
boolean |
Jelzi, hogy a képszolgáltatást engedélyezni kell-e ezen a tudásforrásnak a lekérdezés idején. Ha igaz, a felvétel során kinyert képek a következő modellekhez jutnak. |
| failOnError |
boolean |
Jelzi, hogy az egész lekérdezési kérelemnek meghibásodnia kell, ha a tudásforrásból történő visszakeresés hibával találkozik. Alapértelmezés szerint hamis. |
| filterAddOn |
string |
Az indexre alkalmazott szűrési feltétel (pl. "State eq VA"). |
| includeReferenceSourceData |
boolean |
Azt jelzi, hogy a hivatkozásoknak tartalmazniuk kell-e a lekérés során kapott strukturált adatokat a hasznos adatokban. |
| includeReferences |
boolean |
Azt jelzi, hogy a forrásból beolvasott adatokhoz kell-e hivatkozásokat is belefoglalni. |
| kind |
string:
search |
A tudásforrás típusa. |
| knowledgeSourceName |
string |
Annak az indexnek a neve, amelyre a paraméterek vonatkoznak. |
| maxOutputDocuments |
integer (int32) |
Korlátozza a dokumentumok maximális számát ebből a tudásforrásból. |
| neverQuerySource |
boolean |
Jelzi, hogy ezt a tudásforrást ki kell zárni a kérelem jelöltkészletéből, és soha nem kell lekérdezni a lekérdezés idején. A kizárás helyi kérés, és nem módosítja a tudásbázis tagságát. Nem lehet összevonni alwaysQuerySource-val ugyanazon a tudásforráson. |
| queryHintOverrides |
Tippek, amelyek segítenek a lekérdezési tervezésben hasznos szűrők és bónuszok felé. Ha ez a tárgy megadja a tudásforráson konfigurált teljes lekérdezési tippkészletet. |
|
| rerankerThreshold |
number (float) |
Az újrarangsoroló küszöbértéke, amelyet minden lekért dokumentumnak meg kell felelnie ahhoz, hogy szerepeljen a válaszban. |
| resultsProcessing |
Felülírja a tudásforrás tárolt eredményeitFeldolgozás csak ehhez a híváshoz. Ha kihagyják, a tárolt tudásforrás értéke érvényes. |
SearchIndexKnowledgeSourceQueryHints
Tippek, amelyek segítenek a lekérdezési tervezésben hasznos szűrők és bónuszok felé keresési index tudásforráshoz.
| Name | Típus | Description |
|---|---|---|
| boosts | SearchIndexKnowledgeSourceBoost[]: |
Erősítsd fel azokat a feltételeket, amelyeket a lekérdezési tervező használhat a dokumentumok rangsorolásának befolyásolására. |
| filters |
Szűrő tippek, amelyek azonosítják a mezőket és reprezentatív értékeket, amelyeket a lekérdezéstervező használhat szűrők építésekor. |
ServedImage
Egyetlen képet ír le, amelyet a modell kiválasztott, hogy szolgáljon egy visszakeresési tevékenység során.
| Name | Típus | Description |
|---|---|---|
| imageId |
string |
A képcímkét a forrásdokumentumból a Content Understanding enrichment által kinyerve. Megfelel az eredeti dokumentumban szereplő számszámozásnak. |
| imagePath |
string |
Az eszköz tárolón belüli relatív út a képhez. |
| sizeBytes |
integer (int64) |
A kép bájtokban terjedő mérete, ahogy a modellhez küldött. |
WebKnowledgeSourceParams
Futásidejű paramétereket ad meg egy webes tudásforráshoz
| Name | Típus | Description |
|---|---|---|
| alwaysQuerySource |
boolean |
Azt jelzi, hogy ennek a tudásforrásnak meg kell kerülnie a forrás kiválasztását, és mindig le kell kérdeznie a lekéréskor. |
| count |
integer (int32) |
A visszaadandó webes találatok száma. |
| enableImageServing |
boolean |
Jelzi, hogy a képszolgáltatást engedélyezni kell-e ezen a tudásforrásnak a lekérdezés idején. Ha igaz, a felvétel során kinyert képek a következő modellekhez jutnak. |
| failOnError |
boolean |
Jelzi, hogy az egész lekérdezési kérelemnek meghibásodnia kell, ha a tudásforrásból történő visszakeresés hibával találkozik. Alapértelmezés szerint hamis. |
| freshness |
string |
A webes eredmények frissessége. |
| includeReferenceSourceData |
boolean |
Azt jelzi, hogy a hivatkozásoknak tartalmazniuk kell-e a lekérés során kapott strukturált adatokat a hasznos adatokban. |
| includeReferences |
boolean |
Azt jelzi, hogy a forrásból beolvasott adatokhoz kell-e hivatkozásokat is belefoglalni. |
| kind |
string:
web |
A tudásforrás típusa. |
| knowledgeSourceName |
string |
Annak az indexnek a neve, amelyre a paraméterek vonatkoznak. |
| language |
string |
A webes eredmények nyelve. |
| market |
string |
A webes eredmények piaca. |
| maxOutputDocuments |
integer (int32) |
Korlátozza a dokumentumok maximális számát ebből a tudásforrásból. |
| neverQuerySource |
boolean |
Jelzi, hogy ezt a tudásforrást ki kell zárni a kérelem jelöltkészletéből, és soha nem kell lekérdezni a lekérdezés idején. A kizárás helyi kérés, és nem módosítja a tudásbázis tagságát. Nem lehet összevonni alwaysQuerySource-val ugyanazon a tudásforráson. |
| rerankerThreshold |
number (float) |
Az újrarangsoroló küszöbértéke, amelyet minden lekért dokumentumnak meg kell felelnie ahhoz, hogy szerepeljen a válaszban. |
| resultsProcessing |
Felülírja a tudásforrás tárolt eredményeitFeldolgozás csak ehhez a híváshoz. Ha kihagyják, a tárolt tudásforrás értéke érvényes. |
WorkIQKnowledgeSourceParams
Meghatározza a WorkIQ tudásforrás futási idejű paramétereit
| Name | Típus | Description |
|---|---|---|
| alwaysQuerySource |
boolean |
Azt jelzi, hogy ennek a tudásforrásnak meg kell kerülnie a forrás kiválasztását, és mindig le kell kérdeznie a lekéréskor. |
| enableImageServing |
boolean |
Jelzi, hogy a képszolgáltatást engedélyezni kell-e ezen a tudásforrásnak a lekérdezés idején. Ha igaz, a felvétel során kinyert képek a következő modellekhez jutnak. |
| failOnError |
boolean |
Jelzi, hogy az egész lekérdezési kérelemnek meghibásodnia kell, ha a tudásforrásból történő visszakeresés hibával találkozik. Alapértelmezés szerint hamis. |
| includeReferenceSourceData |
boolean |
Azt jelzi, hogy a hivatkozásoknak tartalmazniuk kell-e a lekérés során kapott strukturált adatokat a hasznos adatokban. |
| includeReferences |
boolean |
Azt jelzi, hogy a forrásból beolvasott adatokhoz kell-e hivatkozásokat is belefoglalni. |
| kind |
string:
workIQ |
A tudásforrás típusa. |
| knowledgeSourceName |
string |
Annak az indexnek a neve, amelyre a paraméterek vonatkoznak. |
| maxOutputDocuments |
integer (int32) |
Korlátozza a dokumentumok maximális számát ebből a tudásforrásból. |
| neverQuerySource |
boolean |
Jelzi, hogy ezt a tudásforrást ki kell zárni a kérelem jelöltkészletéből, és soha nem kell lekérdezni a lekérdezés idején. A kizárás helyi kérés, és nem módosítja a tudásbázis tagságát. Nem lehet összevonni alwaysQuerySource-val ugyanazon a tudásforráson. |
| rerankerThreshold |
number (float) |
Az újrarangsoroló küszöbértéke, amelyet minden lekért dokumentumnak meg kell felelnie ahhoz, hogy szerepeljen a válaszban. |
| resultsProcessing |
Felülírja a tudásforrás tárolt eredményeitFeldolgozás csak ehhez a híváshoz. Ha kihagyják, a tárolt tudásforrás értéke érvényes. |