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

查找文档 (Azure AI 搜索 REST API)

  • 项目

“查找文档”操作从 Azure AI 搜索检索文档。 当用户单击特定搜索结果并且希望查找关于该文档的特定详细信息时，这很有用。 一次只能获取一个文档。 使用 “搜索文档” 在单个请求中获取多个文档。

GET https://[service name].search.windows.net/indexes/[index name]/docs/key?[query parameters]  
  Content-Type: application/json   
  api-key: [admin or query key]

此外，也可以为键查找使用传统 OData 语法：

GET /indexes/[index name]/docs('[key]')?[query parameters]

URI 参数

参数 说明
服务名称 必需。 将其设置为搜索服务的唯一用户定义名称。
索引名称 必需。 请求 URI 指定要查询的索引的名称。 查询参数在 GET 请求的查询字符串和 POST 请求的请求正文中指定。
key 必需。 一个 Edm.String 值，该值唯一标识索引中的每个文档。 该密钥有时称为文档 ID。 键的值区分大小写。 例如，具有键“abc”的文档不同于键为“ABC”的文档。
查询参数 (query parameters) 包含 (可选) 和 api-version=2020-06-30 () 的多部分构造$select。 对于此操作，api-version 指定为查询参数。
$select=[string] 是要检索的逗号分隔字段的列表。 此子句中只能包含标记为可检索的字段。 如果未指定或设置为 *，会在投影中包含架构中标记为可检索的所有字段。

请求标头

下表介绍必需和可选的请求标头。

字段 说明
Content-Type 必需。 将其设置为 application/json
api-key 如果使用的是 Azure 角色 ，并且请求中提供了持有者令牌，则为可选，否则需要密钥。 api-key 是系统生成的唯一字符串，用于对搜索服务的请求进行身份验证。 获取对象定义的请求必须包含设置为管理密钥 (而不是查询密钥) 的 api 密钥字段。 有关详细信息 ，请参阅使用密钥身份验证连接到 Azure AI 搜索 。

请求正文

无。

响应

成功响应时返回状态代码：“200 正常”。

{   
   field_name: field_value (fields matching the default or specified projection)   
}

示例

查找具有键“2”的文档：

GET /indexes/hotels/docs/2?api-version=2020-06-30

使用 OData 语法查找具有键“3”的文档：

GET /indexes/hotels/docs('3')?api-version=2020-06-30

另请参阅