Indexes - Get Statistics

Služba:
Search Service
Verze rozhraní API:
2023-11-01

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

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

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é s požadavkem, které vám pomůže s laděním.

Odpovědi

Name Typ Description
200 OK

GetIndexStatisticsResult

Other Status Codes

SearchError

Chybová odpověď.

Příklady

SearchServiceGetIndexStatistics

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:
200 
{
  "documentCount": 239572,
  "storageSize": 72375920,
  "vectorIndexSize": 123456
}

Definice

Name Description
GetIndexStatisticsResult

Statistika pro daný index Statistiky se shromažďují pravidelně a není zaručeno, že budou vždy up-to-date.
SearchError

Popisuje chybový stav rozhraní API.

GetIndexStatisticsResult

Objekt

Statistika pro daný index Statistiky se shromažďují pravidelně a není zaručeno, že budou vždy up-to-date.

Name Typ Description
documentCount

integer (int64)

Počet dokumentů v indexu
storageSize

integer (int64)

Množství úložiště v bajtech spotřebované indexem
vectorIndexSize

integer (int64)

Množství paměti v bajtech spotřebované vektory v indexu.

SearchError

Objekt

Popisuje chybový stav rozhraní API.

Name Typ Description
code

string

Jedna ze serverově definovaných kódů chyb.
details

SearchError[]

Pole podrobností o konkrétních chybách, které vedly k této nahlášené chybě.
message

string

Čitelné znázornění chyby člověkem.