Získání statistik indexu (rozhraní REST API verze Preview)
Platí pro: 2023-07-01-Preview
Důležité
2023-07-01-Preview přidá vectorIndexSize vymezený do indexu.
Operace Získat statistiku indexu vrátí počet dokumentů pro aktuální index plus celkové úložiště využité indexem a množství úložiště spotřebované pouze jeho vektorovými daty. Vyhledávací služba má celkový limit velikosti úložiště vektorů, jak je hlášeno službou Get Service Statistics. Metrika vectorIndexSize udává, kolik úložiště vektorů se používá pro vektorová pole v aktuálním indexu vyhledávání.
Poznámka
Statistiky o počtu dokumentů a velikosti úložiště se shromažďují každých několik minut, ne v reálném čase. Statistiky vrácené tímto rozhraním API proto nemusí odrážet změny způsobené nedávnými operacemi indexování.
GET https://[service name].search.windows.net/indexes/[index name]/stats?api-version=[api-version]
Content-Type: application/json
api-key: [admin key]
Parametry identifikátoru URI
| Parametr | Popis |
|---|---|
| název služby | Povinná hodnota. Nastavte tuto hodnotu na jedinečný, uživatelem definovaný název vaší vyhledávací služby. |
| název indexu | Povinná hodnota. Identifikátor URI požadavku určuje název indexu, pro který se mají vracet statistiky. |
| verze-api | Povinná hodnota. Aktuální stabilní verze je api-version=2020-06-30. Další verze najdete v tématu Verze rozhraní API . |
Hlavičky požadavku
Následující tabulka popisuje požadované a volitelné hlavičky požadavků.
| Pole | Description |
|---|---|
| Typ obsahu | Povinná hodnota. Nastavte tuto hodnotu na application/json |
| api-key | Volitelné, pokud používáte role Azure a v požadavku je k dispozici nosný token, jinak se vyžaduje klíč. Klíč api-key je jedinečný systémově vygenerovaný řetězec, který ověřuje požadavek pro vaši vyhledávací službu. Požadavky na získání definice objektu musí obsahovat pole api-key nastavené na klíč správce (na rozdíl od klíče dotazu). Podrobnosti najdete v tématu Připojení ke službě Azure AI Search pomocí ověřování pomocí klíče . |
Text požadavku
Žádné
Odpověď
Pro úspěšnou odpověď se vrátí stavový kód 200 OK. Text odpovědi je v následujícím formátu:
{
"documentCount": number,
"storageSize": number (size of the index in bytes),
"vectorIndexSize": number (size of the index in bytes)
}
Pokud v indexu nejsou žádná vektorová pole, hodnota vectorIndexSize je nulová.