Indexes - Get Statistics
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=2023-11-01
Paramètres URI
| Nom | Dans | Obligatoire | Type | Description |
|---|---|---|---|---|
|
endpoint
|
path | True |
string |
URL du point de terminaison du service de recherche. |
|
index
|
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 | ||
| Other Status Codes |
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 |
|---|---|
|
Get |
Statistiques d’un index donné. Les statistiques sont collectées régulièrement et ne sont pas garanties d’être toujours up-to-date. |
|
Search |
Décrit une condition d’erreur pour l’API. |
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 (int64) |
Nombre de documents dans l’index. |
| storageSize |
integer (int64) |
Quantité de stockage en octets consommée par l’index. |
| vectorIndexSize |
integer (int64) |
Quantité de mémoire en octets consommée par des vecteurs dans l’index. |
SearchError
Décrit une condition d’erreur pour l’API.
| Nom | Type | Description |
|---|---|---|
| code |
string |
Un ensemble de codes d’erreur définis par le serveur. |
| details |
Tableau de détails sur des erreurs spécifiques qui ont conduit à cette erreur signalée. |
|
| message |
string |
Représentation lisible par l’homme de l’erreur. |