你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

(Azure AI 搜索 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 角色，则为可选，否则需要密钥。 Count Documents 请求可以为 指定管理密钥或查询密钥api-key。 有关详细信息 ，请参阅使用密钥身份验证连接到 Azure AI 搜索 。

请求正文

无。

响应

对于成功的响应，返回“状态代码：200 正常”。

响应正文以纯文本格式的整数形式包含计数值。

另请参阅

Azure AI 搜索 REST API
HTTP 状态代码
Azure AI 搜索的 OData 表达式语法
搜索结果