Obtenir des statistiques d’index (API REST en préversion)

Article
06/28/2024

s’applique à: 2023-07-01-Preview. Cette version n’est plus prise en charge. mettre à niveau immédiatement vers une version plus récente.

Important

2023-07-01-Preview ajoute vectorIndexSize délimité à un index.

L’opération Obtenir les statistiques d’index retourne le nombre de documents pour l’index actuel, ainsi que la quantité totale de stockage utilisée par l’index tout-haut et le stockage de quantité consommée par ses données vectorielles uniquement. Un service de recherche a une limite globale sur la quantité de stockage vectoriel comme indiqué par Obtenir des statistiques de service. La métrique « vectorIndexSize » indique la quantité de stockage vectoriel utilisée pour les champs vectoriels dans l’index de recherche actuel.

Note

Les statistiques sur le nombre de documents et la taille de stockage sont collectées toutes les quelques minutes, et non en temps réel. Par conséquent, les statistiques retournées par cette API peuvent ne pas refléter les modifications provoquées par les opérations d’indexation récentes.

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

Paramètres d’URI

Paramètre	Description
nom du service	Obligatoire. Définissez cette valeur sur le nom unique défini par l’utilisateur de votre service de recherche.
nom de l’index	Obligatoire. L’URI de requête spécifie le nom de l’index pour lequel les statistiques doivent être retournées.
api-version	Obligatoire. Consultez versions de l’API pour plus de versions.

En-têtes de requête

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

Champs Description

Type de contenu Obligatoire. Définissez cette valeur sur application/json

api-key Facultatif si vous utilisez rôles Azure et qu’un jeton du porteur est fourni sur la demande, sinon une clé est requise. Une clé API est une chaîne unique générée par le système qui authentifie la requête auprès de votre service de recherche. Les demandes d’obtention d’une définition d’objet doivent inclure un champ clé API défini sur votre clé d’administration (par opposition à une clé de requête). Pour plus d’informations, consultez Se connecter à Azure AI Search à l’aide de l’authentification par clé.

Champs	Description
Type de contenu	Obligatoire. Définissez cette valeur sur `application/json`
api-key	Facultatif si vous utilisez rôles Azure et qu’un jeton du porteur est fourni sur la demande, sinon une clé est requise. Une clé API est une chaîne unique générée par le système qui authentifie la requête auprès de votre service de recherche. Les demandes d’obtention d’une définition d’objet doivent inclure un champ clé API défini sur votre clé d’administration (par opposition à une clé de requête). Pour plus d’informations, consultez Se connecter à Azure AI Search à l’aide de l’authentification par clé.

Corps de la demande

Aucun.

Réponse

Code d’état : « 200 OK » est retourné pour une réponse réussie. Le corps de la réponse est au format suivant :

{  
  "documentCount": number,  
  "storageSize": number (size of the index in bytes), 
  "vectorIndexSize": number (size of the index in bytes) 
}

S’il n’existe aucun champ vectoriel dans l’index, « vectorIndexSize » est égal à zéro.

Voir aussi

API REST Recherche Azure AI
limites de service

Partager via