Knowledge Retrieval - Retrieve

Servizio:
Search Service
Versione API:
2026-04-01

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

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

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 Necessario Tipo Descrizione
Accept

Accept

L'intestazione Accetta.
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[]:

Elenco di parametri di runtime per le fonti di conoscenza.
maxOutputSizeInTokens

integer (int32)

Limita la dimensione massima del contenuto nell'output.
maxRuntimeInSeconds

integer (int32)

L'autonomia massima in secondi.

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
KnowledgeBaseRetrieveWithIntents

KnowledgeBaseRetrieve

Esempio di richiesta

POST https://exampleservice.search.windows.net/knowledgebases('base-example-index')/retrieve?api-version=2026-04-01


{
  "maxRuntimeInSeconds": 60,
  "maxOutputSizeInTokens": 100000,
  "includeActivity": true,
  "knowledgeSourceParams": [
    {
      "filterAddOn": "foo eq bar",
      "knowledgeSourceName": "ks-example-index",
      "includeReferences": true,
      "includeReferenceSourceData": true,
      "rerankerThreshold": 2.1,
      "kind": "searchIndex"
    }
  ]
}

Risposta di esempio

Codice di stato:
200 
{
  "response": [
    {
      "content": [
        {
          "type": "text",
          "text": "[{...}]"
        }
      ]
    }
  ],
  "activity": [
    {
      "type": "modelQueryPlanning",
      "id": 0,
      "inputTokens": 11,
      "outputTokens": 22,
      "elapsedMs": 10
    },
    {
      "type": "searchIndex",
      "id": 1,
      "knowledgeSourceName": "ks-example-index",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 2,
      "elapsedMs": 1234,
      "searchIndexArguments": {
        "search": "hello world",
        "filter": "foo eq bar",
        "sourceDataFields": [
          {
            "name": "category"
          },
          {
            "name": "description"
          },
          {
            "name": "ownerId"
          },
          {
            "name": "id"
          }
        ],
        "searchFields": [],
        "semanticConfigurationName": "testconfig"
      }
    },
    {
      "type": "searchIndex",
      "id": 2,
      "knowledgeSourceName": "ks-example-index",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 2,
      "elapsedMs": 1234,
      "searchIndexArguments": {
        "search": "hello world two",
        "filter": "foo eq bar",
        "sourceDataFields": [
          {
            "name": "category"
          },
          {
            "name": "description"
          },
          {
            "name": "ownerId"
          },
          {
            "name": "id"
          }
        ],
        "searchFields": [],
        "semanticConfigurationName": "testconfig"
      }
    },
    {
      "type": "agenticReasoning",
      "id": 3,
      "reasoningTokens": 74
    },
    {
      "type": "modelAnswerSynthesis",
      "id": 4,
      "inputTokens": 664,
      "outputTokens": 1328,
      "elapsedMs": 10
    }
  ],
  "references": [
    {
      "type": "searchIndex",
      "id": "83dd7d40",
      "activitySource": 1,
      "sourceData": {
        "id": "myDocKey1",
        "title": "high_doc",
        "content": "hello world"
      },
      "rerankerScore": 3.5,
      "docKey": "myDocKey1"
    },
    {
      "type": "searchIndex",
      "id": "83dd7d41",
      "activitySource": 1,
      "sourceData": {
        "id": "myDocKey2",
        "title": "low_doc",
        "content": "goodbye world"
      },
      "rerankerScore": 2.7,
      "docKey": "myDocKey2"
    }
  ]
}
Codice di stato:
206 
{
  "response": [
    {
      "content": [
        {
          "type": "text",
          "text": "[{...}]"
        }
      ]
    }
  ],
  "activity": [
    {
      "type": "modelQueryPlanning",
      "id": 0,
      "inputTokens": 11,
      "outputTokens": 22,
      "elapsedMs": 10
    },
    {
      "type": "searchIndex",
      "id": 1,
      "knowledgeSourceName": "ks-example-index",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 2,
      "elapsedMs": 1234,
      "searchIndexArguments": {
        "search": "hello world",
        "filter": "foo eq bar",
        "sourceDataFields": [
          {
            "name": "category"
          },
          {
            "name": "description"
          },
          {
            "name": "ownerId"
          },
          {
            "name": "id"
          }
        ],
        "searchFields": [],
        "semanticConfigurationName": "testconfig"
      }
    },
    {
      "type": "web",
      "id": 2,
      "knowledgeSourceName": "ks-preview-web",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 10,
      "elapsedMs": 2345,
      "error": {
        "code": "403",
        "message": "The error message",
        "details": [],
        "additionalInfo": [
          {
            "type": "SomeErrorType",
            "info": {
              "someProperty": "Some value"
            }
          }
        ]
      }
    },
    {
      "type": "agenticReasoning",
      "id": 3,
      "reasoningTokens": 74
    },
    {
      "type": "modelAnswerSynthesis",
      "id": 4,
      "inputTokens": 664,
      "outputTokens": 1328,
      "elapsedMs": 10
    }
  ],
  "references": [
    {
      "type": "searchIndex",
      "id": "83dd7d40",
      "activitySource": 1,
      "sourceData": {
        "id": "myDocKey1",
        "title": "high_doc",
        "content": "hello world"
      },
      "rerankerScore": 3.5,
      "docKey": "myDocKey1"
    },
    {
      "type": "searchIndex",
      "id": "83dd7d41",
      "activitySource": 1,
      "sourceData": {
        "id": "myDocKey2",
        "title": "low_doc",
        "content": "goodbye world"
      },
      "rerankerScore": 2.7,
      "docKey": "myDocKey2"
    }
  ]
}

KnowledgeBaseRetrieveWithIntents

Esempio di richiesta

POST https://exampleservice.search.windows.net/knowledgebases('base-example-index')/retrieve?api-version=2026-04-01


{
  "intents": [
    {
      "search": "foo",
      "type": "semantic"
    }
  ],
  "maxRuntimeInSeconds": 60,
  "maxOutputSizeInTokens": 100000,
  "includeActivity": true,
  "knowledgeSourceParams": [
    {
      "filterAddOn": "foo eq bar",
      "knowledgeSourceName": "ks-example-index",
      "includeReferences": true,
      "includeReferenceSourceData": true,
      "rerankerThreshold": 2.1,
      "kind": "searchIndex"
    }
  ]
}

Risposta di esempio

Codice di stato:
200 
{
  "response": [
    {
      "content": [
        {
          "type": "text",
          "text": "[{...}]"
        }
      ]
    }
  ],
  "activity": [
    {
      "type": "searchIndex",
      "id": 0,
      "knowledgeSourceName": "ks-example-index",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 2,
      "elapsedMs": 1234,
      "searchIndexArguments": {
        "search": "foo",
        "filter": "foo eq bar",
        "sourceDataFields": [
          {
            "name": "category"
          },
          {
            "name": "description"
          },
          {
            "name": "ownerId"
          },
          {
            "name": "id"
          }
        ],
        "searchFields": [],
        "semanticConfigurationName": "testconfig"
      }
    },
    {
      "type": "agenticReasoning",
      "id": 1,
      "reasoningTokens": 37
    }
  ],
  "references": [
    {
      "type": "searchIndex",
      "id": "83dd7d40",
      "activitySource": 0,
      "sourceData": {
        "id": "myDocKey1",
        "title": "high_doc",
        "content": "hello world"
      },
      "rerankerScore": 3.5,
      "docKey": "myDocKey1"
    },
    {
      "type": "searchIndex",
      "id": "83dd7d41",
      "activitySource": 0,
      "sourceData": {
        "id": "myDocKey2",
        "title": "low_doc",
        "content": "goodbye world"
      },
      "rerankerScore": 2.7,
      "docKey": "myDocKey2"
    }
  ]
}
Codice di stato:
206 
{
  "response": [
    {
      "content": [
        {
          "type": "text",
          "text": "[{...}]"
        }
      ]
    }
  ],
  "activity": [
    {
      "type": "searchIndex",
      "id": 0,
      "knowledgeSourceName": "ks-example-index",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 2,
      "elapsedMs": 1234,
      "searchIndexArguments": {
        "search": "foo",
        "filter": "foo eq bar",
        "sourceDataFields": [
          {
            "name": "category"
          },
          {
            "name": "description"
          },
          {
            "name": "ownerId"
          },
          {
            "name": "id"
          }
        ],
        "searchFields": [],
        "semanticConfigurationName": "testconfig"
      }
    },
    {
      "type": "web",
      "id": 1,
      "knowledgeSourceName": "ks-preview-web",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 10,
      "elapsedMs": 2345,
      "error": {
        "code": "403",
        "message": "The error message",
        "details": [],
        "additionalInfo": [
          {
            "type": "SomeErrorType",
            "info": {
              "someProperty": "Some value"
            }
          }
        ]
      }
    },
    {
      "type": "agenticReasoning",
      "id": 2,
      "reasoningTokens": 37
    }
  ],
  "references": [
    {
      "type": "searchIndex",
      "id": "83dd7d40",
      "activitySource": 0,
      "sourceData": {
        "id": "myDocKey1",
        "title": "high_doc",
        "content": "hello world"
      },
      "rerankerScore": 3.5,
      "docKey": "myDocKey1"
    },
    {
      "type": "searchIndex",
      "id": "83dd7d41",
      "activitySource": 0,
      "sourceData": {
        "id": "myDocKey2",
        "title": "low_doc",
        "content": "goodbye world"
      },
      "rerankerScore": 2.7,
      "docKey": "myDocKey2"
    }
  ]
}

Definizioni

Nome Descrizione
Accept

L'intestazione Accetta.
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.
IndexedOneLakeKnowledgeSourceParams

Specifica i parametri di runtime per un'origine della conoscenza OneLake indicizzata
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.
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.
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.
KnowledgeBaseModelWebSummarizationActivityRecord

Rappresenta un record di attività di riassunto web LLM.
KnowledgeBaseReferenceType

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

Tipo di configurazione della Knowledge Base da utilizzare.
KnowledgeRetrievalMinimalReasoningEffort

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

Quantità di sforzo da utilizzare durante il recupero.
KnowledgeRetrievalSemanticIntent

Un'intenzione di interrogazione semantica.
KnowledgeSourceKind

Il tipo di fonte di conoscenza.
SearchIndexFieldReference

Riferimento di campo per un indice di ricerca.
SearchIndexKnowledgeSourceParams

Specifica i parametri di runtime per un'origine conoscenza dell'indice di ricerca
WebKnowledgeSourceParams

Specifica i parametri di runtime per un'origine della conoscenza Web

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
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.
rerankerThreshold

number (float)

La soglia di reranker che tutti i documenti recuperati devono soddisfare per essere inclusi nella risposta.

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

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.

IndexedOneLakeKnowledgeSourceParams

Oggetto

Specifica i parametri di runtime per un'origine della conoscenza OneLake indicizzata

Nome Tipo Descrizione
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.
rerankerThreshold

number (float)

La soglia di reranker che tutti i documenti recuperati devono soddisfare per essere inclusi nella risposta.

KnowledgeBaseActivityRecordType

Enumerazione

Il tipo di record di attività.

Valore Descrizione
searchIndex

Attività di ricerca nell'indice di ricerca.
azureBlob

Attività di recupero Azure Blob.
indexedOneLake

Attività di recupero indicizzata di OneLake.
web

Attività di recupero web.
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
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à.
reasoningTokens

integer (int32)

Numero di token di input per il ragionamento agentico.
retrievalReasoningEffort KnowledgeRetrievalReasoningEffort:

KnowledgeRetrievalMinimalReasoningEffort

La configurazione dello sforzo di ragionamento per il recupero.
type string:

agenticReasoning

Tipo di record dell'attività.

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.
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à.
knowledgeSourceName

string

La fonte di conoscenza per l'attività di recupero.
queryTime

string (date-time)

Tempo di query per l'attività di recupero.
type string:

azureBlob

Tipo di record dell'attività.

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.
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:

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

Destinazione dell'errore.

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
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à.
indexedOneLakeArguments

KnowledgeBaseIndexedOneLakeActivityArguments

Gli argomenti indicizzati di OneLake per l'attività di recupero.
knowledgeSourceName

string

La fonte di conoscenza per l'attività di recupero.
queryTime

string (date-time)

Tempo di query per l'attività di recupero.
type string:

indexedOneLake

Tipo di record dell'attività.

KnowledgeBaseIndexedOneLakeReference

Oggetto

Rappresenta un riferimento indicizzato a un documento OneLake.

Nome Tipo Descrizione
activitySource

integer (int32)

ID attività di origine per il riferimento.
docUrl

string

URL del documento per il riferimento.
id

string

L'ID del riferimento.
rerankerScore

number (float)

Punteggio del reranker per il riferimento al documento.
sourceData

I dati sorgente per il riferimento.
type string:

indexedOneLake

Tipo di riferimento.

KnowledgeBaseMessage

Oggetto

L'oggetto stile del messaggio in linguaggio naturale.

Nome Tipo Descrizione
content KnowledgeBaseMessageContent[]:

Il contenuto del messaggio.
role

string

Il ruolo della risposta dello strumento.

KnowledgeBaseMessageContentType

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

Il tipo di messaggio

KnowledgeBaseMessageTextContent

Oggetto

Tipo di messaggio di testo.

Nome Tipo Descrizione
text

string

Contenuto di testo.
type string:

text

Il tipo di messaggio

KnowledgeBaseModelWebSummarizationActivityRecord

Oggetto

Rappresenta un record di attività di riassunto web LLM.

Nome Tipo Descrizione
elapsedMs

integer (int32)

Il tempo trascorso in millisecondi per l'attività di recupero.
error

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.
outputTokens

integer (int32)

Il numero di token di output per l'attività di riassunto web LLM.
type string:

modelWebSummarization

Tipo di record dell'attività.

KnowledgeBaseReferenceType

Enumerazione

Tipo di riferimento.

Valore Descrizione
searchIndex

Cerca, indice, riferimento documento.
azureBlob

Riferimento documento Azure Blob.
indexedOneLake

Riferimento indicizzato a un documento OneLake.
web

Riferimento a documenti web.

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[]:

Elenco di parametri di runtime per le fonti di conoscenza.
maxOutputSizeInTokens

integer (int32)

Limita la dimensione massima del contenuto nell'output.
maxRuntimeInSeconds

integer (int32)

L'autonomia massima in secondi.

KnowledgeBaseRetrievalResponse

Oggetto

Contratto di output per la risposta di recupero.

Nome Tipo Descrizione
activity KnowledgeBaseActivityRecord[]:

I record di attività per tenere traccia dello stato di avanzamento e delle implicazioni di fatturazione.
references KnowledgeBaseReference[]:

I riferimenti per i dati di recupero utilizzati nella risposta.
response

KnowledgeBaseMessage[]

I messaggi di risposta.

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.
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
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à.
knowledgeSourceName

string

La fonte di conoscenza per l'attività di recupero.
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.
type string:

searchIndex

Tipo di record dell'attività.

KnowledgeBaseSearchIndexReference

Oggetto

Rappresenta un riferimento al documento di Ricerca di Azure.

Nome Tipo Descrizione
activitySource

integer (int32)

ID attività di origine per il riferimento.
docKey

string

La chiave del documento per il riferimento.
id

string

L'ID del riferimento.
rerankerScore

number (float)

Punteggio del reranker per il riferimento al documento.
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
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à.
knowledgeSourceName

string

La fonte di conoscenza per l'attività di recupero.
queryTime

string (date-time)

Tempo di query per l'attività di recupero.
type string:

web

Tipo di record dell'attività.
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.

KnowledgeRetrievalIntentType

Enumerazione

Tipo di configurazione della Knowledge Base da utilizzare.

Valore Descrizione
semantic

Finalità di query semantica in linguaggio naturale.

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.

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.

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.
indexedOneLake

Una fonte di conoscenza che legge dati da OneLake indicizzato.
web

Una fonte di conoscenza che legge dati dal web.

SearchIndexFieldReference

Oggetto

Riferimento di campo per un indice di ricerca.

Nome Tipo Descrizione
name

string

Nome del campo.

SearchIndexKnowledgeSourceParams

Oggetto

Specifica i parametri di runtime per un'origine conoscenza dell'indice di ricerca

Nome Tipo Descrizione
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.
rerankerThreshold

number (float)

La soglia di reranker che tutti i documenti recuperati devono soddisfare per essere inclusi nella risposta.

WebKnowledgeSourceParams

Oggetto

Specifica i parametri di runtime per un'origine della conoscenza Web

Nome Tipo Descrizione
count

integer (int32)

Il numero di risultati Web da restituire.
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.
rerankerThreshold

number (float)

La soglia di reranker che tutti i documenti recuperati devono soddisfare per essere inclusi nella risposta.