Краткое руководство. Использование API

Внимание

Из-за объявления об Службы мультимедиа Azure выхода на пенсию Индексатор видео Azure объявляет корректировки функций Индексатора видео Azure. Ознакомьтесь с изменениями, связанными с выходом на пенсию службы мультимедиа Azure (AMS), чтобы понять, что это означает для учетной записи Индексатора видео Azure. Ознакомьтесь с руководством по обновлению и миграции AMS: VI.

Индексатор видео Azure AI объединяет различные технологии искусственного интеллекта аудио и видео, предлагаемые корпорацией Майкрософт, в одну интегрированную службу, что упрощает разработку. Индексатор видео azure ai предназначен для того, чтобы разработчики могли сосредоточиться на использовании технологий ИИ мультимедиа, не беспокоясь о масштабировании, глобальном охвате, доступности и надежности облачных платформ. Api можно использовать для отправки файлов, получения подробных сведений о видео, получения URL-адресов внедренных аналитических сведений, мини-приложений проигрывателя и т. д.

При первом посещении веб-сайта Индексатора видео Azure ai пробная учетная запись создается автоматически. С помощью пробной учетной записи вы получаете несколько минут бесплатного индексирования. Позже можно добавить платную учетную запись. С помощью платного варианта вы платите за индексированные минуты. Дополнительные сведения о доступных учетных записях (пробных и платных вариантах) см. в разделе "Типы учетных записей Индексатора видео Azure".

В этой статье показано, как использовать API индексатора видео в Azure.

Необходимые компоненты

Отправьте файл мультимедиа. Существует два способа:

1. Отправьте файл мультимедиа в URL-адрес выбранного url-адреса (рекомендуется). Вы можете использовать общедоступное сетевое расположение. После отправки файла вы можете проверка, доступен ли файл для AVI, скопировав и вставив его в строку расположения браузера. Если вы можете воспроизвести файл мультимедиа, скорее всего, он также может получить к нему доступ. Если вы хотите защитить расположение хранилища с помощью служба хранилища Azure BLOB-объекта, отправьте файл и получите URL-адрес SAS. Дополнительные сведения о получении безопасного URL-адреса для файла см. в разделе Хранилище BLOB-объектов Azure URL-адреса SAS. Этот URL-адрес используется для копирования файла в индексатор видео Azure AI для индексирования.

2. Отправьте видеофайл массива байтов в тексте запроса. Дополнительные сведения о отправке файла мультимедиа в виде массива байтов в тексте запроса см. в статье "Отправка БОЛЬШОго двоичного объекта с помощью .NET".

Примечание.

Существует ограничение на запрос API в 10 запросов в секунду и до 120 запросов в минуту.

Оформление подписки на API

Внимание

• Необходимо использовать ту же электронную почту, которую вы использовали при регистрации в Индексаторе видео Azure AI.
• Личные учетные записи Google и Майкрософт (Outlook и Live) можно использовать только в качестве пробных учетных записей. Для учетных записей, подключенных к Azure, требуется идентификатор записи.
• На один адрес электронной почты может быть зарегистрирована только одна активная учетная запись. Если пользователь пытается войти с помощью учетной записи user@gmail.com для LinkedIn, а после этого с помощью учетной записи user@gmail.com для Google, отобразится страница с ошибкой о том, что такой пользователь уже существует.
• Ключи должны быть защищены. Их нужно использовать только в серверном коде. Они не должны быть доступны на стороне клиента (в файлах с расширением JS, HTML и т. д.).

1. Войдите напортал разработчика API Индексатора видео в Azure AI.
2. Подпишитесь, выбрав вкладку "Продукты". Затем выберите "Авторизация" и подпишитесь. Новые пользователи автоматически подписываются на API Authorization.
3. Поиск, копирование и сохранение первичных и вторичных ключей. Подписку можно найти в профиле. Первичные и вторичные ключи находятся в разделе "Подписки".
4. Выберите ссылку "Показать " для первичного ключа и вторичного ключа. Скопируйте и вставьте их в текстовый редактор, пока не будете готовы использовать их в файле переменных среды.

Получение маркера доступа с помощью API авторизации

Вы не хотите предоставлять полный доступ каждому пользователю для приложения. Существует несколько уровней доступа для VI.

Уровень	Просмотр видео	Обработка видео	Просмотр проектов	Процессы проектов	Просмотр учетных записей	Управление учетными записями
Средство чтения видео	✔️
Участник видео	✔️	✔️
Средство чтения проектов	✔️		✔️
Участник проекта	✔️	✔️	✔️	✔️
Средство чтения учетных записей	✔️		✔️		✔️
Участник учетной записи	✔️	✔️	✔️	✔️	✔️	✔️

Создание и отправка запроса маркера доступа

subscription-idЗадайте , resource-group-namevi account-name в запросе и задайте scopepermissionType параметр в тексте запроса на нужный уровень доступа.

Например, если вы хотите предоставить пользователю доступ, чтобы они могли работать с проектами, но не могут работать с учетными записями, задайте permissionType для параметра "Участник" и scope "Проект". Укажите projectIdразрешения параметра IF для проекта.

POST https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/Microsoft.VideoIndexer/accounts/{account-name}/generateAccessToken?api-version=2024-01-01

{
  "permissionType": "Reader",
  "scope": "Project",
  "projectId": "07ec9e38d4"
}

Пример ответа

{
  "accessToken": "<jwt token of 1260 characters length>"
}

Дополнительные примеры настройки область и типов разрешений см. в REST API VI.

Приступая к работе с API

Вы готовы начать работу с API. Найдите подробное описание каждого REST API индексатора видео Azure.

Подробный пример использования ключей в файле переменной среды и использования маркеров доступа см. в примере Индексатора видео в Azure AI.

Рекомендации

• Если вы вызываете API, чтобы получить аналитические сведения для выбранного видео, вы получите подробные выходные данные в формате JSON в виде содержимого ответа. Дополнительные сведения о возвращаемом JSON в этой статье.
• Выходные данные JSON, созданные API, содержат Insights и SummarizedInsights элементы. Настоятельно рекомендуется использовать и не использовать InsightsSummarizedInsights (которое присутствует для обратной совместимости).
• Мы не рекомендуем использовать данные непосредственно из папки артефактов для рабочих целей. Артефакты являются промежуточными выходными данными процесса индексирования и являются необработанными выходными данными различных обработчиков ИИ, которые анализируют видео. Схема артефактов может изменяться с течением времени.
• Используйте API получения индекса видео, как описано в статье Get insights и артефакты, созданные API, а неGet-Video-Artifact-Download-Url.