Knowledge Retrieval - Retrieve

Service:: Search Service

Version d'API:: 2026-04-01

La base de connaissances récupère les données pertinentes à partir des magasins de sauvegarde.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
endpoint	path	True	string (uri)	URL du point de terminaison du service de recherche.
knowledgeBaseName	path	True	string	Nom de la base de connaissances.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.

En-tête de la demande

Nom	Obligatoire	Type	Description
Accept		Accept	L’en-tête Accept.
x-ms-client-request-id		string (uuid)	Identificateur de chaîne opaque, globalement unique et généré par le client pour la requête.

Corps de la demande

Nom	Type	Description
includeActivity	boolean	Indique que les résultats de la récupération doivent inclure des informations sur l’activité.
intents	KnowledgeRetrievalIntent[]: KnowledgeRetrievalSemanticIntent[]	Liste des requêtes prévues à exécuter sans planification de requête de modèle.
knowledgeSourceParams	KnowledgeSourceParams[]: AzureBlobKnowledgeSourceParams[] IndexedOneLakeKnowledgeSourceParams[] SearchIndexKnowledgeSourceParams[] WebKnowledgeSourceParams[]	Liste des paramètres d’exécution des sources de connaissances.
maxOutputSizeInTokens	integer (int32)	Limite la taille maximale du contenu dans la sortie.
maxRuntimeInSeconds	integer (int32)	Durée d’exécution maximale en secondes.

Réponses

Nom	Type	Description
200 OK	KnowledgeBaseRetrievalResponse	Réponse de prélèvement réussie.
Other Status Codes	KnowledgeBaseRetrievalResponse	Réponse de récupération partielle.
Other Status Codes	ErrorResponse	Réponse d’erreur inattendue.

Sécurité

api-key

Type: apiKey
Dans: header

OAuth2Auth

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Étendues

Nom	Description
https://search.azure.com/.default

Exemples

KnowledgeBaseRetrieve

KnowledgeBaseRetrieveWithIntents

KnowledgeBaseRetrieve

Exemple de requête

HTTP

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"
    }
  ]
}

Exemple de réponse

Code d’état:: 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"
    }
  ]
}

Code d’état:: 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

Exemple de requête

HTTP

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"
    }
  ]
}

Exemple de réponse

Code d’état:: 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"
    }
  ]
}

Code d’état:: 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"
    }
  ]
}

Définitions

Nom	Description
Accept	L’en-tête Accept.
AzureBlobKnowledgeSourceParams	Spécifie les paramètres d’exécution d’une source de connaissances d’objet blob azure
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse à l’erreur courante pour toutes les API Azure Resource Manager afin de renvoyer les détails d’erreur pour les opérations ratées. (Cela suit également le format de réponse d’erreur OData.).
IndexedOneLakeKnowledgeSourceParams	Spécifie les paramètres d’exécution d’une source de connaissances OneLake indexée
KnowledgeBaseActivityRecordType	Le type de dossier d’activité.
KnowledgeBaseAgenticReasoningActivityRecord	Représente un enregistrement d’activité de raisonnement agentique.
KnowledgeBaseAzureBlobActivityArguments	Représente les arguments avec lesquels l’activité d’extraction d’objets blob Azure a été exécutée.
KnowledgeBaseAzureBlobActivityRecord	Représente un enregistrement d’activité d’extraction d’objets blob Azure.
KnowledgeBaseAzureBlobReference	Représente une référence de document de référence sur le stockage Blob Azure.
KnowledgeBaseErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
KnowledgeBaseErrorDetail	Détails de l’erreur.
KnowledgeBaseImageContent	Contenu d’images.
KnowledgeBaseIndexedOneLakeActivityArguments	Représente les arguments avec lesquels l’activité de récupération indexée de OneLake a été menée.
KnowledgeBaseIndexedOneLakeActivityRecord	Représente un enregistrement indexé d’activité de récupération OneLake.
KnowledgeBaseIndexedOneLakeReference	Représente une référence indexée de document OneLake.
KnowledgeBaseMessage	Objet de style de message en langage naturel.
KnowledgeBaseMessageContentType	Le type de contenu du message.
KnowledgeBaseMessageImageContent	Type de message d’image.
KnowledgeBaseMessageTextContent	Type de SMS.
KnowledgeBaseModelWebSummarizationActivityRecord	Représente un enregistrement d’activité de synthèse web de LLM.
KnowledgeBaseReferenceType	Type de référence.
KnowledgeBaseRetrievalRequest	Contrat d’entrée pour la demande d’extraction.
KnowledgeBaseRetrievalResponse	Contrat de sortie pour la réponse d’extraction.
KnowledgeBaseSearchIndexActivityArguments	Représente les arguments avec lesquels l’activité d’extraction d’index de recherche a été exécutée.
KnowledgeBaseSearchIndexActivityRecord	Représente un enregistrement d’activité d’extraction d’index de recherche.
KnowledgeBaseSearchIndexReference	Représente une référence de document Recherche Azure.
KnowledgeBaseWebActivityArguments	Représente les arguments avec lesquels l’activité de récupération web a été menée.
KnowledgeBaseWebActivityRecord	Représente un enregistrement d’activité de récupération web.
KnowledgeBaseWebReference	Représente une référence de document Web.
KnowledgeRetrievalIntentType	Le type de configuration de la base de connaissances à utiliser.
KnowledgeRetrievalMinimalReasoningEffort	Exécutez la récupération des connaissances avec un minimum d’effort de raisonnement.
KnowledgeRetrievalReasoningEffortKind	La quantité d’effort à fournir lors de la récupération.
KnowledgeRetrievalSemanticIntent	Une intention de requête sémantique.
KnowledgeSourceKind	Le type de source de connaissance.
SearchIndexFieldReference	Référence de champ pour un index de recherche.
SearchIndexKnowledgeSourceParams	Spécifie les paramètres d’exécution d’une source de connaissances d’index de recherche
WebKnowledgeSourceParams	Spécifie les paramètres d’exécution d’une source de connaissances Web

Accept

Énumération

L’en-tête Accept.

Valeur	Description
application/json;odata.metadata=minimal

AzureBlobKnowledgeSourceParams

Objet

Spécifie les paramètres d’exécution d’une source de connaissances d’objet blob azure

Nom	Type	Description
includeReferenceSourceData	boolean	Indique si les références doivent inclure les données structurées obtenues lors de l’extraction dans leur charge utile.
includeReferences	boolean	Indique si des références doivent être incluses pour les données extraites de cette source.
kind	string: azureBlob	Le type de source de connaissances.
knowledgeSourceName	string	Nom de l’index auquel les paramètres s’appliquent.
rerankerThreshold	number (float)	Le seuil de reclassement que tous les documents récupérés doivent atteindre pour être inclus dans la réponse.

ErrorAdditionalInfo

Objet

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info		Informations supplémentaires.
type	string	Type d’informations supplémentaire.

ErrorDetail

Objet

Détail de l’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d’erreur.
details	ErrorDetail[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

ErrorResponse

Objet

Réponse à l’erreur courante pour toutes les API Azure Resource Manager afin de renvoyer les détails d’erreur pour les opérations ratées. (Cela suit également le format de réponse d’erreur OData.).

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

IndexedOneLakeKnowledgeSourceParams

Objet

Spécifie les paramètres d’exécution d’une source de connaissances OneLake indexée

Nom	Type	Description
includeReferenceSourceData	boolean	Indique si les références doivent inclure les données structurées obtenues lors de l’extraction dans leur charge utile.
includeReferences	boolean	Indique si des références doivent être incluses pour les données extraites de cette source.
kind	string: indexedOneLake	Le type de source de connaissances.
knowledgeSourceName	string	Nom de l’index auquel les paramètres s’appliquent.
rerankerThreshold	number (float)	Le seuil de reclassement que tous les documents récupérés doivent atteindre pour être inclus dans la réponse.

KnowledgeBaseActivityRecordType

Énumération

Le type de dossier d’activité.

Valeur	Description
searchIndex	Activité de recherche dans l’index.
azureBlob	Activité de récupération Azure Blob.
indexedOneLake	Activité indexée de récupération OneLake.
web	Activité de recherche web.
modelWebSummarization	Activité de résumé web de LLM.
agenticReasoning	Activité de raisonnement agentique.

KnowledgeBaseAgenticReasoningActivityRecord

Objet

Représente un enregistrement d’activité de raisonnement agentique.

Nom	Type	Description
elapsedMs	integer (int32)	Temps écoulé en millisecondes pour l’activité d’extraction.
error	KnowledgeBaseErrorDetail	L’erreur détaille la raison de l’échec de l’opération. Cette propriété n’est incluse que lorsque l’activité ne réussit pas.
id	integer (int32)	ID de l’enregistrement d’activité.
reasoningTokens	integer (int32)	Nombre de jetons d’entrée pour le raisonnement agentique.
retrievalReasoningEffort	KnowledgeRetrievalReasoningEffort: KnowledgeRetrievalMinimalReasoningEffort	La configuration de l’effort de raisonnement de récupération.
type	string: agenticReasoning	Type d’enregistrement d’activité.

KnowledgeBaseAzureBlobActivityArguments

Objet

Représente les arguments avec lesquels l’activité d’extraction d’objets blob Azure a été exécutée.

Nom	Type	Description
search	string	Chaîne de recherche utilisée pour interroger le contenu d’un objet blob.

KnowledgeBaseAzureBlobActivityRecord

Objet

Représente un enregistrement d’activité d’extraction d’objets blob Azure.

Nom	Type	Description
azureBlobArguments	KnowledgeBaseAzureBlobActivityArguments	Les arguments blob Azure pour l’activité d’extraction.
count	integer (int32)	Le nombre de documents récupérés qui étaient suffisamment pertinents pour passer le seuil de reranker.
elapsedMs	integer (int32)	Temps écoulé en millisecondes pour l’activité d’extraction.
error	KnowledgeBaseErrorDetail	L’erreur détaille la raison de l’échec de l’opération. Cette propriété n’est incluse que lorsque l’activité ne réussit pas.
id	integer (int32)	ID de l’enregistrement d’activité.
knowledgeSourceName	string	Source de connaissances pour l’activité d’extraction.
queryTime	string (date-time)	Temps de requête pour cette activité d’extraction.
type	string: azureBlob	Type d’enregistrement d’activité.

KnowledgeBaseAzureBlobReference

Objet

Représente une référence de document de référence sur le stockage Blob Azure.

Nom	Type	Description
activitySource	integer (int32)	ID de l’activité source de la référence.
blobUrl	string	URL de l’objet blob de référence.
id	string	ID de la référence.
rerankerScore	number (float)	Le score du reranker pour la référence du document.
sourceData		Les données sources pour la référence.
type	string: azureBlob	Type de référence.

KnowledgeBaseErrorAdditionalInfo

Objet

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info		Informations supplémentaires.
type	string	Type d’informations supplémentaire.

KnowledgeBaseErrorDetail

Objet

Détails de l’erreur.

Nom	Type	Description
additionalInfo	KnowledgeBaseErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d’erreur.
details	KnowledgeBaseErrorDetail[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

KnowledgeBaseImageContent

Objet

Contenu d’images.

Nom	Type	Description
url	string (uri)	L’URL de l’image.

KnowledgeBaseIndexedOneLakeActivityArguments

Objet

Représente les arguments avec lesquels l’activité de récupération indexée de OneLake a été menée.

Nom	Type	Description
search	string	La chaîne de recherche utilisée pour interroger indexait le contenu OneLake.

KnowledgeBaseIndexedOneLakeActivityRecord

Objet

Représente un enregistrement indexé d’activité de récupération OneLake.

Nom	Type	Description
count	integer (int32)	Le nombre de documents récupérés qui étaient suffisamment pertinents pour passer le seuil de reranker.
elapsedMs	integer (int32)	Temps écoulé en millisecondes pour l’activité d’extraction.
error	KnowledgeBaseErrorDetail	L’erreur détaille la raison de l’échec de l’opération. Cette propriété n’est incluse que lorsque l’activité ne réussit pas.
id	integer (int32)	ID de l’enregistrement d’activité.
indexedOneLakeArguments	KnowledgeBaseIndexedOneLakeActivityArguments	Les arguments indexés de OneLake pour l’activité de récupération.
knowledgeSourceName	string	Source de connaissances pour l’activité d’extraction.
queryTime	string (date-time)	Temps de requête pour cette activité d’extraction.
type	string: indexedOneLake	Type d’enregistrement d’activité.

KnowledgeBaseIndexedOneLakeReference

Objet

Représente une référence indexée de document OneLake.

Nom	Type	Description
activitySource	integer (int32)	ID de l’activité source de la référence.
docUrl	string	URL du document de référence.
id	string	ID de la référence.
rerankerScore	number (float)	Le score du reranker pour la référence du document.
sourceData		Les données sources pour la référence.
type	string: indexedOneLake	Type de référence.

KnowledgeBaseMessage

Objet

Objet de style de message en langage naturel.

Nom	Type	Description
content	KnowledgeBaseMessageContent[]: KnowledgeBaseMessageImageContent[] KnowledgeBaseMessageTextContent[]	Contenu du message.
role	string	Le rôle de la réponse de l’outil.

KnowledgeBaseMessageContentType

Énumération

Le type de contenu du message.

Valeur	Description
text	Type de contenu de message texte.
image	Type de contenu de message d’image.

KnowledgeBaseMessageImageContent

Objet

Type de message d’image.

Nom	Type	Description
image	KnowledgeBaseImageContent	Le contenu de l’image.
type	string: image	Le type du message

KnowledgeBaseMessageTextContent

Objet

Type de SMS.

Nom	Type	Description
text	string	Contenu du texte.
type	string: text	Le type du message

KnowledgeBaseModelWebSummarizationActivityRecord

Objet

Représente un enregistrement d’activité de synthèse web de LLM.

Nom	Type	Description
elapsedMs	integer (int32)	Temps écoulé en millisecondes pour l’activité d’extraction.
error	KnowledgeBaseErrorDetail	L’erreur détaille la raison de l’échec de l’opération. Cette propriété n’est incluse que lorsque l’activité ne réussit pas.
id	integer (int32)	ID de l’enregistrement d’activité.
inputTokens	integer (int32)	Le nombre de jetons d’entrée pour l’activité de résumé web du LLM.
outputTokens	integer (int32)	Le nombre de jetons de sortie pour l’activité de résumé web des LLM.
type	string: modelWebSummarization	Type d’enregistrement d’activité.

KnowledgeBaseReferenceType

Énumération

Type de référence.

Valeur	Description
searchIndex	Recherchez l’index des références du document.
azureBlob	Référence de document Azure Blob.
indexedOneLake	Référence indexée du document OneLake.
web	Référence de document web.

KnowledgeBaseRetrievalRequest

Objet

Contrat d’entrée pour la demande d’extraction.

Nom	Type	Description
includeActivity	boolean	Indique que les résultats de la récupération doivent inclure des informations sur l’activité.
intents	KnowledgeRetrievalIntent[]: KnowledgeRetrievalSemanticIntent[]	Liste des requêtes prévues à exécuter sans planification de requête de modèle.
knowledgeSourceParams	KnowledgeSourceParams[]: AzureBlobKnowledgeSourceParams[] IndexedOneLakeKnowledgeSourceParams[] SearchIndexKnowledgeSourceParams[] WebKnowledgeSourceParams[]	Liste des paramètres d’exécution des sources de connaissances.
maxOutputSizeInTokens	integer (int32)	Limite la taille maximale du contenu dans la sortie.
maxRuntimeInSeconds	integer (int32)	Durée d’exécution maximale en secondes.

KnowledgeBaseRetrievalResponse

Objet

Contrat de sortie pour la réponse d’extraction.

Nom	Type	Description
activity	KnowledgeBaseActivityRecord[]: KnowledgeBaseAgenticReasoningActivityRecord[] KnowledgeBaseAzureBlobActivityRecord[] KnowledgeBaseIndexedOneLakeActivityRecord[] KnowledgeBaseModelWebSummarizationActivityRecord[] KnowledgeBaseSearchIndexActivityRecord[] KnowledgeBaseWebActivityRecord[]	Les enregistrements d’activité permettent de suivre l’avancement et les implications de facturation.
references	KnowledgeBaseReference[]: KnowledgeBaseAzureBlobReference[] KnowledgeBaseIndexedOneLakeReference[] KnowledgeBaseSearchIndexReference[] KnowledgeBaseWebReference[]	Les références des données d’extraction utilisées dans la réponse.
response	KnowledgeBaseMessage[]	Les messages de réponse.

KnowledgeBaseSearchIndexActivityArguments

Objet

Représente les arguments avec lesquels l’activité d’extraction d’index de recherche a été exécutée.

Nom	Type	Description
filter	string	Chaîne de filtre.
search	string	Chaîne de recherche utilisée pour interroger l’index de recherche.
searchFields	SearchIndexFieldReference[]	Quels champs ont été consultés.
semanticConfigurationName	string	Quelle configuration sémantique a été utilisée à partir de l’index de recherche.
sourceDataFields	SearchIndexFieldReference[]	Quels champs ont été sélectionnés pour la recherche.

KnowledgeBaseSearchIndexActivityRecord

Objet

Représente un enregistrement d’activité d’extraction d’index de recherche.

Nom	Type	Description
count	integer (int32)	Le nombre de documents récupérés qui étaient suffisamment pertinents pour passer le seuil de reranker.
elapsedMs	integer (int32)	Temps écoulé en millisecondes pour l’activité d’extraction.
error	KnowledgeBaseErrorDetail	L’erreur détaille la raison de l’échec de l’opération. Cette propriété n’est incluse que lorsque l’activité ne réussit pas.
id	integer (int32)	ID de l’enregistrement d’activité.
knowledgeSourceName	string	Source de connaissances pour l’activité d’extraction.
queryTime	string (date-time)	Temps de requête pour cette activité d’extraction.
searchIndexArguments	KnowledgeBaseSearchIndexActivityArguments	Arguments d’index de recherche pour l’activité d’extraction.
type	string: searchIndex	Type d’enregistrement d’activité.

KnowledgeBaseSearchIndexReference

Objet

Représente une référence de document Recherche Azure.

Nom	Type	Description
activitySource	integer (int32)	ID de l’activité source de la référence.
docKey	string	Clé de document de référence.
id	string	ID de la référence.
rerankerScore	number (float)	Le score du reranker pour la référence du document.
sourceData		Les données sources pour la référence.
type	string: searchIndex	Type de référence.

KnowledgeBaseWebActivityArguments

Objet

Représente les arguments avec lesquels l’activité de récupération web a été menée.

Nom	Type	Description
count	integer (int32)	Le nombre de résultats web est revenu.
freshness	string	La fraîcheur pour l’activité de récupération.
language	string	Le langage pour l’activité de récupération.
market	string	Le marché pour l’activité de récupération.
search	string	La chaîne de recherche utilisée pour interroger le web.

KnowledgeBaseWebActivityRecord

Objet

Représente un enregistrement d’activité de récupération web.

Nom	Type	Description
count	integer (int32)	Le nombre de documents récupérés qui étaient suffisamment pertinents pour passer le seuil de reranker.
elapsedMs	integer (int32)	Temps écoulé en millisecondes pour l’activité d’extraction.
error	KnowledgeBaseErrorDetail	L’erreur détaille la raison de l’échec de l’opération. Cette propriété n’est incluse que lorsque l’activité ne réussit pas.
id	integer (int32)	ID de l’enregistrement d’activité.
knowledgeSourceName	string	Source de connaissances pour l’activité d’extraction.
queryTime	string (date-time)	Temps de requête pour cette activité d’extraction.
type	string: web	Type d’enregistrement d’activité.
webArguments	KnowledgeBaseWebActivityArguments	Les arguments web pour l’activité de récupération.

KnowledgeBaseWebReference

Objet

Représente une référence de document Web.

Nom	Type	Description
activitySource	integer (int32)	ID de l’activité source de la référence.
id	string	ID de la référence.
rerankerScore	number (float)	Le score du reranker pour la référence du document.
sourceData		Les données sources pour la référence.
title	string	Le titre du document web.
type	string: web	Type de référence.
url	string (uri)	L’URL d’où proviennent les données de référence.

KnowledgeRetrievalIntentType

Énumération

Le type de configuration de la base de connaissances à utiliser.

Valeur	Description
semantic	Intention de requête sémantique en langage naturel.

KnowledgeRetrievalMinimalReasoningEffort

Objet

Exécutez la récupération des connaissances avec un minimum d’effort de raisonnement.

Nom	Type	Description
kind	string: minimal	Le genre d’effort de raisonnement.

KnowledgeRetrievalReasoningEffortKind

Énumération

La quantité d’effort à fournir lors de la récupération.

Valeur	Description
minimal	N’effectue pas de sélections de sources, de planification de requêtes ou de recherche itérative.

KnowledgeRetrievalSemanticIntent

Objet

Une intention de requête sémantique.

Nom	Type	Description
search	string	La requête sémantique à exécuter
type	string: semantic	Type d’intention.

KnowledgeSourceKind

Énumération

Le type de source de connaissance.

Valeur	Description
searchIndex	Source de connaissances qui lit les données d’un index de recherche.
azureBlob	Source de connaissances qui lit et ingère des données de Stockage Blob Azure dans un index de recherche.
indexedOneLake	Une source de connaissances qui lit les données provenant de OneLake indexé.
web	Une source de connaissances qui lit des données du web.

SearchIndexFieldReference

Objet

Référence de champ pour un index de recherche.

Nom	Type	Description
name	string	Nom du champ.

SearchIndexKnowledgeSourceParams

Objet

Spécifie les paramètres d’exécution d’une source de connaissances d’index de recherche

Nom	Type	Description
filterAddOn	string	Une condition de filtre appliquée à l’index (par exemple, 'State eq VA').
includeReferenceSourceData	boolean	Indique si les références doivent inclure les données structurées obtenues lors de l’extraction dans leur charge utile.
includeReferences	boolean	Indique si des références doivent être incluses pour les données extraites de cette source.
kind	string: searchIndex	Le type de source de connaissances.
knowledgeSourceName	string	Nom de l’index auquel les paramètres s’appliquent.
rerankerThreshold	number (float)	Le seuil de reclassement que tous les documents récupérés doivent atteindre pour être inclus dans la réponse.

WebKnowledgeSourceParams

Objet

Spécifie les paramètres d’exécution d’une source de connaissances Web

Nom	Type	Description
count	integer (int32)	Le nombre de résultats web à renvoyer.
freshness	string	La fraîcheur des résultats web.
includeReferenceSourceData	boolean	Indique si les références doivent inclure les données structurées obtenues lors de l’extraction dans leur charge utile.
includeReferences	boolean	Indique si des références doivent être incluses pour les données extraites de cette source.
kind	string: web	Le type de source de connaissances.
knowledgeSourceName	string	Nom de l’index auquel les paramètres s’appliquent.
language	string	La langue des résultats web.
market	string	Le marché des résultats web.
rerankerThreshold	number (float)	Le seuil de reclassement que tous les documents récupérés doivent atteindre pour être inclus dans la réponse.