En-têtes de requête et de réponse HTTP courants (Recherche Azure AI)
Article
Les API REST Azure AI Search prennent en charge un ensemble d’en-têtes de requête/réponse HTTP courants, résumés ici pour référence :
En-tête de la demande
Type
Description
Accepter
Type de contenu
Type de contenu demandé pour la réponse. Par défaut, il s'agit d'application/json;odata.metadata=minimal. Les autres valeurs autorisées sont application/json, application/json ; odata.metadata=full, application/json ; odata.metadata=none et text/plain (pour $count uniquement).
Jeton d’accès OAuth 2.0 pour la demande. Nécessite la configuration de votre service de recherche pour l’accès en fonction du rôle. Cet en-tête de requête est destiné aux applications clientes qui utilisent l’authentification Microsoft Entra ID et les attributions de rôles. Votre code client doit fournir le jeton. Vous pouvez utiliser cet en-tête de requête avec n’importe quelle version d’API REST prise en charge tant que le service de recherche est configuré pour l’authentification du plan de données.
Content-Type
Content-Type
Type de contenu du corps de la demande (PUT/POST). La valeur par défaut est application/json.
client-request-id
GUID
ID de requête facultatif spécifié par l’appelant, sous la forme d’un GUID sans décoration telle que des accolades (par exemple, client-request-id : 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0). Une valeur définie par l’appelant qui identifie la requête donnée. Si elle est spécifiée, cette valeur est incluse dans les informations de réponse pour mapper la demande.
OData-MaxVersion
"4.0"
Spécifie la version maximale du protocole OData prise en charge par le client. La valeur par défaut est « 4.0 ».
Prefer
« return=representation » ou « return=minimal »
Utilisé pour contrôler la charge utile de réponse à des demandes d'index / PUT et POST. La valeur par défaut est « return=representation » lors de la création d’un index via POST ou PUT, et « return=minimal » pour la mise à jour d’un index existant via PUT.
return-client-request-id
True ou False
Si spécifié quand client-request-id est spécifié, indique au serveur d'inclure l'en-tête client-request-id dans la réponse. La valeur par défaut est FALSE.
If-Match
ETag ou *
Permet de modifier une ressource uniquement si la version actuelle correspond à l’ETag spécifié. Utilisez cet en-tête avec les méthodes POST, PUT ou DELETE sur les ressources (telles que les indexeurs, les index et les sources de données, mais pas les documents) pour activer le contrôle d’accès concurrentiel optimiste.
If-None-Match
ETag ou *
Permet de modifier une ressource uniquement si la version actuelle ne correspond pas à l’ETag spécifié. Utilisez cet en-tête avec les méthodes POST, PUT ou DELETE sur les ressources (telles que les indexeurs, les index et les sources de données, mais pas les documents) pour activer le contrôle d’accès concurrentiel optimiste.
En-tête de réponse
Type
Description
client-request-id
GUID
Un identificateur spécifié par l’appelant dans la requête d’origine, le cas échéant.
Content-Type
Content-Type
Le type de contenu du corps de la réponse.
Emplacement
URL
URL de la définition d’index nouvellement créée pour les requêtes POST et PUT /indexes.
OData-Version
"4.0"
Version du protocole OData de la réponse.
request-id
GUID
Identificateur unique de l'opération en cours. Égal à client-request-id si spécifié ; sinon, la valeur est générée sur le serveur.
elapsed-time
Nombre
Temps, en millisecondes, que le service a passé à traiter la demande. Cette valeur inclut uniquement le temps consacré au traitement de la demande, et n’inclut pas le temps de transfert réseau.
ETag
String
Chaîne opaque représentant la version actuelle d’une ressource (retournée pour les indexeurs, les index et les sources de données, mais pas pour les documents). Utilisez cette chaîne dans l’en-tête If-Match ou If-None-Match pour le contrôle d’accès concurrentiel optimiste.