Indexes - Get Statistics

Služba:

Search Service

Verze rozhraní API:

2023-10-01-Preview

Vrátí statistiky pro daný index, včetně počtu dokumentů a využití úložiště.

GET {endpoint}/indexes('{indexName}')/search.stats?api-version=2023-10-01-Preview

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
endpoint	path	True	string	Adresa URL koncového bodu vyhledávací služby.
indexName	path	True	string	Název indexu, pro který se mají načíst statistiky.
api-version	query	True	string	Verze rozhraní API klienta.

Hlavička požadavku

Name	Vyžadováno	Typ	Description
x-ms-client-request-id		string uuid	ID sledování odeslané spolu s požadavkem na pomoc s laděním.

Odpovědi

Name	Typ	Description
200 OK	GetIndexStatisticsResult
Other Status Codes	SearchError	Odpověď na chybu.

Příklady

SearchServiceGetIndexStatistics

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:

200

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

Definice

Name	Description
GetIndexStatisticsResult	Statistika daného indexu Statistiky se shromažďují pravidelně a není zaručeno, že budou vždy aktuální.
SearchError	Popisuje chybový stav rozhraní API.

GetIndexStatisticsResult

Statistika daného indexu Statistiky se shromažďují pravidelně a není zaručeno, že budou vždy aktuální.

Name	Typ	Description
documentCount	integer	Počet dokumentů v indexu.
storageSize	integer	Velikost úložiště v bajtech spotřebovaných indexem
vectorIndexSize	integer	Množství paměti v bajtech spotřebované vektory v indexu.

SearchError

Popisuje chybový stav rozhraní API.

Name	Typ	Description
code	string	Jeden ze serverem definované sady kódů chyb.
details	SearchError[]	Pole podrobností o konkrétních chybách, které vedly k této nahlášené chybě.
message	string	Lidsky čitelná reprezentace chyby.