Pobieranie statystyk indeksu (interfejs API REST w wersji zapoznawczej)
Dotyczy: 2023-07-01-Preview
Ważne
2023-07-01-Preview dodaje wektorIndexSize zakres do indeksu.
Operacja Pobierz statystykę indeksu zwraca liczbę dokumentów dla bieżącego indeksu oraz łączną ilość miejsca używanego przez indeks all-up oraz ilość miejsca zużywanego przez tylko jego dane wektorowe. Usługa wyszukiwania ma ogólny limit ilości magazynu wektorowego zgłoszonego przez funkcję Get Service Statistics. Metryka "vectorIndexSize" informuje, ile miejsca do magazynowania wektorów jest używane dla pól wektorów w bieżącym indeksie wyszukiwania.
Uwaga
Statystyki dotyczące liczby dokumentów i rozmiaru magazynu są zbierane co kilka minut, a nie w czasie rzeczywistym. W związku z tym statystyki zwracane przez ten interfejs API mogą nie odzwierciedlać zmian spowodowanych ostatnimi operacjami indeksowania.
GET https://[service name].search.windows.net/indexes/[index name]/stats?api-version=[api-version]
Content-Type: application/json
api-key: [admin key]
Parametry identyfikatora URI
| Parametr | Opis |
|---|---|
| nazwa usługi | Wymagane. Ustaw tę wartość na unikatową, zdefiniowaną przez użytkownika nazwę usługi wyszukiwania. |
| nazwa indeksu | Wymagane. Identyfikator URI żądania określa nazwę indeksu, dla którego powinny zostać zwrócone statystyki. |
| api-version | Wymagane. Bieżąca stabilna wersja to api-version=2020-06-30. Zobacz Wersje interfejsu API , aby uzyskać więcej wersji. |
Nagłówki żądań
W poniższej tabeli opisano wymagane i opcjonalne nagłówki żądań.
| Pola | Opis |
|---|---|
| Content-Type | Wymagane. Ustaw tę wartość na application/json |
| api-key | Opcjonalnie, jeśli używasz ról platformy Azure , a token elementu nośnego jest udostępniany w żądaniu, w przeciwnym razie wymagany jest klucz. Klucz api-key to unikatowy, generowany przez system ciąg, który uwierzytelnia żądanie w usłudze wyszukiwania. Żądania pobierania definicji obiektu muszą zawierać pole api-key ustawione na klucz administratora (w przeciwieństwie do klucza zapytania). Aby uzyskać szczegółowe informacje, zobacz Nawiązywanie połączenia z usługą Azure AI Search przy użyciu uwierzytelniania klucza . |
Treść żądania
Brak.
Reakcja
Kod stanu: "200 OK" jest zwracany dla pomyślnej odpowiedzi. Treść odpowiedzi jest w następującym formacie:
{
"documentCount": number,
"storageSize": number (size of the index in bytes),
"vectorIndexSize": number (size of the index in bytes)
}
Jeśli w indeksie nie ma pól wektorów, wartość "vectorIndexSize" to zero.