Získání statistik indexu (rozhraní REST API verze Preview)
platí pro: 2023-07-01-Preview. Tato verze se už nepodporuje. okamžitě upgradovat na novější verzi.
Důležitý
2023-07-01-Preview přidá vectorIndexSize rozsahu indexu.
Operace Získat statistiku indexu vrátí počet dokumentů pro aktuální index a celkové úložiště využité indexem a velikost úložiště spotřebovanou pouze jeho vektorovými daty. Vyhledávací služba má celkový limit množství vektorového úložiště, jak je hlášeno Získat statistiky služby. Metrika vectorIndexSize udává, kolik vektorového úložiště 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 | Požadovaný. Nastavte tuto hodnotu na jedinečný uživatelsky definovaný název vyhledávací služby. |
název indexu | Požadovaný. Identifikátor URI požadavku určuje název indexu, pro který se mají vrátit statistiky. |
api-version | Požadovaný. Další verze najdete v verzích rozhraní API. |
Hlavičky požadavku
Následující tabulka popisuje povinnou a volitelnou hlavičku požadavku.
Pole | Popis |
---|---|
Typ obsahu | Požadovaný. 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íč. Api-key je jedinečný systémový vygenerovaný řetězec, který ověřuje požadavek ve vaší vyhledávací službě. Žádosti o 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í k Azure AI Search pomocí ověřování klíčů. |
Text požadavku
Žádný.
Odpověď
Stavový kód: "200 OK" se vrátí pro úspěšnou odpověď. 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, "vectorIndexSize" je nula.
Viz také
- rozhraní REST API služby Azure AI Search
- omezení služby service