你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Documents - Get
从索引中检索文档。
GET {endpoint}/indexes('{indexName}')/docs('{key}')?api-version=2023-11-01
GET {endpoint}/indexes('{indexName}')/docs('{key}')?$select={$select}&api-version=2023-11-01
URI 参数
名称 | 在 | 必需 | 类型 | 说明 |
---|---|---|---|---|
endpoint
|
path | True |
string |
搜索服务的终结点 URL。 |
index
|
path | True |
string |
索引的名称。 |
key
|
path | True |
string |
要检索的文档的键。 |
api-version
|
query | True |
string |
客户端 API 版本。 |
$select
|
query |
string[] |
要为文档检索的字段名称列表;返回的文档中将缺少任何未检索到的字段。 |
请求头
名称 | 必需 | 类型 | 说明 |
---|---|---|---|
x-ms-client-request-id |
string uuid |
随请求一起发送以帮助调试的跟踪 ID。 |
响应
名称 | 类型 | 说明 |
---|---|---|
200 OK |
Lookup |
包含所请求文档的响应。 |
Other Status Codes |
错误响应。 |
示例
SearchIndexGetDocument
示例请求
GET https://myservice.search.windows.net/indexes('myindex')/docs('1')?$select=docId,title,description&api-version=2023-11-01
示例响应
{
"description": "Cheapest hotel in town",
"docId": "1",
"title": "Nice Hotel"
}
定义
SearchError
描述 API 的错误条件。
名称 | 类型 | 说明 |
---|---|---|
code |
string |
服务器定义的一组错误代码中的一个。 |
details |
有关导致此项报告错误的特定错误的详细信息数组。 |
|
message |
string |
错误的用户可读表示形式。 |