Documents - Get

Служба:

Search Service

Версия API:

2023-11-01

Извлекает документ из индекса.

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-адрес конечной точки службы поиска.
indexName	path	True	string	Имя индекса.
key	path	True	string	Ключ извлекаемого документа.
api-version	query	True	string	Версия API клиента.
$select	query		string[]	Список имен полей, извлекаемых для документа; В возвращаемом документе не будет отсутствовать любое поле, не полученное.

Заголовок запроса

Имя	Обязательно	Тип	Описание
x-ms-client-request-id		string uuid	Идентификатор отслеживания, отправленный с запросом на помощь в отладке.

Ответы

Имя	Тип	Описание
200 OK	LookupDocument	Ответ, содержащий запрошенный документ.
Other Status Codes	SearchError	Ответ об ошибке.

Примеры

SearchIndexGetDocument

Образец запроса

HTTP

GET https://myservice.search.windows.net/indexes('myindex')/docs('1')?$select=docId,title,description&api-version=2023-11-01

Пример ответа

Код состояния:

200

{
  "description": "Cheapest hotel in town",
  "docId": "1",
  "title": "Nice Hotel"
}

Определения

SearchError

Описывает условие ошибки для API.

Имя	Тип	Описание
code	string	Один из определяемого сервером набора кодов ошибок.
details	SearchError[]	Массив сведений о конкретных ошибках, которые привели к этой сообщаемой ошибке.
message	string	Удобочитаемое представление ошибки.