Indexes - Get Statistics

Service:

Search Service

Version d'API:

2024-07-01

Retourne des statistiques pour l’index donné, y compris un nombre de documents et une utilisation du stockage.

GET {endpoint}/indexes('{indexName}')/search.stats?api-version=2024-07-01

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
endpoint	path	True	string	URL du point de terminaison du service de recherche.
indexName	path	True	string	Nom de l’index pour lequel récupérer des statistiques.
api-version	query	True	string	Version de l’API cliente.

En-tête de la demande

Nom	Obligatoire	Type	Description
x-ms-client-request-id		string uuid	ID de suivi envoyé avec la demande pour faciliter le débogage.

Réponses

Nom	Type	Description
200 OK	GetIndexStatisticsResult
Other Status Codes	ErrorResponse	Réponse d’erreur.

Exemples

SearchServiceGetIndexStatistics

Exemple de requête

HTTP

GET https://myservice.search.windows.net/indexes('hotels')/search.stats?api-version=2024-07-01

Exemple de réponse

Code d’état:

200

{
  "documentCount": 239572,
  "storageSize": 72375920,
  "vectorIndexSize": 123456
}

Définitions

Nom	Description
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur
GetIndexStatisticsResult	Statistiques d’un index donné. Les statistiques sont collectées régulièrement et ne sont pas garanties d’être toujours up-to-date.

ErrorAdditionalInfo

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

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

ErrorDetail

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

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

GetIndexStatisticsResult

Statistiques d’un index donné. Les statistiques sont collectées régulièrement et ne sont pas garanties d’être toujours up-to-date.

Nom	Type	Description
documentCount	integer	Nombre de documents dans l’index.
storageSize	integer	Quantité de stockage en octets consommée par l’index.
vectorIndexSize	integer	Quantité de mémoire en octets consommée par des vecteurs dans l’index.