Udostępnij za pośrednictwem

Uzyskiwanie statystyk usługi (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 zakresem usługi wyszukiwania.

2021-04-30-Preview dodaje aliasesCount.

Operacja Service Statistics zwraca liczbę i typ obiektów w usłudze, maksymalną dozwoloną dla każdego typu obiektu, biorąc pod uwagę warstwę usługi, rzeczywisty i maksymalny magazyn oraz inne limity, które różnią się w zależności od warstwy. To żądanie pobiera informacje z usługi, aby nie trzeba było wyszukać ani obliczyć limitów usługi .

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/servicestats?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. 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 względem usługi wyszukiwania muszą zawierać nagłówek api-key ustawiony 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:

{
    "counters": {
        "documentCount": {
            "usage": number,
            "quota": number | null (if the service has unlimited document counts, the quota will be null)
        },
        "indexesCount": {
            "usage": number,
            "quota": number
        },
        "indexersCount": {
            "usage": number,
            "quota": number
        },
        "dataSourcesCount": {
            "usage": number,
            "quota": number
        },
        "storageSize": {
            "usage": number (bytes),
            "quota": number (bytes) 
        },
        "synonymMaps": {
            "usage": number,
            "quota": number
        },
        "aliasesCount": {
            "usage": number,
            "quota": number
        },
        "vectorIndexSize": {
            "usage": number (bytes),
            "quota": number (bytes)
        }
    },
    "limits": {
        "maxFieldsPerIndex": number,
        "maxIndexerRunTime": string,
        "maxFileExtractionSize": number,
        "maxFileContentCharactersToExtract": number,
        "maxFieldNestingDepthPerIndex": number,
        "maxComplexCollectionFieldsPerIndex": number,
        "maxComplexObjectsInCollectionsPerDocument": number
    }
}
Statystyki Typ Opis
documentCount Hrabia Agregacja wszystkich dokumentów ze wszystkich indeksów. Wczesne wersje usługi Azure AI Search wymuszały limity liczby dokumentów, ale ten limit już nie istnieje. Limit przydziału zawsze ma wartość null wskazującą, że usługa może mieć nieograniczoną liczbę dokumentów.
indexesCount Hrabia Liczba indeksów w usłudze wyszukiwania. Maksymalne indeksy różnią się w zależności od warstwy zgodnie z limitem przydziału.
indexersCount Hrabia Liczba indeksatorów w usłudze wyszukiwania. Maksymalne indeksatory różnią się w zależności od warstwy, zgodnie z limitem przydziału.
dataSourcesCount Hrabia Liczba źródeł danych w usłudze wyszukiwania. Maksymalne źródła danych różnią się w zależności od warstwy zgodnie z limitem przydziału. Maksymalna liczba źródeł danych jest taka sama jak maksymalna liczba indeksatorów.
aliasesCount Hrabia Liczba aliasów indeksu w usłudze wyszukiwania. Maksymalna wartość zależy od warstwy, zgodnie z raportem limitu przydziału.
synonimyMapy Hrabia Liczba map synonimów w usłudze wyszukiwania. Maksymalna wartość zależy od warstwy, zgodnie z raportem limitu przydziału.
storageSize Bajtów Użycie to ilość miejsca używanego przez wszystkie obiekty w usłudze. Limit przydziału to maksymalny dostępny magazyn na podstawie rozmiaru i liczby partycji skonfigurowanych dla usługi. Limit przydziału zwiększa się i zmniejsza w odpowiedzi na liczbę partycji aprowizowania w usłudze wyszukiwania. Rozmiar partycji różni się w zależności od warstwy.
vectorIndexSize Bajtów Indeks wektorowy to wewnętrzna struktura, jeden indeks wektora na pole wektora, zgodnie z definicją w indeksie wyszukiwania. Łączne użycie jest zgłaszane w usłudze, dzięki czemu można monitorować zużycie przestrzeni wektorowej względem limitu indeksu wektorowego usługi wyszukiwania. Limit przydziału zależy od wieku usługi wyszukiwania, liczby partycji i rozmiaru partycji określonych według warstwy.

Aby uzyskać więcej informacji na temat wszystkich limitów, zobacz Service limits .

Przykłady

Ten interfejs API jest płaszczyzną danych. Aby uzyskać więcej informacji na temat usługi, takiej jak warstwa lub lokalizacja, zobacz interfejs API REST usługi Management.

{
    "@odata.context": "https://my-search-service.search.windows.net/$metadata#Microsoft.Azure.Search.V2019_05_06.ServiceStatistics",
    "counters": {
        "documentCount": {
            "usage": 5072,
            "quota": null
        },
        "indexesCount": {
            "usage": 10,
            "quota": 15
        },
        "indexersCount": {
            "usage": 8,
            "quota": 15
        },
        "dataSourcesCount": {
            "usage": 9,
            "quota": 15
        },
        "storageSize": {
            "usage": 22265221,
            "quota": 2147483648
        },
        "synonymMaps": {
            "usage": 0,
            "quota": 3
        },
        "aliasesCount": {
            "usage": 7,
            "quota": 30
        },
        "vectorIndexSize": {
            "usage": 1342476,
            "quota": 1073741824
    },
    "limits": {
        "maxFieldsPerIndex": 1000,
        "maxIndexerRunTime": "P1D",
        "maxFileExtractionSize": 16777216,
        "maxFileContentCharactersToExtract": 65536,
        "maxFieldNestingDepthPerIndex": 10,
        "maxComplexCollectionFieldsPerIndex": 40,
        "maxComplexObjectsInCollectionsPerDocument": 3000
    }
}

Zobacz też