Knowledge Retrieval - Retrieve
KnowledgeBase hämtar relevanta data från säkerhetskopieringsbutiker.
POST {endpoint}/knowledgebases('{knowledgeBaseName}')/retrieve?api-version=2026-05-01-preview
URI-parametrar
| Name | I | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
endpoint
|
path | True |
string (uri) |
Slutpunkts-URL:en för söktjänsten. |
|
knowledge
|
path | True |
string |
Namnet på kunskapsbasen. |
|
api-version
|
query | True |
string minLength: 1 |
Den API-version som ska användas för den här åtgärden. |
Begärandehuvud
| Name | Obligatorisk | Typ | Description |
|---|---|---|---|
| Accept |
Acceptera-rubriken. |
||
| x-ms-query-source-authorization |
string |
Token som identifierar den användare som frågan körs för. Denna token används för att framtvinga säkerhetsbegränsningar för dokument. |
|
| x-ms-client-request-id |
string (uuid) |
En ogenomskinlig, globalt unik, klientgenererad strängidentifierare för begäran. |
Begärandetext
| Name | Typ | Description |
|---|---|---|
| includeActivity |
boolean |
Anger att hämtningsresultaten ska innehålla aktivitetsinformation. |
| intents | KnowledgeRetrievalIntent[]: |
En lista över avsedda frågor som ska köras utan planering av modellfrågor. |
| knowledgeSourceParams |
KnowledgeSourceParams[]:
|
En lista över körningsparametrar för kunskapskällorna. |
| maxOutputDocuments |
integer (int32) |
Begränsar det maximala antalet dokument i utdatan. |
| maxOutputSize |
integer (int32) |
Begränsar den maximala storleken på innehållet i utdata. |
| maxOutputSizeInTokens |
integer (int32) |
Begränsar den maximala storleken på innehållet i utdata. |
| maxRuntimeInSeconds |
integer (int32) |
Den maximala körtiden i sekunder. |
| messages |
En lista med indata för chattmeddelandeformat. |
|
| outputMode |
Utdatakonfigurationen för den här hämtningen. |
|
| retrievalReasoningEffort | KnowledgeRetrievalReasoningEffort: |
Konfigurationen för återhämtningsresonemangsinsats. |
Svar
| Name | Typ | Description |
|---|---|---|
| 200 OK |
Lyckad uttagsrespons. |
|
| Other Status Codes |
Partiell uttagsrespons. |
|
| Other Status Codes |
Ett oväntat felsvar. |
Säkerhet
api-key
Typ:
apiKey
I:
header
OAuth2Auth
Typ:
oauth2
Flow:
implicit
Auktoriseringswebbadress:
https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Omfattningar
| Name | Description |
|---|---|
| https://search.azure.com/.default |
Exempel
|
Knowledge |
|
Knowledge |
KnowledgeBaseRetrieve
Exempelbegäran
POST https://previewexampleservice.search.windows.net/knowledgebases('base-preview-test')/retrieve?api-version=2026-05-01-preview
{
"messages": [
{
"role": "user",
"content": [
{
"text": "hello world",
"type": "text"
}
]
}
],
"maxRuntimeInSeconds": 60,
"maxOutputSize": 100000,
"maxOutputDocuments": 50,
"retrievalReasoningEffort": {
"kind": "low"
},
"includeActivity": true,
"outputMode": "answerSynthesis",
"knowledgeSourceParams": [
{
"filterAddOn": "foo eq bar",
"knowledgeSourceName": "ks-preview-test",
"includeReferences": true,
"includeReferenceSourceData": true,
"alwaysQuerySource": false,
"failOnError": false,
"rerankerThreshold": 2.1,
"kind": "searchIndex"
}
]
}
Exempelsvar
{
"response": [
{
"content": [
{
"type": "text",
"text": "[{...}]"
}
]
}
],
"activity": [
{
"type": "modelQueryPlanning",
"id": 0,
"inputTokens": 11,
"outputTokens": 22,
"elapsedMs": 10
},
{
"type": "searchIndex",
"id": 1,
"knowledgeSourceName": "ks-preview-test",
"queryTime": "2025-01-01T00:08:45.045Z",
"count": 2,
"elapsedMs": 1234,
"warning": "6 additional documents were dropped because rerankerThreshold filtered them out during reranking. Adjust the threshold if higher recall is desired.",
"searchIndexArguments": {
"search": "hello world",
"filter": "foo eq bar",
"sourceDataFields": [
{
"name": "category"
},
{
"name": "description"
},
{
"name": "ownerId"
},
{
"name": "id"
}
],
"searchFields": [],
"semanticConfigurationName": "testconfig"
}
},
{
"type": "searchIndex",
"id": 2,
"knowledgeSourceName": "ks-preview-test",
"queryTime": "2025-01-01T00:08:45.045Z",
"count": 2,
"elapsedMs": 1234,
"searchIndexArguments": {
"search": "hello world two",
"filter": "foo eq bar",
"sourceDataFields": [
{
"name": "category"
},
{
"name": "description"
},
{
"name": "ownerId"
},
{
"name": "id"
}
],
"searchFields": [],
"semanticConfigurationName": "testconfig"
}
},
{
"type": "agenticReasoning",
"id": 3,
"retrievalReasoningEffort": {
"kind": "low"
},
"reasoningTokens": 74
},
{
"type": "modelAnswerSynthesis",
"id": 4,
"inputTokens": 664,
"outputTokens": 1328,
"elapsedMs": 10
}
],
"references": [
{
"type": "searchIndex",
"id": "83dd7d40",
"activitySource": 1,
"sourceData": {
"id": "myDocKey1",
"title": "high_doc",
"content": "hello world"
},
"rerankerScore": 3.5,
"docKey": "myDocKey1"
},
{
"type": "searchIndex",
"id": "83dd7d41",
"activitySource": 1,
"sourceData": {
"id": "myDocKey2",
"title": "low_doc",
"content": "goodbye world"
},
"rerankerScore": 2.7,
"docKey": "myDocKey2"
}
],
"responseSensitivityLabelInfo": {
"displayName": "Confidential",
"sensitivityLabelId": "00000000-0000-0000-0000-000000000001",
"toolTip": "This content is confidential.",
"priority": 2,
"color": "#FF0000",
"isEncrypted": false
}
}
{
"response": [
{
"content": [
{
"type": "text",
"text": "[{...}]"
}
]
}
],
"activity": [
{
"type": "modelQueryPlanning",
"id": 0,
"inputTokens": 11,
"outputTokens": 22,
"elapsedMs": 10
},
{
"type": "searchIndex",
"id": 1,
"knowledgeSourceName": "ks-preview-test",
"queryTime": "2025-01-01T00:08:45.045Z",
"count": 2,
"elapsedMs": 1234,
"searchIndexArguments": {
"search": "hello world",
"filter": "foo eq bar",
"sourceDataFields": [
{
"name": "category"
},
{
"name": "description"
},
{
"name": "ownerId"
},
{
"name": "id"
}
],
"searchFields": [],
"semanticConfigurationName": "testconfig"
}
},
{
"type": "web",
"id": 2,
"knowledgeSourceName": "ks-preview-web",
"queryTime": "2025-01-01T00:08:45.045Z",
"count": 10,
"elapsedMs": 2345,
"error": {
"code": "403",
"message": "The error message",
"details": [],
"additionalInfo": [
{
"type": "SomeErrorType",
"info": {
"someProperty": "Some value"
}
}
]
}
},
{
"type": "agenticReasoning",
"id": 3,
"retrievalReasoningEffort": {
"kind": "low"
},
"reasoningTokens": 74
},
{
"type": "modelAnswerSynthesis",
"id": 4,
"inputTokens": 664,
"outputTokens": 1328,
"elapsedMs": 10
}
],
"references": [
{
"type": "searchIndex",
"id": "83dd7d40",
"activitySource": 1,
"sourceData": {
"id": "myDocKey1",
"title": "high_doc",
"content": "hello world"
},
"rerankerScore": 3.5,
"docKey": "myDocKey1"
},
{
"type": "searchIndex",
"id": "83dd7d41",
"activitySource": 1,
"sourceData": {
"id": "myDocKey2",
"title": "low_doc",
"content": "goodbye world"
},
"rerankerScore": 2.7,
"docKey": "myDocKey2"
}
]
}
KnowledgeBaseRetrieveWithIntents
Exempelbegäran
POST https://previewexampleservice.search.windows.net/knowledgebases('base-preview-test')/retrieve?api-version=2026-05-01-preview
{
"intents": [
{
"search": "foo",
"type": "semantic"
}
],
"maxRuntimeInSeconds": 60,
"maxOutputSize": 100000,
"maxOutputDocuments": 50,
"retrievalReasoningEffort": {
"kind": "minimal"
},
"includeActivity": true,
"outputMode": "extractiveData",
"knowledgeSourceParams": [
{
"filterAddOn": "foo eq bar",
"knowledgeSourceName": "ks-preview-test",
"includeReferences": true,
"includeReferenceSourceData": true,
"alwaysQuerySource": true,
"failOnError": true,
"rerankerThreshold": 2.1,
"kind": "searchIndex"
}
]
}
Exempelsvar
{
"response": [
{
"content": [
{
"type": "text",
"text": "[{...}]"
}
]
}
],
"activity": [
{
"type": "searchIndex",
"id": 0,
"knowledgeSourceName": "ks-preview-test",
"queryTime": "2025-01-01T00:08:45.045Z",
"count": 2,
"elapsedMs": 1234,
"searchIndexArguments": {
"search": "foo",
"filter": "foo eq bar",
"sourceDataFields": [
{
"name": "category"
},
{
"name": "description"
},
{
"name": "ownerId"
},
{
"name": "id"
}
],
"searchFields": [],
"semanticConfigurationName": "testconfig"
}
},
{
"type": "agenticReasoning",
"id": 1,
"retrievalReasoningEffort": {
"kind": "minimal"
},
"reasoningTokens": 37
}
],
"references": [
{
"type": "searchIndex",
"id": "83dd7d40",
"activitySource": 0,
"sourceData": {
"id": "myDocKey1",
"title": "high_doc",
"content": "hello world"
},
"rerankerScore": 3.5,
"docKey": "myDocKey1"
},
{
"type": "searchIndex",
"id": "83dd7d41",
"activitySource": 0,
"sourceData": {
"id": "myDocKey2",
"title": "low_doc",
"content": "goodbye world"
},
"rerankerScore": 2.7,
"docKey": "myDocKey2"
}
]
}
{
"response": [
{
"content": [
{
"type": "text",
"text": "[{...}]"
}
]
}
],
"activity": [
{
"type": "searchIndex",
"id": 0,
"knowledgeSourceName": "ks-preview-test",
"queryTime": "2025-01-01T00:08:45.045Z",
"count": 2,
"elapsedMs": 1234,
"searchIndexArguments": {
"search": "foo",
"filter": "foo eq bar",
"sourceDataFields": [
{
"name": "category"
},
{
"name": "description"
},
{
"name": "ownerId"
},
{
"name": "id"
}
],
"searchFields": [],
"semanticConfigurationName": "testconfig"
}
},
{
"type": "web",
"id": 1,
"knowledgeSourceName": "ks-preview-web",
"queryTime": "2025-01-01T00:08:45.045Z",
"count": 10,
"elapsedMs": 2345,
"error": {
"code": "403",
"message": "The error message",
"details": [],
"additionalInfo": [
{
"type": "SomeErrorType",
"info": {
"someProperty": "Some value"
}
}
]
}
},
{
"type": "agenticReasoning",
"id": 2,
"retrievalReasoningEffort": {
"kind": "minimal"
},
"reasoningTokens": 37
}
],
"references": [
{
"type": "searchIndex",
"id": "83dd7d40",
"activitySource": 0,
"sourceData": {
"id": "myDocKey1",
"title": "high_doc",
"content": "hello world"
},
"rerankerScore": 3.5,
"docKey": "myDocKey1"
},
{
"type": "searchIndex",
"id": "83dd7d41",
"activitySource": 0,
"sourceData": {
"id": "myDocKey2",
"title": "low_doc",
"content": "goodbye world"
},
"rerankerScore": 2.7,
"docKey": "myDocKey2"
}
]
}
Definitioner
| Name | Description |
|---|---|
| Accept |
Acceptera-rubriken. |
|
Azure |
Anger körningsparametrar för en Azure Blob-kunskapskälla |
|
Error |
Ytterligare information om resurshanteringsfelet. |
|
Error |
Felinformationen. |
|
Error |
Vanligt felsvar för alla Azure Resource Manager-API:er för att returnera felinformation för misslyckade åtgärder. (Detta följer även formatet för OData-felsvar.). |
|
Fabric |
Specificerar runtime-parametrar för en kunskapskälla för Fabric Data Agent |
|
Fabric |
Specificerar körtidsparametrar för en kunskapskälla om Fabric Ontology |
|
File |
Specificerar körtidsparametrar för en filkunskapskälla |
|
Image |
Statistik om bildservering under en återvinningsaktivitet. |
|
Indexed |
Anger körningsparametrar för en indexerad OneLake-kunskapskälla |
|
Indexed |
Anger körningsparametrar för en indexerad SharePoint-kunskapskälla |
|
Indexed |
Specificerar körtidsparametrar för en indexerad SQL-kunskapskälla |
|
Knowledge |
Typen av aktivitetsregister. |
|
Knowledge |
Representerar en aktivitetspost för agentiskt resonemang. |
|
Knowledge |
Representerar argumenten som Azure Blob Retrieval-aktiviteten kördes med. |
|
Knowledge |
Representerar en aktivitetspost för hämtning av Azure Blob-blobar. |
|
Knowledge |
Representerar en Azure Blob Storage dokumentreferens. |
|
Knowledge |
Ytterligare information om resurshanteringsfelet. |
|
Knowledge |
Felinformationen. |
|
Knowledge |
Representerar de argument som Fabric Data Agent-hämtningsaktiviteten kördes med. |
|
Knowledge |
Representerar en Fabric Data Agent-återvinningsaktivitetspost. |
|
Knowledge |
Representerar en dokumentreferens för Fabric Data Agent. |
|
Knowledge |
Representerar argumenten som Fabric Ontology-återvinningsaktiviteten kördes med. |
|
Knowledge |
Representerar en Fabric Ontology-återvinningsaktivitetspost. |
|
Knowledge |
Representerar en referens till Fabric Ontology-dokument. |
|
Knowledge |
Representerar de argument som filhämtningsaktiviteten kördes med. |
|
Knowledge |
Representerar en filåtervinningsaktivitetspost. |
|
Knowledge |
Representerar en fildokumentreferens. |
|
Knowledge |
Bildinnehåll. |
|
Knowledge |
Representerar argumenten som den indexerade OneLake-återvinningsaktiviteten kördes med. |
|
Knowledge |
Representerar en indexerad OneLake-återvinningsaktivitetspost. |
|
Knowledge |
Representerar en indexerad OneLake-dokumentreferens. |
|
Knowledge |
Representerar argumenten som den indexerade SharePoint-hämtningsaktiviteten kördes med. |
|
Knowledge |
Representerar en indexerad SharePoint-återvinningsaktivitetspost. |
|
Knowledge |
Representerar en indexerad SharePoint-dokumentreferens. |
|
Knowledge |
Representerar de argument som den indexerade SQL-hämtningsaktiviteten kördes med. |
|
Knowledge |
Representerar en indexerad SQL-återvinningsaktivitetspost. |
|
Knowledge |
Representerar en Azure SQL-dokumentreferens. |
|
Knowledge |
Representerar de argument som MCP-serverns återhämtningsaktivitet kördes med. |
|
Knowledge |
Representerar en MCP-serverhämtningsaktivitetspost. |
|
Knowledge |
Representerar en MCP-serverdokumentreferens. |
|
Knowledge |
Objektet för meddelandeformat på naturligt språk. |
|
Knowledge |
Typ av meddelandeinnehåll. |
|
Knowledge |
Typ av bildmeddelande. |
|
Knowledge |
Typ av textmeddelande. |
|
Knowledge |
Representerar en LLM-svarssyntesaktivitetspost. |
|
Knowledge |
Representerar en LLM-frågeplaneringsaktivitetspost. |
|
Knowledge |
Representerar en LLM-webbsammanfattningsaktivitetspost. |
|
Knowledge |
Typ av referens. |
|
Knowledge |
Representerar argumenten som den fjärrstyrda SharePoint-hämtningsaktiviteten kördes med. |
|
Knowledge |
Representerar en fjärråtkomst av SharePoint-återvinningsaktivitet. |
|
Knowledge |
Representerar en fjärrreferens till SharePoint-dokument. |
|
Knowledge |
Indatakontraktet för hämtningsbegäran. |
|
Knowledge |
Utdatakontraktet för hämtningssvaret. |
|
Knowledge |
Representerar de argument som sökindexhämtningsaktiviteten kördes med. |
|
Knowledge |
Representerar en post för hämtningsaktivitet för sökindex. |
|
Knowledge |
Representerar en referens för ett Azure Search-dokument. |
|
Knowledge |
Representerar argumenten som webbåtervinningsaktiviteten kördes med. |
|
Knowledge |
Representerar en webbsökningsaktivitetspost. |
|
Knowledge |
Representerar en referens till ett webbdokument. |
|
Knowledge |
Representerar argumenten som WorkIQ-återvinningsaktiviteten kördes med. |
|
Knowledge |
Representerar en WorkIQ-hämtningsaktivitetspost. |
|
Knowledge |
Representerar en referens för WorkIQ-dokument. |
|
Knowledge |
Vilken typ av 知識庫-konfiguration som ska användas. |
|
Knowledge |
Kör kunskapshämtning med låg ansträngning för att resonera. |
|
Knowledge |
Kör kunskapshämtning med medelhög ansträngning för resonemang. |
|
Knowledge |
Kör kunskapshämtning med minimal ansträngning för att resonera. |
|
Knowledge |
Utdatakonfigurationen för den här hämtningen. |
|
Knowledge |
Mängden ansträngning som ska användas under hämtningen. |
|
Knowledge |
En semantisk frågeavsikt. |
|
Knowledge |
Typen av kunskapskälla. |
|
Mcp |
Specificerar körtidsparametrar för en MCP-serverkunskapskälla |
|
Purview |
Information om känslighetsetiketten som appliceras på ett dokument |
|
Remote |
Anger körningsparametrar för en fjärransluten SharePoint-kunskapskälla |
|
Search |
Fältreferens för ett sökindex. |
|
Search |
Anger körningsparametrar för en kunskapskälla för sökindex |
|
Web |
Anger körningsparametrar för en webbkunskapskälla |
|
Work |
Attributionsinformation för en WorkIQ-referens. |
|
Work |
Specificerar körtidsparametrar för en WorkIQ-kunskapskälla |
Accept
Acceptera-rubriken.
| Värde | Description |
|---|---|
| application/json;odata.metadata=minimal |
AzureBlobKnowledgeSourceParams
Anger körningsparametrar för en Azure Blob-kunskapskälla
| Name | Typ | Description |
|---|---|---|
| alwaysQuerySource |
boolean |
Anger att den här kunskapskällan ska kringgå valet av källa och alltid efterfrågas vid hämtningen. |
| enableImageServing |
boolean |
Anger om bildservering bör aktiveras för denna kunskapskälla vid hämtningstillfället. När de är sanna levereras bilder som extraheras under intagning till modeller nedströms. |
| failOnError |
boolean |
Indikerar att hela hämtningsförfrågan ska misslyckas om hämtan från denna kunskapskälla stöter på ett fel. Standardvärdet är falskt. |
| includeReferenceSourceData |
boolean |
Anger om referenser ska innehålla strukturerade data som erhålls under hämtningen i nyttolasten. |
| includeReferences |
boolean |
Anger om referenser ska inkluderas för data som hämtas från den här källan. |
| kind |
string:
azure |
Typen av kunskapskälla. |
| knowledgeSourceName |
string |
Namnet på det index som parametrarna gäller för. |
| maxOutputDocuments |
integer (int32) |
Begränsar det maximala antalet dokument som returneras från denna kunskapskälla. |
| rerankerThreshold |
number (float) |
Tröskelvärdet för omrankning som alla hämtade dokument måste uppfylla för att tas med i svaret. |
ErrorAdditionalInfo
Ytterligare information om resurshanteringsfelet.
| Name | Typ | Description |
|---|---|---|
| info |
Ytterligare information. |
|
| type |
string |
Ytterligare informationstyp. |
ErrorDetail
Felinformationen.
| Name | Typ | Description |
|---|---|---|
| additionalInfo |
Ytterligare information om felet. |
|
| code |
string |
Felkoden. |
| details |
Felinformationen. |
|
| message |
string |
Felmeddelandet. |
| target |
string |
Felmålet. |
ErrorResponse
Vanligt felsvar för alla Azure Resource Manager-API:er för att returnera felinformation för misslyckade åtgärder. (Detta följer även formatet för OData-felsvar.).
| Name | Typ | Description |
|---|---|---|
| error |
Felobjektet. |
FabricDataAgentKnowledgeSourceParams
Specificerar runtime-parametrar för en kunskapskälla för Fabric Data Agent
| Name | Typ | Description |
|---|---|---|
| alwaysQuerySource |
boolean |
Anger att den här kunskapskällan ska kringgå valet av källa och alltid efterfrågas vid hämtningen. |
| enableImageServing |
boolean |
Anger om bildservering bör aktiveras för denna kunskapskälla vid hämtningstillfället. När de är sanna levereras bilder som extraheras under intagning till modeller nedströms. |
| failOnError |
boolean |
Indikerar att hela hämtningsförfrågan ska misslyckas om hämtan från denna kunskapskälla stöter på ett fel. Standardvärdet är falskt. |
| includeReferenceSourceData |
boolean |
Anger om referenser ska innehålla strukturerade data som erhålls under hämtningen i nyttolasten. |
| includeReferences |
boolean |
Anger om referenser ska inkluderas för data som hämtas från den här källan. |
| kind |
string:
fabric |
Typen av kunskapskälla. |
| knowledgeSourceName |
string |
Namnet på det index som parametrarna gäller för. |
| maxOutputDocuments |
integer (int32) |
Begränsar det maximala antalet dokument som returneras från denna kunskapskälla. |
| rerankerThreshold |
number (float) |
Tröskelvärdet för omrankning som alla hämtade dokument måste uppfylla för att tas med i svaret. |
FabricOntologyKnowledgeSourceParams
Specificerar körtidsparametrar för en kunskapskälla om Fabric Ontology
| Name | Typ | Description |
|---|---|---|
| alwaysQuerySource |
boolean |
Anger att den här kunskapskällan ska kringgå valet av källa och alltid efterfrågas vid hämtningen. |
| enableImageServing |
boolean |
Anger om bildservering bör aktiveras för denna kunskapskälla vid hämtningstillfället. När de är sanna levereras bilder som extraheras under intagning till modeller nedströms. |
| failOnError |
boolean |
Indikerar att hela hämtningsförfrågan ska misslyckas om hämtan från denna kunskapskälla stöter på ett fel. Standardvärdet är falskt. |
| includeReferenceSourceData |
boolean |
Anger om referenser ska innehålla strukturerade data som erhålls under hämtningen i nyttolasten. |
| includeReferences |
boolean |
Anger om referenser ska inkluderas för data som hämtas från den här källan. |
| kind |
string:
fabric |
Typen av kunskapskälla. |
| knowledgeSourceName |
string |
Namnet på det index som parametrarna gäller för. |
| maxOutputDocuments |
integer (int32) |
Begränsar det maximala antalet dokument som returneras från denna kunskapskälla. |
| rerankerThreshold |
number (float) |
Tröskelvärdet för omrankning som alla hämtade dokument måste uppfylla för att tas med i svaret. |
FileKnowledgeSourceParams
Specificerar körtidsparametrar för en filkunskapskälla
| Name | Typ | Description |
|---|---|---|
| alwaysQuerySource |
boolean |
Anger att den här kunskapskällan ska kringgå valet av källa och alltid efterfrågas vid hämtningen. |
| enableImageServing |
boolean |
Anger om bildservering bör aktiveras för denna kunskapskälla vid hämtningstillfället. När de är sanna levereras bilder som extraheras under intagning till modeller nedströms. |
| failOnError |
boolean |
Indikerar att hela hämtningsförfrågan ska misslyckas om hämtan från denna kunskapskälla stöter på ett fel. Standardvärdet är falskt. |
| includeReferenceSourceData |
boolean |
Anger om referenser ska innehålla strukturerade data som erhålls under hämtningen i nyttolasten. |
| includeReferences |
boolean |
Anger om referenser ska inkluderas för data som hämtas från den här källan. |
| kind |
string:
file |
Typen av kunskapskälla. |
| knowledgeSourceName |
string |
Namnet på det index som parametrarna gäller för. |
| maxOutputDocuments |
integer (int32) |
Begränsar det maximala antalet dokument som returneras från denna kunskapskälla. |
| rerankerThreshold |
number (float) |
Tröskelvärdet för omrankning som alla hämtade dokument måste uppfylla för att tas med i svaret. |
ImageServingStatistics
Statistik om bildservering under en återvinningsaktivitet.
| Name | Typ | Description |
|---|---|---|
| imagesRetrieved |
integer (int32) |
Antalet bilder hämtade från tillgångsbutiken. |
| imagesSentToModel |
integer (int32) |
Antalet bilder som skickas till nedströmsmodellen. |
| totalImageSizeBytes |
integer (int64) |
Den totala storleken i byte av bilder som skickas till modellen. |
| verbalizationUsed |
boolean |
Anger om bildverbalisering användes istället för direkt bildservering. |
IndexedOneLakeKnowledgeSourceParams
Anger körningsparametrar för en indexerad OneLake-kunskapskälla
| Name | Typ | Description |
|---|---|---|
| alwaysQuerySource |
boolean |
Anger att den här kunskapskällan ska kringgå valet av källa och alltid efterfrågas vid hämtningen. |
| enableImageServing |
boolean |
Anger om bildservering bör aktiveras för denna kunskapskälla vid hämtningstillfället. När de är sanna levereras bilder som extraheras under intagning till modeller nedströms. |
| failOnError |
boolean |
Indikerar att hela hämtningsförfrågan ska misslyckas om hämtan från denna kunskapskälla stöter på ett fel. Standardvärdet är falskt. |
| includeReferenceSourceData |
boolean |
Anger om referenser ska innehålla strukturerade data som erhålls under hämtningen i nyttolasten. |
| includeReferences |
boolean |
Anger om referenser ska inkluderas för data som hämtas från den här källan. |
| kind |
string:
indexed |
Typen av kunskapskälla. |
| knowledgeSourceName |
string |
Namnet på det index som parametrarna gäller för. |
| maxOutputDocuments |
integer (int32) |
Begränsar det maximala antalet dokument som returneras från denna kunskapskälla. |
| rerankerThreshold |
number (float) |
Tröskelvärdet för omrankning som alla hämtade dokument måste uppfylla för att tas med i svaret. |
IndexedSharePointKnowledgeSourceParams
Anger körningsparametrar för en indexerad SharePoint-kunskapskälla
| Name | Typ | Description |
|---|---|---|
| alwaysQuerySource |
boolean |
Anger att den här kunskapskällan ska kringgå valet av källa och alltid efterfrågas vid hämtningen. |
| enableImageServing |
boolean |
Anger om bildservering bör aktiveras för denna kunskapskälla vid hämtningstillfället. När de är sanna levereras bilder som extraheras under intagning till modeller nedströms. |
| failOnError |
boolean |
Indikerar att hela hämtningsförfrågan ska misslyckas om hämtan från denna kunskapskälla stöter på ett fel. Standardvärdet är falskt. |
| includeReferenceSourceData |
boolean |
Anger om referenser ska innehålla strukturerade data som erhålls under hämtningen i nyttolasten. |
| includeReferences |
boolean |
Anger om referenser ska inkluderas för data som hämtas från den här källan. |
| kind |
string:
indexed |
Typen av kunskapskälla. |
| knowledgeSourceName |
string |
Namnet på det index som parametrarna gäller för. |
| maxOutputDocuments |
integer (int32) |
Begränsar det maximala antalet dokument som returneras från denna kunskapskälla. |
| rerankerThreshold |
number (float) |
Tröskelvärdet för omrankning som alla hämtade dokument måste uppfylla för att tas med i svaret. |
IndexedSqlKnowledgeSourceParams
Specificerar körtidsparametrar för en indexerad SQL-kunskapskälla
| Name | Typ | Description |
|---|---|---|
| alwaysQuerySource |
boolean |
Anger att den här kunskapskällan ska kringgå valet av källa och alltid efterfrågas vid hämtningen. |
| enableImageServing |
boolean |
Anger om bildservering bör aktiveras för denna kunskapskälla vid hämtningstillfället. När de är sanna levereras bilder som extraheras under intagning till modeller nedströms. |
| failOnError |
boolean |
Indikerar att hela hämtningsförfrågan ska misslyckas om hämtan från denna kunskapskälla stöter på ett fel. Standardvärdet är falskt. |
| includeReferenceSourceData |
boolean |
Anger om referenser ska innehålla strukturerade data som erhålls under hämtningen i nyttolasten. |
| includeReferences |
boolean |
Anger om referenser ska inkluderas för data som hämtas från den här källan. |
| kind |
string:
indexed |
Typen av kunskapskälla. |
| knowledgeSourceName |
string |
Namnet på det index som parametrarna gäller för. |
| maxOutputDocuments |
integer (int32) |
Begränsar det maximala antalet dokument som returneras från denna kunskapskälla. |
| rerankerThreshold |
number (float) |
Tröskelvärdet för omrankning som alla hämtade dokument måste uppfylla för att tas med i svaret. |
KnowledgeBaseActivityRecordType
Typen av aktivitetsregister.
| Värde | Description |
|---|---|
| searchIndex |
Sökindex-återvinningsaktivitet. |
| azureBlob |
Azure Blob retrieval activity. |
| indexedSharePoint |
Indexerad SharePoint-återvinningsaktivitet. |
| indexedOneLake |
Indexerad OneLake-återvinningsaktivitet. |
| web |
Webbåtervinningsaktivitet. |
| remoteSharePoint |
Fjärråtkomst av SharePoint. |
| workIQ |
WorkIQ-återhämtningsaktivitet. |
| fabricDataAgent |
Fabric Data Agent-återvinningsaktivitet. |
| fabricOntology |
Fabric Ontology-återvinningsaktivitet. |
| mcpServer |
MCP-serverhämtningsaktivitet. |
| file |
Filhämtningsaktivitet. |
| indexedSql |
Indexerad SQL-återvinningsaktivitet. |
| modelQueryPlanning |
LLM-frågeplaneringsaktivitet. |
| modelAnswerSynthesis |
LLM-svarssyntesaktivitet. |
| modelWebSummarization |
LLM-webbsammanfattningsaktivitet. |
| agenticReasoning |
Agentiskt resonerande aktivitet. |
KnowledgeBaseAgenticReasoningActivityRecord
Representerar en aktivitetspost för agentiskt resonemang.
| Name | Typ | Description |
|---|---|---|
| elapsedMs |
integer (int32) |
Den förflutna tiden i millisekunder för hämtningsaktiviteten. |
| error |
Felinformationen som förklarar varför åtgärden misslyckades. Den här egenskapen ingår bara när aktiviteten inte lyckas. |
|
| id |
integer (int32) |
ID för aktivitetsposten. |
| reasoningTokens |
integer (int32) |
Antalet indatatoken för agentisk resonemang. |
| retrievalReasoningEffort | KnowledgeRetrievalReasoningEffort: |
Konfigurationen för återhämtningsresonemangsinsats. |
| type |
string:
agentic |
Typ av aktivitetspost. |
| warning |
string |
Ett varningsmeddelande som visar potentiella konfigurationsproblem som observerats under aktiviteten, såsom dokument som tappas på grund av poängtröskel, tokenbegränsning eller timeout-villkor. |
KnowledgeBaseAzureBlobActivityArguments
Representerar argumenten som Azure Blob Retrieval-aktiviteten kördes med.
| Name | Typ | Description |
|---|---|---|
| search |
string |
Söksträngen som används för att fråga blobinnehåll. |
KnowledgeBaseAzureBlobActivityRecord
Representerar en aktivitetspost för hämtning av Azure Blob-blobar.
| Name | Typ | Description |
|---|---|---|
| azureBlobArguments |
Azure Blob-argumenten för hämtningsaktiviteten. |
|
| count |
integer (int32) |
Antalet dokument som hämtats som var tillräckligt relevanta för att passera tröskelvärdet för omrankning. |
| elapsedMs |
integer (int32) |
Den förflutna tiden i millisekunder för hämtningsaktiviteten. |
| error |
Felinformationen som förklarar varför åtgärden misslyckades. Den här egenskapen ingår bara när aktiviteten inte lyckas. |
|
| id |
integer (int32) |
ID för aktivitetsposten. |
| imageServing |
Statistik om bildservering för denna återvinningsaktivitet |
|
| knowledgeSourceName |
string |
Kunskapskällan för hämtningsaktiviteten. |
| queryTime |
string (date-time) |
Frågetiden för den här hämtningsaktiviteten. |
| type |
string:
azure |
Typ av aktivitetspost. |
| warning |
string |
Ett varningsmeddelande som visar potentiella konfigurationsproblem som observerats under aktiviteten, såsom dokument som tappas på grund av poängtröskel, tokenbegränsning eller timeout-villkor. |
KnowledgeBaseAzureBlobReference
Representerar en Azure Blob Storage dokumentreferens.
| Name | Typ | Description |
|---|---|---|
| activitySource |
integer (int32) |
Källaktivitets-ID:t för referensen. |
| blobUrl |
string |
Blob-URL:en för referensen. |
| id |
string |
ID för referensen. |
| rerankerScore |
number (float) |
Rankningspoängen för dokumentreferensen. |
| searchSensitivityLabelInfo |
Informationen om känslighetsetiketten för referensen. |
|
| sourceData |
Källdata för referensen. |
|
| type |
string:
azure |
Typen av referens. |
KnowledgeBaseErrorAdditionalInfo
Ytterligare information om resurshanteringsfelet.
| Name | Typ | Description |
|---|---|---|
| info |
Ytterligare information. |
|
| type |
string |
Ytterligare informationstyp. |
KnowledgeBaseErrorDetail
Felinformationen.
| Name | Typ | Description |
|---|---|---|
| additionalInfo |
Ytterligare information om felet. |
|
| code |
string |
Felkoden. |
| details |
Felinformationen. |
|
| message |
string |
Felmeddelandet. |
| target |
string |
Felmålet. |
KnowledgeBaseFabricDataAgentActivityArguments
Representerar de argument som Fabric Data Agent-hämtningsaktiviteten kördes med.
| Name | Typ | Description |
|---|---|---|
| search |
string |
Söksträngen som används för att söka kunskapskällan från Fabric Data Agent. |
KnowledgeBaseFabricDataAgentActivityRecord
Representerar en Fabric Data Agent-återvinningsaktivitetspost.
| Name | Typ | Description |
|---|---|---|
| count |
integer (int32) |
Antalet dokument som hämtats som var tillräckligt relevanta för att passera tröskelvärdet för omrankning. |
| elapsedMs |
integer (int32) |
Den förflutna tiden i millisekunder för hämtningsaktiviteten. |
| error |
Felinformationen som förklarar varför åtgärden misslyckades. Den här egenskapen ingår bara när aktiviteten inte lyckas. |
|
| fabricDataAgentArguments |
Fabric Data Agent argumenterar för återhämtningsaktiviteten. |
|
| id |
integer (int32) |
ID för aktivitetsposten. |
| imageServing |
Statistik om bildservering för denna återvinningsaktivitet |
|
| knowledgeSourceName |
string |
Kunskapskällan för hämtningsaktiviteten. |
| queryTime |
string (date-time) |
Frågetiden för den här hämtningsaktiviteten. |
| type |
string:
fabric |
Typ av aktivitetspost. |
| warning |
string |
Ett varningsmeddelande som visar potentiella konfigurationsproblem som observerats under aktiviteten, såsom dokument som tappas på grund av poängtröskel, tokenbegränsning eller timeout-villkor. |
KnowledgeBaseFabricDataAgentReference
Representerar en dokumentreferens för Fabric Data Agent.
| Name | Typ | Description |
|---|---|---|
| activitySource |
integer (int32) |
Källaktivitets-ID:t för referensen. |
| dataAgentId |
string |
Fabric Data Agent ID. |
| id |
string |
ID för referensen. |
| rerankerScore |
number (float) |
Rankningspoängen för dokumentreferensen. |
| sourceData |
Källdata för referensen. |
|
| type |
string:
fabric |
Typen av referens. |
| workspaceId |
string |
ID:t för Fabric arbetsyta. |
KnowledgeBaseFabricOntologyActivityArguments
Representerar argumenten som Fabric Ontology-återvinningsaktiviteten kördes med.
| Name | Typ | Description |
|---|---|---|
| search |
string |
Söksträngen som används för att söka i kunskapskällan från Fabric Ontology. |
KnowledgeBaseFabricOntologyActivityRecord
Representerar en Fabric Ontology-återvinningsaktivitetspost.
| Name | Typ | Description |
|---|---|---|
| count |
integer (int32) |
Antalet dokument som hämtats som var tillräckligt relevanta för att passera tröskelvärdet för omrankning. |
| elapsedMs |
integer (int32) |
Den förflutna tiden i millisekunder för hämtningsaktiviteten. |
| error |
Felinformationen som förklarar varför åtgärden misslyckades. Den här egenskapen ingår bara när aktiviteten inte lyckas. |
|
| fabricOntologyArguments |
Fabric Ontology-argumenten för återhämtningsaktiviteten. |
|
| id |
integer (int32) |
ID för aktivitetsposten. |
| imageServing |
Statistik om bildservering för denna återvinningsaktivitet |
|
| knowledgeSourceName |
string |
Kunskapskällan för hämtningsaktiviteten. |
| queryTime |
string (date-time) |
Frågetiden för den här hämtningsaktiviteten. |
| type |
string:
fabric |
Typ av aktivitetspost. |
| warning |
string |
Ett varningsmeddelande som visar potentiella konfigurationsproblem som observerats under aktiviteten, såsom dokument som tappas på grund av poängtröskel, tokenbegränsning eller timeout-villkor. |
KnowledgeBaseFabricOntologyReference
Representerar en referens till Fabric Ontology-dokument.
| Name | Typ | Description |
|---|---|---|
| activitySource |
integer (int32) |
Källaktivitets-ID:t för referensen. |
| id |
string |
ID för referensen. |
| ontologyId |
string |
Ontologi-ID:t inom arbetsytan. |
| rerankerScore |
number (float) |
Rankningspoängen för dokumentreferensen. |
| sourceData |
Källdata för referensen. |
|
| type |
string:
fabric |
Typen av referens. |
| workspaceId |
string |
ID:t för Fabric arbetsyta. |
KnowledgeBaseFileActivityArguments
Representerar de argument som filhämtningsaktiviteten kördes med.
| Name | Typ | Description |
|---|---|---|
| search |
string |
Söksträngen som används för att söka filinnehåll. |
KnowledgeBaseFileActivityRecord
Representerar en filåtervinningsaktivitetspost.
| Name | Typ | Description |
|---|---|---|
| count |
integer (int32) |
Antalet dokument som hämtats som var tillräckligt relevanta för att passera tröskelvärdet för omrankning. |
| elapsedMs |
integer (int32) |
Den förflutna tiden i millisekunder för hämtningsaktiviteten. |
| error |
Felinformationen som förklarar varför åtgärden misslyckades. Den här egenskapen ingår bara när aktiviteten inte lyckas. |
|
| fileArguments |
Filen argumenten för återhämtningsaktiviteten. |
|
| id |
integer (int32) |
ID för aktivitetsposten. |
| imageServing |
Statistik om bildservering för denna återvinningsaktivitet |
|
| knowledgeSourceName |
string |
Kunskapskällan för hämtningsaktiviteten. |
| queryTime |
string (date-time) |
Frågetiden för den här hämtningsaktiviteten. |
| type |
string:
file |
Typ av aktivitetspost. |
| warning |
string |
Ett varningsmeddelande som visar potentiella konfigurationsproblem som observerats under aktiviteten, såsom dokument som tappas på grund av poängtröskel, tokenbegränsning eller timeout-villkor. |
KnowledgeBaseFileReference
Representerar en fildokumentreferens.
| Name | Typ | Description |
|---|---|---|
| activitySource |
integer (int32) |
Källaktivitets-ID:t för referensen. |
| docName |
string |
Dokumentnamnet på referensen. |
| id |
string |
ID för referensen. |
| rerankerScore |
number (float) |
Rankningspoängen för dokumentreferensen. |
| sourceData |
Källdata för referensen. |
|
| type |
string:
file |
Typen av referens. |
KnowledgeBaseImageContent
Bildinnehåll.
| Name | Typ | Description |
|---|---|---|
| url |
string (uri) |
Webbadressen till bilden. |
KnowledgeBaseIndexedOneLakeActivityArguments
Representerar argumenten som den indexerade OneLake-återvinningsaktiviteten kördes med.
| Name | Typ | Description |
|---|---|---|
| search |
string |
Söksträngen som används för att söka indexerade innehåll i OneLake. |
KnowledgeBaseIndexedOneLakeActivityRecord
Representerar en indexerad OneLake-återvinningsaktivitetspost.
| Name | Typ | Description |
|---|---|---|
| count |
integer (int32) |
Antalet dokument som hämtats som var tillräckligt relevanta för att passera tröskelvärdet för omrankning. |
| elapsedMs |
integer (int32) |
Den förflutna tiden i millisekunder för hämtningsaktiviteten. |
| error |
Felinformationen som förklarar varför åtgärden misslyckades. Den här egenskapen ingår bara när aktiviteten inte lyckas. |
|
| id |
integer (int32) |
ID för aktivitetsposten. |
| imageServing |
Statistik om bildservering för denna återvinningsaktivitet |
|
| indexedOneLakeArguments |
De indexerade OneLake-argumenten för återvinningsaktiviteten. |
|
| knowledgeSourceName |
string |
Kunskapskällan för hämtningsaktiviteten. |
| queryTime |
string (date-time) |
Frågetiden för den här hämtningsaktiviteten. |
| type |
string:
indexed |
Typ av aktivitetspost. |
| warning |
string |
Ett varningsmeddelande som visar potentiella konfigurationsproblem som observerats under aktiviteten, såsom dokument som tappas på grund av poängtröskel, tokenbegränsning eller timeout-villkor. |
KnowledgeBaseIndexedOneLakeReference
Representerar en indexerad OneLake-dokumentreferens.
| Name | Typ | Description |
|---|---|---|
| activitySource |
integer (int32) |
Källaktivitets-ID:t för referensen. |
| docUrl |
string |
Dokumentets URL för referensen. |
| id |
string |
ID för referensen. |
| rerankerScore |
number (float) |
Rankningspoängen för dokumentreferensen. |
| searchSensitivityLabelInfo |
Informationen om känslighetsetiketten för referensen. |
|
| sourceData |
Källdata för referensen. |
|
| type |
string:
indexed |
Typen av referens. |
KnowledgeBaseIndexedSharePointActivityArguments
Representerar argumenten som den indexerade SharePoint-hämtningsaktiviteten kördes med.
| Name | Typ | Description |
|---|---|---|
| search |
string |
Söksträngen som används för att söka indexerade SharePoint-innehåll. |
KnowledgeBaseIndexedSharePointActivityRecord
Representerar en indexerad SharePoint-återvinningsaktivitetspost.
| Name | Typ | Description |
|---|---|---|
| count |
integer (int32) |
Antalet dokument som hämtats som var tillräckligt relevanta för att passera tröskelvärdet för omrankning. |
| elapsedMs |
integer (int32) |
Den förflutna tiden i millisekunder för hämtningsaktiviteten. |
| error |
Felinformationen som förklarar varför åtgärden misslyckades. Den här egenskapen ingår bara när aktiviteten inte lyckas. |
|
| id |
integer (int32) |
ID för aktivitetsposten. |
| imageServing |
Statistik om bildservering för denna återvinningsaktivitet |
|
| indexedSharePointArguments |
De indexerade SharePoint-argumenten för hämtaaktiviteten. |
|
| knowledgeSourceName |
string |
Kunskapskällan för hämtningsaktiviteten. |
| queryTime |
string (date-time) |
Frågetiden för den här hämtningsaktiviteten. |
| type |
string:
indexed |
Typ av aktivitetspost. |
| warning |
string |
Ett varningsmeddelande som visar potentiella konfigurationsproblem som observerats under aktiviteten, såsom dokument som tappas på grund av poängtröskel, tokenbegränsning eller timeout-villkor. |
KnowledgeBaseIndexedSharePointReference
Representerar en indexerad SharePoint-dokumentreferens.
| Name | Typ | Description |
|---|---|---|
| activitySource |
integer (int32) |
Källaktivitets-ID:t för referensen. |
| docUrl |
string |
Dokumentets URL för referensen. |
| id |
string |
ID för referensen. |
| rerankerScore |
number (float) |
Rankningspoängen för dokumentreferensen. |
| searchSensitivityLabelInfo |
Informationen om känslighetsetiketten för referensen. |
|
| sourceData |
Källdata för referensen. |
|
| type |
string:
indexed |
Typen av referens. |
KnowledgeBaseIndexedSqlActivityArguments
Representerar de argument som den indexerade SQL-hämtningsaktiviteten kördes med.
| Name | Typ | Description |
|---|---|---|
| search |
string |
Söksträngen som används för att söka indexerat SQL-innehåll. |
KnowledgeBaseIndexedSqlActivityRecord
Representerar en indexerad SQL-återvinningsaktivitetspost.
| Name | Typ | Description |
|---|---|---|
| count |
integer (int32) |
Antalet dokument som hämtats som var tillräckligt relevanta för att passera tröskelvärdet för omrankning. |
| elapsedMs |
integer (int32) |
Den förflutna tiden i millisekunder för hämtningsaktiviteten. |
| error |
Felinformationen som förklarar varför åtgärden misslyckades. Den här egenskapen ingår bara när aktiviteten inte lyckas. |
|
| id |
integer (int32) |
ID för aktivitetsposten. |
| imageServing |
Statistik om bildservering för denna återvinningsaktivitet |
|
| indexedSqlArguments |
De indexerade SQL-argumenten för hämtandet. |
|
| knowledgeSourceName |
string |
Kunskapskällan för hämtningsaktiviteten. |
| queryTime |
string (date-time) |
Frågetiden för den här hämtningsaktiviteten. |
| type |
string:
indexed |
Typ av aktivitetspost. |
| warning |
string |
Ett varningsmeddelande som visar potentiella konfigurationsproblem som observerats under aktiviteten, såsom dokument som tappas på grund av poängtröskel, tokenbegränsning eller timeout-villkor. |
KnowledgeBaseIndexedSqlReference
Representerar en Azure SQL-dokumentreferens.
| Name | Typ | Description |
|---|---|---|
| activitySource |
integer (int32) |
Källaktivitets-ID:t för referensen. |
| docUrl |
string |
Dokumentets URL för referensen. |
| id |
string |
ID för referensen. |
| rerankerScore |
number (float) |
Rankningspoängen för dokumentreferensen. |
| sourceData |
Källdata för referensen. |
|
| type |
string:
indexed |
Typen av referens. |
KnowledgeBaseMcpServerActivityArguments
Representerar de argument som MCP-serverns återhämtningsaktivitet kördes med.
| Name | Typ | Description |
|---|---|---|
| toolArguments |
Argumenten skickades vidare till MCP:s serververktyg. |
|
| toolName |
string |
Namnet på MCP-serververktyget som används för hämtandet. |
KnowledgeBaseMcpServerActivityRecord
Representerar en MCP-serverhämtningsaktivitetspost.
| Name | Typ | Description |
|---|---|---|
| count |
integer (int32) |
Antalet dokument som hämtats som var tillräckligt relevanta för att passera tröskelvärdet för omrankning. |
| elapsedMs |
integer (int32) |
Den förflutna tiden i millisekunder för hämtningsaktiviteten. |
| error |
Felinformationen som förklarar varför åtgärden misslyckades. Den här egenskapen ingår bara när aktiviteten inte lyckas. |
|
| id |
integer (int32) |
ID för aktivitetsposten. |
| imageServing |
Statistik om bildservering för denna återvinningsaktivitet |
|
| knowledgeSourceName |
string |
Kunskapskällan för hämtningsaktiviteten. |
| mcpServerArguments |
MCP-servern argumenterar för återhämtningsaktiviteten. |
|
| queryTime |
string (date-time) |
Frågetiden för den här hämtningsaktiviteten. |
| type |
string:
mcp |
Typ av aktivitetspost. |
| warning |
string |
Ett varningsmeddelande som visar potentiella konfigurationsproblem som observerats under aktiviteten, såsom dokument som tappas på grund av poängtröskel, tokenbegränsning eller timeout-villkor. |
KnowledgeBaseMcpServerReference
Representerar en MCP-serverdokumentreferens.
| Name | Typ | Description |
|---|---|---|
| activitySource |
integer (int32) |
Källaktivitets-ID:t för referensen. |
| id |
string |
ID för referensen. |
| rerankerScore |
number (float) |
Rankningspoängen för dokumentreferensen. |
| sourceData |
Källdata för referensen. |
|
| title |
string |
Resultatet är namnet på MCP-serververktyget. |
| toolName |
string |
Namnet på MCP-serververktyget som producerade referensen. |
| type |
string:
mcp |
Typen av referens. |
KnowledgeBaseMessage
Objektet för meddelandeformat på naturligt språk.
| Name | Typ | Description |
|---|---|---|
| content | KnowledgeBaseMessageContent[]: |
Innehållet i meddelandet. |
| role |
string |
Rollen för verktygets svar. |
KnowledgeBaseMessageContentType
Typ av meddelandeinnehåll.
| Värde | Description |
|---|---|
| text |
Typ av textmeddelandeinnehåll. |
| image |
Typ av innehåll i bildmeddelanden. |
KnowledgeBaseMessageImageContent
Typ av bildmeddelande.
| Name | Typ | Description |
|---|---|---|
| image |
Bildinnehållet. |
|
| type |
string:
image |
Typ av meddelande |
KnowledgeBaseMessageTextContent
Typ av textmeddelande.
| Name | Typ | Description |
|---|---|---|
| text |
string |
Textinnehållet. |
| type |
string:
text |
Typ av meddelande |
KnowledgeBaseModelAnswerSynthesisActivityRecord
Representerar en LLM-svarssyntesaktivitetspost.
| Name | Typ | Description |
|---|---|---|
| elapsedMs |
integer (int32) |
Den förflutna tiden i millisekunder för hämtningsaktiviteten. |
| error |
Felinformationen som förklarar varför åtgärden misslyckades. Den här egenskapen ingår bara när aktiviteten inte lyckas. |
|
| id |
integer (int32) |
ID för aktivitetsposten. |
| inputTokens |
integer (int32) |
Antalet indatatoken för LLM-svarssyntesaktiviteten. |
| modelName |
string |
Namnet på modellen som används för LLM-svarssyntesaktiviteten. |
| outputTokens |
integer (int32) |
Antalet utdatatoken för LLM-svarssyntesaktiviteten. |
| type |
string:
model |
Typ av aktivitetspost. |
| warning |
string |
Ett varningsmeddelande som visar potentiella konfigurationsproblem som observerats under aktiviteten, såsom dokument som tappas på grund av poängtröskel, tokenbegränsning eller timeout-villkor. |
KnowledgeBaseModelQueryPlanningActivityRecord
Representerar en LLM-frågeplaneringsaktivitetspost.
| Name | Typ | Description |
|---|---|---|
| elapsedMs |
integer (int32) |
Den förflutna tiden i millisekunder för hämtningsaktiviteten. |
| error |
Felinformationen som förklarar varför åtgärden misslyckades. Den här egenskapen ingår bara när aktiviteten inte lyckas. |
|
| id |
integer (int32) |
ID för aktivitetsposten. |
| inputTokens |
integer (int32) |
Antalet indatatoken för LLM-frågeplaneringsaktiviteten. |
| modelName |
string |
Namnet på modellen som används för LLM-frågeplaneringsaktiviteten. |
| outputTokens |
integer (int32) |
Antalet utdatatoken för LLM-frågeplaneringsaktiviteten. |
| type |
string:
model |
Typ av aktivitetspost. |
| warning |
string |
Ett varningsmeddelande som visar potentiella konfigurationsproblem som observerats under aktiviteten, såsom dokument som tappas på grund av poängtröskel, tokenbegränsning eller timeout-villkor. |
KnowledgeBaseModelWebSummarizationActivityRecord
Representerar en LLM-webbsammanfattningsaktivitetspost.
| Name | Typ | Description |
|---|---|---|
| elapsedMs |
integer (int32) |
Den förflutna tiden i millisekunder för hämtningsaktiviteten. |
| error |
Felinformationen som förklarar varför åtgärden misslyckades. Den här egenskapen ingår bara när aktiviteten inte lyckas. |
|
| id |
integer (int32) |
ID för aktivitetsposten. |
| inputTokens |
integer (int32) |
Antalet inmatningstokens för LLM:s webbsammanfattningsaktivitet. |
| modelName |
string |
Namnet på modellen som används för LLM:s webbsammanfattningsaktivitet. |
| outputTokens |
integer (int32) |
Antalet utdatatoken för LLM:s webbsammanfattningsaktivitet. |
| type |
string:
model |
Typ av aktivitetspost. |
| warning |
string |
Ett varningsmeddelande som visar potentiella konfigurationsproblem som observerats under aktiviteten, såsom dokument som tappas på grund av poängtröskel, tokenbegränsning eller timeout-villkor. |
KnowledgeBaseReferenceType
Typ av referens.
| Värde | Description |
|---|---|
| searchIndex |
Sök i indexdokumentreferens. |
| azureBlob |
Azure Blob dokumentreferens. |
| indexedSharePoint |
Indexerad SharePoint-dokumentreferens. |
| indexedOneLake |
Indexerad dokumentreferens från OneLake. |
| web |
Webbdokumentreferens. |
| remoteSharePoint |
Fjärrreferens för SharePoint-dokument. |
| workIQ |
Referens för arbetsintelligensdokument. |
| fabricDataAgent |
Fabric Data Agent dokumentreferens. |
| fabricOntology |
Fabric Ontology-dokumentreferens. |
| mcpServer |
MCP-serverdokumentreferens. |
| file |
Arkivera dokumentreferens. |
| indexedSql |
Indexerad SQL-dokumentreferens. |
KnowledgeBaseRemoteSharePointActivityArguments
Representerar argumenten som den fjärrstyrda SharePoint-hämtningsaktiviteten kördes med.
| Name | Typ | Description |
|---|---|---|
| filterExpressionAddOn |
string |
Filteruttryckstillägget för återhämtningsaktiviteten. |
| search |
string |
Söksträngen som används för att söka den fjärrstyrda SharePoint-kunskapskällan. |
KnowledgeBaseRemoteSharePointActivityRecord
Representerar en fjärråtkomst av SharePoint-återvinningsaktivitet.
| Name | Typ | Description |
|---|---|---|
| count |
integer (int32) |
Antalet dokument som hämtats som var tillräckligt relevanta för att passera tröskelvärdet för omrankning. |
| elapsedMs |
integer (int32) |
Den förflutna tiden i millisekunder för hämtningsaktiviteten. |
| error |
Felinformationen som förklarar varför åtgärden misslyckades. Den här egenskapen ingår bara när aktiviteten inte lyckas. |
|
| id |
integer (int32) |
ID för aktivitetsposten. |
| imageServing |
Statistik om bildservering för denna återvinningsaktivitet |
|
| knowledgeSourceName |
string |
Kunskapskällan för hämtningsaktiviteten. |
| queryTime |
string (date-time) |
Frågetiden för den här hämtningsaktiviteten. |
| remoteSharePointArguments |
De fjärrstyrda SharePoint-argumenten för hämtningsaktiviteten. |
|
| type |
string:
remote |
Typ av aktivitetspost. |
| warning |
string |
Ett varningsmeddelande som visar potentiella konfigurationsproblem som observerats under aktiviteten, såsom dokument som tappas på grund av poängtröskel, tokenbegränsning eller timeout-villkor. |
KnowledgeBaseRemoteSharePointReference
Representerar en fjärrreferens till SharePoint-dokument.
| Name | Typ | Description |
|---|---|---|
| activitySource |
integer (int32) |
Källaktivitets-ID:t för referensen. |
| id |
string |
ID för referensen. |
| rerankerScore |
number (float) |
Rankningspoängen för dokumentreferensen. |
| searchSensitivityLabelInfo |
Informationen om känslighetsetiketten för referensen. |
|
| sourceData |
Källdata för referensen. |
|
| type |
string:
remote |
Typen av referens. |
| webUrl |
string (uri) |
Den URL som referensdata kommer från. |
KnowledgeBaseRetrievalRequest
Indatakontraktet för hämtningsbegäran.
| Name | Typ | Description |
|---|---|---|
| includeActivity |
boolean |
Anger att hämtningsresultaten ska innehålla aktivitetsinformation. |
| intents | KnowledgeRetrievalIntent[]: |
En lista över avsedda frågor som ska köras utan planering av modellfrågor. |
| knowledgeSourceParams |
KnowledgeSourceParams[]:
|
En lista över körningsparametrar för kunskapskällorna. |
| maxOutputDocuments |
integer (int32) |
Begränsar det maximala antalet dokument i utdatan. |
| maxOutputSize |
integer (int32) |
Begränsar den maximala storleken på innehållet i utdata. |
| maxOutputSizeInTokens |
integer (int32) |
Begränsar den maximala storleken på innehållet i utdata. |
| maxRuntimeInSeconds |
integer (int32) |
Den maximala körtiden i sekunder. |
| messages |
En lista med indata för chattmeddelandeformat. |
|
| outputMode |
Utdatakonfigurationen för den här hämtningen. |
|
| retrievalReasoningEffort | KnowledgeRetrievalReasoningEffort: |
Konfigurationen för återhämtningsresonemangsinsats. |
KnowledgeBaseRetrievalResponse
Utdatakontraktet för hämtningssvaret.
KnowledgeBaseSearchIndexActivityArguments
Representerar de argument som sökindexhämtningsaktiviteten kördes med.
| Name | Typ | Description |
|---|---|---|
| filter |
string |
Filtersträngen. |
| search |
string |
Söksträngen som används för att fråga sökindexet. |
| searchFields |
Vilka fält genomsöktes. |
|
| semanticConfigurationName |
string |
Vilken semantisk konfiguration som användes från sökindexet. |
| sourceDataFields |
Vilka fält som valdes för sökning. |
KnowledgeBaseSearchIndexActivityRecord
Representerar en post för hämtningsaktivitet för sökindex.
| Name | Typ | Description |
|---|---|---|
| count |
integer (int32) |
Antalet dokument som hämtats som var tillräckligt relevanta för att passera tröskelvärdet för omrankning. |
| elapsedMs |
integer (int32) |
Den förflutna tiden i millisekunder för hämtningsaktiviteten. |
| error |
Felinformationen som förklarar varför åtgärden misslyckades. Den här egenskapen ingår bara när aktiviteten inte lyckas. |
|
| id |
integer (int32) |
ID för aktivitetsposten. |
| imageServing |
Statistik om bildservering för denna återvinningsaktivitet |
|
| knowledgeSourceName |
string |
Kunskapskällan för hämtningsaktiviteten. |
| queryTime |
string (date-time) |
Frågetiden för den här hämtningsaktiviteten. |
| searchIndexArguments |
Sökindexargumenten för hämtningsaktiviteten. |
|
| type |
string:
search |
Typ av aktivitetspost. |
| warning |
string |
Ett varningsmeddelande som visar potentiella konfigurationsproblem som observerats under aktiviteten, såsom dokument som tappas på grund av poängtröskel, tokenbegränsning eller timeout-villkor. |
KnowledgeBaseSearchIndexReference
Representerar en referens för ett Azure Search-dokument.
| Name | Typ | Description |
|---|---|---|
| activitySource |
integer (int32) |
Källaktivitets-ID:t för referensen. |
| docKey |
string |
Dokumentnyckeln för referensen. |
| id |
string |
ID för referensen. |
| rerankerScore |
number (float) |
Rankningspoängen för dokumentreferensen. |
| searchSensitivityLabelInfo |
Informationen om känslighetsetiketten för referensen. |
|
| sourceData |
Källdata för referensen. |
|
| type |
string:
search |
Typen av referens. |
KnowledgeBaseWebActivityArguments
Representerar argumenten som webbåtervinningsaktiviteten kördes med.
| Name | Typ | Description |
|---|---|---|
| count |
integer (int32) |
Antalet webbresultat returnerades. |
| freshness |
string |
Fräschheten för hämtningsaktiviteten. |
| language |
string |
Språket för återhämtningsaktiviteten. |
| market |
string |
Marknaden för återvinningsaktiviteten. |
| search |
string |
Söksträngen som används för att söka på webben. |
KnowledgeBaseWebActivityRecord
Representerar en webbsökningsaktivitetspost.
| Name | Typ | Description |
|---|---|---|
| count |
integer (int32) |
Antalet dokument som hämtats som var tillräckligt relevanta för att passera tröskelvärdet för omrankning. |
| elapsedMs |
integer (int32) |
Den förflutna tiden i millisekunder för hämtningsaktiviteten. |
| error |
Felinformationen som förklarar varför åtgärden misslyckades. Den här egenskapen ingår bara när aktiviteten inte lyckas. |
|
| id |
integer (int32) |
ID för aktivitetsposten. |
| imageServing |
Statistik om bildservering för denna återvinningsaktivitet |
|
| knowledgeSourceName |
string |
Kunskapskällan för hämtningsaktiviteten. |
| queryTime |
string (date-time) |
Frågetiden för den här hämtningsaktiviteten. |
| type |
string:
web |
Typ av aktivitetspost. |
| warning |
string |
Ett varningsmeddelande som visar potentiella konfigurationsproblem som observerats under aktiviteten, såsom dokument som tappas på grund av poängtröskel, tokenbegränsning eller timeout-villkor. |
| webArguments |
Webbargumenten för återvinningsaktiviteten. |
KnowledgeBaseWebReference
Representerar en referens till ett webbdokument.
| Name | Typ | Description |
|---|---|---|
| activitySource |
integer (int32) |
Källaktivitets-ID:t för referensen. |
| id |
string |
ID för referensen. |
| rerankerScore |
number (float) |
Rankningspoängen för dokumentreferensen. |
| sourceData |
Källdata för referensen. |
|
| title |
string |
Titeln på webbdokumentet. |
| type |
string:
web |
Typen av referens. |
| url |
string (uri) |
Den URL som referensdata kommer från. |
KnowledgeBaseWorkIQActivityArguments
Representerar argumenten som WorkIQ-återvinningsaktiviteten kördes med.
| Name | Typ | Description |
|---|---|---|
| search |
string |
Söksträngen som används för att söka i WorkIQ:s kunskapskälla. |
KnowledgeBaseWorkIQActivityRecord
Representerar en WorkIQ-hämtningsaktivitetspost.
| Name | Typ | Description |
|---|---|---|
| count |
integer (int32) |
Antalet dokument som hämtats som var tillräckligt relevanta för att passera tröskelvärdet för omrankning. |
| elapsedMs |
integer (int32) |
Den förflutna tiden i millisekunder för hämtningsaktiviteten. |
| error |
Felinformationen som förklarar varför åtgärden misslyckades. Den här egenskapen ingår bara när aktiviteten inte lyckas. |
|
| id |
integer (int32) |
ID för aktivitetsposten. |
| imageServing |
Statistik om bildservering för denna återvinningsaktivitet |
|
| knowledgeSourceName |
string |
Kunskapskällan för hämtningsaktiviteten. |
| queryTime |
string (date-time) |
Frågetiden för den här hämtningsaktiviteten. |
| type |
string:
workIQ |
Typ av aktivitetspost. |
| warning |
string |
Ett varningsmeddelande som visar potentiella konfigurationsproblem som observerats under aktiviteten, såsom dokument som tappas på grund av poängtröskel, tokenbegränsning eller timeout-villkor. |
| workIQArguments |
WorkIQ-argumenten för återhämtningsaktiviteten. |
KnowledgeBaseWorkIQReference
Representerar en referens för WorkIQ-dokument.
| Name | Typ | Description |
|---|---|---|
| activitySource |
integer (int32) |
Källaktivitets-ID:t för referensen. |
| attributions |
Attributen för referensen. |
|
| id |
string |
ID för referensen. |
| rerankerScore |
number (float) |
Rankningspoängen för dokumentreferensen. |
| sourceData |
Källdata för referensen. |
|
| type |
string:
workIQ |
Typen av referens. |
KnowledgeRetrievalIntentType
Vilken typ av 知識庫-konfiguration som ska användas.
| Värde | Description |
|---|---|
| semantic |
En semantisk frågeavsikt med naturligt språk. |
KnowledgeRetrievalLowReasoningEffort
Kör kunskapshämtning med låg ansträngning för att resonera.
| Name | Typ | Description |
|---|---|---|
| kind |
string:
low |
Den sortens resonemangsförsök. |
KnowledgeRetrievalMediumReasoningEffort
Kör kunskapshämtning med medelhög ansträngning för resonemang.
| Name | Typ | Description |
|---|---|---|
| kind |
string:
medium |
Den sortens resonemangsförsök. |
KnowledgeRetrievalMinimalReasoningEffort
Kör kunskapshämtning med minimal ansträngning för att resonera.
| Name | Typ | Description |
|---|---|---|
| kind |
string:
minimal |
Den sortens resonemangsförsök. |
KnowledgeRetrievalOutputMode
Utdatakonfigurationen för den här hämtningen.
| Värde | Description |
|---|---|
| extractiveData |
Returnera data från kunskapskällorna direkt utan generativ förändring. |
| answerSynthesis |
Syntetisera ett svar för svarsnyttolasten. |
KnowledgeRetrievalReasoningEffortKind
Mängden ansträngning som ska användas under hämtningen.
| Värde | Description |
|---|---|
| minimal |
Utför inga källval, frågeplanering eller iterativ sökning. |
| low |
Använd lågt resonemang under hämtningen. |
| medium |
Använd en måttlig mängd resonemang under hämtningen. |
KnowledgeRetrievalSemanticIntent
En semantisk frågeavsikt.
| Name | Typ | Description |
|---|---|---|
| search |
string |
Den semantiska fråga som ska köras |
| type |
string:
semantic |
Typen av avsikt. |
KnowledgeSourceKind
Typen av kunskapskälla.
| Värde | Description |
|---|---|
| searchIndex |
En kunskapskälla som läser data från ett sökindex. |
| azureBlob |
En kunskapskälla som läser och matar in data från Azure Blob Storage till ett sökindex. |
| indexedSharePoint |
En kunskapskälla som läser data från indexerad SharePoint. |
| indexedOneLake |
En kunskapskälla som läser data från indexerad OneLake. |
| indexedSql |
En kunskapskälla som hämtar och tar in data från Azure SQL Database eller SQL Managed Instance till ett sökindex. |
| web |
En kunskapskälla som läser data från webben. |
| remoteSharePoint |
En kunskapskälla som läser data från fjärr-SharePoint. |
| workIQ |
En kunskapskälla som läser data från arbets-IQ |
| file |
En kunskapskälla som stödjer direkt filuppladdning och indexering. |
| mcpServer |
En kunskapskälla som backas upp av en MCP (Model Context Protocol)-server. |
| fabricDataAgent |
En kunskapskälla som hämtar data från en Fabric Data Agent. |
| fabricOntology |
En kunskapskälla som hämtar data från Microsoft Fabric Ontology-ontologier. |
McpServerKnowledgeSourceParams
Specificerar körtidsparametrar för en MCP-serverkunskapskälla
| Name | Typ | Description |
|---|---|---|
| alwaysQuerySource |
boolean |
Anger att den här kunskapskällan ska kringgå valet av källa och alltid efterfrågas vid hämtningen. |
| enableImageServing |
boolean |
Anger om bildservering bör aktiveras för denna kunskapskälla vid hämtningstillfället. När de är sanna levereras bilder som extraheras under intagning till modeller nedströms. |
| failOnError |
boolean |
Indikerar att hela hämtningsförfrågan ska misslyckas om hämtan från denna kunskapskälla stöter på ett fel. Standardvärdet är falskt. |
| includeReferenceSourceData |
boolean |
Anger om referenser ska innehålla strukturerade data som erhålls under hämtningen i nyttolasten. |
| includeReferences |
boolean |
Anger om referenser ska inkluderas för data som hämtas från den här källan. |
| kind |
string:
mcp |
Typen av kunskapskälla. |
| knowledgeSourceName |
string |
Namnet på det index som parametrarna gäller för. |
| maxOutputDocuments |
integer (int32) |
Begränsar det maximala antalet dokument som returneras från denna kunskapskälla. |
| rerankerThreshold |
number (float) |
Tröskelvärdet för omrankning som alla hämtade dokument måste uppfylla för att tas med i svaret. |
PurviewSensitivityLabelInfo
Information om känslighetsetiketten som appliceras på ett dokument
| Name | Typ | Description |
|---|---|---|
| color |
string |
Den färg som användargränssnittet ska visa för etiketten, om den är konfigurerad. |
| displayName |
string |
Visningsnamnet för känslighetsetiketten. |
| isEncrypted |
boolean |
Anger om känslighetsetiketten framtvingar kryptering. |
| priority |
integer (int32) |
Den prioritet som känslighetsetiketten används i. |
| sensitivityLabelId |
string |
ID:t för känslighetsetiketten. |
| toolTip |
string |
Knappbeskrivningen som ska visas för etiketten i ett användargränssnitt. |
RemoteSharePointKnowledgeSourceParams
Anger körningsparametrar för en fjärransluten SharePoint-kunskapskälla
| Name | Typ | Description |
|---|---|---|
| alwaysQuerySource |
boolean |
Anger att den här kunskapskällan ska kringgå valet av källa och alltid efterfrågas vid hämtningen. |
| enableImageServing |
boolean |
Anger om bildservering bör aktiveras för denna kunskapskälla vid hämtningstillfället. När de är sanna levereras bilder som extraheras under intagning till modeller nedströms. |
| failOnError |
boolean |
Indikerar att hela hämtningsförfrågan ska misslyckas om hämtan från denna kunskapskälla stöter på ett fel. Standardvärdet är falskt. |
| filterExpressionAddOn |
string |
Ett filtervillkor som tillämpas på SharePoint-datakällan. Den måste anges i syntaxen för nyckelordsfrågespråk. Det kombineras som en kombination med det filteruttryck som anges i definitionen av kunskapskällan. |
| includeReferenceSourceData |
boolean |
Anger om referenser ska innehålla strukturerade data som erhålls under hämtningen i nyttolasten. |
| includeReferences |
boolean |
Anger om referenser ska inkluderas för data som hämtas från den här källan. |
| kind |
string:
remote |
Typen av kunskapskälla. |
| knowledgeSourceName |
string |
Namnet på det index som parametrarna gäller för. |
| maxOutputDocuments |
integer (int32) |
Begränsar det maximala antalet dokument som returneras från denna kunskapskälla. |
| rerankerThreshold |
number (float) |
Tröskelvärdet för omrankning som alla hämtade dokument måste uppfylla för att tas med i svaret. |
SearchIndexFieldReference
Fältreferens för ett sökindex.
| Name | Typ | Description |
|---|---|---|
| name |
string |
Namnet på fältet. |
SearchIndexKnowledgeSourceParams
Anger körningsparametrar för en kunskapskälla för sökindex
| Name | Typ | Description |
|---|---|---|
| alwaysQuerySource |
boolean |
Anger att den här kunskapskällan ska kringgå valet av källa och alltid efterfrågas vid hämtningen. |
| enableImageServing |
boolean |
Anger om bildservering bör aktiveras för denna kunskapskälla vid hämtningstillfället. När de är sanna levereras bilder som extraheras under intagning till modeller nedströms. |
| failOnError |
boolean |
Indikerar att hela hämtningsförfrågan ska misslyckas om hämtan från denna kunskapskälla stöter på ett fel. Standardvärdet är falskt. |
| filterAddOn |
string |
Ett filtervillkor som tillämpas på indexet (t.ex. "State eq VA"). |
| includeReferenceSourceData |
boolean |
Anger om referenser ska innehålla strukturerade data som erhålls under hämtningen i nyttolasten. |
| includeReferences |
boolean |
Anger om referenser ska inkluderas för data som hämtas från den här källan. |
| kind |
string:
search |
Typen av kunskapskälla. |
| knowledgeSourceName |
string |
Namnet på det index som parametrarna gäller för. |
| maxOutputDocuments |
integer (int32) |
Begränsar det maximala antalet dokument som returneras från denna kunskapskälla. |
| rerankerThreshold |
number (float) |
Tröskelvärdet för omrankning som alla hämtade dokument måste uppfylla för att tas med i svaret. |
WebKnowledgeSourceParams
Anger körningsparametrar för en webbkunskapskälla
| Name | Typ | Description |
|---|---|---|
| alwaysQuerySource |
boolean |
Anger att den här kunskapskällan ska kringgå valet av källa och alltid efterfrågas vid hämtningen. |
| count |
integer (int32) |
Antalet webbresultat som ska returneras. |
| enableImageServing |
boolean |
Anger om bildservering bör aktiveras för denna kunskapskälla vid hämtningstillfället. När de är sanna levereras bilder som extraheras under intagning till modeller nedströms. |
| failOnError |
boolean |
Indikerar att hela hämtningsförfrågan ska misslyckas om hämtan från denna kunskapskälla stöter på ett fel. Standardvärdet är falskt. |
| freshness |
string |
Färskheten i webbresultaten. |
| includeReferenceSourceData |
boolean |
Anger om referenser ska innehålla strukturerade data som erhålls under hämtningen i nyttolasten. |
| includeReferences |
boolean |
Anger om referenser ska inkluderas för data som hämtas från den här källan. |
| kind |
string:
web |
Typen av kunskapskälla. |
| knowledgeSourceName |
string |
Namnet på det index som parametrarna gäller för. |
| language |
string |
Språket i webbresultaten. |
| market |
string |
Marknaden för webbens resultat. |
| maxOutputDocuments |
integer (int32) |
Begränsar det maximala antalet dokument som returneras från denna kunskapskälla. |
| rerankerThreshold |
number (float) |
Tröskelvärdet för omrankning som alla hämtade dokument måste uppfylla för att tas med i svaret. |
WorkIQAttribution
Attributionsinformation för en WorkIQ-referens.
| Name | Typ | Description |
|---|---|---|
| seeMoreWebUrl |
string (uri) |
URL:en för attribueringen. |
WorkIQKnowledgeSourceParams
Specificerar körtidsparametrar för en WorkIQ-kunskapskälla
| Name | Typ | Description |
|---|---|---|
| alwaysQuerySource |
boolean |
Anger att den här kunskapskällan ska kringgå valet av källa och alltid efterfrågas vid hämtningen. |
| enableImageServing |
boolean |
Anger om bildservering bör aktiveras för denna kunskapskälla vid hämtningstillfället. När de är sanna levereras bilder som extraheras under intagning till modeller nedströms. |
| failOnError |
boolean |
Indikerar att hela hämtningsförfrågan ska misslyckas om hämtan från denna kunskapskälla stöter på ett fel. Standardvärdet är falskt. |
| includeReferenceSourceData |
boolean |
Anger om referenser ska innehålla strukturerade data som erhålls under hämtningen i nyttolasten. |
| includeReferences |
boolean |
Anger om referenser ska inkluderas för data som hämtas från den här källan. |
| kind |
string:
workIQ |
Typen av kunskapskälla. |
| knowledgeSourceName |
string |
Namnet på det index som parametrarna gäller för. |
| maxOutputDocuments |
integer (int32) |
Begränsar det maximala antalet dokument som returneras från denna kunskapskälla. |
| rerankerThreshold |
number (float) |
Tröskelvärdet för omrankning som alla hämtade dokument måste uppfylla för att tas med i svaret. |