Knowledge Retrieval - Retrieve

Servizio:: Search Service

Versione API:: 2026-08-01-preview

La Knowledge Base recupera i dati rilevanti dagli archivi di backup.

POST {endpoint}/knowledgebases('{knowledgeBaseName}')/retrieve?api-version=2026-08-01-preview

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
endpoint	path	True	string (uri)	URL dell'endpoint del servizio di ricerca.
knowledgeBaseName	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	Tipo	Descrizione
Accept	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-query-work-iq-source-authorization	string (password)	Token di dichiarazione utente per una registrazione dell'app Entra di proprietà del cliente configurata su una fonte di conoscenza Work IQ. Utilizzato per l'autenticazione a nome dell'API Work IQ.
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[]: KnowledgeRetrievalSemanticIntent[]	Elenco delle query da eseguire senza la pianificazione delle query del modello.
knowledgeSourceParams	KnowledgeSourceParams[]: AzureBlobKnowledgeSourceParams[] FabricDataAgentKnowledgeSourceParams[] FabricOntologyKnowledgeSourceParams[] FileKnowledgeSourceParams[] IndexedOneLakeKnowledgeSourceParams[] IndexedSharePointKnowledgeSourceParams[] IndexedSqlKnowledgeSourceParams[] McpServerKnowledgeSourceParams[] RemoteSharePointKnowledgeSourceParams[] SearchIndexKnowledgeSourceParams[] WebKnowledgeSourceParams[] WorkIQKnowledgeSourceParams[]	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	KnowledgeBaseMessage[]	Un elenco di input per lo stile dei messaggi di chat.
outputMode	KnowledgeRetrievalOutputMode	Configurazione dell'output per il recupero.
retrievalReasoningEffort	KnowledgeRetrievalReasoningEffort: KnowledgeRetrievalAutoReasoningEffort KnowledgeRetrievalLowReasoningEffort KnowledgeRetrievalMediumReasoningEffort KnowledgeRetrievalMinimalReasoningEffort	La configurazione dello sforzo di ragionamento per il recupero.

Risposte

Nome	Tipo	Descrizione
200 OK	KnowledgeBaseRetrievalResponse	Risposta al prelievo riuscita.
Other Status Codes	KnowledgeBaseRetrievalResponse	Risposta parziale al prelievo.
Other Status Codes	ErrorResponse	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

KnowledgeBaseRetrieve

KnowledgeBaseRetrieveAzureBlobImageServing

KnowledgeBaseRetrieveWithIntents

KnowledgeBaseRetrieveWithSourceExclusion

KnowledgeBaseRetrieve

Esempio di richiesta

HTTP

POST https://typespecpreviewexampleservice.search.windows.net/knowledgebases('base-preview-test')/retrieve?api-version=2026-08-01-preview





{
  "messages": [
    {
      "role": "user",
      "content": [
        {
          "type": "text",
          "text": "hello world"
        }
      ]
    }
  ],
  "maxRuntimeInSeconds": 60,
  "maxOutputSize": 100000,
  "maxOutputDocuments": 50,
  "retrievalReasoningEffort": {
    "kind": "low"
  },
  "includeActivity": true,
  "outputMode": "answerSynthesis",
  "knowledgeSourceParams": [
    {
      "knowledgeSourceName": "ks-preview-test",
      "includeReferences": true,
      "includeReferenceSourceData": true,
      "alwaysQuerySource": false,
      "neverQuerySource": false,
      "failOnError": false,
      "rerankerThreshold": 2.1,
      "resultsProcessing": "rerank",
      "kind": "searchIndex",
      "filterAddOn": "foo eq bar",
      "queryHintOverrides": {
        "filters": [
          {
            "field": "country",
            "fieldValues": [
              "United States",
              "Japan",
              "France",
              "Germany"
            ],
            "filterInstructions": "Country associated with the document."
          }
        ],
        "boosts": [
          {
            "kind": "fieldValue",
            "boostInstructions": "Prefer documents matching the user's locale.",
            "field": "language",
            "fieldValues": [
              "en-US",
              "ja-JP",
              "fr-FR",
              "de-DE"
            ],
            "boost": 1.5
          }
        ]
      }
    }
  ]
}

Risposta di esempio

Codice di stato:: 200

{
  "response": [
    {
      "content": [
        {
          "type": "text",
          "text": "[{...}]"
        }
      ]
    }
  ],
  "activity": [
    {
      "type": "modelQueryPlanning",
      "id": 0,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "inputTokens": 11,
      "outputTokens": 22,
      "elapsedMs": 10,
      "model": {
        "modelName": "gpt-4o",
        "deploymentId": "gpt-4o-deployment"
      }
    },
    {
      "type": "searchIndex",
      "id": 1,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "knowledgeSourceName": "ks-preview-test",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 2,
      "elapsedMs": 1234,
      "searchIndexArguments": {
        "search": "hello world",
        "filter": "((category eq 'news') and (foo eq bar)) and (Key eq 'myDocKey1')",
        "semanticConfigurationName": "testconfig",
        "queryType": "simple",
        "sourceDataFields": [
          {
            "name": "category"
          },
          {
            "name": "description"
          },
          {
            "name": "ownerId"
          },
          {
            "name": "id"
          }
        ],
        "searchFields": []
      },
      "queryHintProcessing": {
        "generatedFilter": "Key eq 'myDocKey1'"
      }
    },
    {
      "type": "searchIndex",
      "id": 2,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "knowledgeSourceName": "ks-preview-test",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 2,
      "elapsedMs": 1234,
      "searchIndexArguments": {
        "search": "hello world two",
        "filter": "((category eq 'news') and (foo eq bar)) and (Key eq 'myDocKey1')",
        "semanticConfigurationName": "testconfig",
        "queryType": "simple",
        "sourceDataFields": [
          {
            "name": "category"
          },
          {
            "name": "description"
          },
          {
            "name": "ownerId"
          },
          {
            "name": "id"
          }
        ],
        "searchFields": []
      },
      "queryHintProcessing": {
        "generatedFilter": "Key eq 'myDocKey1'"
      }
    },
    {
      "type": "modelAnswerSynthesis",
      "id": 3,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "inputTokens": 11,
      "outputTokens": 22,
      "elapsedMs": 10,
      "model": {
        "modelName": "gpt-4o",
        "deploymentId": "gpt-4o-deployment"
      }
    },
    {
      "type": "agenticReasoning",
      "id": 4,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "reasoningTokens": 78,
      "retrievalReasoningEffort": {
        "kind": "low"
      },
      "logicalReasoningEffort": {
        "kind": "low"
      }
    }
  ],
  "references": [
    {
      "type": "searchIndex",
      "id": "83dd7d40",
      "activitySource": 1,
      "rerankerScore": 4,
      "docKey": "myDocKey1",
      "citationUrl": "https://typespecpreviewexampleservice.search.windows.net/indexes/preview-test/docs/myDocKey1?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-08-01-preview",
      "sourceData": {
        "id": "myDocKey1",
        "title": "high_doc",
        "content": "hello world"
      }
    },
    {
      "type": "searchIndex",
      "id": "83dd7d41",
      "activitySource": 1,
      "rerankerScore": 3.9,
      "docKey": "myDocKey2",
      "citationUrl": "https://typespecpreviewexampleservice.search.windows.net/indexes/preview-test/docs/myDocKey2?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-08-01-preview",
      "sourceData": {
        "id": "myDocKey2",
        "title": "low_doc",
        "content": "goodbye world"
      }
    }
  ]
}

Codice di stato:: 206

{
  "response": [
    {
      "content": [
        {
          "type": "text",
          "text": "[{...}]"
        }
      ]
    }
  ],
  "activity": [
    {
      "type": "modelQueryPlanning",
      "id": 0,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "inputTokens": 11,
      "outputTokens": 22,
      "elapsedMs": 10,
      "model": {
        "modelName": "gpt-4o",
        "deploymentId": "gpt-4o-deployment"
      }
    },
    {
      "type": "searchIndex",
      "id": 1,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "knowledgeSourceName": "ks-preview-test",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 2,
      "elapsedMs": 1234,
      "searchIndexArguments": {
        "search": "hello world",
        "filter": "((category eq 'news') and (foo eq bar)) and (Key eq 'myDocKey1')",
        "semanticConfigurationName": "testconfig",
        "queryType": "simple",
        "sourceDataFields": [
          {
            "name": "category"
          },
          {
            "name": "description"
          },
          {
            "name": "ownerId"
          },
          {
            "name": "id"
          }
        ],
        "searchFields": []
      },
      "queryHintProcessing": {
        "generatedFilter": "Key eq 'myDocKey1'"
      }
    },
    {
      "type": "searchIndex",
      "id": 2,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "knowledgeSourceName": "ks-preview-test",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 2,
      "elapsedMs": 1234,
      "searchIndexArguments": {
        "search": "hello world two",
        "filter": "((category eq 'news') and (foo eq bar)) and (Key eq 'myDocKey1')",
        "semanticConfigurationName": "testconfig",
        "queryType": "simple",
        "sourceDataFields": [
          {
            "name": "category"
          },
          {
            "name": "description"
          },
          {
            "name": "ownerId"
          },
          {
            "name": "id"
          }
        ],
        "searchFields": []
      },
      "queryHintProcessing": {
        "generatedFilter": "Key eq 'myDocKey1'"
      }
    },
    {
      "type": "modelAnswerSynthesis",
      "id": 3,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "inputTokens": 11,
      "outputTokens": 22,
      "elapsedMs": 10,
      "model": {
        "modelName": "gpt-4o",
        "deploymentId": "gpt-4o-deployment"
      }
    },
    {
      "type": "agenticReasoning",
      "id": 4,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "reasoningTokens": 78,
      "retrievalReasoningEffort": {
        "kind": "low"
      },
      "logicalReasoningEffort": {
        "kind": "low"
      }
    }
  ],
  "references": [
    {
      "type": "searchIndex",
      "id": "83dd7d40",
      "activitySource": 1,
      "rerankerScore": 4,
      "docKey": "myDocKey1",
      "citationUrl": "https://typespecpreviewexampleservice.search.windows.net/indexes/preview-test/docs/myDocKey1?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-08-01-preview",
      "sourceData": {
        "id": "myDocKey1",
        "title": "high_doc",
        "content": "hello world"
      }
    },
    {
      "type": "searchIndex",
      "id": "83dd7d41",
      "activitySource": 1,
      "rerankerScore": 3.9,
      "docKey": "myDocKey2",
      "citationUrl": "https://typespecpreviewexampleservice.search.windows.net/indexes/preview-test/docs/myDocKey2?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-08-01-preview",
      "sourceData": {
        "id": "myDocKey2",
        "title": "low_doc",
        "content": "goodbye world"
      }
    }
  ]
}

KnowledgeBaseRetrieveAzureBlobImageServing

Esempio di richiesta

HTTP

POST https://typespecpreviewexampleservice.search.windows.net/knowledgebases('base-azureblob-preview-test')/retrieve?api-version=2026-08-01-preview





{
  "messages": [
    {
      "role": "user",
      "content": [
        {
          "type": "text",
          "text": "hello world"
        }
      ]
    }
  ],
  "maxRuntimeInSeconds": 60,
  "maxOutputSize": 100000,
  "maxOutputDocuments": 50,
  "retrievalReasoningEffort": {
    "kind": "low"
  },
  "includeActivity": true,
  "outputMode": "answerSynthesis",
  "knowledgeSourceParams": [
    {
      "knowledgeSourceName": "azureblob-ks-preview-test",
      "includeReferences": true,
      "includeReferenceSourceData": true,
      "alwaysQuerySource": false,
      "failOnError": false,
      "rerankerThreshold": 2.1,
      "kind": "azureBlob",
      "enableImageServing": true
    }
  ]
}

Risposta di esempio

Codice di stato:: 200

{
  "response": [
    {
      "content": [
        {
          "type": "text",
          "text": "[{...}]"
        }
      ]
    }
  ],
  "activity": [
    {
      "type": "modelQueryPlanning",
      "id": 0,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "inputTokens": 11,
      "outputTokens": 22,
      "elapsedMs": 10,
      "model": {
        "modelName": "gpt-4o",
        "deploymentId": "gpt-4o-deployment"
      }
    },
    {
      "type": "azureBlob",
      "id": 1,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "knowledgeSourceName": "azureblob-ks-preview-test",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 2,
      "elapsedMs": 1234,
      "azureBlobArguments": {
        "search": "hello world"
      },
      "imageServing": {
        "imagesRetrieved": 2,
        "imagesSentToModel": 1,
        "totalImageSizeBytes": 3,
        "verbalizationUsed": true,
        "servedImages": [
          {
            "imageId": "1.1",
            "imagePath": "doc/normalized_images_0.jpg",
            "sizeBytes": 3
          }
        ]
      }
    },
    {
      "type": "azureBlob",
      "id": 2,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "knowledgeSourceName": "azureblob-ks-preview-test",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 2,
      "elapsedMs": 1234,
      "azureBlobArguments": {
        "search": "hello world two"
      }
    },
    {
      "type": "modelAnswerSynthesis",
      "id": 3,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "inputTokens": 11,
      "outputTokens": 22,
      "elapsedMs": 10,
      "model": {
        "modelName": "gpt-4o",
        "deploymentId": "gpt-4o-deployment"
      }
    },
    {
      "type": "agenticReasoning",
      "id": 4,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "reasoningTokens": 78,
      "retrievalReasoningEffort": {
        "kind": "low"
      },
      "logicalReasoningEffort": {
        "kind": "low"
      }
    }
  ],
  "references": [
    {
      "type": "azureBlob",
      "id": "83dd7d40",
      "activitySource": 1,
      "rerankerScore": 4,
      "citationUrl": "https://typespecpreviewexampleservice.search.windows.net/indexes/azureblob-ks-preview-test-index/docs/myDocKey1?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-08-01-preview",
      "sourceData": {
        "id": "myDocKey1",
        "title": "high_doc",
        "content": "hello world",
        "image_path": "1.1:doc/normalized_images_0.jpg"
      }
    },
    {
      "type": "azureBlob",
      "id": "83dd7d41",
      "activitySource": 1,
      "rerankerScore": 3.9,
      "citationUrl": "https://typespecpreviewexampleservice.search.windows.net/indexes/azureblob-ks-preview-test-index/docs/myDocKey2?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-08-01-preview",
      "sourceData": {
        "id": "myDocKey2",
        "title": "low_doc",
        "content": "goodbye world",
        "image_path": "3.2:doc/normalized_images_1.jpg"
      }
    }
  ]
}

Codice di stato:: 206

{
  "response": [
    {
      "content": [
        {
          "type": "text",
          "text": "[{...}]"
        }
      ]
    }
  ],
  "activity": [
    {
      "type": "modelQueryPlanning",
      "id": 0,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "inputTokens": 11,
      "outputTokens": 22,
      "elapsedMs": 10,
      "model": {
        "modelName": "gpt-4o",
        "deploymentId": "gpt-4o-deployment"
      }
    },
    {
      "type": "azureBlob",
      "id": 1,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "knowledgeSourceName": "azureblob-ks-preview-test",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 2,
      "elapsedMs": 1234,
      "azureBlobArguments": {
        "search": "hello world"
      },
      "imageServing": {
        "imagesRetrieved": 2,
        "imagesSentToModel": 1,
        "totalImageSizeBytes": 3,
        "verbalizationUsed": true,
        "servedImages": [
          {
            "imageId": "1.1",
            "imagePath": "doc/normalized_images_0.jpg",
            "sizeBytes": 3
          }
        ]
      }
    },
    {
      "type": "azureBlob",
      "id": 2,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "knowledgeSourceName": "azureblob-ks-preview-test",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 2,
      "elapsedMs": 1234,
      "azureBlobArguments": {
        "search": "hello world two"
      }
    },
    {
      "type": "modelAnswerSynthesis",
      "id": 3,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "inputTokens": 11,
      "outputTokens": 22,
      "elapsedMs": 10,
      "model": {
        "modelName": "gpt-4o",
        "deploymentId": "gpt-4o-deployment"
      }
    },
    {
      "type": "agenticReasoning",
      "id": 4,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "reasoningTokens": 78,
      "retrievalReasoningEffort": {
        "kind": "low"
      },
      "logicalReasoningEffort": {
        "kind": "low"
      }
    }
  ],
  "references": [
    {
      "type": "azureBlob",
      "id": "83dd7d40",
      "activitySource": 1,
      "rerankerScore": 4,
      "citationUrl": "https://typespecpreviewexampleservice.search.windows.net/indexes/azureblob-ks-preview-test-index/docs/myDocKey1?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-08-01-preview",
      "sourceData": {
        "id": "myDocKey1",
        "title": "high_doc",
        "content": "hello world",
        "image_path": "1.1:doc/normalized_images_0.jpg"
      }
    },
    {
      "type": "azureBlob",
      "id": "83dd7d41",
      "activitySource": 1,
      "rerankerScore": 3.9,
      "citationUrl": "https://typespecpreviewexampleservice.search.windows.net/indexes/azureblob-ks-preview-test-index/docs/myDocKey2?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-08-01-preview",
      "sourceData": {
        "id": "myDocKey2",
        "title": "low_doc",
        "content": "goodbye world",
        "image_path": "3.2:doc/normalized_images_1.jpg"
      }
    }
  ]
}

KnowledgeBaseRetrieveWithIntents

Esempio di richiesta

HTTP

POST https://typespecpreviewexampleservice.search.windows.net/knowledgebases('base-preview-test')/retrieve?api-version=2026-08-01-preview





{
  "intents": [
    {
      "type": "semantic",
      "search": "foo"
    }
  ],
  "maxRuntimeInSeconds": 60,
  "maxOutputSize": 100000,
  "maxOutputDocuments": 50,
  "retrievalReasoningEffort": {
    "kind": "minimal"
  },
  "includeActivity": true,
  "outputMode": "extractiveData",
  "knowledgeSourceParams": [
    {
      "knowledgeSourceName": "ks-preview-test",
      "includeReferences": true,
      "includeReferenceSourceData": true,
      "alwaysQuerySource": true,
      "failOnError": true,
      "rerankerThreshold": 2.1,
      "resultsProcessing": "rerank",
      "kind": "searchIndex",
      "filterAddOn": "foo eq bar",
      "queryHintOverrides": {
        "filters": [
          {
            "field": "country",
            "fieldValues": [
              "United States",
              "Japan",
              "France",
              "Germany"
            ],
            "filterInstructions": "Country associated with the document."
          }
        ],
        "boosts": [
          {
            "kind": "fieldValue",
            "boostInstructions": "Prefer documents matching the user's locale.",
            "field": "language",
            "fieldValues": [
              "en-US",
              "ja-JP",
              "fr-FR",
              "de-DE"
            ],
            "boost": 1.5
          }
        ]
      }
    }
  ]
}

Risposta di esempio

Codice di stato:: 200

{
  "response": [
    {
      "content": [
        {
          "type": "text",
          "text": "[{...}]"
        }
      ]
    }
  ],
  "activity": [
    {
      "type": "searchIndex",
      "id": 0,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "knowledgeSourceName": "ks-preview-test",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 2,
      "elapsedMs": 1234,
      "searchIndexArguments": {
        "search": "foo",
        "filter": "(category eq 'news') and (foo eq bar)",
        "semanticConfigurationName": "testconfig",
        "sourceDataFields": [
          {
            "name": "category"
          },
          {
            "name": "description"
          },
          {
            "name": "ownerId"
          },
          {
            "name": "id"
          }
        ],
        "searchFields": []
      }
    },
    {
      "type": "agenticReasoning",
      "id": 1,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "reasoningTokens": 39,
      "retrievalReasoningEffort": {
        "kind": "minimal"
      },
      "logicalReasoningEffort": {
        "kind": "minimal"
      }
    }
  ],
  "references": [
    {
      "type": "searchIndex",
      "id": "83dd7d40",
      "activitySource": 0,
      "rerankerScore": 4,
      "docKey": "myDocKey1",
      "citationUrl": "https://typespecpreviewexampleservice.search.windows.net/indexes/preview-test/docs/myDocKey1?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-08-01-preview",
      "sourceData": {
        "id": "myDocKey1",
        "title": "high_doc",
        "content": "hello world"
      }
    },
    {
      "type": "searchIndex",
      "id": "83dd7d41",
      "activitySource": 0,
      "rerankerScore": 3.9,
      "docKey": "myDocKey2",
      "citationUrl": "https://typespecpreviewexampleservice.search.windows.net/indexes/preview-test/docs/myDocKey2?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-08-01-preview",
      "sourceData": {
        "id": "myDocKey2",
        "title": "low_doc",
        "content": "goodbye world"
      }
    }
  ]
}

Codice di stato:: 206

{
  "response": [
    {
      "content": [
        {
          "type": "text",
          "text": "[{...}]"
        }
      ]
    }
  ],
  "activity": [
    {
      "type": "searchIndex",
      "id": 0,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "knowledgeSourceName": "ks-preview-test",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 2,
      "elapsedMs": 1234,
      "searchIndexArguments": {
        "search": "foo",
        "filter": "(category eq 'news') and (foo eq bar)",
        "semanticConfigurationName": "testconfig",
        "sourceDataFields": [
          {
            "name": "category"
          },
          {
            "name": "description"
          },
          {
            "name": "ownerId"
          },
          {
            "name": "id"
          }
        ],
        "searchFields": []
      }
    },
    {
      "type": "agenticReasoning",
      "id": 1,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "reasoningTokens": 39,
      "retrievalReasoningEffort": {
        "kind": "minimal"
      },
      "logicalReasoningEffort": {
        "kind": "minimal"
      }
    }
  ],
  "references": [
    {
      "type": "searchIndex",
      "id": "83dd7d40",
      "activitySource": 0,
      "rerankerScore": 4,
      "docKey": "myDocKey1",
      "citationUrl": "https://typespecpreviewexampleservice.search.windows.net/indexes/preview-test/docs/myDocKey1?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-08-01-preview",
      "sourceData": {
        "id": "myDocKey1",
        "title": "high_doc",
        "content": "hello world"
      }
    },
    {
      "type": "searchIndex",
      "id": "83dd7d41",
      "activitySource": 0,
      "rerankerScore": 3.9,
      "docKey": "myDocKey2",
      "citationUrl": "https://typespecpreviewexampleservice.search.windows.net/indexes/preview-test/docs/myDocKey2?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-08-01-preview",
      "sourceData": {
        "id": "myDocKey2",
        "title": "low_doc",
        "content": "goodbye world"
      }
    }
  ]
}

KnowledgeBaseRetrieveWithSourceExclusion

Esempio di richiesta

HTTP

POST https://previewexampleservice.search.windows.net/knowledgebases('support-kb')/retrieve?api-version=2026-08-01-preview




{
  "messages": [
    {
      "role": "user",
      "content": [
        {
          "text": "Explain the SSO provisioning steps from the product documentation only.",
          "type": "text"
        }
      ]
    }
  ],
  "includeActivity": true,
  "outputMode": "answerSynthesis",
  "knowledgeSourceParams": [
    {
      "knowledgeSourceName": "product-docs-ks",
      "includeReferences": true,
      "includeReferenceSourceData": true,
      "kind": "searchIndex"
    },
    {
      "knowledgeSourceName": "troubleshooting-ks",
      "neverQuerySource": true,
      "kind": "searchIndex"
    },
    {
      "knowledgeSourceName": "release-notes-web",
      "neverQuerySource": true,
      "kind": "web"
    }
  ]
}

Risposta di esempio

Codice di stato:: 200

{
  "response": [
    {
      "content": [
        {
          "type": "text",
          "text": "To provision SSO, register the enterprise application, configure the redirect URI, upload the signing certificate, and complete the tenant-specific identity settings described in the product documentation."
        }
      ]
    }
  ],
  "activity": [
    {
      "type": "modelQueryPlanning",
      "id": 0,
      "inputTokens": 11,
      "outputTokens": 22,
      "elapsedMs": 10
    },
    {
      "type": "searchIndex",
      "id": 1,
      "knowledgeSourceName": "product-docs-ks",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 4,
      "elapsedMs": 64,
      "searchIndexArguments": {
        "search": "SSO provisioning steps",
        "sourceDataFields": [
          {
            "name": "title"
          },
          {
            "name": "content"
          },
          {
            "name": "id"
          }
        ],
        "searchFields": [],
        "semanticConfigurationName": "testconfig"
      }
    },
    {
      "type": "agenticReasoning",
      "id": 2,
      "retrievalReasoningEffort": {
        "kind": "low"
      },
      "reasoningTokens": 74
    },
    {
      "type": "modelAnswerSynthesis",
      "id": 3,
      "inputTokens": 664,
      "outputTokens": 1328,
      "elapsedMs": 10
    }
  ],
  "references": [
    {
      "type": "searchIndex",
      "id": "83dd7d40",
      "activitySource": 1,
      "sourceData": {
        "id": "sso-provisioning-guide",
        "title": "SSO provisioning guide",
        "content": "Register the enterprise application and configure the redirect URI."
      },
      "rerankerScore": 3.5,
      "docKey": "sso-provisioning-guide"
    }
  ]
}

Codice di stato:: 206

{
  "response": [
    {
      "content": [
        {
          "type": "text",
          "text": "Partial results were returned before the retrieval completed."
        }
      ]
    }
  ],
  "activity": [
    {
      "type": "modelQueryPlanning",
      "id": 0,
      "inputTokens": 11,
      "outputTokens": 22,
      "elapsedMs": 10
    },
    {
      "type": "searchIndex",
      "id": 1,
      "knowledgeSourceName": "product-docs-ks",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 1,
      "elapsedMs": 64,
      "searchIndexArguments": {
        "search": "SSO provisioning steps",
        "sourceDataFields": [
          {
            "name": "title"
          },
          {
            "name": "content"
          },
          {
            "name": "id"
          }
        ],
        "searchFields": [],
        "semanticConfigurationName": "testconfig"
      }
    }
  ],
  "references": [
    {
      "type": "searchIndex",
      "id": "83dd7d40",
      "activitySource": 1,
      "sourceData": {
        "id": "sso-provisioning-guide",
        "title": "SSO provisioning guide",
        "content": "Register the enterprise application and configure the redirect URI."
      },
      "rerankerScore": 3.5,
      "docKey": "sso-provisioning-guide"
    }
  ]
}

Definizioni

Nome	Descrizione
Accept	L'intestazione Accetta.
AzureBlobKnowledgeSourceParams	Specifica i parametri di runtime per un'origine della conoscenza BLOB di Azure
ErrorAdditionalInfo	Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorDetail	Dettagli 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.
FabricDataAgentKnowledgeSourceParams	Specifica i parametri di runtime per una sorgente di conoscenza del Fabric Data Agent
FabricOntologyKnowledgeSourceParams	Specifica parametri di runtime per una sorgente di conoscenza di Fabric Ontology
FileKnowledgeSourceParams	Specifica parametri di runtime per una sorgente di conoscenza di file
ImageServingStatistics	Statistiche sul servizio di immagini durante un'attività di recupero.
IndexedOneLakeKnowledgeSourceParams	Specifica i parametri di runtime per un'origine della conoscenza OneLake indicizzata
IndexedSharePointKnowledgeSourceParams	Specifica i parametri di runtime per un'origine della conoscenza di SharePoint indicizzata
IndexedSqlKnowledgeSourceParams	Specifica parametri di runtime per una sorgente di conoscenza SQL indicizzata
KnowledgeBaseActivityRecordModel	Rappresenta il modello utilizzato per un'attività di un LLM di knowledge base, inclusi il nome del modello e l'identificatore di deployment.
KnowledgeBaseActivityRecordType	Il tipo di record di attività.
KnowledgeBaseAgenticReasoningActivityRecord	Rappresenta un record di attività di ragionamento agentico.
KnowledgeBaseAzureBlobActivityArguments	Rappresenta gli argomenti con cui è stata eseguita l'attività di recupero del BLOB di Azure.
KnowledgeBaseAzureBlobActivityRecord	Rappresenta un record di attività di recupero BLOB di Azure.
KnowledgeBaseAzureBlobReference	Rappresenta un riferimento al documento di Archiviazione BLOB di Azure.
KnowledgeBaseErrorAdditionalInfo	Informazioni aggiuntive sull'errore di gestione delle risorse.
KnowledgeBaseErrorDetail	Dettagli dell'errore.
KnowledgeBaseFabricDataAgentActivityArguments	Rappresenta gli argomenti con cui è stata eseguita l'attività di recupero del Fabric Data Agent.
KnowledgeBaseFabricDataAgentActivityRecord	Rappresenta un record di attività di recupero del Fabric Data Agent.
KnowledgeBaseFabricDataAgentReference	Rappresenta un riferimento documentale Fabric Data Agent.
KnowledgeBaseFabricOntologyActivityArguments	Rappresenta gli argomenti con cui è stata condotta l'attività di recupero dell'Ontologia Fabric.
KnowledgeBaseFabricOntologyActivityRecord	Rappresenta un record di attività di recupero di Fabric Ontology.
KnowledgeBaseFabricOntologyReference	Rappresenta un riferimento documentale di Fabric Ontology.
KnowledgeBaseFileActivityArguments	Rappresenta gli argomenti con cui è stata eseguita l'attività di recupero dei file.
KnowledgeBaseFileActivityRecord	Rappresenta un record di attività di recupero file.
KnowledgeBaseFileReference	Rappresenta un riferimento a un documento di file.
KnowledgeBaseImageContent	Contenuto delle immagini.
KnowledgeBaseIndexedOneLakeActivityArguments	Rappresenta gli argomenti con cui è stata condotta l'attività di recupero indicizzata di OneLake.
KnowledgeBaseIndexedOneLakeActivityRecord	Rappresenta un record indicizzato di attività di recupero OneLake.
KnowledgeBaseIndexedOneLakeReference	Rappresenta un riferimento indicizzato a un documento OneLake.
KnowledgeBaseIndexedSharePointActivityArguments	Rappresenta gli argomenti con cui è stata eseguita l'attività di recupero di SharePoint indicizzato.
KnowledgeBaseIndexedSharePointActivityRecord	Rappresenta un record di attività di recupero SharePoint indicizzato.
KnowledgeBaseIndexedSharePointReference	Rappresenta un riferimento indicizzato a un documento SharePoint.
KnowledgeBaseIndexedSqlActivityArguments	Rappresenta gli argomenti con cui è stata eseguita l'attività di recupero SQL indicizzata.
KnowledgeBaseIndexedSqlActivityRecord	Rappresenta un record di attività di recupero SQL indicizzato.
KnowledgeBaseIndexedSqlReference	Rappresenta un riferimento a un documento Azure SQL.
KnowledgeBaseMcpServerActivityArguments	Rappresenta gli argomenti con cui è stata condotta l'attività di recupero del server MCP.
KnowledgeBaseMcpServerActivityRecord	Rappresenta un record di attività di recupero del server MCP.
KnowledgeBaseMcpServerReference	Rappresenta un riferimento a un documento server MCP.
KnowledgeBaseMessage	L'oggetto stile del messaggio in linguaggio naturale.
KnowledgeBaseMessageContentType	Tipo di contenuto del messaggio.
KnowledgeBaseMessageImageContent	Tipo di messaggio immagine.
KnowledgeBaseMessageTextContent	Tipo di messaggio di testo.
KnowledgeBaseModelAnswerSynthesisActivityRecord	Rappresenta un record di attività di sintesi delle risposte LLM.
KnowledgeBaseModelQueryPlanningActivityRecord	Rappresenta un record di attività di pianificazione delle query LLM.
KnowledgeBaseModelWebSummarizationActivityRecord	Rappresenta un record di attività di riassunto web LLM.
KnowledgeBaseQueryHintProcessing	Dettagli sulle espressioni generate dai query hint per un'attività di recupero.
KnowledgeBaseReferenceType	Tipo di riferimento.
KnowledgeBaseRemoteSharePointActivityArguments	Rappresenta gli argomenti con cui è stata eseguita l'attività di recupero remota di SharePoint.
KnowledgeBaseRemoteSharePointActivityRecord	Rappresenta un record di attività di recupero remoto di SharePoint.
KnowledgeBaseRemoteSharePointReference	Rappresenta un riferimento remoto a un documento di SharePoint.
KnowledgeBaseRetrievalRequest	Contratto di input per la richiesta di 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.
KnowledgeBaseSearchIndexActivityRecord	Rappresenta un record dell'attività di recupero dell'indice di ricerca.
KnowledgeBaseSearchIndexReference	Rappresenta un riferimento al documento di Ricerca di Azure.
KnowledgeBaseWebActivityArguments	Rappresenta gli argomenti con cui è stata condotta l'attività di recupero web.
KnowledgeBaseWebActivityRecord	Rappresenta un record di attività di recupero web.
KnowledgeBaseWebReference	Rappresenta un riferimento a un documento Web.
KnowledgeBaseWorkIQActivityArguments	Rappresenta gli argomenti con cui è stata condotta l'attività di recupero WorkIQ.
KnowledgeBaseWorkIQActivityRecord	Rappresenta un record di attività di recupero WorkIQ.
KnowledgeBaseWorkIQReference	Rappresenta un riferimento a un documento WorkIQ.
KnowledgeRetrievalAutoReasoningEffort	Seleziona automaticamente lo sforzo di ragionamento durante il recupero. Il servizio semina ogni richiesta al livello più basso e si estende solo fino al livello massimo disponibile del servizio.
KnowledgeRetrievalIntentType	Tipo di configurazione della Knowledge Base da utilizzare.
KnowledgeRetrievalLowReasoningEffort	Esegui il recupero delle conoscenze con un basso sforzo di ragionamento.
KnowledgeRetrievalMediumReasoningEffort	Esegui il recupero delle conoscenze con uno sforzo di ragionamento medio.
KnowledgeRetrievalMinimalReasoningEffort	Esegui il recupero delle conoscenze con il minimo sforzo di ragionamento.
KnowledgeRetrievalOutputMode	Configurazione dell'output per il recupero.
KnowledgeRetrievalReasoningEffortKind	Quantità di sforzo da utilizzare durante il recupero.
KnowledgeRetrievalSemanticIntent	Un'intenzione di interrogazione semantica.
KnowledgeSourceKind	Il tipo di fonte di conoscenza.
KnowledgeSourceResultsProcessing	Controlla se i risultati di una fonte di conoscenza vengono riclassificati.
McpServerKnowledgeSourceParams	Specifica parametri di runtime per una sorgente di conoscenza di un server MCP
PurviewSensitivityLabelInfo	Informazioni sull'etichetta di sensibilità applicata a un documento
QueryType	Specifica la sintassi della query di ricerca. Il valore predefinito è 'simple'. Utilizzare 'full' se la query utilizza la sintassi della query Lucene e 'semantic' se la sintassi della query non è necessaria.
RemoteSharePointKnowledgeSourceParams	Specifica i parametri di runtime per un'origine della conoscenza remota di SharePoint
SearchIndexFieldReference	Riferimento di campo per un indice di ricerca.
SearchIndexKnowledgeSourceBoostKind	Il tipo di suggerimento per un incarico di ricerca e una fonte di conoscenza dell'indice di ricerca.
SearchIndexKnowledgeSourceFieldValueBoost	Un suggerimento che potenzia i documenti in base al valore di un campo.
SearchIndexKnowledgeSourceFilterHint	Un suggerimento che identifica un campo e valori rappresentativi che il query planner può usare per costruire un filtro.
SearchIndexKnowledgeSourceMultiWordExpressionBoost	Un suggerimento che migliora i documenti basandosi su un'espressione di più parole.
SearchIndexKnowledgeSourceParams	Specifica i parametri di runtime per un'origine conoscenza dell'indice di ricerca
SearchIndexKnowledgeSourceQueryHints	Suggerimenti che guidano la pianificazione delle query verso filtri utili e potenziamenti per una fonte di conoscenza dell'indice di ricerca.
ServedImage	Descrive una singola immagine che il modello ha selezionato per essere servita durante un'attività di recupero.
WebKnowledgeSourceParams	Specifica i parametri di runtime per un'origine della conoscenza Web
WorkIQKnowledgeSourceParams	Specifica parametri di runtime per una sorgente di conoscenza WorkIQ

Accept

Enumerazione

L'intestazione Accetta.

Valore	Descrizione
application/json;odata.metadata=minimal

AzureBlobKnowledgeSourceParams

Oggetto

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: azureBlob	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.
neverQuerySource	boolean	Indica che questa fonte di conoscenza dovrebbe essere esclusa dal set di candidati della richiesta e mai interrogata al momento del recupero. L'esclusione è request-local e non modifica l'appartenenza alla knowledge base. Non può essere combinato con alwaysQuerySource sulla stessa fonte di conoscenza.
queryHintOverrides	SearchIndexKnowledgeSourceQueryHints	Suggerimenti che guidano la pianificazione delle query verso filtri e potenziamenti utili. Se specificato, questo oggetto sostituisce l'intero insieme di suggerimenti di query configurati sulla sorgente di conoscenza.
rerankerThreshold	number (float)	La soglia di reranker che tutti i documenti recuperati devono soddisfare per essere inclusi nella risposta.
resultsProcessing	KnowledgeSourceResultsProcessing	Sovrascrive i risultati archiviati dalla fonte di conoscenza solo per questa chiamata di recupero. Quando viene omesso, si applica il valore della sorgente di conoscenza memorizzata.

ErrorAdditionalInfo

Oggetto

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome	Tipo	Descrizione
info		Informazioni aggiuntive.
type	string	Tipo di informazioni aggiuntive.

ErrorDetail

Oggetto

Dettagli dell'errore.

Nome	Tipo	Descrizione
additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
code	string	Codice di errore.
details	ErrorDetail[]	Dettagli dell'errore.
message	string	Messaggio di errore.
target	string	La destinazione dell'errore.

ErrorResponse

Oggetto

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	ErrorDetail	Oggetto error.

FabricDataAgentKnowledgeSourceParams

Oggetto

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: fabricDataAgent	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.
neverQuerySource	boolean	Indica che questa fonte di conoscenza dovrebbe essere esclusa dal set di candidati della richiesta e mai interrogata al momento del recupero. L'esclusione è request-local e non modifica l'appartenenza alla knowledge base. Non può essere combinato con alwaysQuerySource sulla stessa fonte di conoscenza.
rerankerThreshold	number (float)	La soglia di reranker che tutti i documenti recuperati devono soddisfare per essere inclusi nella risposta.
resultsProcessing	KnowledgeSourceResultsProcessing	Sovrascrive i risultati archiviati dalla fonte di conoscenza solo per questa chiamata di recupero. Quando viene omesso, si applica il valore della sorgente di conoscenza memorizzata.

FabricOntologyKnowledgeSourceParams

Oggetto

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: fabricOntology	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.
neverQuerySource	boolean	Indica che questa fonte di conoscenza dovrebbe essere esclusa dal set di candidati della richiesta e mai interrogata al momento del recupero. L'esclusione è request-local e non modifica l'appartenenza alla knowledge base. Non può essere combinato con alwaysQuerySource sulla stessa fonte di conoscenza.
rerankerThreshold	number (float)	La soglia di reranker che tutti i documenti recuperati devono soddisfare per essere inclusi nella risposta.
resultsProcessing	KnowledgeSourceResultsProcessing	Sovrascrive i risultati archiviati dalla fonte di conoscenza solo per questa chiamata di recupero. Quando viene omesso, si applica il valore della sorgente di conoscenza memorizzata.

FileKnowledgeSourceParams

Oggetto

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.
neverQuerySource	boolean	Indica che questa fonte di conoscenza dovrebbe essere esclusa dal set di candidati della richiesta e mai interrogata al momento del recupero. L'esclusione è request-local e non modifica l'appartenenza alla knowledge base. Non può essere combinato con alwaysQuerySource sulla stessa fonte di conoscenza.
queryHintOverrides	SearchIndexKnowledgeSourceQueryHints	Suggerimenti che guidano la pianificazione delle query verso filtri e potenziamenti utili. Se specificato, questo oggetto sostituisce l'intero insieme di suggerimenti di query configurati sulla sorgente di conoscenza.
rerankerThreshold	number (float)	La soglia di reranker che tutti i documenti recuperati devono soddisfare per essere inclusi nella risposta.
resultsProcessing	KnowledgeSourceResultsProcessing	Sovrascrive i risultati archiviati dalla fonte di conoscenza solo per questa chiamata di recupero. Quando viene omesso, si applica il valore della sorgente di conoscenza memorizzata.

ImageServingStatistics

Oggetto

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.
servedImages	ServedImage[]	L'insieme di immagini selezionate dal modello da servire al modello a valle per questa attività di recupero.
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

Oggetto

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: indexedOneLake	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.
neverQuerySource	boolean	Indica che questa fonte di conoscenza dovrebbe essere esclusa dal set di candidati della richiesta e mai interrogata al momento del recupero. L'esclusione è request-local e non modifica l'appartenenza alla knowledge base. Non può essere combinato con alwaysQuerySource sulla stessa fonte di conoscenza.
queryHintOverrides	SearchIndexKnowledgeSourceQueryHints	Suggerimenti che guidano la pianificazione delle query verso filtri e potenziamenti utili. Se specificato, questo oggetto sostituisce l'intero insieme di suggerimenti di query configurati sulla sorgente di conoscenza.
rerankerThreshold	number (float)	La soglia di reranker che tutti i documenti recuperati devono soddisfare per essere inclusi nella risposta.
resultsProcessing	KnowledgeSourceResultsProcessing	Sovrascrive i risultati archiviati dalla fonte di conoscenza solo per questa chiamata di recupero. Quando viene omesso, si applica il valore della sorgente di conoscenza memorizzata.

IndexedSharePointKnowledgeSourceParams

Oggetto

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: indexedSharePoint	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.
neverQuerySource	boolean	Indica che questa fonte di conoscenza dovrebbe essere esclusa dal set di candidati della richiesta e mai interrogata al momento del recupero. L'esclusione è request-local e non modifica l'appartenenza alla knowledge base. Non può essere combinato con alwaysQuerySource sulla stessa fonte di conoscenza.
queryHintOverrides	SearchIndexKnowledgeSourceQueryHints	Suggerimenti che guidano la pianificazione delle query verso filtri e potenziamenti utili. Se specificato, questo oggetto sostituisce l'intero insieme di suggerimenti di query configurati sulla sorgente di conoscenza.
rerankerThreshold	number (float)	La soglia di reranker che tutti i documenti recuperati devono soddisfare per essere inclusi nella risposta.
resultsProcessing	KnowledgeSourceResultsProcessing	Sovrascrive i risultati archiviati dalla fonte di conoscenza solo per questa chiamata di recupero. Quando viene omesso, si applica il valore della sorgente di conoscenza memorizzata.

IndexedSqlKnowledgeSourceParams

Oggetto

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: indexedSql	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.
neverQuerySource	boolean	Indica che questa fonte di conoscenza dovrebbe essere esclusa dal set di candidati della richiesta e mai interrogata al momento del recupero. L'esclusione è request-local e non modifica l'appartenenza alla knowledge base. Non può essere combinato con alwaysQuerySource sulla stessa fonte di conoscenza.
queryHintOverrides	SearchIndexKnowledgeSourceQueryHints	Suggerimenti che guidano la pianificazione delle query verso filtri e potenziamenti utili. Se specificato, questo oggetto sostituisce l'intero insieme di suggerimenti di query configurati sulla sorgente di conoscenza.
rerankerThreshold	number (float)	La soglia di reranker che tutti i documenti recuperati devono soddisfare per essere inclusi nella risposta.
resultsProcessing	KnowledgeSourceResultsProcessing	Sovrascrive i risultati archiviati dalla fonte di conoscenza solo per questa chiamata di recupero. Quando viene omesso, si applica il valore della sorgente di conoscenza memorizzata.

KnowledgeBaseActivityRecordModel

Oggetto

Rappresenta il modello utilizzato per un'attività di un LLM di knowledge base, inclusi il nome del modello e l'identificatore di deployment.

Nome	Tipo	Descrizione
deploymentId	string	L'identificatore di distribuzione del modello utilizzato per l'attività.
modelName	string	Il nome del modello utilizzato per l'attività.

KnowledgeBaseActivityRecordType

Enumerazione

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

Oggetto

Rappresenta un record di attività di ragionamento agentico.

Nome	Tipo	Descrizione
completedAt	string (date-time)	Il momento in cui l'attività si è conclusa.
elapsedMs	integer (int32)	Il tempo trascorso in millisecondi per l'attività di recupero.
error	KnowledgeBaseErrorDetail	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à.
logicalReasoningEffort	KnowledgeRetrievalReasoningEffort: KnowledgeRetrievalAutoReasoningEffort KnowledgeRetrievalLowReasoningEffort KnowledgeRetrievalMediumReasoningEffort KnowledgeRetrievalMinimalReasoningEffort	Lo sforzo di ragionamento logico richiesto dal cliente. Questo è distinto da `retrievalReasoningEffort`, che riporta lo sforzo di ragionamento utilizzato per la fatturazione.
reasoningTokens	integer (int32)	Numero di token di input per il ragionamento agentico.
retrievalReasoningEffort	KnowledgeRetrievalReasoningEffort: KnowledgeRetrievalAutoReasoningEffort KnowledgeRetrievalLowReasoningEffort KnowledgeRetrievalMediumReasoningEffort KnowledgeRetrievalMinimalReasoningEffort	La configurazione dello sforzo di ragionamento per il recupero.
startedAt	string (date-time)	L'orario in cui è iniziata l'attività.
type	string: agenticReasoning	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

Oggetto

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

Oggetto

Rappresenta un record di attività di recupero BLOB di Azure.

Nome	Tipo	Descrizione
azureBlobArguments	KnowledgeBaseAzureBlobActivityArguments	Argomenti del BLOB di Azure per l'attività di recupero.
completedAt	string (date-time)	Il momento in cui l'attività si è conclusa.
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	KnowledgeBaseErrorDetail	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	ImageServingStatistics	Statistiche sul servizio di immagini per questa attività di recupero
knowledgeSourceName	string	La fonte di conoscenza per l'attività di recupero.
queryHintProcessing	KnowledgeBaseQueryHintProcessing	Dettagli sulle espressioni generate dai query hint per questa attività.
queryTime	string (date-time)	Tempo di query per l'attività di recupero.
startedAt	string (date-time)	L'orario in cui è iniziata l'attività.
type	string: azureBlob	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

Oggetto

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.
citationUrl	string (uri)	Un URL di proprietà di Search che punta al documento di supporto di questo riferimento, utilizzabile come target di citazione.
id	string	L'ID del riferimento.
rerankerScore	number (float)	Punteggio del reranker per il riferimento al documento.
searchSensitivityLabelInfo	PurviewSensitivityLabelInfo	Le informazioni sull'etichetta di sensibilità per il riferimento.
sourceData		I dati sorgente per il riferimento.
type	string: azureBlob	Tipo di riferimento.

KnowledgeBaseErrorAdditionalInfo

Oggetto

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome	Tipo	Descrizione
info		Informazioni aggiuntive.
type	string	Tipo di informazioni aggiuntive.

KnowledgeBaseErrorDetail

Oggetto

Dettagli dell'errore.

Nome	Tipo	Descrizione
additionalInfo	KnowledgeBaseErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
code	string	Codice di errore.
details	KnowledgeBaseErrorDetail[]	Dettagli dell'errore.
message	string	Messaggio di errore.
target	string	La destinazione dell'errore.

KnowledgeBaseFabricDataAgentActivityArguments

Oggetto

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

Oggetto

Rappresenta un record di attività di recupero del Fabric Data Agent.

Nome	Tipo	Descrizione
completedAt	string (date-time)	Il momento in cui l'attività si è conclusa.
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	KnowledgeBaseErrorDetail	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	KnowledgeBaseFabricDataAgentActivityArguments	Gli argomenti del Fabric Data Agent per l'attività di recupero.
id	integer (int32)	L'ID del record dell'attività.
imageServing	ImageServingStatistics	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.
startedAt	string (date-time)	L'orario in cui è iniziata l'attività.
type	string: fabricDataAgent	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

Oggetto

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: fabricDataAgent	Tipo di riferimento.
workspaceId	string	ID dell'area di lavoro Fabric.

KnowledgeBaseFabricOntologyActivityArguments

Oggetto

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

Oggetto

Rappresenta un record di attività di recupero di Fabric Ontology.

Nome	Tipo	Descrizione
completedAt	string (date-time)	Il momento in cui l'attività si è conclusa.
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	KnowledgeBaseErrorDetail	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	KnowledgeBaseFabricOntologyActivityArguments	L'Ontologia Fabric argomenta l'attività di recupero.
id	integer (int32)	L'ID del record dell'attività.
imageServing	ImageServingStatistics	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.
startedAt	string (date-time)	L'orario in cui è iniziata l'attività.
type	string: fabricOntology	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

Oggetto

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: fabricOntology	Tipo di riferimento.
workspaceId	string	ID dell'area di lavoro Fabric.

KnowledgeBaseFileActivityArguments

Oggetto

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

Oggetto

Rappresenta un record di attività di recupero file.

Nome	Tipo	Descrizione
completedAt	string (date-time)	Il momento in cui l'attività si è conclusa.
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	KnowledgeBaseErrorDetail	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	KnowledgeBaseFileActivityArguments	Gli argomenti del file per l'attività di recupero.
id	integer (int32)	L'ID del record dell'attività.
imageServing	ImageServingStatistics	Statistiche sul servizio di immagini per questa attività di recupero
knowledgeSourceName	string	La fonte di conoscenza per l'attività di recupero.
queryHintProcessing	KnowledgeBaseQueryHintProcessing	Dettagli sulle espressioni generate dai query hint per questa attività.
queryTime	string (date-time)	Tempo di query per l'attività di recupero.
startedAt	string (date-time)	L'orario in cui è iniziata l'attività.
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

Oggetto

Rappresenta un riferimento a un documento di file.

Nome	Tipo	Descrizione
activitySource	integer (int32)	ID attività di origine per il riferimento.
citationUrl	string (uri)	Un URL di proprietà di Search che punta al documento di supporto di questo riferimento, utilizzabile come target di citazione.
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

Oggetto

Contenuto delle immagini.

Nome	Tipo	Descrizione
url	string (uri)	L'URL dell'immagine.

KnowledgeBaseIndexedOneLakeActivityArguments

Oggetto

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

Oggetto

Rappresenta un record indicizzato di attività di recupero OneLake.

Nome	Tipo	Descrizione
completedAt	string (date-time)	Il momento in cui l'attività si è conclusa.
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	KnowledgeBaseErrorDetail	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	ImageServingStatistics	Statistiche sul servizio di immagini per questa attività di recupero
indexedOneLakeArguments	KnowledgeBaseIndexedOneLakeActivityArguments	Gli argomenti indicizzati di OneLake per l'attività di recupero.
knowledgeSourceName	string	La fonte di conoscenza per l'attività di recupero.
queryHintProcessing	KnowledgeBaseQueryHintProcessing	Dettagli sulle espressioni generate dai query hint per questa attività.
queryTime	string (date-time)	Tempo di query per l'attività di recupero.
startedAt	string (date-time)	L'orario in cui è iniziata l'attività.
type	string: indexedOneLake	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

Oggetto

Rappresenta un riferimento indicizzato a un documento OneLake.

Nome	Tipo	Descrizione
activitySource	integer (int32)	ID attività di origine per il riferimento.
citationUrl	string (uri)	Un URL di proprietà di Search che punta al documento di supporto di questo riferimento, utilizzabile come target di citazione.
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	PurviewSensitivityLabelInfo	Le informazioni sull'etichetta di sensibilità per il riferimento.
sourceData		I dati sorgente per il riferimento.
type	string: indexedOneLake	Tipo di riferimento.

KnowledgeBaseIndexedSharePointActivityArguments

Oggetto

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

Oggetto

Rappresenta un record di attività di recupero SharePoint indicizzato.

Nome	Tipo	Descrizione
completedAt	string (date-time)	Il momento in cui l'attività si è conclusa.
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	KnowledgeBaseErrorDetail	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	ImageServingStatistics	Statistiche sul servizio di immagini per questa attività di recupero
indexedSharePointArguments	KnowledgeBaseIndexedSharePointActivityArguments	Gli argomenti indicizzati di SharePoint per l'attività di recupero.
knowledgeSourceName	string	La fonte di conoscenza per l'attività di recupero.
queryHintProcessing	KnowledgeBaseQueryHintProcessing	Dettagli sulle espressioni generate dai query hint per questa attività.
queryTime	string (date-time)	Tempo di query per l'attività di recupero.
startedAt	string (date-time)	L'orario in cui è iniziata l'attività.
type	string: indexedSharePoint	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

Oggetto

Rappresenta un riferimento indicizzato a un documento SharePoint.

Nome	Tipo	Descrizione
activitySource	integer (int32)	ID attività di origine per il riferimento.
citationUrl	string (uri)	Un URL di proprietà di Search che punta al documento di supporto di questo riferimento, utilizzabile come target di citazione.
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	PurviewSensitivityLabelInfo	Le informazioni sull'etichetta di sensibilità per il riferimento.
sourceData		I dati sorgente per il riferimento.
type	string: indexedSharePoint	Tipo di riferimento.

KnowledgeBaseIndexedSqlActivityArguments

Oggetto

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

Oggetto

Rappresenta un record di attività di recupero SQL indicizzato.

Nome	Tipo	Descrizione
completedAt	string (date-time)	Il momento in cui l'attività si è conclusa.
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	KnowledgeBaseErrorDetail	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	ImageServingStatistics	Statistiche sul servizio di immagini per questa attività di recupero
indexedSqlArguments	KnowledgeBaseIndexedSqlActivityArguments	Gli argomenti SQL indicizzati per l'attività di recupero.
knowledgeSourceName	string	La fonte di conoscenza per l'attività di recupero.
queryHintProcessing	KnowledgeBaseQueryHintProcessing	Dettagli sulle espressioni generate dai query hint per questa attività.
queryTime	string (date-time)	Tempo di query per l'attività di recupero.
startedAt	string (date-time)	L'orario in cui è iniziata l'attività.
type	string: indexedSql	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

Oggetto

Rappresenta un riferimento a un documento Azure SQL.

Nome	Tipo	Descrizione
activitySource	integer (int32)	ID attività di origine per il riferimento.
citationUrl	string (uri)	Un URL di proprietà di Search che punta al documento di supporto di questo riferimento, utilizzabile come target di citazione.
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: indexedSql	Tipo di riferimento.

KnowledgeBaseMcpServerActivityArguments

Oggetto

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

Oggetto

Rappresenta un record di attività di recupero del server MCP.

Nome	Tipo	Descrizione
completedAt	string (date-time)	Il momento in cui l'attività si è conclusa.
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	KnowledgeBaseErrorDetail	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	ImageServingStatistics	Statistiche sul servizio di immagini per questa attività di recupero
knowledgeSourceName	string	La fonte di conoscenza per l'attività di recupero.
mcpServerArguments	KnowledgeBaseMcpServerActivityArguments	Il server MCP argomenta per l'attività di recupero.
queryTime	string (date-time)	Tempo di query per l'attività di recupero.
startedAt	string (date-time)	L'orario in cui è iniziata l'attività.
type	string: mcpServer	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

Oggetto

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: mcpServer	Tipo di riferimento.

KnowledgeBaseMessage

Oggetto

L'oggetto stile del messaggio in linguaggio naturale.

Nome	Tipo	Descrizione
content	KnowledgeBaseMessageContent[]: KnowledgeBaseMessageImageContent[] KnowledgeBaseMessageTextContent[]	Il contenuto del messaggio.
role	string	Il ruolo della risposta dello strumento.

KnowledgeBaseMessageContentType

Enumerazione

Tipo di contenuto del messaggio.

Valore	Descrizione
text	Tipo di contenuto del messaggio di testo.
image	Tipo di contenuto del messaggio immagine.

KnowledgeBaseMessageImageContent

Oggetto

Tipo di messaggio immagine.

Nome	Tipo	Descrizione
image	KnowledgeBaseImageContent	Il contenuto dell'immagine.
type	string: image	Tipo del messaggio

KnowledgeBaseMessageTextContent

Oggetto

Tipo di messaggio di testo.

Nome	Tipo	Descrizione
text	string	Contenuto di testo.
type	string: text	Tipo del messaggio

KnowledgeBaseModelAnswerSynthesisActivityRecord

Oggetto

Rappresenta un record di attività di sintesi delle risposte LLM.

Nome	Tipo	Descrizione
completedAt	string (date-time)	Il momento in cui l'attività si è conclusa.
elapsedMs	integer (int32)	Il tempo trascorso in millisecondi per l'attività di recupero.
error	KnowledgeBaseErrorDetail	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.
model	KnowledgeBaseActivityRecordModel	Il 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.
startedAt	string (date-time)	L'orario in cui è iniziata l'attività.
type	string: modelAnswerSynthesis	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

Oggetto

Rappresenta un record di attività di pianificazione delle query LLM.

Nome	Tipo	Descrizione
completedAt	string (date-time)	Il momento in cui l'attività si è conclusa.
elapsedMs	integer (int32)	Il tempo trascorso in millisecondi per l'attività di recupero.
error	KnowledgeBaseErrorDetail	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.
model	KnowledgeBaseActivityRecordModel	Il 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.
startedAt	string (date-time)	L'orario in cui è iniziata l'attività.
type	string: modelQueryPlanning	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

Oggetto

Rappresenta un record di attività di riassunto web LLM.

Nome	Tipo	Descrizione
completedAt	string (date-time)	Il momento in cui l'attività si è conclusa.
elapsedMs	integer (int32)	Il tempo trascorso in millisecondi per l'attività di recupero.
error	KnowledgeBaseErrorDetail	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.
model	KnowledgeBaseActivityRecordModel	Il 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.
startedAt	string (date-time)	L'orario in cui è iniziata l'attività.
type	string: modelWebSummarization	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.

KnowledgeBaseQueryHintProcessing

Oggetto

Dettagli sulle espressioni generate dai query hint per un'attività di recupero.

Nome	Tipo	Descrizione
generatedBoost	string	La clausola di ricerca generata dai suggerimenti boost per questa attività.
generatedFilter	string	L'espressione del filtro generata dagli indizi del filtro per questa attività.

KnowledgeBaseReferenceType

Enumerazione

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

Oggetto

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

Oggetto

Rappresenta un record di attività di recupero remoto di SharePoint.

Nome	Tipo	Descrizione
completedAt	string (date-time)	Il momento in cui l'attività si è conclusa.
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	KnowledgeBaseErrorDetail	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	ImageServingStatistics	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	KnowledgeBaseRemoteSharePointActivityArguments	Gli argomenti di SharePoint remoti per l'attività di recupero.
startedAt	string (date-time)	L'orario in cui è iniziata l'attività.
type	string: remoteSharePoint	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

Oggetto

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	PurviewSensitivityLabelInfo	Le informazioni sull'etichetta di sensibilità per il riferimento.
sourceData		I dati sorgente per il riferimento.
type	string: remoteSharePoint	Tipo di riferimento.
webUrl	string (uri)	L'URL da cui provengono i dati di riferimento.

KnowledgeBaseRetrievalRequest

Oggetto

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[]: KnowledgeRetrievalSemanticIntent[]	Elenco delle query da eseguire senza la pianificazione delle query del modello.
knowledgeSourceParams	KnowledgeSourceParams[]: AzureBlobKnowledgeSourceParams[] FabricDataAgentKnowledgeSourceParams[] FabricOntologyKnowledgeSourceParams[] FileKnowledgeSourceParams[] IndexedOneLakeKnowledgeSourceParams[] IndexedSharePointKnowledgeSourceParams[] IndexedSqlKnowledgeSourceParams[] McpServerKnowledgeSourceParams[] RemoteSharePointKnowledgeSourceParams[] SearchIndexKnowledgeSourceParams[] WebKnowledgeSourceParams[] WorkIQKnowledgeSourceParams[]	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	KnowledgeBaseMessage[]	Un elenco di input per lo stile dei messaggi di chat.
outputMode	KnowledgeRetrievalOutputMode	Configurazione dell'output per il recupero.
retrievalReasoningEffort	KnowledgeRetrievalReasoningEffort: KnowledgeRetrievalAutoReasoningEffort KnowledgeRetrievalLowReasoningEffort KnowledgeRetrievalMediumReasoningEffort KnowledgeRetrievalMinimalReasoningEffort	La configurazione dello sforzo di ragionamento per il recupero.

KnowledgeBaseRetrievalResponse

Oggetto

Contratto di output per la risposta di recupero.

Nome	Tipo	Descrizione
activity	KnowledgeBaseActivityRecord[]: KnowledgeBaseAgenticReasoningActivityRecord[] KnowledgeBaseAzureBlobActivityRecord[] KnowledgeBaseFabricDataAgentActivityRecord[] KnowledgeBaseFabricOntologyActivityRecord[] KnowledgeBaseFileActivityRecord[] KnowledgeBaseIndexedOneLakeActivityRecord[] KnowledgeBaseIndexedSharePointActivityRecord[] KnowledgeBaseIndexedSqlActivityRecord[] KnowledgeBaseMcpServerActivityRecord[] KnowledgeBaseModelAnswerSynthesisActivityRecord[] KnowledgeBaseModelQueryPlanningActivityRecord[] KnowledgeBaseModelWebSummarizationActivityRecord[] KnowledgeBaseRemoteSharePointActivityRecord[] KnowledgeBaseSearchIndexActivityRecord[] KnowledgeBaseWebActivityRecord[] KnowledgeBaseWorkIQActivityRecord[]	I record di attività per tenere traccia dello stato di avanzamento e delle implicazioni di fatturazione.
references	KnowledgeBaseReference[]: KnowledgeBaseAzureBlobReference[] KnowledgeBaseFabricDataAgentReference[] KnowledgeBaseFabricOntologyReference[] KnowledgeBaseFileReference[] KnowledgeBaseIndexedOneLakeReference[] KnowledgeBaseIndexedSharePointReference[] KnowledgeBaseIndexedSqlReference[] KnowledgeBaseMcpServerReference[] KnowledgeBaseRemoteSharePointReference[] KnowledgeBaseSearchIndexReference[] KnowledgeBaseWebReference[] KnowledgeBaseWorkIQReference[]	I riferimenti per i dati di recupero utilizzati nella risposta.
response	KnowledgeBaseMessage[]	I messaggi di risposta.
responseSensitivityLabelInfo	PurviewSensitivityLabelInfo	Le informazioni sull'etichetta di sensibilità per la risposta complessiva.

KnowledgeBaseSearchIndexActivityArguments

Oggetto

Rappresenta gli argomenti con cui è stata eseguita l'attività di recupero dell'indice di ricerca.

Nome	Tipo	Descrizione
filter	string	Stringa di filtro.
queryType	QueryType	La sintassi della query utilizzata per eseguire la ricerca. I suggerimenti di query possono far sì che le query semantiche utilizzino la sintassi completa delle query.
search	string	Stringa di ricerca utilizzata per eseguire una query sull'indice di ricerca.
searchFields	SearchIndexFieldReference[]	Quali campi sono stati cercati.
semanticConfigurationName	string	Quale configurazione semantica è stata utilizzata dall'indice di ricerca.
sourceDataFields	SearchIndexFieldReference[]	Quali campi sono stati selezionati per la ricerca.

KnowledgeBaseSearchIndexActivityRecord

Oggetto

Rappresenta un record dell'attività di recupero dell'indice di ricerca.

Nome	Tipo	Descrizione
completedAt	string (date-time)	Il momento in cui l'attività si è conclusa.
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	KnowledgeBaseErrorDetail	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	ImageServingStatistics	Statistiche sul servizio di immagini per questa attività di recupero
knowledgeSourceName	string	La fonte di conoscenza per l'attività di recupero.
queryHintProcessing	KnowledgeBaseQueryHintProcessing	Dettagli sulle espressioni generate dai query hint per questa attività.
queryTime	string (date-time)	Tempo di query per l'attività di recupero.
searchIndexArguments	KnowledgeBaseSearchIndexActivityArguments	Gli argomenti dell'indice di ricerca per l'attività di recupero.
startedAt	string (date-time)	L'orario in cui è iniziata l'attività.
type	string: searchIndex	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

Oggetto

Rappresenta un riferimento al documento di Ricerca di Azure.

Nome	Tipo	Descrizione
activitySource	integer (int32)	ID attività di origine per il riferimento.
citationUrl	string (uri)	Un URL di proprietà di Search che punta al documento di supporto di questo riferimento, utilizzabile come target di citazione.
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	PurviewSensitivityLabelInfo	Le informazioni sull'etichetta di sensibilità per il riferimento.
sourceData		I dati sorgente per il riferimento.
type	string: searchIndex	Tipo di riferimento.

KnowledgeBaseWebActivityArguments

Oggetto

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

Oggetto

Rappresenta un record di attività di recupero web.

Nome	Tipo	Descrizione
completedAt	string (date-time)	Il momento in cui l'attività si è conclusa.
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	KnowledgeBaseErrorDetail	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	ImageServingStatistics	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.
startedAt	string (date-time)	L'orario in cui è iniziata l'attività.
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	KnowledgeBaseWebActivityArguments	Gli argomenti web a favore dell'attività di recupero.

KnowledgeBaseWebReference

Oggetto

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

Oggetto

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

Oggetto

Rappresenta un record di attività di recupero WorkIQ.

Nome	Tipo	Descrizione
completedAt	string (date-time)	Il momento in cui l'attività si è conclusa.
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	KnowledgeBaseErrorDetail	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	ImageServingStatistics	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.
startedAt	string (date-time)	L'orario in cui è iniziata l'attività.
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	KnowledgeBaseWorkIQActivityArguments	Gli argomenti WorkIQ a favore dell'attività di recupero.

KnowledgeBaseWorkIQReference

Oggetto

Rappresenta un riferimento a un documento WorkIQ.

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	PurviewSensitivityLabelInfo	Le informazioni sull'etichetta di sensibilità per il riferimento.
sourceData		I dati sorgente per il riferimento.
type	string: workIQ	Tipo di riferimento.

KnowledgeRetrievalAutoReasoningEffort

Oggetto

Seleziona automaticamente lo sforzo di ragionamento durante il recupero. Il servizio semina ogni richiesta al livello più basso e si estende solo fino al livello massimo disponibile del servizio.

Nome	Tipo	Descrizione
kind	string: auto	Il tipo di sforzo di ragionamento.

KnowledgeRetrievalIntentType

Enumerazione

Tipo di configurazione della Knowledge Base da utilizzare.

Valore	Descrizione
semantic	Finalità di query semantica in linguaggio naturale.

KnowledgeRetrievalLowReasoningEffort

Oggetto

Esegui il recupero delle conoscenze con un basso sforzo di ragionamento.

Nome	Tipo	Descrizione
kind	string: low	Il tipo di sforzo di ragionamento.

KnowledgeRetrievalMediumReasoningEffort

Oggetto

Esegui il recupero delle conoscenze con uno sforzo di ragionamento medio.

Nome	Tipo	Descrizione
kind	string: medium	Il tipo di sforzo di ragionamento.

KnowledgeRetrievalMinimalReasoningEffort

Oggetto

Esegui il recupero delle conoscenze con il minimo sforzo di ragionamento.

Nome	Tipo	Descrizione
kind	string: minimal	Il tipo di sforzo di ragionamento.

KnowledgeRetrievalOutputMode

Enumerazione

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

Enumerazione

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.
auto	Seleziona automaticamente lo sforzo di ragionamento durante il recupero, aumentando dal livello più economico solo fino a dove serve.

KnowledgeRetrievalSemanticIntent

Oggetto

Un'intenzione di interrogazione semantica.

Nome	Tipo	Descrizione
search	string	La query semantica da eseguire
type	string: semantic	Tipo di finalità.

KnowledgeSourceKind

Enumerazione

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.

KnowledgeSourceResultsProcessing

Enumerazione

Controlla se i risultati di una fonte di conoscenza vengono riclassificati.

Valore	Descrizione
rerank	I risultati di questa fonte di conoscenza passano attraverso la pipeline di riclassificazione. Questo è il comportamento predefinito.
none	I risultati di questa fonte di conoscenza bypassano il riordinamento e preservano il loro ordine sottostante.

McpServerKnowledgeSourceParams

Oggetto

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: mcpServer	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.
neverQuerySource	boolean	Indica che questa fonte di conoscenza dovrebbe essere esclusa dal set di candidati della richiesta e mai interrogata al momento del recupero. L'esclusione è request-local e non modifica l'appartenenza alla knowledge base. Non può essere combinato con alwaysQuerySource sulla stessa fonte di conoscenza.
rerankerThreshold	number (float)	La soglia di reranker che tutti i documenti recuperati devono soddisfare per essere inclusi nella risposta.
resultsProcessing	KnowledgeSourceResultsProcessing	Sovrascrive i risultati archiviati dalla fonte di conoscenza solo per questa chiamata di recupero. Quando viene omesso, si applica il valore della sorgente di conoscenza memorizzata.

PurviewSensitivityLabelInfo

Oggetto

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.

QueryType

Enumerazione

Specifica la sintassi della query di ricerca. Il valore predefinito è 'simple'. Utilizzare 'full' se la query utilizza la sintassi della query Lucene e 'semantic' se la sintassi della query non è necessaria.

Valore	Descrizione
simple	Utilizza la sintassi di query semplice per le ricerche. Il testo di ricerca viene interpretato utilizzando un semplice linguaggio di query che consente l'uso di simboli come +, * e "". Per impostazione predefinita, le query vengono valutate in tutti i campi in cui è possibile eseguire la ricerca, a meno che non venga specificato il parametro searchFields.
full	Utilizza la sintassi di query Lucene completa per le ricerche. Il testo di ricerca viene interpretato utilizzando il linguaggio di query Lucene, che consente ricerche specifiche per campo e ponderate, oltre ad altre funzionalità avanzate.
semantic	Ideale per query espresse in linguaggio naturale anziché con parole chiave. Migliora la precisione dei risultati di ricerca riclassificando i primi risultati di ricerca utilizzando un modello di classificazione addestrato sul corpus Web.

RemoteSharePointKnowledgeSourceParams

Oggetto

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: remoteSharePoint	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.
neverQuerySource	boolean	Indica che questa fonte di conoscenza dovrebbe essere esclusa dal set di candidati della richiesta e mai interrogata al momento del recupero. L'esclusione è request-local e non modifica l'appartenenza alla knowledge base. Non può essere combinato con alwaysQuerySource sulla stessa fonte di conoscenza.
rerankerThreshold	number (float)	La soglia di reranker che tutti i documenti recuperati devono soddisfare per essere inclusi nella risposta.
resultsProcessing	KnowledgeSourceResultsProcessing	Sovrascrive i risultati archiviati dalla fonte di conoscenza solo per questa chiamata di recupero. Quando viene omesso, si applica il valore della sorgente di conoscenza memorizzata.

SearchIndexFieldReference

Oggetto

Riferimento di campo per un indice di ricerca.

Nome	Tipo	Descrizione
name	string	Nome del campo.

SearchIndexKnowledgeSourceBoostKind

Enumerazione

Il tipo di suggerimento per un incarico di ricerca e una fonte di conoscenza dell'indice di ricerca.

Valore	Descrizione
fieldValue	Potenzia i documenti basandosi sul valore di un campo.
multiWordExpression	Potenzia i documenti basandosi su un'espressione di più parole.

SearchIndexKnowledgeSourceFieldValueBoost

Oggetto

Un suggerimento che potenzia i documenti in base al valore di un campo.

Nome	Tipo	Descrizione
boost	number (double)	Un moltiplicatore per il punteggio del documento. Deve essere un numero positivo diverso da 1,0.
boostInstructions	string	Istruzioni in linguaggio naturale che spiegano quando e come applicare il boost.
field	string minLength: 1	Il nome del campo indice di ricerca.
fieldValues	string[]	Valori rappresentativi per il campo.
kind	string: fieldValue	Quel tipo di suggerimento di potenziamento.

SearchIndexKnowledgeSourceFilterHint

Oggetto

Un suggerimento che identifica un campo e valori rappresentativi che il query planner può usare per costruire un filtro.

Nome	Tipo	Descrizione
field	string minLength: 1	Il nome del campo indice di ricerca filtrabile.
fieldValues	string[]	Valori rappresentativi per il campo.
filterInstructions	string	Istruzioni in linguaggio naturale che spiegano quando e come filtrare sul campo.

SearchIndexKnowledgeSourceMultiWordExpressionBoost

Oggetto

Un suggerimento che migliora i documenti basandosi su un'espressione di più parole.

Nome	Tipo	Descrizione
boost	number (double)	Un moltiplicatore per il punteggio del documento. Deve essere un numero positivo diverso da 1,0.
boostInstructions	string	Istruzioni in linguaggio naturale che spiegano quando e come applicare il boost.
fieldValues	string[]	Valori rappresentativi per il potenziamento.
kind	string: multiWordExpression	Quel tipo di suggerimento di potenziamento.

SearchIndexKnowledgeSourceParams

Oggetto

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: searchIndex	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.
neverQuerySource	boolean	Indica che questa fonte di conoscenza dovrebbe essere esclusa dal set di candidati della richiesta e mai interrogata al momento del recupero. L'esclusione è request-local e non modifica l'appartenenza alla knowledge base. Non può essere combinato con alwaysQuerySource sulla stessa fonte di conoscenza.
queryHintOverrides	SearchIndexKnowledgeSourceQueryHints	Suggerimenti che guidano la pianificazione delle query verso filtri e potenziamenti utili. Se specificato, questo oggetto sostituisce l'intero insieme di suggerimenti di query configurati sulla sorgente di conoscenza.
rerankerThreshold	number (float)	La soglia di reranker che tutti i documenti recuperati devono soddisfare per essere inclusi nella risposta.
resultsProcessing	KnowledgeSourceResultsProcessing	Sovrascrive i risultati archiviati dalla fonte di conoscenza solo per questa chiamata di recupero. Quando viene omesso, si applica il valore della sorgente di conoscenza memorizzata.

SearchIndexKnowledgeSourceQueryHints

Oggetto

Suggerimenti che guidano la pianificazione delle query verso filtri utili e potenziamenti per una fonte di conoscenza dell'indice di ricerca.

Nome	Tipo	Descrizione
boosts	SearchIndexKnowledgeSourceBoost[]: SearchIndexKnowledgeSourceFieldValueBoost[] SearchIndexKnowledgeSourceMultiWordExpressionBoost[]	Potenzia i suggerimenti che identificano condizioni che il query planner può utilizzare per influenzare la classificazione dei documenti.
filters	SearchIndexKnowledgeSourceFilterHint[]	Suggerimenti di filtro che identificano campi e valori rappresentativi che il query planner può usare per costruire filtri.

ServedImage

Oggetto

Descrive una singola immagine che il modello ha selezionato per essere servita durante un'attività di recupero.

Nome	Tipo	Descrizione
imageId	string	L'etichetta dell'immagine estratta dal documento sorgente tramite Content Understanding enrichment. Corrisponde alla numerazione delle cifre nel documento originale.
imagePath	string	Il percorso relativo all'immagine all'interno dello asset store.
sizeBytes	integer (int64)	La dimensione in byte di questa immagine inviata al modello.

WebKnowledgeSourceParams

Oggetto

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.
neverQuerySource	boolean	Indica che questa fonte di conoscenza dovrebbe essere esclusa dal set di candidati della richiesta e mai interrogata al momento del recupero. L'esclusione è request-local e non modifica l'appartenenza alla knowledge base. Non può essere combinato con alwaysQuerySource sulla stessa fonte di conoscenza.
rerankerThreshold	number (float)	La soglia di reranker che tutti i documenti recuperati devono soddisfare per essere inclusi nella risposta.
resultsProcessing	KnowledgeSourceResultsProcessing	Sovrascrive i risultati archiviati dalla fonte di conoscenza solo per questa chiamata di recupero. Quando viene omesso, si applica il valore della sorgente di conoscenza memorizzata.

WorkIQKnowledgeSourceParams

Oggetto

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.
neverQuerySource	boolean	Indica che questa fonte di conoscenza dovrebbe essere esclusa dal set di candidati della richiesta e mai interrogata al momento del recupero. L'esclusione è request-local e non modifica l'appartenenza alla knowledge base. Non può essere combinato con alwaysQuerySource sulla stessa fonte di conoscenza.
rerankerThreshold	number (float)	La soglia di reranker che tutti i documenti recuperati devono soddisfare per essere inclusi nella risposta.
resultsProcessing	KnowledgeSourceResultsProcessing	Sovrascrive i risultati archiviati dalla fonte di conoscenza solo per questa chiamata di recupero. Quando viene omesso, si applica il valore della sorgente di conoscenza memorizzata.