Count Documents (Azure AI Search REST API)
Count Documents 操作は、検索インデックス内のドキュメントの数を取得します。
$count
構文は、OData プロトコルの一部です。
GET https://[service name].search.windows.net/indexes/[index name]/docs/$count?api-version=[api-version]
Content-Type: application/json
api-key: [admin or query key]
URI パラメーター
パラメーター | 説明 |
---|---|
サービス名 | 必須。 検索サービスの一意のユーザー定義名に設定します。 |
インデックス名 | 必須。 要求 URI 内の [index name] は、指定したインデックスのドキュメント コレクション内のすべてのアイテムの数を返すようにサービスに指示します。 |
api-version | 必須。 サポートされている バージョンの 一覧については、「API のバージョン」を参照してください。 |
要求ヘッダー
次の表では、必須と省略可能の要求ヘッダーについて説明します。
フィールド | 説明 |
---|---|
Content-Type | 必須。
application/json
|
api-key |
Azure ロールを使用している場合は省略可能。それ以外の場合はキーが必要です。
ドキュメント数要求では、 の管理キーまたはクエリ キーapi-key を指定できます。 詳細については、「 キー認証を使用して Azure AI Search に接続 する」を参照してください。 |
要求本文
[なし] :
Response
状態コード: 応答の成功に対して「200 OK」が返されます。
応答本文には、プレーン テキスト形式の整数として、カウント値が含まれます。
こちらもご覧ください
Azure AI Search REST API
HTTP 状態コード
Azure AI Search の OData 式の構文
検索結果