Documents - Get

Служба:
Search Service
Версия API:
2025-08-01-preview

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

GET {endpoint}/indexes('{indexName}')/docs('{key}')?api-version=2025-08-01-preview
С использованием необязательных параметров: 
GET {endpoint}/indexes('{indexName}')/docs('{key}')?$select={$select}&api-version=2025-08-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)

Идентификатор отслеживания, отправленный вместе с запросом на помощь в отладке.
x-ms-query-source-authorization

string

Маркер, идентифицирующий пользователя, для которого выполняется запрос. Этот маркер используется для применения ограничений безопасности к документам.

Ответы

Имя Тип Описание
200 OK

LookupDocument

Ответ, содержащий запрашиваемый документ.
Other Status Codes

ErrorResponse

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

Примеры

SearchIndexGetDocument

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

GET https://previewexampleservice.search.windows.net/indexes('preview-test')/docs('1')?$select=id,description,name,category,ownerId&api-version=2025-08-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

Объект ошибки.