Справочник по REST API поиска изображений

Конечная точка:POST https://api.microsoft.ai/v3/search/images

Пример запроса:

curl -X POST "https://api.microsoft.ai/v3/search/images" \
  -H "host: api.microsoft.ai" \
  -H "x-apikey: <Your key>" \
  -H 'content-type: application/json' \
  -d '{
    "query": "cats",
    "maxResults": 2,
    "language": "en",
    "region": "US"
  }'

Parameters

Parameter Required Type Default Description
query Yes string - Строка запроса поиска. Максимальная длина — 1000 символов.
maxResults No integer 30 Максимальное количество возвращаемых результатов. Значение по умолчанию равно 30, а максимальное — 30.
language No string "en" 2-буквенный код ЯЗЫКА ISO 639-1 для языка интерфейса в результатах поиска. Полный список см. на поддерживаемых языках .
region No string "US" 2-буквенный код страны или региона, из которого должны поступать результаты (например, "US", "JP", "CN"). Полный список см. в поддерживаемых регионах .
aspectRatio No string(enum) - Фильтрация изображений по пропорциям. Значения: "квадрат" (примерно 1:1), "широкий" (высота ширины > ), "высокий" (ширина высоты > ). Если не задано, фильтрация не применяется.
color No string(enum) - Фильтрация изображений по цвету изображения. Значения: colorOnly (только возвращаемые цветовые изображения), монохромные (только возвращают черные и белые изображения). Если не задано, фильтрация не применяется.
safeSearch No string(enum) "строгий" Уровень безопасной фильтрации поиска. Значения: "off", "strict". Значение по умолчанию — "строго".
imageSize No string(enum) - Фильтрация изображений по категории размера. Значения: "small" (200x200px), "средний" (ширина или высота 200-500px), "большой" (<ширина или высота >=500px), "extraLarge>" (1024x768px). Можно также использовать ограничения пикселей (maxHeight, minHeight, maxWidth, minWidth) для пользовательских границ; Ограничения пикселей имеют приоритет над imageSize, когда они конфликтуют. Если не задано, фильтрация не применяется.
watermarkFree No boolean неправда Исключите изображения с подложкой. По умолчанию — false.
maxHeight No integer - Максимальная высота изображения в пикселях. Используется с изображениемSize для пользовательских границ.
minHeight No integer - Минимальная высота изображения в пикселях.
maxWidth No integer - Максимальная ширина изображения в пикселях.
minWidth No integer - Минимальная ширина изображения в пикселях.

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

Field Type Description
host string Узел для API Microsoft ИИ: api.microsoft.ai
x-apikey или authorization string Ключ API или маркер доступа Entra ID для проверки подлинности.
тип контента string Тип MIME текста запроса. Используйте application/json.

Response

ImagesResponse

Field Type Description
imageResults массив ImageResult Список результатов изображения.
instrumentationClickBase string Базовый URL-адрес для запросов на связь. instrumentationSuffix Добавьте значение из элемента результата, чтобы сформировать полный URL-адрес связи. Только для приложений с флагом профиля EnableInstrumentationPing. Примечание. Щелчки пользователей также могут быть зарегистрированы с помощью перенаправления URL-адресов. Если перенаправление включено, действие не требуется для регистрации щелчков пользователей и instrumentationClickBase не будет включено в ответ. Инструкции по настройке см. в руководстве по инструментированию .
instrumentationCitationBase string Базовый URL-адрес для запросов ping журнала LLM. Добавьте полезные данные DATA, чтобы сформировать полный URL-адрес ping. Только для приложений с флагом профиля EnableInstrumentationPing.
traceId string Идентификатор трассировки для отладки и отслеживания.

ImageResult

Field Type Description
title string Заголовок изображения.
url string Исходный URL-адрес изображения. Для пользователей Китая с включенным перенаправлением URL-адресов это поле содержит тот же URL-адрес перенаправления, что clickUrlи .
domain string Узел назначения для результата. Возвращается только для пользователей Китая с включенным перенаправлением URL-адресов.
hostPageUrl string URL-адрес веб-страницы, на котором размещен образ.
caption string Созданное описание изображения.
width integer Ширина изображения в пикселях.
height integer Высота изображения в пикселях.
thumbnailUrl string URL-адрес источника эскиза изображения.
lastUpdatedAt string Последняя обновленная дата изображения следует ISO8601 формате.
isAdult boolean Указывает, является ли содержимое контентом для взрослых.
clickUrl string URL-адрес перенаправления, который прокси-сервер щелкает Bing. Присутствует только при включении перенаправления щелчка.
instrumentationSuffix string Суффикс для добавления к базе URL-адреса проверки связи инструментирования для этого элемента результата. Используется как значение K для URL-адреса проверки ping инструментирования, так и перенаправления clickUrl . Присутствует при включении проверки пинга инструментирования.

Коды ошибок

Код состояния Категория ошибки Description Распространенные причины
200 Success Запрос был выполнен успешно. -
400 ошибка запроса Недопустимые параметры запроса. Отсутствующие обязательные поля, недопустимые значения параметров, некорректный JSON
401 Unauthorized Сбой проверки подлинности или отсутствие. Недопустимый ключ API, отсутствующий заголовок x-apikey
403 Forbidden Допустимые учетные данные, но недостаточно разрешений. Ключ API не имеет необходимых разрешений
410 Отсутствует (Gone) Требуется ПРОТОКОЛ HTTPS. Запрос, сделанный по протоколу HTTP вместо HTTPS
415 Неподдерживаемый тип носителя Тип контента не поддерживается. Отсутствует или неправильный заголовок типа контента
429 Слишком много запросов Превышено ограничение скорости. Слишком много запросов в период времени
500 Внутренняя ошибка сервера Непредвиденная ошибка сервера. Проблема с временным сервером
503 Служба недоступна Служба временно недоступна. Обслуживание или временный сбой
504 Тайм-аут шлюза Истекло время ожидания для запроса. Время ожидания вышестоящей службы

Подробные инструкции по обработке ошибок см. в разделе "Обработка ошибок".

См. также:Поисквидео | в Интернете | обзор | поиска новостей | MCP

  • Последнее обновление: