Hämta indexstatistik (förhandsversion av REST API)

  • Artikel

gäller för: 2023-07-01-Preview. Den här versionen stöds inte längre. Uppgradera omedelbart till en nyare version.

Viktig

2023-07-01-Preview lägger till vectorIndexSize begränsat till ett index.

Åtgärden Hämta indexstatistik returnerar dokumentantalet för det aktuella indexet, plus mängden totalt lagringsutrymme som används av indexet och mängden lagringsutrymme som bara används av dess vektordata. En söktjänst har en övergripande gräns för mängden vektorlagring som rapporteras av Hämta tjänststatistik. Måttet "vectorIndexSize" visar hur mycket vektorlagring som används för vektorfält i det aktuella sökindexet.

Not

Statistik över antal dokument och lagringsstorlek samlas in med några minuters mellanrum, inte i realtid. Därför kanske den statistik som returneras av det här API:et inte återspeglar ändringar som orsakats av de senaste indexeringsåtgärderna.

GET https://[service name].search.windows.net/indexes/[index name]/stats?api-version=[api-version]  
  Content-Type: application/json  
  api-key: [admin key]

URI-parametrar

Parameter Beskrivning
tjänstnamn Krävs. Ange det här värdet till det unika, användardefinierade namnet på söktjänsten.
indexnamn Krävs. Begärande-URI anger namnet på indexet för vilket statistik ska returneras.
api-version Krävs. Se API-versioner för fler versioner.

Begärandehuvuden

I följande tabell beskrivs de obligatoriska och valfria begäranderubrikerna.

Fält Beskrivning
Innehållstyp Krävs. Ange det här värdet till application/json
api-key Valfritt om du använder Azure-roller och en ägartoken anges i begäran, annars krävs en nyckel. En API-nyckel är en unik, systemgenererad sträng som autentiserar begäran till din söktjänst. Hämta begäranden om en objektdefinition måste innehålla ett api-nyckelfält som är inställt på din administratörsnyckel (i motsats till en frågenyckel). Mer information finns i Anslut till Azure AI Search med hjälp av nyckelautentisering.

Begärandetext

Ingen.

Svar

Statuskod: "200 OK" returneras för ett lyckat svar. Svarstexten är i följande format:

{  
  "documentCount": number,  
  "storageSize": number (size of the index in bytes), 
  "vectorIndexSize": number (size of the index in bytes) 
}

Om det inte finns några vektorfält i indexet är "vectorIndexSize" noll.

Se även