インデックス統計の取得 (プレビュー REST API)

: 2023-07-01-Preview に適用されます。 このバージョンはサポートされなくなりました。 新しいバージョンにすぐに アップグレードします。

大事な

2023-07-01-Preview vectorIndexSize インデックスにスコープが追加されます。

インデックス統計の取得 操作では、現在のインデックスのドキュメント数と、インデックス全体で使用されるストレージの合計量と、そのベクター データによって消費されるストレージの量が返されます。 検索サービスには、サービス統計の取得によって報告されるベクター ストレージの量 全体的な制限があります。 "vectorIndexSize" メトリックは、現在の検索インデックスのベクター フィールドに使用されるベクター ストレージの量を示します。

手記

ドキュメント数とストレージ サイズに関する統計は、リアルタイムではなく数分ごとに収集されます。 そのため、この API によって返される統計には、最近のインデックス作成操作による変更が反映されない場合があります。

GET https://[service name].search.windows.net/indexes/[index name]/stats?api-version=[api-version]  
  Content-Type: application/json  
  api-key: [admin key]   

URI パラメーター

パラメーター	形容
サービス名	必須。 この値を、検索サービスの一意のユーザー定義名に設定します。
インデックス名	必須。 要求 URI は、統計を返すインデックスの名前を指定します。
api-version	必須。 その他のバージョンについては、API のバージョン を参照してください。

要求ヘッダー

次の表では、必須の要求ヘッダーと省略可能な要求ヘッダーについて説明します。

田畑	形容
Content-Type	必須。 この値を application/json に設定します
api-key	Azure ロール 使用していて、要求にベアラー トークンが提供されている場合は省略可能。それ以外の場合はキーが必要です。 API キーは、検索サービスに対する要求を認証する一意のシステム生成文字列です。 オブジェクト定義の要求を取得するには、(クエリ キーではなく) 管理者キーに設定された API キー フィールドを含める必要があります。 詳細については、「キー認証 を使用して Azure AI Search に接続する」を参照してください。

要求本文

何一つ。

応答

状態コード: "200 OK" が返され、応答が成功します。 応答本文の形式は次のとおりです。

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

インデックスにベクター フィールドがない場合、"vectorIndexSize" は 0 です。

関連項目

• Azure AI Search REST API
• サービスの制限