Documents - Get

Служба:

Search Service

Версия API:

2024-11-01-preview

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

GET {endpoint}/indexes('{indexName}')/docs('{key}')?api-version=2024-11-01-preview

С использованием необязательных параметров:

GET {endpoint}/indexes('{indexName}')/docs('{key}')?$select={$select}&api-version=2024-11-01-preview

Параметры 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	ErrorResponse	Ответ на ошибку.

Примеры

SearchIndexGetDocument

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

HTTP

GET https://previewexampleservice.search.windows.net/indexes('preview-test')/docs('1')?$select=id,description,name,category,ownerId&api-version=2024-11-01-preview

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

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

200

{
  "id": "1",
  "name": "test",
  "description": "test1 hello",
  "category": "purple",
  "ownerId": "sam"
}

Определения

Имя	Описание
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Ответ на ошибку

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Дополнительный тип сведений.

ErrorDetail

Сведения об ошибке.

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorResponse

Ответ на ошибку

Имя	Тип	Описание
error	ErrorDetail	Объект ошибки.