快速入門：使用 API

Azure AI Video Indexer 會將 Microsoft 提供的各種音訊和視訊人工智慧 (AI) 技術合併成一個整合式服務，讓開發變得更簡單。 Azure AI 影片索引器的設計目的是讓開發人員專注於使用媒體 AI 技術，而不必擔心雲端平臺的規模、全球觸達、可用性和可靠性。 您可以使用 API 來上傳檔案、取得詳細的影片深入解析、取得可內嵌深入解析的 URL、播放器小工具等等。

第一次造訪 Azure AI Video Indexer 網站時，系統會自動為您建立試用帳戶。 使用試用帳戶時，您會取得一些免費的編製索引分鐘數。 您稍後可以新增付費帳戶。 使用付費選項時，您會支付已編製索引的分鐘數。 如需可用帳戶 (試用版和付費選項) 的詳細資料，請參閱 Azure AI Video Indexer 帳戶類型。

本文說明如何使用 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 識別碼。
• 每個電子郵件只能有一個使用中的帳戶。 如果使用者嘗試在使用 LinkedIn 的 user@gmail.com 登入後，然後使用 Google 的 user@gmail.com 登入，則系統會顯示錯誤頁面，表示使用者已存在。
• 金鑰應受到保護。 這些金鑰應只供伺服器程式碼使用。 不應該用於用戶端 (.js、.html 等等)。

1. 登入 Azure AI 影片索引器 API 開發人員入口網站。
2. 選取 [產品] 索引標籤來訂閱。然後，選取 [授權] 並訂閱。 系統會自動完成新使用者的授權訂閱。
3. 尋找、複製和儲存主要和次要金鑰。 您可以在設定檔中找到您的訂用帳戶。 主要和次要金鑰位於 [訂用帳戶 ] 區段中。
4. 選取 [ 主要金鑰] 和 [次要金鑰] 的 [顯示 ] 連結。 複製並貼到文本編輯器，直到您準備好在環境變數檔案中使用它們為止。

使用授權 API 取得存取令牌

您不想為應用程式授與每個使用者的完整存取權。 VI 有數個層級的存取權。

層級	檢視影片	處理影片	檢視專案	處理專案	檢視帳戶	管理帳戶
視訊閱讀程式	✔️
影片參與者	✔️	✔️
項目讀取器	✔️		✔️
項目參與者	✔️	✔️	✔️	✔️
帳戶讀取者	✔️		✔️		✔️
帳戶參與者	✔️	✔️	✔️	✔️	✔️	✔️

建立並傳送存取令牌要求

subscription-id設定 、、 resource-group-name要求中的 VIaccount-name，並將要求主體中的 和 permissionType 參數設定scope為您需要的存取層級。

例如，如果您想要提供使用者的存取權，讓他們可以使用專案，但無法使用帳戶，請將 設定為 [參與者]，並將 scope 設定permissionType為 [專案]。如果設定項目的權限，請提供 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 Video Indexer REST API 的詳細描述。

如需在環境變數檔案中使用密鑰的詳細範例，以及使用存取令牌，請參閱 Azure AI 影片索引器 範例。

建議

• 當您呼叫 API 以取得指定影片的影片深入解析時，取得的回應內容會是詳細的 JSON 輸出。
• API 所產生的 JSON 輸出包含 Insights 和 SummarizedInsights 元素。 強烈建議您使用 Insights，而非 SummarizedInsights (為了提供回溯相容性)。
• 不建議您因生產目的直接在成品資料夾中使用資料。 成品是編製索引程式的中繼輸出，而且是分析影片的各種 AI 引擎的原始輸出。 成品架構可能會隨著時間而變更。
• 使用取得影片索引 API，而不是 Get-Video-Artifact-Download-Url。