Partager via


Indexes - Get Statistics

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

GET {endpoint}/indexes('{indexName}')/search.stats?api-version=2023-11-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 d’aide pour le débogage.

Réponses

Nom Type Description
200 OK

GetIndexStatisticsResult

Other Status Codes

SearchError

Réponse d’erreur.

Exemples

SearchServiceGetIndexStatistics

Exemple de requête

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

Exemple de réponse

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

Définitions

Nom Description
GetIndexStatisticsResult

Statistiques pour un index donné. Les statistiques sont collectées régulièrement et ne sont pas garanties d’être toujours à jour.

SearchError

Décrit une condition d’erreur pour l’API.

GetIndexStatisticsResult

Statistiques pour un index donné. Les statistiques sont collectées régulièrement et ne sont pas garanties d’être toujours à jour.

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 les vecteurs dans l’index.

SearchError

Décrit une condition d’erreur pour l’API.

Nom Type Description
code

string

Un des codes d’erreur définis par le serveur.

details

SearchError[]

Tableau de détails sur les erreurs spécifiques qui ont conduit à cette erreur signalée.

message

string

Représentation lisible par l’homme de l’erreur.