Indexes - Get Statistics

Retourneert statistieken voor de opgegeven index, inclusief het aantal documenten en het opslaggebruik.

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

URI-parameters

Name In Vereist Type Description
endpoint
path True

string

De eindpunt-URL van de zoekservice.

indexName
path True

string

De naam van de index waarvoor statistieken moeten worden opgehaald.

api-version
query True

string

Client-API-versie.

Aanvraagkoptekst

Name Vereist Type Description
x-ms-client-request-id

string (uuid)

De tracerings-id die is verzonden met de aanvraag om hulp te bieden bij foutopsporing.

Antwoorden

Name Type Description
200 OK

GetIndexStatisticsResult

Other Status Codes

SearchError

Foutreactie.

Voorbeelden

SearchServiceGetIndexStatistics

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Definities

Name Description
GetIndexStatisticsResult

Statistieken voor een bepaalde index. Statistieken worden periodiek verzameld en worden niet gegarandeerd altijd up-to-datum.

SearchError

Beschrijft een foutvoorwaarde voor de API.

GetIndexStatisticsResult

Statistieken voor een bepaalde index. Statistieken worden periodiek verzameld en worden niet gegarandeerd altijd up-to-datum.

Name Type Description
documentCount

integer (int64)

Het aantal documenten in de index.

storageSize

integer (int64)

De hoeveelheid opslagruimte in bytes die door de index worden verbruikt.

vectorIndexSize

integer (int64)

De hoeveelheid geheugen in bytes die door vectoren in de index worden gebruikt.

SearchError

Beschrijft een foutvoorwaarde voor de API.

Name Type Description
code

string

Een van een door de server gedefinieerde set foutcodes.

details

SearchError[]

Een matrix met details over specifieke fouten die hebben geleid tot deze gemelde fout.

message

string

Een leesbare weergave van de fout.