Knowledge Retrieval - Retrieve
La Knowledge Base recupera i dati rilevanti dagli archivi di backup.
POST {endpoint}/knowledgebases('{knowledgeBaseName}')/retrieve?api-version=2026-05-01-preview
Parametri dell'URI
| Nome | In | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
endpoint
|
path | True |
string (uri) |
URL dell'endpoint del servizio di ricerca. |
|
knowledge
|
path | True |
string |
Nome della Knowledge Base. |
|
api-version
|
query | True |
string minLength: 1 |
Versione dell'API da usare per questa operazione. |
Intestazione della richiesta
| Nome | Necessario | Tipo | Descrizione |
|---|---|---|---|
| Accept |
L'intestazione Accetta. |
||
| x-ms-query-source-authorization |
string |
Token che identifica l'utente per il quale viene eseguita la query. Questo token viene utilizzato per applicare restrizioni di sicurezza ai documenti. |
|
| x-ms-client-request-id |
string (uuid) |
Identificatore di stringa opaco, univoco a livello globale e generato dal client per la richiesta. |
Corpo della richiesta
| Nome | Tipo | Descrizione |
|---|---|---|
| includeActivity |
boolean |
Indica che i risultati del recupero devono includere informazioni sull'attività. |
| intents | KnowledgeRetrievalIntent[]: |
Elenco delle query da eseguire senza la pianificazione delle query del modello. |
| knowledgeSourceParams |
KnowledgeSourceParams[]:
|
Elenco di parametri di runtime per le fonti di conoscenza. |
| maxOutputDocuments |
integer (int32) |
Limita il numero massimo di documenti nell'output. |
| maxOutputSize |
integer (int32) |
Limita la dimensione massima del contenuto nell'output. |
| maxOutputSizeInTokens |
integer (int32) |
Limita la dimensione massima del contenuto nell'output. |
| maxRuntimeInSeconds |
integer (int32) |
L'autonomia massima in secondi. |
| messages |
Un elenco di input per lo stile dei messaggi di chat. |
|
| outputMode |
Configurazione dell'output per il recupero. |
|
| retrievalReasoningEffort | KnowledgeRetrievalReasoningEffort: |
La configurazione dello sforzo di ragionamento per il recupero. |
Risposte
| Nome | Tipo | Descrizione |
|---|---|---|
| 200 OK |
Risposta al prelievo riuscita. |
|
| Other Status Codes |
Risposta parziale al prelievo. |
|
| Other Status Codes |
Risposta di errore imprevista. |
Sicurezza
api-key
Tipo:
apiKey
In:
header
OAuth2Auth
Tipo:
oauth2
Flow:
implicit
URL di autorizzazione:
https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Ambiti
| Nome | Descrizione |
|---|---|
| https://search.azure.com/.default |
Esempio
|
Knowledge |
|
Knowledge |
KnowledgeBaseRetrieve
Esempio di richiesta
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"
}
]
}
Risposta di esempio
{
"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
Esempio di richiesta
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"
}
]
}
Risposta di esempio
{
"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"
}
]
}
Definizioni
| Nome | Descrizione |
|---|---|
| Accept |
L'intestazione Accetta. |
|
Azure |
Specifica i parametri di runtime per un'origine della conoscenza BLOB di Azure |
|
Error |
Informazioni aggiuntive sull'errore di gestione delle risorse. |
|
Error |
Dettagli dell'errore. |
|
Error |
Risposta di errore comune per tutte le API di Azure Resource Manager per restituire i dettagli dell'errore per le operazioni non riuscite. Questo segue anche il formato di risposta di errore OData. |
|
Fabric |
Specifica i parametri di runtime per una sorgente di conoscenza del Fabric Data Agent |
|
Fabric |
Specifica parametri di runtime per una sorgente di conoscenza di Fabric Ontology |
|
File |
Specifica parametri di runtime per una sorgente di conoscenza di file |
|
Image |
Statistiche sul servizio di immagini durante un'attività di recupero. |
|
Indexed |
Specifica i parametri di runtime per un'origine della conoscenza OneLake indicizzata |
|
Indexed |
Specifica i parametri di runtime per un'origine della conoscenza di SharePoint indicizzata |
|
Indexed |
Specifica parametri di runtime per una sorgente di conoscenza SQL indicizzata |
|
Knowledge |
Il tipo di record di attività. |
|
Knowledge |
Rappresenta un record di attività di ragionamento agentico. |
|
Knowledge |
Rappresenta gli argomenti con cui è stata eseguita l'attività di recupero del BLOB di Azure. |
|
Knowledge |
Rappresenta un record di attività di recupero BLOB di Azure. |
|
Knowledge |
Rappresenta un riferimento al documento di Archiviazione BLOB di Azure. |
|
Knowledge |
Informazioni aggiuntive sull'errore di gestione delle risorse. |
|
Knowledge |
Dettagli dell'errore. |
|
Knowledge |
Rappresenta gli argomenti con cui è stata eseguita l'attività di recupero del Fabric Data Agent. |
|
Knowledge |
Rappresenta un record di attività di recupero del Fabric Data Agent. |
|
Knowledge |
Rappresenta un riferimento documentale Fabric Data Agent. |
|
Knowledge |
Rappresenta gli argomenti con cui è stata condotta l'attività di recupero dell'Ontologia Fabric. |
|
Knowledge |
Rappresenta un record di attività di recupero di Fabric Ontology. |
|
Knowledge |
Rappresenta un riferimento documentale di Fabric Ontology. |
|
Knowledge |
Rappresenta gli argomenti con cui è stata eseguita l'attività di recupero dei file. |
|
Knowledge |
Rappresenta un record di attività di recupero file. |
|
Knowledge |
Rappresenta un riferimento a un documento di file. |
|
Knowledge |
Contenuto delle immagini. |
|
Knowledge |
Rappresenta gli argomenti con cui è stata condotta l'attività di recupero indicizzata di OneLake. |
|
Knowledge |
Rappresenta un record indicizzato di attività di recupero OneLake. |
|
Knowledge |
Rappresenta un riferimento indicizzato a un documento OneLake. |
|
Knowledge |
Rappresenta gli argomenti con cui è stata eseguita l'attività di recupero di SharePoint indicizzato. |
|
Knowledge |
Rappresenta un record di attività di recupero SharePoint indicizzato. |
|
Knowledge |
Rappresenta un riferimento indicizzato a un documento SharePoint. |
|
Knowledge |
Rappresenta gli argomenti con cui è stata eseguita l'attività di recupero SQL indicizzata. |
|
Knowledge |
Rappresenta un record di attività di recupero SQL indicizzato. |
|
Knowledge |
Rappresenta un riferimento a un documento Azure SQL. |
|
Knowledge |
Rappresenta gli argomenti con cui è stata condotta l'attività di recupero del server MCP. |
|
Knowledge |
Rappresenta un record di attività di recupero del server MCP. |
|
Knowledge |
Rappresenta un riferimento a un documento server MCP. |
|
Knowledge |
L'oggetto stile del messaggio in linguaggio naturale. |
|
Knowledge |
Tipo di contenuto del messaggio. |
|
Knowledge |
Tipo di messaggio immagine. |
|
Knowledge |
Tipo di messaggio di testo. |
|
Knowledge |
Rappresenta un record di attività di sintesi delle risposte LLM. |
|
Knowledge |
Rappresenta un record di attività di pianificazione delle query LLM. |
|
Knowledge |
Rappresenta un record di attività di riassunto web LLM. |
|
Knowledge |
Tipo di riferimento. |
|
Knowledge |
Rappresenta gli argomenti con cui è stata eseguita l'attività di recupero remota di SharePoint. |
|
Knowledge |
Rappresenta un record di attività di recupero remoto di SharePoint. |
|
Knowledge |
Rappresenta un riferimento remoto a un documento di SharePoint. |
|
Knowledge |
Contratto di input per la richiesta di recupero. |
|
Knowledge |
Contratto di output per la risposta di recupero. |
|
Knowledge |
Rappresenta gli argomenti con cui è stata eseguita l'attività di recupero dell'indice di ricerca. |
|
Knowledge |
Rappresenta un record dell'attività di recupero dell'indice di ricerca. |
|
Knowledge |
Rappresenta un riferimento al documento di Ricerca di Azure. |
|
Knowledge |
Rappresenta gli argomenti con cui è stata condotta l'attività di recupero web. |
|
Knowledge |
Rappresenta un record di attività di recupero web. |
|
Knowledge |
Rappresenta un riferimento a un documento Web. |
|
Knowledge |
Rappresenta gli argomenti con cui è stata condotta l'attività di recupero WorkIQ. |
|
Knowledge |
Rappresenta un record di attività di recupero WorkIQ. |
|
Knowledge |
Rappresenta un riferimento a un documento WorkIQ. |
|
Knowledge |
Tipo di configurazione della Knowledge Base da utilizzare. |
|
Knowledge |
Esegui il recupero delle conoscenze con un basso sforzo di ragionamento. |
|
Knowledge |
Esegui il recupero delle conoscenze con uno sforzo di ragionamento medio. |
|
Knowledge |
Esegui il recupero delle conoscenze con il minimo sforzo di ragionamento. |
|
Knowledge |
Configurazione dell'output per il recupero. |
|
Knowledge |
Quantità di sforzo da utilizzare durante il recupero. |
|
Knowledge |
Un'intenzione di interrogazione semantica. |
|
Knowledge |
Il tipo di fonte di conoscenza. |
|
Mcp |
Specifica parametri di runtime per una sorgente di conoscenza di un server MCP |
|
Purview |
Informazioni sull'etichetta di sensibilità applicata a un documento |
|
Remote |
Specifica i parametri di runtime per un'origine della conoscenza remota di SharePoint |
|
Search |
Riferimento di campo per un indice di ricerca. |
|
Search |
Specifica i parametri di runtime per un'origine conoscenza dell'indice di ricerca |
|
Web |
Specifica i parametri di runtime per un'origine della conoscenza Web |
|
Work |
Informazioni di attribuzione per un riferimento WorkIQ. |
|
Work |
Specifica parametri di runtime per una sorgente di conoscenza WorkIQ |
Accept
L'intestazione Accetta.
| Valore | Descrizione |
|---|---|
| application/json;odata.metadata=minimal |
AzureBlobKnowledgeSourceParams
Specifica i parametri di runtime per un'origine della conoscenza BLOB di Azure
| Nome | Tipo | Descrizione |
|---|---|---|
| alwaysQuerySource |
boolean |
Indica che l'origine della conoscenza deve ignorare la selezione dell'origine e deve essere sempre interrogata al momento del recupero. |
| enableImageServing |
boolean |
Indica se il servizio immagini debba essere abilitato per questa fonte di conoscenza al momento del recupero. Quando è vero, le immagini estratte durante l'ingestione vengono inviate ai modelli a valle. |
| failOnError |
boolean |
Indica che l'intera richiesta di recupero dovrebbe fallire se il recupero da questa fonte di conoscenza incontra un errore. Il valore predefinito è falso. |
| includeReferenceSourceData |
boolean |
Indica se i riferimenti devono includere nel payload i dati strutturati ottenuti durante il recupero. |
| includeReferences |
boolean |
Indica se è necessario includere i riferimenti per i dati recuperati da questa origine. |
| kind |
string:
azure |
Tipo di origine della conoscenza. |
| knowledgeSourceName |
string |
Nome dell'indice a cui si applicano i parametri. |
| maxOutputDocuments |
integer (int32) |
Limita il numero massimo di documenti restituiti da questa fonte di conoscenza. |
| rerankerThreshold |
number (float) |
La soglia di reranker che tutti i documenti recuperati devono soddisfare per essere inclusi nella risposta. |
ErrorAdditionalInfo
Informazioni aggiuntive sull'errore di gestione delle risorse.
| Nome | Tipo | Descrizione |
|---|---|---|
| info |
Informazioni aggiuntive. |
|
| type |
string |
Tipo di informazioni aggiuntive. |
ErrorDetail
Dettagli dell'errore.
| Nome | Tipo | Descrizione |
|---|---|---|
| additionalInfo |
Informazioni aggiuntive sull'errore. |
|
| code |
string |
Codice di errore. |
| details |
Dettagli dell'errore. |
|
| message |
string |
Messaggio di errore. |
| target |
string |
La destinazione dell'errore. |
ErrorResponse
Risposta di errore comune per tutte le API di Azure Resource Manager per restituire i dettagli dell'errore per le operazioni non riuscite. Questo segue anche il formato di risposta di errore OData.
| Nome | Tipo | Descrizione |
|---|---|---|
| error |
Oggetto error. |
FabricDataAgentKnowledgeSourceParams
Specifica i parametri di runtime per una sorgente di conoscenza del Fabric Data Agent
| Nome | Tipo | Descrizione |
|---|---|---|
| alwaysQuerySource |
boolean |
Indica che l'origine della conoscenza deve ignorare la selezione dell'origine e deve essere sempre interrogata al momento del recupero. |
| enableImageServing |
boolean |
Indica se il servizio immagini debba essere abilitato per questa fonte di conoscenza al momento del recupero. Quando è vero, le immagini estratte durante l'ingestione vengono inviate ai modelli a valle. |
| failOnError |
boolean |
Indica che l'intera richiesta di recupero dovrebbe fallire se il recupero da questa fonte di conoscenza incontra un errore. Il valore predefinito è falso. |
| includeReferenceSourceData |
boolean |
Indica se i riferimenti devono includere nel payload i dati strutturati ottenuti durante il recupero. |
| includeReferences |
boolean |
Indica se è necessario includere i riferimenti per i dati recuperati da questa origine. |
| kind |
string:
fabric |
Tipo di origine della conoscenza. |
| knowledgeSourceName |
string |
Nome dell'indice a cui si applicano i parametri. |
| maxOutputDocuments |
integer (int32) |
Limita il numero massimo di documenti restituiti da questa fonte di conoscenza. |
| rerankerThreshold |
number (float) |
La soglia di reranker che tutti i documenti recuperati devono soddisfare per essere inclusi nella risposta. |
FabricOntologyKnowledgeSourceParams
Specifica parametri di runtime per una sorgente di conoscenza di Fabric Ontology
| Nome | Tipo | Descrizione |
|---|---|---|
| alwaysQuerySource |
boolean |
Indica che l'origine della conoscenza deve ignorare la selezione dell'origine e deve essere sempre interrogata al momento del recupero. |
| enableImageServing |
boolean |
Indica se il servizio immagini debba essere abilitato per questa fonte di conoscenza al momento del recupero. Quando è vero, le immagini estratte durante l'ingestione vengono inviate ai modelli a valle. |
| failOnError |
boolean |
Indica che l'intera richiesta di recupero dovrebbe fallire se il recupero da questa fonte di conoscenza incontra un errore. Il valore predefinito è falso. |
| includeReferenceSourceData |
boolean |
Indica se i riferimenti devono includere nel payload i dati strutturati ottenuti durante il recupero. |
| includeReferences |
boolean |
Indica se è necessario includere i riferimenti per i dati recuperati da questa origine. |
| kind |
string:
fabric |
Tipo di origine della conoscenza. |
| knowledgeSourceName |
string |
Nome dell'indice a cui si applicano i parametri. |
| maxOutputDocuments |
integer (int32) |
Limita il numero massimo di documenti restituiti da questa fonte di conoscenza. |
| rerankerThreshold |
number (float) |
La soglia di reranker che tutti i documenti recuperati devono soddisfare per essere inclusi nella risposta. |
FileKnowledgeSourceParams
Specifica parametri di runtime per una sorgente di conoscenza di file
| Nome | Tipo | Descrizione |
|---|---|---|
| alwaysQuerySource |
boolean |
Indica che l'origine della conoscenza deve ignorare la selezione dell'origine e deve essere sempre interrogata al momento del recupero. |
| enableImageServing |
boolean |
Indica se il servizio immagini debba essere abilitato per questa fonte di conoscenza al momento del recupero. Quando è vero, le immagini estratte durante l'ingestione vengono inviate ai modelli a valle. |
| failOnError |
boolean |
Indica che l'intera richiesta di recupero dovrebbe fallire se il recupero da questa fonte di conoscenza incontra un errore. Il valore predefinito è falso. |
| includeReferenceSourceData |
boolean |
Indica se i riferimenti devono includere nel payload i dati strutturati ottenuti durante il recupero. |
| includeReferences |
boolean |
Indica se è necessario includere i riferimenti per i dati recuperati da questa origine. |
| kind |
string:
file |
Tipo di origine della conoscenza. |
| knowledgeSourceName |
string |
Nome dell'indice a cui si applicano i parametri. |
| maxOutputDocuments |
integer (int32) |
Limita il numero massimo di documenti restituiti da questa fonte di conoscenza. |
| rerankerThreshold |
number (float) |
La soglia di reranker che tutti i documenti recuperati devono soddisfare per essere inclusi nella risposta. |
ImageServingStatistics
Statistiche sul servizio di immagini durante un'attività di recupero.
| Nome | Tipo | Descrizione |
|---|---|---|
| imagesRetrieved |
integer (int32) |
Il numero di immagini recuperate dallo store degli asset. |
| imagesSentToModel |
integer (int32) |
Il numero di immagini inviate al modello a valle. |
| totalImageSizeBytes |
integer (int64) |
La dimensione totale in byte delle immagini inviate al modello. |
| verbalizationUsed |
boolean |
Indica se è stata utilizzata la verbalizzazione dell'immagine invece della diffusione diretta dell'immagine. |
IndexedOneLakeKnowledgeSourceParams
Specifica i parametri di runtime per un'origine della conoscenza OneLake indicizzata
| Nome | Tipo | Descrizione |
|---|---|---|
| alwaysQuerySource |
boolean |
Indica che l'origine della conoscenza deve ignorare la selezione dell'origine e deve essere sempre interrogata al momento del recupero. |
| enableImageServing |
boolean |
Indica se il servizio immagini debba essere abilitato per questa fonte di conoscenza al momento del recupero. Quando è vero, le immagini estratte durante l'ingestione vengono inviate ai modelli a valle. |
| failOnError |
boolean |
Indica che l'intera richiesta di recupero dovrebbe fallire se il recupero da questa fonte di conoscenza incontra un errore. Il valore predefinito è falso. |
| includeReferenceSourceData |
boolean |
Indica se i riferimenti devono includere nel payload i dati strutturati ottenuti durante il recupero. |
| includeReferences |
boolean |
Indica se è necessario includere i riferimenti per i dati recuperati da questa origine. |
| kind |
string:
indexed |
Tipo di origine della conoscenza. |
| knowledgeSourceName |
string |
Nome dell'indice a cui si applicano i parametri. |
| maxOutputDocuments |
integer (int32) |
Limita il numero massimo di documenti restituiti da questa fonte di conoscenza. |
| rerankerThreshold |
number (float) |
La soglia di reranker che tutti i documenti recuperati devono soddisfare per essere inclusi nella risposta. |
IndexedSharePointKnowledgeSourceParams
Specifica i parametri di runtime per un'origine della conoscenza di SharePoint indicizzata
| Nome | Tipo | Descrizione |
|---|---|---|
| alwaysQuerySource |
boolean |
Indica che l'origine della conoscenza deve ignorare la selezione dell'origine e deve essere sempre interrogata al momento del recupero. |
| enableImageServing |
boolean |
Indica se il servizio immagini debba essere abilitato per questa fonte di conoscenza al momento del recupero. Quando è vero, le immagini estratte durante l'ingestione vengono inviate ai modelli a valle. |
| failOnError |
boolean |
Indica che l'intera richiesta di recupero dovrebbe fallire se il recupero da questa fonte di conoscenza incontra un errore. Il valore predefinito è falso. |
| includeReferenceSourceData |
boolean |
Indica se i riferimenti devono includere nel payload i dati strutturati ottenuti durante il recupero. |
| includeReferences |
boolean |
Indica se è necessario includere i riferimenti per i dati recuperati da questa origine. |
| kind |
string:
indexed |
Tipo di origine della conoscenza. |
| knowledgeSourceName |
string |
Nome dell'indice a cui si applicano i parametri. |
| maxOutputDocuments |
integer (int32) |
Limita il numero massimo di documenti restituiti da questa fonte di conoscenza. |
| rerankerThreshold |
number (float) |
La soglia di reranker che tutti i documenti recuperati devono soddisfare per essere inclusi nella risposta. |
IndexedSqlKnowledgeSourceParams
Specifica parametri di runtime per una sorgente di conoscenza SQL indicizzata
| Nome | Tipo | Descrizione |
|---|---|---|
| alwaysQuerySource |
boolean |
Indica che l'origine della conoscenza deve ignorare la selezione dell'origine e deve essere sempre interrogata al momento del recupero. |
| enableImageServing |
boolean |
Indica se il servizio immagini debba essere abilitato per questa fonte di conoscenza al momento del recupero. Quando è vero, le immagini estratte durante l'ingestione vengono inviate ai modelli a valle. |
| failOnError |
boolean |
Indica che l'intera richiesta di recupero dovrebbe fallire se il recupero da questa fonte di conoscenza incontra un errore. Il valore predefinito è falso. |
| includeReferenceSourceData |
boolean |
Indica se i riferimenti devono includere nel payload i dati strutturati ottenuti durante il recupero. |
| includeReferences |
boolean |
Indica se è necessario includere i riferimenti per i dati recuperati da questa origine. |
| kind |
string:
indexed |
Tipo di origine della conoscenza. |
| knowledgeSourceName |
string |
Nome dell'indice a cui si applicano i parametri. |
| maxOutputDocuments |
integer (int32) |
Limita il numero massimo di documenti restituiti da questa fonte di conoscenza. |
| rerankerThreshold |
number (float) |
La soglia di reranker che tutti i documenti recuperati devono soddisfare per essere inclusi nella risposta. |
KnowledgeBaseActivityRecordType
Il tipo di record di attività.
| Valore | Descrizione |
|---|---|
| searchIndex |
Attività di ricerca nell'indice di ricerca. |
| azureBlob |
Attività di recupero Azure Blob. |
| indexedSharePoint |
Attività di recupero SharePoint indicizzata. |
| indexedOneLake |
Attività di recupero indicizzata di OneLake. |
| web |
Attività di recupero web. |
| remoteSharePoint |
Attività di recupero da remoto di SharePoint. |
| workIQ |
Attività di recupero WorkIQ. |
| fabricDataAgent |
Attività di recupero Fabric Data Agent. |
| fabricOntology |
Attività di recupero dell'Ontologia Fabric. |
| mcpServer |
Attività di recupero del server MCP. |
| file |
Attività di recupero file. |
| indexedSql |
Attività di recupero SQL indicizzata. |
| modelQueryPlanning |
Attività di pianificazione delle query LLM. |
| modelAnswerSynthesis |
Attività di sintesi delle risposte LLM. |
| modelWebSummarization |
Attività di riassunto web per LLM. |
| agenticReasoning |
Attività di ragionamento agentico. |
KnowledgeBaseAgenticReasoningActivityRecord
Rappresenta un record di attività di ragionamento agentico.
| Nome | Tipo | Descrizione |
|---|---|---|
| elapsedMs |
integer (int32) |
Il tempo trascorso in millisecondi per l'attività di recupero. |
| error |
I dettagli dell'errore che spiegano il motivo per cui l'operazione non è riuscita. Questa proprietà viene inclusa solo quando l'attività non riesce. |
|
| id |
integer (int32) |
L'ID del record dell'attività. |
| reasoningTokens |
integer (int32) |
Numero di token di input per il ragionamento agentico. |
| retrievalReasoningEffort | KnowledgeRetrievalReasoningEffort: |
La configurazione dello sforzo di ragionamento per il recupero. |
| type |
string:
agentic |
Tipo di record dell'attività. |
| warning |
string |
Un messaggio di avviso che evidenzia potenziali problemi di configurazione osservati durante l'attività, come documenti caduti a causa della soglia del punteggio, troncamento del limite dei token o condizioni di timeout. |
KnowledgeBaseAzureBlobActivityArguments
Rappresenta gli argomenti con cui è stata eseguita l'attività di recupero del BLOB di Azure.
| Nome | Tipo | Descrizione |
|---|---|---|
| search |
string |
Stringa di ricerca usata per eseguire query sul contenuto del BLOB. |
KnowledgeBaseAzureBlobActivityRecord
Rappresenta un record di attività di recupero BLOB di Azure.
| Nome | Tipo | Descrizione |
|---|---|---|
| azureBlobArguments |
Argomenti del BLOB di Azure per l'attività di recupero. |
|
| count |
integer (int32) |
Il conteggio dei documenti recuperati che erano sufficientemente rilevanti per superare la soglia di reranker. |
| elapsedMs |
integer (int32) |
Il tempo trascorso in millisecondi per l'attività di recupero. |
| error |
I dettagli dell'errore che spiegano il motivo per cui l'operazione non è riuscita. Questa proprietà viene inclusa solo quando l'attività non riesce. |
|
| id |
integer (int32) |
L'ID del record dell'attività. |
| imageServing |
Statistiche sul servizio di immagini per questa attività di recupero |
|
| knowledgeSourceName |
string |
La fonte di conoscenza per l'attività di recupero. |
| queryTime |
string (date-time) |
Tempo di query per l'attività di recupero. |
| type |
string:
azure |
Tipo di record dell'attività. |
| warning |
string |
Un messaggio di avviso che evidenzia potenziali problemi di configurazione osservati durante l'attività, come documenti caduti a causa della soglia del punteggio, troncamento del limite dei token o condizioni di timeout. |
KnowledgeBaseAzureBlobReference
Rappresenta un riferimento al documento di Archiviazione BLOB di Azure.
| Nome | Tipo | Descrizione |
|---|---|---|
| activitySource |
integer (int32) |
ID attività di origine per il riferimento. |
| blobUrl |
string |
URL del BLOB per il riferimento. |
| id |
string |
L'ID del riferimento. |
| rerankerScore |
number (float) |
Punteggio del reranker per il riferimento al documento. |
| searchSensitivityLabelInfo |
Le informazioni sull'etichetta di sensibilità per il riferimento. |
|
| sourceData |
I dati sorgente per il riferimento. |
|
| type |
string:
azure |
Tipo di riferimento. |
KnowledgeBaseErrorAdditionalInfo
Informazioni aggiuntive sull'errore di gestione delle risorse.
| Nome | Tipo | Descrizione |
|---|---|---|
| info |
Informazioni aggiuntive. |
|
| type |
string |
Tipo di informazioni aggiuntive. |
KnowledgeBaseErrorDetail
Dettagli dell'errore.
| Nome | Tipo | Descrizione |
|---|---|---|
| additionalInfo |
Informazioni aggiuntive sull'errore. |
|
| code |
string |
Codice di errore. |
| details |
Dettagli dell'errore. |
|
| message |
string |
Messaggio di errore. |
| target |
string |
La destinazione dell'errore. |
KnowledgeBaseFabricDataAgentActivityArguments
Rappresenta gli argomenti con cui è stata eseguita l'attività di recupero del Fabric Data Agent.
| Nome | Tipo | Descrizione |
|---|---|---|
| search |
string |
La stringa di ricerca utilizzata per interrogare la sorgente di conoscenza del Fabric Data Agent. |
KnowledgeBaseFabricDataAgentActivityRecord
Rappresenta un record di attività di recupero del Fabric Data Agent.
| Nome | Tipo | Descrizione |
|---|---|---|
| count |
integer (int32) |
Il conteggio dei documenti recuperati che erano sufficientemente rilevanti per superare la soglia di reranker. |
| elapsedMs |
integer (int32) |
Il tempo trascorso in millisecondi per l'attività di recupero. |
| error |
I dettagli dell'errore che spiegano il motivo per cui l'operazione non è riuscita. Questa proprietà viene inclusa solo quando l'attività non riesce. |
|
| fabricDataAgentArguments |
Gli argomenti del Fabric Data Agent per l'attività di recupero. |
|
| id |
integer (int32) |
L'ID del record dell'attività. |
| imageServing |
Statistiche sul servizio di immagini per questa attività di recupero |
|
| knowledgeSourceName |
string |
La fonte di conoscenza per l'attività di recupero. |
| queryTime |
string (date-time) |
Tempo di query per l'attività di recupero. |
| type |
string:
fabric |
Tipo di record dell'attività. |
| warning |
string |
Un messaggio di avviso che evidenzia potenziali problemi di configurazione osservati durante l'attività, come documenti caduti a causa della soglia del punteggio, troncamento del limite dei token o condizioni di timeout. |
KnowledgeBaseFabricDataAgentReference
Rappresenta un riferimento documentale Fabric Data Agent.
| Nome | Tipo | Descrizione |
|---|---|---|
| activitySource |
integer (int32) |
ID attività di origine per il riferimento. |
| dataAgentId |
string |
L'ID dell'Agente Fabric Data. |
| id |
string |
L'ID del riferimento. |
| rerankerScore |
number (float) |
Punteggio del reranker per il riferimento al documento. |
| sourceData |
I dati sorgente per il riferimento. |
|
| type |
string:
fabric |
Tipo di riferimento. |
| workspaceId |
string |
ID dell'area di lavoro Fabric. |
KnowledgeBaseFabricOntologyActivityArguments
Rappresenta gli argomenti con cui è stata condotta l'attività di recupero dell'Ontologia Fabric.
| Nome | Tipo | Descrizione |
|---|---|---|
| search |
string |
La stringa di ricerca utilizzata per interrogare la sorgente di conoscenza di Fabric Ontology. |
KnowledgeBaseFabricOntologyActivityRecord
Rappresenta un record di attività di recupero di Fabric Ontology.
| Nome | Tipo | Descrizione |
|---|---|---|
| count |
integer (int32) |
Il conteggio dei documenti recuperati che erano sufficientemente rilevanti per superare la soglia di reranker. |
| elapsedMs |
integer (int32) |
Il tempo trascorso in millisecondi per l'attività di recupero. |
| error |
I dettagli dell'errore che spiegano il motivo per cui l'operazione non è riuscita. Questa proprietà viene inclusa solo quando l'attività non riesce. |
|
| fabricOntologyArguments |
L'Ontologia Fabric argomenta l'attività di recupero. |
|
| id |
integer (int32) |
L'ID del record dell'attività. |
| imageServing |
Statistiche sul servizio di immagini per questa attività di recupero |
|
| knowledgeSourceName |
string |
La fonte di conoscenza per l'attività di recupero. |
| queryTime |
string (date-time) |
Tempo di query per l'attività di recupero. |
| type |
string:
fabric |
Tipo di record dell'attività. |
| warning |
string |
Un messaggio di avviso che evidenzia potenziali problemi di configurazione osservati durante l'attività, come documenti caduti a causa della soglia del punteggio, troncamento del limite dei token o condizioni di timeout. |
KnowledgeBaseFabricOntologyReference
Rappresenta un riferimento documentale di Fabric Ontology.
| Nome | Tipo | Descrizione |
|---|---|---|
| activitySource |
integer (int32) |
ID attività di origine per il riferimento. |
| id |
string |
L'ID del riferimento. |
| ontologyId |
string |
L'ID dell'ontologia all'interno dello spazio di lavoro. |
| rerankerScore |
number (float) |
Punteggio del reranker per il riferimento al documento. |
| sourceData |
I dati sorgente per il riferimento. |
|
| type |
string:
fabric |
Tipo di riferimento. |
| workspaceId |
string |
ID dell'area di lavoro Fabric. |
KnowledgeBaseFileActivityArguments
Rappresenta gli argomenti con cui è stata eseguita l'attività di recupero dei file.
| Nome | Tipo | Descrizione |
|---|---|---|
| search |
string |
La stringa di ricerca usata per interrogare il contenuto del file. |
KnowledgeBaseFileActivityRecord
Rappresenta un record di attività di recupero file.
| Nome | Tipo | Descrizione |
|---|---|---|
| count |
integer (int32) |
Il conteggio dei documenti recuperati che erano sufficientemente rilevanti per superare la soglia di reranker. |
| elapsedMs |
integer (int32) |
Il tempo trascorso in millisecondi per l'attività di recupero. |
| error |
I dettagli dell'errore che spiegano il motivo per cui l'operazione non è riuscita. Questa proprietà viene inclusa solo quando l'attività non riesce. |
|
| fileArguments |
Gli argomenti del file per l'attività di recupero. |
|
| id |
integer (int32) |
L'ID del record dell'attività. |
| imageServing |
Statistiche sul servizio di immagini per questa attività di recupero |
|
| knowledgeSourceName |
string |
La fonte di conoscenza per l'attività di recupero. |
| queryTime |
string (date-time) |
Tempo di query per l'attività di recupero. |
| type |
string:
file |
Tipo di record dell'attività. |
| warning |
string |
Un messaggio di avviso che evidenzia potenziali problemi di configurazione osservati durante l'attività, come documenti caduti a causa della soglia del punteggio, troncamento del limite dei token o condizioni di timeout. |
KnowledgeBaseFileReference
Rappresenta un riferimento a un documento di file.
| Nome | Tipo | Descrizione |
|---|---|---|
| activitySource |
integer (int32) |
ID attività di origine per il riferimento. |
| docName |
string |
Il nome del documento per il riferimento. |
| id |
string |
L'ID del riferimento. |
| rerankerScore |
number (float) |
Punteggio del reranker per il riferimento al documento. |
| sourceData |
I dati sorgente per il riferimento. |
|
| type |
string:
file |
Tipo di riferimento. |
KnowledgeBaseImageContent
Contenuto delle immagini.
| Nome | Tipo | Descrizione |
|---|---|---|
| url |
string (uri) |
L'URL dell'immagine. |
KnowledgeBaseIndexedOneLakeActivityArguments
Rappresenta gli argomenti con cui è stata condotta l'attività di recupero indicizzata di OneLake.
| Nome | Tipo | Descrizione |
|---|---|---|
| search |
string |
La stringa di ricerca utilizzata per interrogare indicizzava i contenuti di OneLake. |
KnowledgeBaseIndexedOneLakeActivityRecord
Rappresenta un record indicizzato di attività di recupero OneLake.
| Nome | Tipo | Descrizione |
|---|---|---|
| count |
integer (int32) |
Il conteggio dei documenti recuperati che erano sufficientemente rilevanti per superare la soglia di reranker. |
| elapsedMs |
integer (int32) |
Il tempo trascorso in millisecondi per l'attività di recupero. |
| error |
I dettagli dell'errore che spiegano il motivo per cui l'operazione non è riuscita. Questa proprietà viene inclusa solo quando l'attività non riesce. |
|
| id |
integer (int32) |
L'ID del record dell'attività. |
| imageServing |
Statistiche sul servizio di immagini per questa attività di recupero |
|
| indexedOneLakeArguments |
Gli argomenti indicizzati di OneLake per l'attività di recupero. |
|
| knowledgeSourceName |
string |
La fonte di conoscenza per l'attività di recupero. |
| queryTime |
string (date-time) |
Tempo di query per l'attività di recupero. |
| type |
string:
indexed |
Tipo di record dell'attività. |
| warning |
string |
Un messaggio di avviso che evidenzia potenziali problemi di configurazione osservati durante l'attività, come documenti caduti a causa della soglia del punteggio, troncamento del limite dei token o condizioni di timeout. |
KnowledgeBaseIndexedOneLakeReference
Rappresenta un riferimento indicizzato a un documento OneLake.
| Nome | Tipo | Descrizione |
|---|---|---|
| activitySource |
integer (int32) |
ID attività di origine per il riferimento. |
| docUrl |
string |
URL del documento per il riferimento. |
| id |
string |
L'ID del riferimento. |
| rerankerScore |
number (float) |
Punteggio del reranker per il riferimento al documento. |
| searchSensitivityLabelInfo |
Le informazioni sull'etichetta di sensibilità per il riferimento. |
|
| sourceData |
I dati sorgente per il riferimento. |
|
| type |
string:
indexed |
Tipo di riferimento. |
KnowledgeBaseIndexedSharePointActivityArguments
Rappresenta gli argomenti con cui è stata eseguita l'attività di recupero di SharePoint indicizzato.
| Nome | Tipo | Descrizione |
|---|---|---|
| search |
string |
La stringa di ricerca usata per interrogare i contenuti indicizzati di SharePoint. |
KnowledgeBaseIndexedSharePointActivityRecord
Rappresenta un record di attività di recupero SharePoint indicizzato.
| Nome | Tipo | Descrizione |
|---|---|---|
| count |
integer (int32) |
Il conteggio dei documenti recuperati che erano sufficientemente rilevanti per superare la soglia di reranker. |
| elapsedMs |
integer (int32) |
Il tempo trascorso in millisecondi per l'attività di recupero. |
| error |
I dettagli dell'errore che spiegano il motivo per cui l'operazione non è riuscita. Questa proprietà viene inclusa solo quando l'attività non riesce. |
|
| id |
integer (int32) |
L'ID del record dell'attività. |
| imageServing |
Statistiche sul servizio di immagini per questa attività di recupero |
|
| indexedSharePointArguments |
Gli argomenti indicizzati di SharePoint per l'attività di recupero. |
|
| knowledgeSourceName |
string |
La fonte di conoscenza per l'attività di recupero. |
| queryTime |
string (date-time) |
Tempo di query per l'attività di recupero. |
| type |
string:
indexed |
Tipo di record dell'attività. |
| warning |
string |
Un messaggio di avviso che evidenzia potenziali problemi di configurazione osservati durante l'attività, come documenti caduti a causa della soglia del punteggio, troncamento del limite dei token o condizioni di timeout. |
KnowledgeBaseIndexedSharePointReference
Rappresenta un riferimento indicizzato a un documento SharePoint.
| Nome | Tipo | Descrizione |
|---|---|---|
| activitySource |
integer (int32) |
ID attività di origine per il riferimento. |
| docUrl |
string |
URL del documento per il riferimento. |
| id |
string |
L'ID del riferimento. |
| rerankerScore |
number (float) |
Punteggio del reranker per il riferimento al documento. |
| searchSensitivityLabelInfo |
Le informazioni sull'etichetta di sensibilità per il riferimento. |
|
| sourceData |
I dati sorgente per il riferimento. |
|
| type |
string:
indexed |
Tipo di riferimento. |
KnowledgeBaseIndexedSqlActivityArguments
Rappresenta gli argomenti con cui è stata eseguita l'attività di recupero SQL indicizzata.
| Nome | Tipo | Descrizione |
|---|---|---|
| search |
string |
La stringa di ricerca usata per interrogare i contenuti SQL indicizzati. |
KnowledgeBaseIndexedSqlActivityRecord
Rappresenta un record di attività di recupero SQL indicizzato.
| Nome | Tipo | Descrizione |
|---|---|---|
| count |
integer (int32) |
Il conteggio dei documenti recuperati che erano sufficientemente rilevanti per superare la soglia di reranker. |
| elapsedMs |
integer (int32) |
Il tempo trascorso in millisecondi per l'attività di recupero. |
| error |
I dettagli dell'errore che spiegano il motivo per cui l'operazione non è riuscita. Questa proprietà viene inclusa solo quando l'attività non riesce. |
|
| id |
integer (int32) |
L'ID del record dell'attività. |
| imageServing |
Statistiche sul servizio di immagini per questa attività di recupero |
|
| indexedSqlArguments |
Gli argomenti SQL indicizzati per l'attività di recupero. |
|
| knowledgeSourceName |
string |
La fonte di conoscenza per l'attività di recupero. |
| queryTime |
string (date-time) |
Tempo di query per l'attività di recupero. |
| type |
string:
indexed |
Tipo di record dell'attività. |
| warning |
string |
Un messaggio di avviso che evidenzia potenziali problemi di configurazione osservati durante l'attività, come documenti caduti a causa della soglia del punteggio, troncamento del limite dei token o condizioni di timeout. |
KnowledgeBaseIndexedSqlReference
Rappresenta un riferimento a un documento Azure SQL.
| Nome | Tipo | Descrizione |
|---|---|---|
| activitySource |
integer (int32) |
ID attività di origine per il riferimento. |
| docUrl |
string |
URL del documento per il riferimento. |
| id |
string |
L'ID del riferimento. |
| rerankerScore |
number (float) |
Punteggio del reranker per il riferimento al documento. |
| sourceData |
I dati sorgente per il riferimento. |
|
| type |
string:
indexed |
Tipo di riferimento. |
KnowledgeBaseMcpServerActivityArguments
Rappresenta gli argomenti con cui è stata condotta l'attività di recupero del server MCP.
| Nome | Tipo | Descrizione |
|---|---|---|
| toolArguments |
Gli argomenti sono passati allo strumento server MCP. |
|
| toolName |
string |
Il nome dello strumento server MCP utilizzato per l'attività di recupero. |
KnowledgeBaseMcpServerActivityRecord
Rappresenta un record di attività di recupero del server MCP.
| Nome | Tipo | Descrizione |
|---|---|---|
| count |
integer (int32) |
Il conteggio dei documenti recuperati che erano sufficientemente rilevanti per superare la soglia di reranker. |
| elapsedMs |
integer (int32) |
Il tempo trascorso in millisecondi per l'attività di recupero. |
| error |
I dettagli dell'errore che spiegano il motivo per cui l'operazione non è riuscita. Questa proprietà viene inclusa solo quando l'attività non riesce. |
|
| id |
integer (int32) |
L'ID del record dell'attività. |
| imageServing |
Statistiche sul servizio di immagini per questa attività di recupero |
|
| knowledgeSourceName |
string |
La fonte di conoscenza per l'attività di recupero. |
| mcpServerArguments |
Il server MCP argomenta per l'attività di recupero. |
|
| queryTime |
string (date-time) |
Tempo di query per l'attività di recupero. |
| type |
string:
mcp |
Tipo di record dell'attività. |
| warning |
string |
Un messaggio di avviso che evidenzia potenziali problemi di configurazione osservati durante l'attività, come documenti caduti a causa della soglia del punteggio, troncamento del limite dei token o condizioni di timeout. |
KnowledgeBaseMcpServerReference
Rappresenta un riferimento a un documento server MCP.
| Nome | Tipo | Descrizione |
|---|---|---|
| activitySource |
integer (int32) |
ID attività di origine per il riferimento. |
| id |
string |
L'ID del riferimento. |
| rerankerScore |
number (float) |
Punteggio del reranker per il riferimento al documento. |
| sourceData |
I dati sorgente per il riferimento. |
|
| title |
string |
Il titolo del risultato dello strumento server MCP. |
| toolName |
string |
Il nome dello strumento server MCP che ha prodotto il riferimento. |
| type |
string:
mcp |
Tipo di riferimento. |
KnowledgeBaseMessage
L'oggetto stile del messaggio in linguaggio naturale.
| Nome | Tipo | Descrizione |
|---|---|---|
| content | KnowledgeBaseMessageContent[]: |
Il contenuto del messaggio. |
| role |
string |
Il ruolo della risposta dello strumento. |
KnowledgeBaseMessageContentType
Tipo di contenuto del messaggio.
| Valore | Descrizione |
|---|---|
| text |
Tipo di contenuto del messaggio di testo. |
| image |
Tipo di contenuto del messaggio immagine. |
KnowledgeBaseMessageImageContent
Tipo di messaggio immagine.
| Nome | Tipo | Descrizione |
|---|---|---|
| image |
Il contenuto dell'immagine. |
|
| type |
string:
image |
Il tipo di messaggio |
KnowledgeBaseMessageTextContent
Tipo di messaggio di testo.
| Nome | Tipo | Descrizione |
|---|---|---|
| text |
string |
Contenuto di testo. |
| type |
string:
text |
Il tipo di messaggio |
KnowledgeBaseModelAnswerSynthesisActivityRecord
Rappresenta un record di attività di sintesi delle risposte LLM.
| Nome | Tipo | Descrizione |
|---|---|---|
| elapsedMs |
integer (int32) |
Il tempo trascorso in millisecondi per l'attività di recupero. |
| error |
I dettagli dell'errore che spiegano il motivo per cui l'operazione non è riuscita. Questa proprietà viene inclusa solo quando l'attività non riesce. |
|
| id |
integer (int32) |
L'ID del record dell'attività. |
| inputTokens |
integer (int32) |
Il numero di token di input per l'attività di sintesi delle risposte LLM. |
| modelName |
string |
Il nome del modello utilizzato per l'attività di sintesi delle risposte LLM. |
| outputTokens |
integer (int32) |
Il numero di token di output per l'attività di sintesi delle risposte LLM. |
| type |
string:
model |
Tipo di record dell'attività. |
| warning |
string |
Un messaggio di avviso che evidenzia potenziali problemi di configurazione osservati durante l'attività, come documenti caduti a causa della soglia del punteggio, troncamento del limite dei token o condizioni di timeout. |
KnowledgeBaseModelQueryPlanningActivityRecord
Rappresenta un record di attività di pianificazione delle query LLM.
| Nome | Tipo | Descrizione |
|---|---|---|
| elapsedMs |
integer (int32) |
Il tempo trascorso in millisecondi per l'attività di recupero. |
| error |
I dettagli dell'errore che spiegano il motivo per cui l'operazione non è riuscita. Questa proprietà viene inclusa solo quando l'attività non riesce. |
|
| id |
integer (int32) |
L'ID del record dell'attività. |
| inputTokens |
integer (int32) |
Il numero di token di input per l'attività di pianificazione delle query LLM. |
| modelName |
string |
Il nome del modello utilizzato per l'attività di pianificazione delle query LLM. |
| outputTokens |
integer (int32) |
Il numero di token di output per l'attività di pianificazione delle query LLM. |
| type |
string:
model |
Tipo di record dell'attività. |
| warning |
string |
Un messaggio di avviso che evidenzia potenziali problemi di configurazione osservati durante l'attività, come documenti caduti a causa della soglia del punteggio, troncamento del limite dei token o condizioni di timeout. |
KnowledgeBaseModelWebSummarizationActivityRecord
Rappresenta un record di attività di riassunto web LLM.
| Nome | Tipo | Descrizione |
|---|---|---|
| elapsedMs |
integer (int32) |
Il tempo trascorso in millisecondi per l'attività di recupero. |
| error |
I dettagli dell'errore che spiegano il motivo per cui l'operazione non è riuscita. Questa proprietà viene inclusa solo quando l'attività non riesce. |
|
| id |
integer (int32) |
L'ID del record dell'attività. |
| inputTokens |
integer (int32) |
Il numero di token di input per l'attività di riassunto web LLM. |
| modelName |
string |
Il nome del modello utilizzato per l'attività di riassunto web degli LLM. |
| outputTokens |
integer (int32) |
Il numero di token di output per l'attività di riassunto web LLM. |
| type |
string:
model |
Tipo di record dell'attività. |
| warning |
string |
Un messaggio di avviso che evidenzia potenziali problemi di configurazione osservati durante l'attività, come documenti caduti a causa della soglia del punteggio, troncamento del limite dei token o condizioni di timeout. |
KnowledgeBaseReferenceType
Tipo di riferimento.
| Valore | Descrizione |
|---|---|
| searchIndex |
Cerca, indice, riferimento documento. |
| azureBlob |
Riferimento documento Azure Blob. |
| indexedSharePoint |
Riferimento indicizzato a un documento SharePoint. |
| indexedOneLake |
Riferimento indicizzato a un documento OneLake. |
| web |
Riferimento a documenti web. |
| remoteSharePoint |
Riferimento remoto a un documento SharePoint. |
| workIQ |
Riferimento al documento Work IQ. |
| fabricDataAgent |
Riferimento documentale Fabric Data Agent. |
| fabricOntology |
Riferimento documentale Fabric Ontology. |
| mcpServer |
Riferimento al documento del server MCP. |
| file |
Archivia il riferimento al documento. |
| indexedSql |
Riferimento indicizzato a un documento SQL. |
KnowledgeBaseRemoteSharePointActivityArguments
Rappresenta gli argomenti con cui è stata eseguita l'attività di recupero remota di SharePoint.
| Nome | Tipo | Descrizione |
|---|---|---|
| filterExpressionAddOn |
string |
L'add-on di espressione del filtro per l'attività di recupero. |
| search |
string |
La stringa di ricerca viene utilizzata per interrogare la sorgente di conoscenza remota di SharePoint. |
KnowledgeBaseRemoteSharePointActivityRecord
Rappresenta un record di attività di recupero remoto di SharePoint.
| Nome | Tipo | Descrizione |
|---|---|---|
| count |
integer (int32) |
Il conteggio dei documenti recuperati che erano sufficientemente rilevanti per superare la soglia di reranker. |
| elapsedMs |
integer (int32) |
Il tempo trascorso in millisecondi per l'attività di recupero. |
| error |
I dettagli dell'errore che spiegano il motivo per cui l'operazione non è riuscita. Questa proprietà viene inclusa solo quando l'attività non riesce. |
|
| id |
integer (int32) |
L'ID del record dell'attività. |
| imageServing |
Statistiche sul servizio di immagini per questa attività di recupero |
|
| knowledgeSourceName |
string |
La fonte di conoscenza per l'attività di recupero. |
| queryTime |
string (date-time) |
Tempo di query per l'attività di recupero. |
| remoteSharePointArguments |
Gli argomenti di SharePoint remoti per l'attività di recupero. |
|
| type |
string:
remote |
Tipo di record dell'attività. |
| warning |
string |
Un messaggio di avviso che evidenzia potenziali problemi di configurazione osservati durante l'attività, come documenti caduti a causa della soglia del punteggio, troncamento del limite dei token o condizioni di timeout. |
KnowledgeBaseRemoteSharePointReference
Rappresenta un riferimento remoto a un documento di SharePoint.
| Nome | Tipo | Descrizione |
|---|---|---|
| activitySource |
integer (int32) |
ID attività di origine per il riferimento. |
| id |
string |
L'ID del riferimento. |
| rerankerScore |
number (float) |
Punteggio del reranker per il riferimento al documento. |
| searchSensitivityLabelInfo |
Le informazioni sull'etichetta di sensibilità per il riferimento. |
|
| sourceData |
I dati sorgente per il riferimento. |
|
| type |
string:
remote |
Tipo di riferimento. |
| webUrl |
string (uri) |
L'URL da cui provengono i dati di riferimento. |
KnowledgeBaseRetrievalRequest
Contratto di input per la richiesta di recupero.
| Nome | Tipo | Descrizione |
|---|---|---|
| includeActivity |
boolean |
Indica che i risultati del recupero devono includere informazioni sull'attività. |
| intents | KnowledgeRetrievalIntent[]: |
Elenco delle query da eseguire senza la pianificazione delle query del modello. |
| knowledgeSourceParams |
KnowledgeSourceParams[]:
|
Elenco di parametri di runtime per le fonti di conoscenza. |
| maxOutputDocuments |
integer (int32) |
Limita il numero massimo di documenti nell'output. |
| maxOutputSize |
integer (int32) |
Limita la dimensione massima del contenuto nell'output. |
| maxOutputSizeInTokens |
integer (int32) |
Limita la dimensione massima del contenuto nell'output. |
| maxRuntimeInSeconds |
integer (int32) |
L'autonomia massima in secondi. |
| messages |
Un elenco di input per lo stile dei messaggi di chat. |
|
| outputMode |
Configurazione dell'output per il recupero. |
|
| retrievalReasoningEffort | KnowledgeRetrievalReasoningEffort: |
La configurazione dello sforzo di ragionamento per il recupero. |
KnowledgeBaseRetrievalResponse
Contratto di output per la risposta di recupero.
KnowledgeBaseSearchIndexActivityArguments
Rappresenta gli argomenti con cui è stata eseguita l'attività di recupero dell'indice di ricerca.
| Nome | Tipo | Descrizione |
|---|---|---|
| filter |
string |
Stringa di filtro. |
| search |
string |
Stringa di ricerca utilizzata per eseguire una query sull'indice di ricerca. |
| searchFields |
Quali campi sono stati cercati. |
|
| semanticConfigurationName |
string |
Quale configurazione semantica è stata utilizzata dall'indice di ricerca. |
| sourceDataFields |
Quali campi sono stati selezionati per la ricerca. |
KnowledgeBaseSearchIndexActivityRecord
Rappresenta un record dell'attività di recupero dell'indice di ricerca.
| Nome | Tipo | Descrizione |
|---|---|---|
| count |
integer (int32) |
Il conteggio dei documenti recuperati che erano sufficientemente rilevanti per superare la soglia di reranker. |
| elapsedMs |
integer (int32) |
Il tempo trascorso in millisecondi per l'attività di recupero. |
| error |
I dettagli dell'errore che spiegano il motivo per cui l'operazione non è riuscita. Questa proprietà viene inclusa solo quando l'attività non riesce. |
|
| id |
integer (int32) |
L'ID del record dell'attività. |
| imageServing |
Statistiche sul servizio di immagini per questa attività di recupero |
|
| knowledgeSourceName |
string |
La fonte di conoscenza per l'attività di recupero. |
| queryTime |
string (date-time) |
Tempo di query per l'attività di recupero. |
| searchIndexArguments |
Gli argomenti dell'indice di ricerca per l'attività di recupero. |
|
| type |
string:
search |
Tipo di record dell'attività. |
| warning |
string |
Un messaggio di avviso che evidenzia potenziali problemi di configurazione osservati durante l'attività, come documenti caduti a causa della soglia del punteggio, troncamento del limite dei token o condizioni di timeout. |
KnowledgeBaseSearchIndexReference
Rappresenta un riferimento al documento di Ricerca di Azure.
| Nome | Tipo | Descrizione |
|---|---|---|
| activitySource |
integer (int32) |
ID attività di origine per il riferimento. |
| docKey |
string |
La chiave del documento per il riferimento. |
| id |
string |
L'ID del riferimento. |
| rerankerScore |
number (float) |
Punteggio del reranker per il riferimento al documento. |
| searchSensitivityLabelInfo |
Le informazioni sull'etichetta di sensibilità per il riferimento. |
|
| sourceData |
I dati sorgente per il riferimento. |
|
| type |
string:
search |
Tipo di riferimento. |
KnowledgeBaseWebActivityArguments
Rappresenta gli argomenti con cui è stata condotta l'attività di recupero web.
| Nome | Tipo | Descrizione |
|---|---|---|
| count |
integer (int32) |
Il numero di risultati web restituiti. |
| freshness |
string |
La freschezza per l'attività di prelievo. |
| language |
string |
Il linguaggio per l'attività di recupero. |
| market |
string |
Il mercato per l'attività di recupero. |
| search |
string |
La stringa di ricerca usata per interrogare il web. |
KnowledgeBaseWebActivityRecord
Rappresenta un record di attività di recupero web.
| Nome | Tipo | Descrizione |
|---|---|---|
| count |
integer (int32) |
Il conteggio dei documenti recuperati che erano sufficientemente rilevanti per superare la soglia di reranker. |
| elapsedMs |
integer (int32) |
Il tempo trascorso in millisecondi per l'attività di recupero. |
| error |
I dettagli dell'errore che spiegano il motivo per cui l'operazione non è riuscita. Questa proprietà viene inclusa solo quando l'attività non riesce. |
|
| id |
integer (int32) |
L'ID del record dell'attività. |
| imageServing |
Statistiche sul servizio di immagini per questa attività di recupero |
|
| knowledgeSourceName |
string |
La fonte di conoscenza per l'attività di recupero. |
| queryTime |
string (date-time) |
Tempo di query per l'attività di recupero. |
| type |
string:
web |
Tipo di record dell'attività. |
| warning |
string |
Un messaggio di avviso che evidenzia potenziali problemi di configurazione osservati durante l'attività, come documenti caduti a causa della soglia del punteggio, troncamento del limite dei token o condizioni di timeout. |
| webArguments |
Gli argomenti web a favore dell'attività di recupero. |
KnowledgeBaseWebReference
Rappresenta un riferimento a un documento Web.
| Nome | Tipo | Descrizione |
|---|---|---|
| activitySource |
integer (int32) |
ID attività di origine per il riferimento. |
| id |
string |
L'ID del riferimento. |
| rerankerScore |
number (float) |
Punteggio del reranker per il riferimento al documento. |
| sourceData |
I dati sorgente per il riferimento. |
|
| title |
string |
Il titolo del documento Web. |
| type |
string:
web |
Tipo di riferimento. |
| url |
string (uri) |
L'URL da cui provengono i dati di riferimento. |
KnowledgeBaseWorkIQActivityArguments
Rappresenta gli argomenti con cui è stata condotta l'attività di recupero WorkIQ.
| Nome | Tipo | Descrizione |
|---|---|---|
| search |
string |
La stringa di ricerca usata per interrogare la fonte di conoscenza di WorkIQ. |
KnowledgeBaseWorkIQActivityRecord
Rappresenta un record di attività di recupero WorkIQ.
| Nome | Tipo | Descrizione |
|---|---|---|
| count |
integer (int32) |
Il conteggio dei documenti recuperati che erano sufficientemente rilevanti per superare la soglia di reranker. |
| elapsedMs |
integer (int32) |
Il tempo trascorso in millisecondi per l'attività di recupero. |
| error |
I dettagli dell'errore che spiegano il motivo per cui l'operazione non è riuscita. Questa proprietà viene inclusa solo quando l'attività non riesce. |
|
| id |
integer (int32) |
L'ID del record dell'attività. |
| imageServing |
Statistiche sul servizio di immagini per questa attività di recupero |
|
| knowledgeSourceName |
string |
La fonte di conoscenza per l'attività di recupero. |
| queryTime |
string (date-time) |
Tempo di query per l'attività di recupero. |
| type |
string:
workIQ |
Tipo di record dell'attività. |
| warning |
string |
Un messaggio di avviso che evidenzia potenziali problemi di configurazione osservati durante l'attività, come documenti caduti a causa della soglia del punteggio, troncamento del limite dei token o condizioni di timeout. |
| workIQArguments |
Gli argomenti WorkIQ a favore dell'attività di recupero. |
KnowledgeBaseWorkIQReference
Rappresenta un riferimento a un documento WorkIQ.
| Nome | Tipo | Descrizione |
|---|---|---|
| activitySource |
integer (int32) |
ID attività di origine per il riferimento. |
| attributions |
Le attribuzioni per il riferimento. |
|
| id |
string |
L'ID del riferimento. |
| rerankerScore |
number (float) |
Punteggio del reranker per il riferimento al documento. |
| sourceData |
I dati sorgente per il riferimento. |
|
| type |
string:
workIQ |
Tipo di riferimento. |
KnowledgeRetrievalIntentType
Tipo di configurazione della Knowledge Base da utilizzare.
| Valore | Descrizione |
|---|---|
| semantic |
Finalità di query semantica in linguaggio naturale. |
KnowledgeRetrievalLowReasoningEffort
Esegui il recupero delle conoscenze con un basso sforzo di ragionamento.
| Nome | Tipo | Descrizione |
|---|---|---|
| kind |
string:
low |
Il tipo di sforzo di ragionamento. |
KnowledgeRetrievalMediumReasoningEffort
Esegui il recupero delle conoscenze con uno sforzo di ragionamento medio.
| Nome | Tipo | Descrizione |
|---|---|---|
| kind |
string:
medium |
Il tipo di sforzo di ragionamento. |
KnowledgeRetrievalMinimalReasoningEffort
Esegui il recupero delle conoscenze con il minimo sforzo di ragionamento.
| Nome | Tipo | Descrizione |
|---|---|---|
| kind |
string:
minimal |
Il tipo di sforzo di ragionamento. |
KnowledgeRetrievalOutputMode
Configurazione dell'output per il recupero.
| Valore | Descrizione |
|---|---|
| extractiveData |
Restituisci i dati direttamente dalle fonti di conoscenza senza alterazioni generative. |
| answerSynthesis |
Sintetizzare una risposta per il payload della risposta. |
KnowledgeRetrievalReasoningEffortKind
Quantità di sforzo da utilizzare durante il recupero.
| Valore | Descrizione |
|---|---|
| minimal |
Non esegue alcuna selezione di origine, pianificazione delle query o ricerca iterativa. |
| low |
Usa un ragionamento basso durante il recupero. |
| medium |
Usa una moderata quantità di ragionamento durante il recupero. |
KnowledgeRetrievalSemanticIntent
Un'intenzione di interrogazione semantica.
| Nome | Tipo | Descrizione |
|---|---|---|
| search |
string |
La query semantica da eseguire |
| type |
string:
semantic |
Tipo di finalità. |
KnowledgeSourceKind
Il tipo di fonte di conoscenza.
| Valore | Descrizione |
|---|---|
| searchIndex |
Origine della conoscenza che legge i dati da un indice di ricerca. |
| azureBlob |
Un'origine delle informazioni che legge e inserisce dati da Archiviazione BLOB di Azure in un indice di ricerca. |
| indexedSharePoint |
Una fonte di conoscenza che legge dati da SharePoint indicizzato. |
| indexedOneLake |
Una fonte di conoscenza che legge dati da OneLake indicizzato. |
| indexedSql |
Una fonte di conoscenza che recupera e assorbe dati da database SQL di Azure o Istanza gestita di SQL in un Search Index. |
| web |
Una fonte di conoscenza che legge dati dal web. |
| remoteSharePoint |
Una fonte di conoscenza che legge dati da SharePoint remoto. |
| workIQ |
Una fonte di conoscenza che legge dati dal QI lavorativo |
| file |
Una fonte di conoscenza che supporta il caricamento e l'indicizzazione diretta dei file. |
| mcpServer |
Una sorgente di conoscenza supportata da un server MCP (Model Context Protocol). |
| fabricDataAgent |
Una fonte di conoscenza che recupera dati da un Fabric Data Agent. |
| fabricOntology |
Una fonte di conoscenza che recupera dati dalle ontologie Microsoft Fabric Ontology. |
McpServerKnowledgeSourceParams
Specifica parametri di runtime per una sorgente di conoscenza di un server MCP
| Nome | Tipo | Descrizione |
|---|---|---|
| alwaysQuerySource |
boolean |
Indica che l'origine della conoscenza deve ignorare la selezione dell'origine e deve essere sempre interrogata al momento del recupero. |
| enableImageServing |
boolean |
Indica se il servizio immagini debba essere abilitato per questa fonte di conoscenza al momento del recupero. Quando è vero, le immagini estratte durante l'ingestione vengono inviate ai modelli a valle. |
| failOnError |
boolean |
Indica che l'intera richiesta di recupero dovrebbe fallire se il recupero da questa fonte di conoscenza incontra un errore. Il valore predefinito è falso. |
| includeReferenceSourceData |
boolean |
Indica se i riferimenti devono includere nel payload i dati strutturati ottenuti durante il recupero. |
| includeReferences |
boolean |
Indica se è necessario includere i riferimenti per i dati recuperati da questa origine. |
| kind |
string:
mcp |
Tipo di origine della conoscenza. |
| knowledgeSourceName |
string |
Nome dell'indice a cui si applicano i parametri. |
| maxOutputDocuments |
integer (int32) |
Limita il numero massimo di documenti restituiti da questa fonte di conoscenza. |
| rerankerThreshold |
number (float) |
La soglia di reranker che tutti i documenti recuperati devono soddisfare per essere inclusi nella risposta. |
PurviewSensitivityLabelInfo
Informazioni sull'etichetta di sensibilità applicata a un documento
| Nome | Tipo | Descrizione |
|---|---|---|
| color |
string |
Colore che l'interfaccia utente deve visualizzare per l'etichetta, se configurata. |
| displayName |
string |
Nome visualizzato per l'etichetta di riservatezza. |
| isEncrypted |
boolean |
Indica se l'etichetta di riservatezza applica la crittografia. |
| priority |
integer (int32) |
Priorità in cui viene applicata l'etichetta di riservatezza. |
| sensitivityLabelId |
string |
ID dell'etichetta di riservatezza. |
| toolTip |
string |
Descrizione comando che deve essere visualizzata per l'etichetta in un'interfaccia utente. |
RemoteSharePointKnowledgeSourceParams
Specifica i parametri di runtime per un'origine della conoscenza remota di SharePoint
| Nome | Tipo | Descrizione |
|---|---|---|
| alwaysQuerySource |
boolean |
Indica che l'origine della conoscenza deve ignorare la selezione dell'origine e deve essere sempre interrogata al momento del recupero. |
| enableImageServing |
boolean |
Indica se il servizio immagini debba essere abilitato per questa fonte di conoscenza al momento del recupero. Quando è vero, le immagini estratte durante l'ingestione vengono inviate ai modelli a valle. |
| failOnError |
boolean |
Indica che l'intera richiesta di recupero dovrebbe fallire se il recupero da questa fonte di conoscenza incontra un errore. Il valore predefinito è falso. |
| filterExpressionAddOn |
string |
Condizione di filtro applicata all'origine dati di SharePoint. Deve essere specificato nella sintassi del linguaggio di query basato su parole chiave. Verrà combinato insieme all'espressione di filtro specificata nella definizione dell'origine della conoscenza. |
| includeReferenceSourceData |
boolean |
Indica se i riferimenti devono includere nel payload i dati strutturati ottenuti durante il recupero. |
| includeReferences |
boolean |
Indica se è necessario includere i riferimenti per i dati recuperati da questa origine. |
| kind |
string:
remote |
Tipo di origine della conoscenza. |
| knowledgeSourceName |
string |
Nome dell'indice a cui si applicano i parametri. |
| maxOutputDocuments |
integer (int32) |
Limita il numero massimo di documenti restituiti da questa fonte di conoscenza. |
| rerankerThreshold |
number (float) |
La soglia di reranker che tutti i documenti recuperati devono soddisfare per essere inclusi nella risposta. |
SearchIndexFieldReference
Riferimento di campo per un indice di ricerca.
| Nome | Tipo | Descrizione |
|---|---|---|
| name |
string |
Nome del campo. |
SearchIndexKnowledgeSourceParams
Specifica i parametri di runtime per un'origine conoscenza dell'indice di ricerca
| Nome | Tipo | Descrizione |
|---|---|---|
| alwaysQuerySource |
boolean |
Indica che l'origine della conoscenza deve ignorare la selezione dell'origine e deve essere sempre interrogata al momento del recupero. |
| enableImageServing |
boolean |
Indica se il servizio immagini debba essere abilitato per questa fonte di conoscenza al momento del recupero. Quando è vero, le immagini estratte durante l'ingestione vengono inviate ai modelli a valle. |
| failOnError |
boolean |
Indica che l'intera richiesta di recupero dovrebbe fallire se il recupero da questa fonte di conoscenza incontra un errore. Il valore predefinito è falso. |
| filterAddOn |
string |
Una condizione di filtro applicata all'indice (ad esempio, 'State eq VA'). |
| includeReferenceSourceData |
boolean |
Indica se i riferimenti devono includere nel payload i dati strutturati ottenuti durante il recupero. |
| includeReferences |
boolean |
Indica se è necessario includere i riferimenti per i dati recuperati da questa origine. |
| kind |
string:
search |
Tipo di origine della conoscenza. |
| knowledgeSourceName |
string |
Nome dell'indice a cui si applicano i parametri. |
| maxOutputDocuments |
integer (int32) |
Limita il numero massimo di documenti restituiti da questa fonte di conoscenza. |
| rerankerThreshold |
number (float) |
La soglia di reranker che tutti i documenti recuperati devono soddisfare per essere inclusi nella risposta. |
WebKnowledgeSourceParams
Specifica i parametri di runtime per un'origine della conoscenza Web
| Nome | Tipo | Descrizione |
|---|---|---|
| alwaysQuerySource |
boolean |
Indica che l'origine della conoscenza deve ignorare la selezione dell'origine e deve essere sempre interrogata al momento del recupero. |
| count |
integer (int32) |
Il numero di risultati Web da restituire. |
| enableImageServing |
boolean |
Indica se il servizio immagini debba essere abilitato per questa fonte di conoscenza al momento del recupero. Quando è vero, le immagini estratte durante l'ingestione vengono inviate ai modelli a valle. |
| failOnError |
boolean |
Indica che l'intera richiesta di recupero dovrebbe fallire se il recupero da questa fonte di conoscenza incontra un errore. Il valore predefinito è falso. |
| freshness |
string |
La freschezza dei risultati web. |
| includeReferenceSourceData |
boolean |
Indica se i riferimenti devono includere nel payload i dati strutturati ottenuti durante il recupero. |
| includeReferences |
boolean |
Indica se è necessario includere i riferimenti per i dati recuperati da questa origine. |
| kind |
string:
web |
Tipo di origine della conoscenza. |
| knowledgeSourceName |
string |
Nome dell'indice a cui si applicano i parametri. |
| language |
string |
La lingua dei risultati web. |
| market |
string |
Il mercato dei risultati web. |
| maxOutputDocuments |
integer (int32) |
Limita il numero massimo di documenti restituiti da questa fonte di conoscenza. |
| rerankerThreshold |
number (float) |
La soglia di reranker che tutti i documenti recuperati devono soddisfare per essere inclusi nella risposta. |
WorkIQAttribution
Informazioni di attribuzione per un riferimento WorkIQ.
| Nome | Tipo | Descrizione |
|---|---|---|
| seeMoreWebUrl |
string (uri) |
L'URL per l'attribuzione. |
WorkIQKnowledgeSourceParams
Specifica parametri di runtime per una sorgente di conoscenza WorkIQ
| Nome | Tipo | Descrizione |
|---|---|---|
| alwaysQuerySource |
boolean |
Indica che l'origine della conoscenza deve ignorare la selezione dell'origine e deve essere sempre interrogata al momento del recupero. |
| enableImageServing |
boolean |
Indica se il servizio immagini debba essere abilitato per questa fonte di conoscenza al momento del recupero. Quando è vero, le immagini estratte durante l'ingestione vengono inviate ai modelli a valle. |
| failOnError |
boolean |
Indica che l'intera richiesta di recupero dovrebbe fallire se il recupero da questa fonte di conoscenza incontra un errore. Il valore predefinito è falso. |
| includeReferenceSourceData |
boolean |
Indica se i riferimenti devono includere nel payload i dati strutturati ottenuti durante il recupero. |
| includeReferences |
boolean |
Indica se è necessario includere i riferimenti per i dati recuperati da questa origine. |
| kind |
string:
workIQ |
Tipo di origine della conoscenza. |
| knowledgeSourceName |
string |
Nome dell'indice a cui si applicano i parametri. |
| maxOutputDocuments |
integer (int32) |
Limita il numero massimo di documenti restituiti da questa fonte di conoscenza. |
| rerankerThreshold |
number (float) |
La soglia di reranker che tutti i documenti recuperati devono soddisfare per essere inclusi nella risposta. |