Indexes - Get Statistics
ドキュメント数やストレージ使用量など、指定されたインデックスの統計を返します。
GET {endpoint}/indexes('{indexName}')/search.stats?api-version=2023-11-01URI パラメーター
| 名前 | / | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
endpoint
|
path | True |
string |
検索サービスのエンドポイント URL。 |
|
index
|
path | True |
string |
統計を取得するインデックスの名前。 |
|
api-version
|
query | True |
string |
クライアント API のバージョン。 |
要求ヘッダー
| 名前 | 必須 | 型 | 説明 |
|---|---|---|---|
| x-ms-client-request-id |
string uuid |
デバッグに役立つ要求と共に送信される追跡 ID。 |
応答
| 名前 | 型 | 説明 |
|---|---|---|
| 200 OK | ||
| Other Status Codes |
エラー応答。 |
例
SearchServiceGetIndexStatistics
要求のサンプル
GET https://myservice.search.windows.net/indexes('hotels')/search.stats?api-version=2023-11-01
応答のサンプル
{
"documentCount": 239572,
"storageSize": 72375920,
"vectorIndexSize": 123456
}定義
| 名前 | 説明 |
|---|---|
|
Get |
特定のインデックスの統計。 統計は定期的に収集され、常に最新であるとは限りません。 |
|
Search |
API のエラー条件について説明します。 |
GetIndexStatisticsResult
特定のインデックスの統計。 統計は定期的に収集され、常に最新であるとは限りません。
| 名前 | 型 | 説明 |
|---|---|---|
| documentCount |
integer |
インデックス内のドキュメントの数。 |
| storageSize |
integer |
インデックスによって消費されるストレージの量 (バイト単位)。 |
| vectorIndexSize |
integer |
インデックス内のベクトルによって消費されるメモリの量 (バイト単位)。 |
SearchError
API のエラー条件について説明します。
| 名前 | 型 | 説明 |
|---|---|---|
| code |
string |
サーバー定義のエラー コードのセットの 1 つ。 |
| details |
この報告されたエラーの原因となった特定のエラーに関する詳細の配列。 |
|
| message |
string |
エラーの人間が判読できる表現。 |