Примечание.
Для доступа к этой странице требуется авторизация. Вы можете попробовать войти или изменить каталоги.
Для доступа к этой странице требуется авторизация. Вы можете попробовать изменить каталоги.
Конечная точка:POST https://api.microsoft.ai/v3/search/videos
Пример запроса:
curl -X POST "https://api.microsoft.ai/v3/search/videos" \
-H "host: api.microsoft.ai" \
-H "x-apikey: <Your key>" \
-H "content-type: application/json" \
-d '{
"query": "cute puppy videos",
"maxResults": 30,
"language": "en",
"region": "US"
}'
Parameters
| Parameter | Required | Type | Default | Description |
|---|---|---|---|---|
| query | Yes | string | - | Строка запроса поиска. Максимальная длина — 1000 символов. |
| максимальноеКоличествоРезультатов | No | integer | 30 | Максимальное количество возвращаемых результатов. Значение по умолчанию равно 30, а максимальное — 30. |
| language | No | string | "en" | 2-буквенный код ЯЗЫКА ISO 639-1 для языка интерфейса в результатах поиска. Полный список см. на поддерживаемых языках . |
| region | No | string | "US" | 2-буквенный код страны или региона, из которого должны поступать результаты (например, "US", "JP", "GB", и т. д.). Полный список см. в поддерживаемых регионах . |
| enablePlaylist | No | boolean | неправда | Указывает, следует ли включать список воспроизведения в ответ. |
| freshness | No | string | - | Диапазон времени для фильтрации результатов на основе даты обнаружения. Поддерживает "week", "month", "year" для относительного времени или интервала даты ISO 8601: "ГГГГ-ММ-ДД/ГГГГ-ММ-ДД" или "ГГГГ-ММ-ДД", или "ГГГГ-ММ-ДДЧЧ:мм:ссЗ/ГГГГ-ММ-DDTHH:мм:ssZ" для диапазона date/datetime. Значение |
| внедренный | No | массив строк | - | Фильтрация видео путем внедрения возможностей. Допустимые значения: "проигрыватель" (имеет внедренный проигрыватель). Если не задано, фильтрация не применяется. |
| резолюция | No | string | - | Фильтрация видео по минимальному разрешению. Значения: "360p", "480p", "720p", "1080p". Если не задано, фильтрация не применяется. |
| safeSearch | No | string | "строгий" | Уровень безопасной фильтрации поиска. Значения: "off", "strict". Значение по умолчанию — "строго". |
| duration | No | string | - | Фильтрация видео по диапазону длительности. Значения: "short" (5 мин), "средний" (5–20 мин), "long"> (<20 мин). Если не задано, фильтрация не применяется. |
Заголовки запроса
| Field | Type | Description |
|---|---|---|
| host | string | Узел для API Microsoft ИИ: api.microsoft.ai |
| x-apikey или authorization | string | Ключ API или маркер доступа Entra ID для проверки подлинности. |
| тип контента | string | Тип MIME текста запроса. Используйте application/json. |
Response
Ответ на видео
| Field | Type | Description |
|---|---|---|
| videoResults | массив videoResult | Список результатов видео. |
| списки воспроизведения | массив playlistResult (необязательно) | Список результатов списка воспроизведения. |
| инструментированиеClickBase | string | Базовый URL-адрес для запросов на связь.
instrumentationSuffix Добавьте значение из элемента результата, чтобы сформировать полный URL-адрес связи. Только для приложений с флагом профиля EnableInstrumentationPing. Примечание. Щелчки пользователей также могут быть зарегистрированы с помощью перенаправления URL-адресов. Если перенаправление включено, действие не требуется для регистрации щелчков пользователей и instrumentationClickBase не будет включено в ответ. Инструкции по настройке см. в руководстве по инструментированию . |
| инструментированиеCitationBase | string | Базовый URL-адрес для запросов ping журнала LLM. Добавьте полезные данные DATA, чтобы сформировать полный URL-адрес ping. Только для приложений с флагом профиля EnableInstrumentationPing. |
| traceId | string | Идентификатор трассировки для отладки. |
Note
playlists — необязательное поле, даже если enablePlaylist задано значение true.
videoResult
| Field | Type | Description |
|---|---|---|
| title | string | Название или имя видео. |
| url | string | Исходный URL-адрес видео. Для пользователей Китая с включенным перенаправлением URL-адресов это поле содержит тот же URL-адрес перенаправления, что clickUrlи . |
| domain | string | Узел назначения для результата. Возвращается только для пользователей Китая с включенным перенаправлением URL-адресов. |
| description | string | Описание видеоконтента. Это предоставляется средством отправки видео или создается LLM. |
| publishedBy | string | Средство отправки или издатель видео. |
| viewCount | long | Количество просмотров видео. |
| summary | string | Сводка по видео, созданному СИ. |
| length | string | Длина видео в формате HH:MM:SS. |
| allowHttpsEmbedding | boolean | Разрешено ли внедрение HTTPS. |
| allowMobileEmbedding | boolean | Разрешено ли внедрение мобильных устройств. |
| embeddingUrl | string | URL-адрес для внедрения видео. |
| lastUpdatedAt | string | Последняя обновленная дата в виде форматируемой строки. |
| bestMomentIndex | integer | Индекс лучшего момента или выделения в видео. |
| Моменты | массив моментов | Массив сегментов и моментов видео. |
| эскизUrl | string | URL-адрес эскиза видео. |
| width | integer | Ширина видео в пикселях. |
| height | integer | Высота видео в пикселях. |
| isAdult | boolean | Указывает, включает ли результат содержимое для взрослых. |
| clickUrl | string | URL-адрес перенаправления, который прокси-сервер щелкает Bing. Присутствует только при включении перенаправления щелчка. |
| инструментированиеSuffix | string | Суффикс для добавления к базе URL-адреса проверки связи инструментирования для этого элемента результата. Используется как значение K для URL-адреса проверки ping инструментирования, так и перенаправления clickUrl . Присутствует при включении проверки пинга инструментирования. |
Note
Некоторые из указанных выше полей являются необязательными— они обслуживаются, если они доступны.
момент
| Field | Type | Description |
|---|---|---|
| title | string | Заголовок сегмента моментов. |
| description | string | Описание того, что происходит в этот момент. |
| startTime | string | Время начала момента в формате "d.hh:mm:ss". |
| endTime | string | Время окончания момента в формате "d.hh:mm:ss". |
| momentUrl | string | Прямой URL-адрес этого конкретного момента в видео. |
Note
moment — необязательный объект ответа. Он недоступен для каждого результата видео.
playlistResult
| Field | Type | Description |
|---|---|---|
| title | string | Название списка воспроизведения. |
| description | string | Описание списка воспроизведения. |
| videos | массив видео | Массив видео в списке воспроизведения. |
Note
playlistResult — необязательный объект ответа.
видео
| Field | Type | Description |
|---|---|---|
| title | string | Заголовок видео. |
| description | string | Описание видео. |
| url | string | URL-адрес видео. |
Коды ошибок
| Код состояния | Категория ошибки | Description | Распространенные причины |
|---|---|---|---|
| 200 | Success | Запрос был выполнен успешно. | - |
| 400 | ошибка запроса | Недопустимые параметры запроса. | Отсутствующие обязательные поля, недопустимые значения параметров, некорректный JSON |
| 401 | Unauthorized | Сбой проверки подлинности или отсутствие. | Недопустимый ключ API, отсутствующий заголовок x-apikey |
| 403 | Forbidden | Допустимые учетные данные, но недостаточно разрешений. | Ключ API не имеет необходимых разрешений |
| 410 | Отсутствует (Gone) | Требуется ПРОТОКОЛ HTTPS. | Запрос, сделанный по протоколу HTTP вместо HTTPS |
| 415 | Неподдерживаемый тип носителя | Тип контента не поддерживается. | Отсутствует или неправильный заголовок типа контента |
| 429 | Слишком много запросов | Превышено ограничение скорости. | Слишком много запросов в период времени |
| 500 | Внутренняя ошибка сервера | Непредвиденная ошибка сервера. | Проблема с временным сервером |
| 503 | Служба недоступна | Служба временно недоступна. | Обслуживание или временный сбой |
| 504 | Тайм-аут шлюза | Истекло время ожидания для запроса. | Время ожидания вышестоящей службы |
Подробные инструкции по обработке ошибок см. в разделе "Обработка ошибок".
См. также:Поиск в Интернете | просмотр | изображений | поиска | новостейв MCP