Získání statistik služby (Rozhraní REST API ve verzi Preview)
Platí pro: 2023-07-01-Preview, 2021-04-30-Preview
Důležité
2023-07-01-Preview přidá do vyhledávací služby obor vectorIndexSize .
2021-04-30-Preview přidává aliasesCount.
Operace Statistika služby vrátí počet a typ objektů ve vaší službě, maximální povolený počet objektů pro každý typ objektu s danou úrovní služby, skutečné a maximální úložiště a další omezení, která se liší podle úrovně. Tato žádost načítá informace ze služby, abyste nemuseli vyhledávat ani počítat limity služby.
Statistiky 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/servicestats?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. Identifikátor URI požadavku určuje název indexu, pro který se mají vracet statistiky. |
| verze-api | Povinná hodnota. Aktuální verze Preview je 2023-07-01-Preview. Další verze najdete v tématu Verze rozhraní API . |
Hlavičky požadavku
Následující tabulka popisuje požadovanou a volitelnou hlavičku požadavku.
| Pole | Description |
|---|---|
| Typ obsahu | Povinná hodnota. Nastavte tuto hodnotu na application/json |
| klíč rozhraní API | 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émem vygenerovaný řetězec, který ověřuje požadavek na vaši vyhledávací službu. Požadavky na vyhledávací službu musí obsahovat hlavičku nastavenou api-key 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:
{
"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
}
}
| Statistický údaj | Typ | Description |
|---|---|---|
| počet dokumentů | Počet | Agregace všech dokumentů ze všech indexů. Starší verze služby Azure AI Search vynucuje omezení počtu dokumentů, ale tento limit už neexistuje. Kvóta má vždy hodnotu null, což znamená, že služba může mít neomezený počet dokumentů. |
| počet indexů | Počet | Počet indexů ve vyhledávací službě. Maximální indexy se liší podle úrovně podle kvóty. |
| indexersCount | Počet | Počet indexerů ve vyhledávací službě. Maximální počet indexerů se liší podle úrovně podle kvóty. |
| počet zdrojů dat | Počet | Počet zdrojů dat ve vyhledávací službě. Maximální počet zdrojů dat se liší podle úrovně podle kvóty. Maximální počet zdrojů dat je stejný jako maximální počet indexerů. |
| aliasesCount | Počet | Počet aliasů indexu ve vyhledávací službě. Maximální hodnota se liší podle úrovně podle kvóty. |
| synonymMaps | Počet | Počet synonym se mapuje ve vyhledávací službě. Maximální hodnota se liší podle úrovně podle kvóty. |
| storageSize | Bajty | Využití je velikost úložiště využitá všemi objekty ve službě. Kvóta je maximální dostupné úložiště na základě velikosti a počtu oddílů nakonfigurovaných pro vaši službu. Kvóta se zvyšuje a snižuje v reakci na počet oddílů zřízených ve vyhledávací službě. Velikost oddílu se liší podle úrovně. |
| vektorIndexSize | Bajty | Vektorový index je vnitřní struktura, jeden vektorový index na vektorové pole definovaný v indexu vyhledávání. Celkové využití se hlásí napříč službou, takže můžete monitorovat využití vektorového prostoru vzhledem k limitu vektorového indexu vaší vyhledávací služby. Kvóta se liší podle stáří vyhledávací služby, počtu oddílů a velikosti oddílů podle úrovně. |
Další informace o všech omezeních najdete v tématu Limity služby .
Příklady
Toto rozhraní API je rovina dat. Další informace o službě, jako je její úroveň nebo umístění, najdete v tématu Věnovaném rozhraní REST API pro správu.
{
"@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
}
}