快速入门：使用 API

  • 项目

重要

由于Azure 媒体服务停用公告，Azure AI 视频索引器会宣布 Azure AI 视频索引器功能调整。 请参阅 与 Azure 媒体服务（AMS）停用 相关的更改，了解 Azure AI 视频索引器帐户的含义。 请参阅 AMS 停用准备：VI 更新和迁移指南。

Azure AI 视频索引器在一个集成式服务中整合了 Microsoft 提供的多种音频和视频人工智能 (AI) 技术，使开发变得更简单。 Azure AI 视频索引器旨在使开发人员能够专注于使用媒体 AI 技术，而无需担心云平台的规模、全球覆盖、可用性和可靠性。 可以使用 API 上传文件、获取详细的视频见解、获取可嵌入见解的 URL、播放器小组件等。

首次访问 Azure AI 视频索引器网站时，系统会自动创建一个试用帐户。 使用试用帐户，可以获取一些免费索引分钟数。 稍后可以添加付费帐户。 对于付费选项，需要为索引分钟数付费。 有关可用帐户（试用和付费选项）的详细信息，请参阅 Azure AI 视频索引器帐户类型。

本文介绍如何使用 Azure AI 视频索引器 API。

先决条件

上传媒体文件。 有两种方法：

  1. 将媒体文件上传到所选 URL（建议）。 可以使用公用网络位置。 上传文件后，可以通过复制文件并将其粘贴到浏览器的位置栏中来检查是否可供 AVI 访问。 如果可以播放媒体文件，则 VI 可能也可以访问它。 若要使用 Azure 存储 Blob 保护存储位置，请上传文件并获取 SAS URL。 有关获取文件的安全 URL 的详细信息，请参阅Azure Blob 存储 SAS URL。 此 URL 用于将文件复制到 Azure AI 视频索引器进行索引。

  2. 将视频文件发送到请求正文中的字节数组。 有关在请求正文中将媒体文件作为字节数组上传的详细信息，请参阅 使用 .NET 上传 Blob。

注意

API 请求限制为每秒 10 个请求或每分钟最多 120 个请求。

订阅 API

重要

  • 注册 Azure AI 视频索引器时必须使用所用的相同电子邮件。
  • 个人 Google 和 Microsoft (Outlook/Live) 帐户只能用作试用帐户。 连接到 Azure 的帐户需要 Entra ID。
  • 只能为每个电子邮件地址提供一个活动帐户。 如果用户尝试使用 user@gmail.com 登录到 LinkedIn，然后又使用 user@gmail.com 登录到 Google，则后一次登录时会显示错误页，指出该用户已存在。
  • 密钥应受到保护。 密钥应仅供服务器代码使用。 在客户端（js、.html 等）应该不可使用密钥。
  1. 登录到Azure AI 视频索引器 API 开发人员门户。
  2. 选择“产品”选项卡进行订阅。然后选择“授权”并订阅。 新用户已自动订阅“授权”。
  3. 查找、复制和保存主密钥和辅助密钥。 可以在配置文件中找到订阅。 主密钥和辅助密钥位于“订阅”部分。
  4. 为主密钥和辅助密钥选择“显示”链接。 将它们复制并粘贴到文本编辑器，直到准备好在环境变量文件中使用这些编辑器。

使用授权 API 获取访问令牌

你不希望为应用程序授予每个用户的完全访问权限。 VI 有多个级别的访问权限。

Level 查看视频 处理视频 查看项目 处理项目 查看帐户 管理客户
视频阅读器 ✔
视频参与者 ✔ ✔
项目读取器 ✔ ✔
项目参与者 ✔ ✔ ✔ ✔
帐户读取者 ✔ ✔ ✔
帐户参与者 ✔ ✔ ✔ ✔ ✔ ✔

创建和发送访问令牌请求

设置subscription-id请求中的 VIaccount-name，并将请求正文中的 and permissionType 参数设置为scoperesource-group-name所需的访问级别。

例如，如果要提供对用户的访问权限，以便他们可以处理项目，但无法使用帐户，请将 permissionType “参与者”和 scope “项目”设置为“项目”。如果为项目设置权限，请提供 projectId。


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>"
}

有关设置范围和权限类型的更多示例，请参阅 VI REST API。

开始使用 API

你已准备好开始使用 API。 查找每个 Azure AI 视频索引器 REST API 的详细说明。

有关在环境变量文件中使用密钥以及使用访问令牌的详细示例，请参阅 Azure AI 视频索引器 示例。

建议