Примечание.
Для доступа к этой странице требуется авторизация. Вы можете попробовать войти или изменить каталоги.
Для доступа к этой странице требуется авторизация. Вы можете попробовать изменить каталоги.
API Azure AI Search REST поддерживают набор общих заголовков HTTP-запросов/ответов, которые приведены здесь для справки:
| Заголовок запроса | Тип | Description |
|---|---|---|
| Принять | Тип контента | Тип запрошенного контента для ответа. По умолчанию — application/json; odata.metadata=minimal. Другие допустимые значения: application/json, application/json; odata.metadata=full, application/json; odata.metadata=none, и текст/обычный (только для $count). |
| API-ключ | String | Задайте ключ запроса или администратора, в зависимости от API. |
| авторизация | String | Токен доступа OAuth 2.0 для запроса. Требуется настройка вашего поискового сервиса для доступа по ролям. Этот заголовок запроса предназначен для клиентских приложений, использующих аутентификацию Microsoft Entra ID и назначение ролей. Ваш клиентский код должен содержать токен. Вы можете использовать этот заголовок запроса с любой поддерживаемой версией REST API, если сервис поиска настроен на аутентификацию на плоскости данных. |
| Тип контента | Тип контента | Тип запроса контента (PUT/POST). Нужно настроить на application/json. |
| идентификатор-запроса-клиента | ГУИД | Необязательный идентификатор запроса, указанный вызывающим, в виде интерфейса без украшений, например, завитых брекетов (например, идентификатор запроса клиента: 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0). Значение, определённое вызывающим, которое идентифицирует заданный запрос. Если указано, это значение включается в информацию о ответе как способ отображения запроса. |
| OData-MaxVersion | "4.0" | Указывает максимальную версию протокола OData, поддерживаемую клиентом. По умолчанию — «4.0». |
| Возможно, предпочтительно | "return=представление" или "return=минимальное" | Используется для управления полезной нагрузкой на ответ от запросов PUT и POST /indexes. По умолчанию «return=representation» при создании нового индекса с помощью POST или PUT, а «return=minimal» — для обновления существующего индекса через PUT. |
| return-client-request-id | Истина или Ложь | Если указано при указании client-request-id, сервер инструктирует включить заголовок client-request-id в ответ. По умолчанию — False. |
| If-Match | ETag или * | Используется для изменения ресурса только если текущая версия соответствует указанному ETag. Используйте этот заголовок с методами POST, PUT или DELETE на ресурсах (таких как индексеры, индексы и источники данных, но не документы), чтобы обеспечить оптимистичный контроль параллелизма. |
| If-None-Match | ETag или * | Используется для изменения ресурса только если текущая версия не соответствует указанному ETag. Используйте этот заголовок с методами POST, PUT или DELETE на ресурсах (таких как индексеры, индексы и источники данных, но не документы), чтобы обеспечить оптимистичный контроль параллелизма. |
| Заголовок ответа | Тип | Description |
|---|---|---|
| идентификатор-запроса-клиента | ГУИД | Идентификатор, указанный вызывающим в исходном запросе, если он присутствует. |
| Тип контента | Тип контента | Тип содержания ответного тела. |
| Местоположение | URL | URL нового определения индекса для запросов POST и PUT /indexes. |
| OData-Version | "4.0" | Версия протокола OData ответа. |
| request-id | ГУИД | Уникальный идентификатор для текущей операции. Равно client-request-id, если указано; в противном случае значение генерируется на сервере. |
| Прошедшее время | Number | Время, в миллисекундах, которое сервис потратил на обработку запроса. Это значение включает только время, потраченное на обработку запроса, и не включает время передачи сети. |
| ETag | String | Непрозрачная строка, представляющая текущую версию ресурса (возвращаемую для индексаторов, индексов и источников данных, но не для документов). Используйте эту строку в заголовке If-Match или If-None-Match для оптимистичного контроля параллелизма. |