Indexes - Get Statistics

  • Odwołanie
Service:
Search Service
API Version:
2023-11-01

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.
indexName
 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 za pomocą żądania ułatwiającego debugowanie.

Odpowiedzi

Nazwa Typ Opis
200 OK

GetIndexStatisticsResult

Other Status Codes

SearchError

Odpowiedź na błąd.

Przykłady

SearchServiceGetIndexStatistics

Sample Request

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

Sample Response

Status code:
200 
{
  "documentCount": 239572,
  "storageSize": 72375920,
  "vectorIndexSize": 123456
}

Definicje

Nazwa Opis
GetIndexStatisticsResult

Statystyki dla danego indeksu. Statystyki są zbierane okresowo i nie mają gwarancji, że zawsze są aktualne.
SearchError

Opisuje warunek błędu interfejsu API.

GetIndexStatisticsResult

Statystyki dla danego indeksu. Statystyki są zbierane okresowo i nie mają gwarancji, że zawsze są aktualne.

Nazwa Typ Opis
documentCount

integer

Liczba dokumentów w indeksie.
storageSize

integer

Ilość miejsca do magazynowania w bajtach używanych przez indeks.
vectorIndexSize

integer

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

SearchError[]

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.