Распространенные заголовки HTTP-запросов и ответов (Поиск ИИ Azure)
Статья
ИНТЕРФЕЙСы REST API поиска ИИ Azure поддерживают набор распространенных заголовков HTTP-запросов и ответов, приведенных здесь для справки:
Заголовок запроса
Тип
Описание
Принять
Тип содержимого
Запрошенный тип содержимого ответа. Значение по умолчанию — application/json;odata.metadata=minimal. Другие допустимые значения: application/json, application/json; odata.metadata=full, application/json; odata.metadata=none и text/plain (только для $count).
Маркер доступа OAuth 2.0 для запроса. Требуется настройка службы поиска для доступа на основе ролей. Этот заголовок запроса предназначен для клиентских приложений, использующих Microsoft Entra ID проверки подлинности и назначения ролей. Код клиента должен предоставить маркер. Этот заголовок запроса можно использовать с любой поддерживаемой версией REST API, если служба поиска настроена для проверки подлинности плоскости данных.
Content-Type
Content-Type
Тип содержимого текста запроса (PUT или POST). По умолчанию — application/json.
client-request-id
GUID
Необязательный идентификатор запроса, указанный вызывающим абонентом, в виде GUID без оформления, например фигурные скобки (например, client-request-id: 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0). Определяемое вызывающим объектом значение, по которому можно идентифицировать данный запрос. Если указано, это значение включается в сведения об ответе для сопоставления запроса.
OData-MaxVersion
"4.0"
Задает максимальную версию протокола OData, поддерживаемую клиентом. Значение по умолчанию — "4.0".
Prefer
"return=representation" или "return=minimal"
Используется для управления полезными данными ответа от запросов PUT и POST /indexes. По умолчанию используется значение "return=representation" при создании нового индекса с помощью POST или PUT и "return=minimal" для обновления существующего индекса с помощью PUT.
return-client-request-id
Значение true или false
Если этот параметр указан, когда задан client-request-id, сервер включает в ответ заголовок client-request-id. Значение по умолчанию — False.
If-Match
ETag или *
Используется для изменения ресурса, только если текущая версия соответствует указанному ETag. Используйте этот заголовок с методами POST, PUT или DELETE для ресурсов (таких как индексаторы, индексы и источники данных, но не документы), чтобы обеспечить управление оптимистическим параллелизмом.
If-None-Match
ETag или *
Используется для изменения ресурса, только если текущая версия не соответствует указанному ETag. Используйте этот заголовок с методами POST, PUT или DELETE для ресурсов (таких как индексаторы, индексы и источники данных, но не документы), чтобы обеспечить управление оптимистическим параллелизмом.
Заголовок ответа
Тип
Описание
client-request-id
GUID
Идентификатор, указанный вызывающим объектом в исходном запросе, если он имеется.
Content-Type
Content-Type
Тип содержимого текста ответа.
Расположение
URL-адрес
URL-адрес только что созданного определения индекса для запросов POST и PUT /indexes.
OData-Version
"4.0"
Версия протокола OData ответа.
request-id
GUID
Уникальный идентификатор текущей операции. Равен client-request-id, если указан; в противном случае значение создается на сервере.
elapsed-time
Число
Время в миллисекундах, затраченное службой на обработку запроса. Это значение включает только время, затраченное на обработку запроса, и не включает время передачи по сети.
ETag
Строка
Непрозрачная строка, представляющая текущую версию ресурса (возвращается для индексаторов, индексов и источников данных, но не для документов). Используйте эту строку в заголовке If-Match или If-None-Match для управления оптимистическим параллелизмом.