Nombre de documents (API REST Recherche Azure AI)

L’opération Count Documents récupère le nombre de documents dans un index de recherche. La syntaxe $count fait partie du protocole OData.

GET https://[service name].search.windows.net/indexes/[index name]/docs/$count?api-version=[api-version]  
  Content-Type: application/json   
  api-key: [admin or query key]    

Paramètres URI

Paramètre Description
nom du service Obligatoire. Définissez sur le nom unique défini par l’utilisateur de votre service de recherche.
nom de l'index Obligatoire. Le [index name] dans l'URI de requête indique au service de renvoyer le nombre de tous les éléments figurant dans la collection docs de l'index spécifié.
api-version Obligatoire. Pour obtenir la liste des versions prises en charge, consultez Versions d’API .

En-têtes de requête

Le tableau suivant décrit les en-têtes de demande obligatoires et facultatifs.

Champs Description
Content-Type Obligatoire. Paramètre à définir sur application/json
api-key Facultatif si vous utilisez des rôles Azure, sinon une clé est requise. La demande Count Documents peut spécifier une clé d’administration ou une clé de requête pour .api-key Pour plus d’informations, consultez Se connecter à Azure AI Search à l’aide de l’authentification par clé .

Corps de la demande

Aucun.

response

Code d'état : 200 OK est retourné pour une réponse correcte.

Le corps de la réponse contient la valeur du nombre sous forme d'entier en texte brut.

Voir aussi

API REST De recherche Azure AI
Codes d’état HTTP
Syntaxe d’expression OData pour Recherche Azure AI
Résultats de la recherche