Indexes - Get Statistics
Zwraca statystyki dla danego indeksu, w tym liczbę dokumentów i użycie magazynu.
GET {endpoint}/indexes('{indexName}')/search.stats?api-version=2023-11-01
Parametry identyfikatora URI
| Nazwa | W | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
endpoint
|
path | True |
string |
Adres URL punktu końcowego usługi wyszukiwania. |
|
index
|
path | True |
string |
Nazwa indeksu, dla którego mają być pobierane statystyki. |
|
api-version
|
query | True |
string |
Wersja interfejsu API klienta. |
Nagłówek żądania
| Nazwa | Wymagane | Typ | Opis |
|---|---|---|---|
| x-ms-client-request-id |
string (uuid) |
Identyfikator śledzenia wysłany z żądaniem, aby ułatwić debugowanie. |
Odpowiedzi
| Nazwa | Typ | Opis |
|---|---|---|
| 200 OK | ||
| Other Status Codes |
Odpowiedź na błąd. |
Przykłady
SearchServiceGetIndexStatistics
Przykładowe żądanie
GET https://myservice.search.windows.net/indexes('hotels')/search.stats?api-version=2023-11-01
Przykładowa odpowiedź
{
"documentCount": 239572,
"storageSize": 72375920,
"vectorIndexSize": 123456
}
Definicje
| Nazwa | Opis |
|---|---|
|
Get |
Statystyki dla danego indeksu. Statystyki są zbierane okresowo i nie mają gwarancji, że zawsze będą up-to-date. |
|
Search |
Opisuje warunek błędu interfejsu API. |
GetIndexStatisticsResult
Statystyki dla danego indeksu. Statystyki są zbierane okresowo i nie mają gwarancji, że zawsze będą up-to-date.
| Nazwa | Typ | Opis |
|---|---|---|
| documentCount |
integer (int64) |
Liczba dokumentów w indeksie. |
| storageSize |
integer (int64) |
Ilość miejsca do magazynowania w bajtach używanych przez indeks. |
| vectorIndexSize |
integer (int64) |
Ilość pamięci w bajtach używanych przez wektory w indeksie. |
SearchError
Opisuje warunek błędu interfejsu API.
| Nazwa | Typ | Opis |
|---|---|---|
| code |
string |
Jeden z zdefiniowanych przez serwer zestaw kodów błędów. |
| details |
Tablica szczegółów dotyczących określonych błędów, które doprowadziły do tego zgłoszonego błędu. |
|
| message |
string |
Czytelna dla człowieka reprezentacja błędu. |