Udostępnij za pośrednictwem

Pobieranie statystyk indeksu (interfejs API REST w wersji zapoznawczej)

  • Artykuł

Dotyczy: 2023-07-01-Preview. Ta wersja nie jest już obsługiwana. Uaktualnij natychmiast do nowszej wersji.

Ważny

2023-07-01-Preview dodaje vectorIndexSize w zakresie indeksu.

Operacja Pobierz statystyki indeksu zwraca liczbę dokumentów dla bieżącego indeksu oraz łączną ilość miejsca do magazynowania używanego przez indeks all-up oraz ilość miejsca używanego tylko przez dane wektorowe. Usługa wyszukiwania ma ogólny limit ilości magazynu wektorowego zgłoszonego przez Get Service Statistics. Metryka "vectorIndexSize" informuje o tym, ile magazynu wektorów jest używany dla pól wektorów w bieżącym indeksie wyszukiwania.

Nuta

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 zwrócone 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.
wersja interfejsu API Wymagane. Aby uzyskać więcej wersji, zobacz wersje interfejsu API.

Nagłówki żądań

W poniższej tabeli opisano wymagane i opcjonalne nagłówki żądań.

Pola Opis
Typ zawartości Wymagane. Ustaw tę wartość na application/json
api-key Opcjonalnie, jeśli używasz ról platformy Azure i 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 Connect to Azure AI Search using key authentication (Łączenie z usługą Azure AI Search przy użyciu uwierzytelniania kluczy).

Treść żądania

Żaden.

Odpowiedź

Kod stanu: "200 OK" jest zwracany dla pomyślnej odpowiedzi. Treść odpowiedzi ma następujący format:

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

Jeśli w indeksie nie ma żadnych pól wektorowych, parametr "vectorIndexSize" ma wartość zero.

Zobacz też