Knowledge Retrieval - Retrieve

Service:: Search Service

Version d'API:: 2025-11-01-preview

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

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

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	Type	Description
Accept	Accept	L’en-tête Accept.
x-ms-query-source-authorization	string	Jeton identifiant l’utilisateur pour lequel la requête est exécutée. Ce jeton est utilisé pour appliquer des restrictions de sécurité sur les documents.
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[] IndexedSharePointKnowledgeSourceParams[] RemoteSharePointKnowledgeSourceParams[] SearchIndexKnowledgeSourceParams[] WebKnowledgeSourceParams[]	Liste des paramètres d’exécution des sources de connaissances.
maxOutputSize	integer (int32)	Limite la taille maximale du contenu dans la sortie.
maxRuntimeInSeconds	integer (int32)	Durée d’exécution maximale en secondes.
messages	KnowledgeBaseMessage[]	Une liste d’entrées de style de message de chat.
outputMode	KnowledgeRetrievalOutputMode	Configuration de sortie pour cette extraction.
retrievalReasoningEffort	KnowledgeRetrievalReasoningEffort: KnowledgeRetrievalLowReasoningEffort KnowledgeRetrievalMediumReasoningEffort KnowledgeRetrievalMinimalReasoningEffort	La configuration de l’effort de raisonnement de récupération.

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://previewexampleservice.search.windows.net/knowledgebases('base-preview-test')/retrieve?api-version=2025-11-01-preview



{
  "messages": [
    {
      "role": "user",
      "content": [
        {
          "text": "hello world",
          "type": "text"
        }
      ]
    }
  ],
  "maxRuntimeInSeconds": 60,
  "maxOutputSize": 100000,
  "retrievalReasoningEffort": {
    "kind": "low"
  },
  "includeActivity": true,
  "outputMode": "answerSynthesis",
  "knowledgeSourceParams": [
    {
      "filterAddOn": "foo eq bar",
      "knowledgeSourceName": "ks-preview-test",
      "includeReferences": true,
      "includeReferenceSourceData": true,
      "alwaysQuerySource": false,
      "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-preview-test",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 2,
      "elapsedMs": 1234,
      "searchIndexArguments": {
        "search": "hello world",
        "filter": "foo eq bar",
        "sourceDataFields": [
          {
            "name": "category"
          },
          {
            "name": "description"
          },
          {
            "name": "ownerId"
          },
          {
            "name": "id"
          }
        ],
        "searchFields": [],
        "semanticConfigurationName": "testconfig"
      }
    },
    {
      "type": "searchIndex",
      "id": 2,
      "knowledgeSourceName": "ks-preview-test",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 2,
      "elapsedMs": 1234,
      "searchIndexArguments": {
        "search": "hello world two",
        "filter": "foo eq bar",
        "sourceDataFields": [
          {
            "name": "category"
          },
          {
            "name": "description"
          },
          {
            "name": "ownerId"
          },
          {
            "name": "id"
          }
        ],
        "searchFields": [],
        "semanticConfigurationName": "testconfig"
      }
    },
    {
      "type": "agenticReasoning",
      "id": 3,
      "retrievalReasoningEffort": {
        "kind": "low"
      },
      "reasoningTokens": 74
    },
    {
      "type": "modelAnswerSynthesis",
      "id": 4,
      "inputTokens": 664,
      "outputTokens": 1328,
      "elapsedMs": 10
    }
  ],
  "references": [
    {
      "type": "searchIndex",
      "id": "83dd7d40",
      "activitySource": 1,
      "sourceData": {
        "id": "myDocKey1",
        "title": "high_doc",
        "content": "hello world"
      },
      "rerankerScore": 3.5,
      "docKey": "myDocKey1"
    },
    {
      "type": "searchIndex",
      "id": "83dd7d41",
      "activitySource": 1,
      "sourceData": {
        "id": "myDocKey2",
        "title": "low_doc",
        "content": "goodbye world"
      },
      "rerankerScore": 2.7,
      "docKey": "myDocKey2"
    }
  ]
}

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-preview-test",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 2,
      "elapsedMs": 1234,
      "searchIndexArguments": {
        "search": "hello world",
        "filter": "foo eq bar",
        "sourceDataFields": [
          {
            "name": "category"
          },
          {
            "name": "description"
          },
          {
            "name": "ownerId"
          },
          {
            "name": "id"
          }
        ],
        "searchFields": [],
        "semanticConfigurationName": "testconfig"
      }
    },
    {
      "type": "web",
      "id": 2,
      "knowledgeSourceName": "ks-preview-web",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 10,
      "elapsedMs": 2345,
      "error": {
        "code": "403",
        "message": "The error message",
        "details": [],
        "additionalInfo": [
          {
            "type": "SomeErrorType",
            "info": {
              "someProperty": "Some value"
            }
          }
        ]
      }
    },
    {
      "type": "agenticReasoning",
      "id": 3,
      "retrievalReasoningEffort": {
        "kind": "low"
      },
      "reasoningTokens": 74
    },
    {
      "type": "modelAnswerSynthesis",
      "id": 4,
      "inputTokens": 664,
      "outputTokens": 1328,
      "elapsedMs": 10
    }
  ],
  "references": [
    {
      "type": "searchIndex",
      "id": "83dd7d40",
      "activitySource": 1,
      "sourceData": {
        "id": "myDocKey1",
        "title": "high_doc",
        "content": "hello world"
      },
      "rerankerScore": 3.5,
      "docKey": "myDocKey1"
    },
    {
      "type": "searchIndex",
      "id": "83dd7d41",
      "activitySource": 1,
      "sourceData": {
        "id": "myDocKey2",
        "title": "low_doc",
        "content": "goodbye world"
      },
      "rerankerScore": 2.7,
      "docKey": "myDocKey2"
    }
  ]
}

KnowledgeBaseRetrieveWithIntents

Exemple de requête

HTTP

POST https://previewexampleservice.search.windows.net/knowledgebases('base-preview-test')/retrieve?api-version=2025-11-01-preview



{
  "intents": [
    {
      "search": "foo",
      "type": "semantic"
    }
  ],
  "maxRuntimeInSeconds": 60,
  "maxOutputSize": 100000,
  "retrievalReasoningEffort": {
    "kind": "minimal"
  },
  "includeActivity": true,
  "outputMode": "extractiveData",
  "knowledgeSourceParams": [
    {
      "filterAddOn": "foo eq bar",
      "knowledgeSourceName": "ks-preview-test",
      "includeReferences": true,
      "includeReferenceSourceData": true,
      "alwaysQuerySource": 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-preview-test",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 2,
      "elapsedMs": 1234,
      "searchIndexArguments": {
        "search": "foo",
        "filter": "foo eq bar",
        "sourceDataFields": [
          {
            "name": "category"
          },
          {
            "name": "description"
          },
          {
            "name": "ownerId"
          },
          {
            "name": "id"
          }
        ],
        "searchFields": [],
        "semanticConfigurationName": "testconfig"
      }
    },
    {
      "type": "agenticReasoning",
      "id": 1,
      "retrievalReasoningEffort": {
        "kind": "minimal"
      },
      "reasoningTokens": 37
    }
  ],
  "references": [
    {
      "type": "searchIndex",
      "id": "83dd7d40",
      "activitySource": 0,
      "sourceData": {
        "id": "myDocKey1",
        "title": "high_doc",
        "content": "hello world"
      },
      "rerankerScore": 3.5,
      "docKey": "myDocKey1"
    },
    {
      "type": "searchIndex",
      "id": "83dd7d41",
      "activitySource": 0,
      "sourceData": {
        "id": "myDocKey2",
        "title": "low_doc",
        "content": "goodbye world"
      },
      "rerankerScore": 2.7,
      "docKey": "myDocKey2"
    }
  ]
}

Code d’état:: 206

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

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 d’erreur courante pour toutes les API Azure Resource Manager afin de retourner les détails de l’erreur pour les opérations ayant échoué. (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
IndexedSharePointKnowledgeSourceParams	Spécifie les paramètres d’exécution d’une source de connaissances SharePoint 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.
KnowledgeBaseIndexedSharePointActivityArguments	Représente les arguments avec lesquels l’activité indexée de récupération SharePoint a été exécutée.
KnowledgeBaseIndexedSharePointActivityRecord	Représente un enregistrement d’activité de récupération SharePoint indexé.
KnowledgeBaseIndexedSharePointReference	Représente une référence indexée à un document SharePoint.
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.
KnowledgeBaseModelAnswerSynthesisActivityRecord	Représente un enregistrement d’activité de synthèse de réponse LLM.
KnowledgeBaseModelQueryPlanningActivityRecord	Représente un enregistrement d’activité de planification de requête LLM.
KnowledgeBaseReferenceType	Type de référence.
KnowledgeBaseRemoteSharePointActivityArguments	Représente les arguments avec lesquels l’activité de récupération SharePoint à distance a été exécutée.
KnowledgeBaseRemoteSharePointActivityRecord	Représente un enregistrement d’activité de récupération SharePoint à distance.
KnowledgeBaseRemoteSharePointReference	Représente une référence de document SharePoint distant.
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.
KnowledgeRetrievalLowReasoningEffort	Exécutez la récupération des connaissances avec un faible effort de raisonnement.
KnowledgeRetrievalMediumReasoningEffort	Exécutez la récupération des connaissances avec un effort de raisonnement moyen.
KnowledgeRetrievalMinimalReasoningEffort	Exécutez la récupération des connaissances avec un minimum d’effort de raisonnement.
KnowledgeRetrievalOutputMode	Configuration de sortie pour cette extraction.
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.
RemoteSharePointKnowledgeSourceParams	Spécifie les paramètres d’exécution d’une source de connaissances SharePoint distante
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
SharePointSensitivityLabelInfo	Informations sur l’étiquette de confidentialité appliquée à un document SharePoint.
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
alwaysQuerySource	boolean	Indique que cette source de connaissances doit contourner la sélection de la source et être toujours interrogée au moment de la récupération.
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 d’erreur courante pour toutes les API Azure Resource Manager afin de retourner les détails de l’erreur pour les opérations ayant échoué. (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
alwaysQuerySource	boolean	Indique que cette source de connaissances doit contourner la sélection de la source et être toujours interrogée au moment de la récupération.
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.

IndexedSharePointKnowledgeSourceParams

Objet

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

Nom	Type	Description
alwaysQuerySource	boolean	Indique que cette source de connaissances doit contourner la sélection de la source et être toujours interrogée au moment de la récupération.
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: indexedSharePoint	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.
indexedSharePoint	Activité indexée de récupération de SharePoint.
indexedOneLake	Activité indexée de récupération OneLake.
web	Activité de recherche web.
remoteSharePoint	Activité de récupération SharePoint à distance.
modelQueryPlanning	Activité de planification des requêtes LLM.
modelAnswerSynthesis	Activité de synthèse de réponses 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: KnowledgeRetrievalLowReasoningEffort KnowledgeRetrievalMediumReasoningEffort 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.

KnowledgeBaseIndexedSharePointActivityArguments

Objet

Représente les arguments avec lesquels l’activité indexée de récupération SharePoint a été exécutée.

Nom	Type	Description
search	string	La chaîne de recherche utilisée pour interroger les contenus SharePoint indexés.

KnowledgeBaseIndexedSharePointActivityRecord

Objet

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

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é.
indexedSharePointArguments	KnowledgeBaseIndexedSharePointActivityArguments	Les arguments indexés SharePoint 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: indexedSharePoint	Type d’enregistrement d’activité.

KnowledgeBaseIndexedSharePointReference

Objet

Représente une référence indexée à un document SharePoint.

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

KnowledgeBaseModelAnswerSynthesisActivityRecord

Objet

Représente un enregistrement d’activité de synthèse de réponse 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)	Nombre de jetons d’entrée pour l’activité de synthèse de réponse LLM.
outputTokens	integer (int32)	Nombre de jetons de sortie pour l’activité de synthèse de réponse LLM.
type	string: modelAnswerSynthesis	Type d’enregistrement d’activité.

KnowledgeBaseModelQueryPlanningActivityRecord

Objet

Représente un enregistrement d’activité de planification de requête 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)	Nombre de jetons d’entrée pour l’activité de planification de requête LLM.
outputTokens	integer (int32)	Nombre de jetons de sortie pour l’activité de planification de requête LLM.
type	string: modelQueryPlanning	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.
indexedSharePoint	Référence indexée du document SharePoint.
indexedOneLake	Référence indexée du document OneLake.
web	Référence de document web.
remoteSharePoint	Référence de document SharePoint à distance.

KnowledgeBaseRemoteSharePointActivityArguments

Objet

Représente les arguments avec lesquels l’activité de récupération SharePoint à distance a été exécutée.

Nom	Type	Description
filterExpressionAddOn	string	L’extension d’expression du filtre pour l’activité de récupération.
search	string	La chaîne de recherche utilisée pour interroger la source de connaissances SharePoint distante.

KnowledgeBaseRemoteSharePointActivityRecord

Objet

Représente un enregistrement d’activité de récupération SharePoint à distance.

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.
remoteSharePointArguments	KnowledgeBaseRemoteSharePointActivityArguments	Les arguments SharePoint à distance pour l’activité de récupération.
type	string: remoteSharePoint	Type d’enregistrement d’activité.

KnowledgeBaseRemoteSharePointReference

Objet

Représente une référence de document SharePoint distant.

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.
searchSensitivityLabelInfo	SharePointSensitivityLabelInfo	Informations sur l’étiquette de sensibilité appliquée au document SharePoint.
sourceData		Les données sources pour la référence.
type	string: remoteSharePoint	Type de référence.
webUrl	string (uri)	L’URL d’où proviennent les données de référence.

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[] IndexedSharePointKnowledgeSourceParams[] RemoteSharePointKnowledgeSourceParams[] SearchIndexKnowledgeSourceParams[] WebKnowledgeSourceParams[]	Liste des paramètres d’exécution des sources de connaissances.
maxOutputSize	integer (int32)	Limite la taille maximale du contenu dans la sortie.
maxRuntimeInSeconds	integer (int32)	Durée d’exécution maximale en secondes.
messages	KnowledgeBaseMessage[]	Une liste d’entrées de style de message de chat.
outputMode	KnowledgeRetrievalOutputMode	Configuration de sortie pour cette extraction.
retrievalReasoningEffort	KnowledgeRetrievalReasoningEffort: KnowledgeRetrievalLowReasoningEffort KnowledgeRetrievalMediumReasoningEffort KnowledgeRetrievalMinimalReasoningEffort	La configuration de l’effort de raisonnement de récupération.

KnowledgeBaseRetrievalResponse

Objet

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

Nom	Type	Description
activity	KnowledgeBaseActivityRecord[]: KnowledgeBaseAgenticReasoningActivityRecord[] KnowledgeBaseAzureBlobActivityRecord[] KnowledgeBaseIndexedOneLakeActivityRecord[] KnowledgeBaseIndexedSharePointActivityRecord[] KnowledgeBaseModelAnswerSynthesisActivityRecord[] KnowledgeBaseModelQueryPlanningActivityRecord[] KnowledgeBaseRemoteSharePointActivityRecord[] KnowledgeBaseSearchIndexActivityRecord[] KnowledgeBaseWebActivityRecord[]	Les enregistrements d’activité permettent de suivre l’avancement et les implications de facturation.
references	KnowledgeBaseReference[]: KnowledgeBaseAzureBlobReference[] KnowledgeBaseIndexedOneLakeReference[] KnowledgeBaseIndexedSharePointReference[] KnowledgeBaseRemoteSharePointReference[] 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.

KnowledgeRetrievalLowReasoningEffort

Objet

Exécutez la récupération des connaissances avec un faible effort de raisonnement.

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

KnowledgeRetrievalMediumReasoningEffort

Objet

Exécutez la récupération des connaissances avec un effort de raisonnement moyen.

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

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.

KnowledgeRetrievalOutputMode

Énumération

Configuration de sortie pour cette extraction.

Valeur	Description
extractiveData	Retournez des données à partir des sources de connaissances directement sans modification générative.
answerSynthesis	Synthétisez une réponse pour la charge utile de réponse.

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.
low	Utilisez un raisonnement faible lors de la récupération.
medium	Utilisez une quantité modérée de raisonnement pendant la récupération.

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.
indexedSharePoint	Une source de connaissances qui lit les données provenant de SharePoint indexé.
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.
remoteSharePoint	Une source de connaissances qui lit les données provenant de SharePoint distant.

RemoteSharePointKnowledgeSourceParams

Objet

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

Nom	Type	Description
alwaysQuerySource	boolean	Indique que cette source de connaissances doit contourner la sélection de la source et être toujours interrogée au moment de la récupération.
filterExpressionAddOn	string	Condition de filtre appliquée à la source de données SharePoint. Il doit être spécifié dans la syntaxe du langage de requête de mots-clés. Elle sera combinée en conjonction avec l’expression de filtre spécifiée dans la définition de la source de connaissances.
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: remoteSharePoint	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.

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
alwaysQuerySource	boolean	Indique que cette source de connaissances doit contourner la sélection de la source et être toujours interrogée au moment de la récupération.
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.

SharePointSensitivityLabelInfo

Objet

Informations sur l’étiquette de confidentialité appliquée à un document SharePoint.

Nom	Type	Description
color	string	Couleur que l’interface utilisateur doit afficher pour l’étiquette, si elle est configurée.
displayName	string	Nom d’affichage de l’étiquette de confidentialité.
isEncrypted	boolean	Indique si l’étiquette de confidentialité applique le chiffrement.
priority	integer (int32)	Priorité dans laquelle l’étiquette de confidentialité est appliquée.
sensitivityLabelId	string	ID de l’étiquette de confidentialité.
tooltip	string	Info-bulle qui doit être affichée pour l’étiquette dans une interface utilisateur.

WebKnowledgeSourceParams

Objet

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

Nom	Type	Description
alwaysQuerySource	boolean	Indique que cette source de connaissances doit contourner la sélection de la source et être toujours interrogée au moment de la récupération.
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.