VPC環境で利用できます。
Media Intelligenceは、従来手動で操作していたビデオ分析を自動化した NAVERクラウドプラットフォームのメディア AI分析サービスです。Media Intelligenceサービスは、プロジェクト管理、ビデオアセットの管理・分析、インデックス管理関連の APIを RETSTful形式で提供します。
サービスの直感性強化のため、Media AI Understanding(MAIU)が Media Intelligenceへと、サービス名を変更しました。既存のデータおよび利用履歴はそのまま維持され、サービス利用に影響はありません。詳細は、Media AI Understandingサービス名およびアクセス経路変更のご案内をご参照ください。
Media Intelligenceの共通設定
Media Intelligence APIで共通して使用されるリクエスト形式とレスポンス形式を説明します。
リクエスト
共通リクエスト形式を説明します。
API URL
リクエスト API URLは次の通りです。
https://mi.apigw.ntruss.com
リクエストヘッダ
リクエストヘッダの説明は次の通りです。
| フィールド | 必須の有無 | 説明 |
|---|---|---|
x-ncp-apigw-timestamp |
Required | 1970年1月1日00:00:00協定世界時(UTC)からの経過時間(ミリ秒)
|
x-ncp-iam-access-key |
Required | NAVERクラウドプラットフォームから発行された Access Key
|
x-ncp-apigw-signature-v2 |
Required | NAVERクラウドプラットフォームから発行された Access Keyとマッピングする Secret Keyと HMAC暗号化アルゴリズム(HmacSHA256)でリクエスト情報を暗号化した後、Base64でエンコードした署名 |
Content-type |
Required | リクエストデータの形式
|
レスポンス
共通レスポンス形式を説明します。
レスポンスボディ
レスポンスボディの説明は次の通りです。
responseError
responseErrorは API呼び出し失敗情報を定義します。responseErrorの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
code |
String | Required | エラーコード |
message |
String | Required | エラーメッセージ |
レスポンスステータスコード
レスポンスステータスコードの説明は次の通りです。
レスポンスステータスコード
レスポンスステータスコードの説明は次の通りです。
| HTTPステータスコード | コード | メッセージ | 説明 |
|---|---|---|---|
| 200 | 0 | success | リクエスト処理成功 |
| 400 | 10001 | Invalid Request. | リクエストパラメータエラー |
| 400 | 10014 | Select the video you want to analyze. | 分析対象のビデオがない |
| 400 | 10016 | Select the bucket to integrate (folder selection not available). | フォルダ項目は登録不可 |
| 400 | 10023 | You can request up to 10 videos at a time. | 登録可能なビデオ数を超過 (最大10個) |
| 400 | 10027 | The base project name can't be changed. | 基本プロジェクト名は変更不可 |
| 400 | 10033 | The base project can't be deleted. | 基本プロジェクトは削除不可 |
| 400 | 10041 | The bucket integration is invalid. Check the bucket information again in the NAVER Cloud Platform console. | 無効なバケット情報 (コンソールにて確認が必要) |
| 400 | 10046 | Failed to set object storage ACL. | Object Storage ACL設定失敗 |
| 400 | 10048 | Check the linked Object Storage settings | Object Storageファイルが存在しない |
| 400 | 50003 | Analyze result not exists. | 分析結果が存在しない |
| 400 | 50010 | Either projectIds or videoAssetIds should be provided, not both. | projectIdsまたは videoAssetIdsのいずれか一方のみ提供すること |
| 400 | 50011 | Either imageQuery or textQuery should be provided, not both. | imageQueryまたは textQueryのいずれか一方のみ提供すること |
| 400 | 50012 | Person query limit reached. You can only pass a maximum of 100 personIds at a time. | 人物 IDは一度に最大100個まで転送可能 |
| 400 | 50013 | Script query limit reached. You can only pass a maximum of 100 scripts at a time. | セリフは一度に最大100個まで転送可能 |
| 400 | 10069 | Please upload a large, clear image of your face, looking straight ahead. | 正面を向いた高解像度の顔画像をアップロードしてください |
| 400 | 10072 | Invalid file format. | 無効なファイル形式 |
| 400 | 10073 | Image crop error. | 画像切り抜きエラー |
| 400 | 10074 | Image cover upload failed. | 画像カバーアップロード失敗 |
| 400 | 10075 | Representative thumbnail not exist. | 代表サムネイルが存在しない |
| 400 | 10077 | Can not delete all thumbnails. | すべてのサムネイルを削除することができない |
| 401 | 10003 | Failed to check permissions. | 権限確認失敗 |
| 404 | 10010 | The video file does not exist. | ビデオファイルが存在しない |
| 404 | 10025 | The project does not exist. | プロジェクトが存在しない |
| 404 | 10030 | The workspace does not exist. | ワークスペースが存在しない |
| 404 | 10038 | Unanalyzed videos can't be canceled. | 分析されていないビデオはキャンセルできない |
| 404 | 40002 | The video analysis job does not exist. | ビデオ分析ジョブが存在しない |
| 409 | 10026 | This project name already exists. | プロジェクト名が既に存在する |
| 409 | 10045 | Can create up to 1,000 items per workspace. | ワークスペースごとの最大作成可能数(1,000個)を超過 |
| 409 | 10049 | The project name exceeds the maximum length(100). | プロジェクト名が最大長さ(100文字)を超過 |
| 409 | 20012 | Exist Workspace Name. | 同一のワークスペース名が存在 |
| 409 | 10062 | Tag already registered. | タグは既に登録される |
| 409 | 10068 | You can register up to 500 items. | 最大登録数(500個)を超過 |
| 409 | 10076 | Primary thumbnail exceeded the limit. | 最大代表サムネイル数を超過 |
| 409 | 50005 | The name is already in use. Please enter a different name. | 名前が既に使用されています。別の名前を入力してください |
| 422 | 10017 | Analyzing video. | ビデオ分析中 |
| 422 | 10072 | Invalid file format. | 無効なファイル形式 |
| 500 | 99999 | An error has occurred. | 内部サーバエラー |
NAVERクラウドプラットフォームで共通して使用されるレスポンスステータスコードの詳細は、Ncloud APIのレスポンスステータスコードをご参照ください。
レスポンス例
呼び出しが成功した場合のレスポンス例は、API仕様書を確認してください。呼び出しに失敗した場合のレスポンスのサンプルコードは次の通りです。
{
"code": "10001",
"message": "Invalid request."
}
Media Intelligence API
Media Intelligenceサービスが提供する APIの説明は次の通りです。
プロジェクトの管理
| API | 説明 |
|---|---|
| プロジェクトの作成 | ビデオアセットと分析結果を管理するスペースであるプロジェクトを作成 |
| プロジェクトリストの照会 | ワークスペースのプロジェクトリストを照会 |
| プロジェクトの詳細照会 | ワークスペースのプロジェクトの詳細情報を照会 |
| プロジェクト情報の更新 | ワークスペースのプロジェクト情報を更新 |
| プロジェクトの削除 | ワークスペースからプロジェクトを削除 |
ビデオアセットの管理
| API | 説明 |
|---|---|
| ビデオアセットの登録 | Object Storageバケットにアップロードしたビデオファイルをプロジェクトに追加 |
| ビデオアセットリストの照会 | プロジェクトのビデオアセットリストを照会 |
| ビデオアセットの詳細照会 | プロジェクトのビデオアセットの詳細情報を照会 |
| ビデオアセット登録状態の照会 | プロジェクトに登録したビデオアセットの状態を照会 |
| ビデオアセットのプロジェクト移動 | ビデオアセットを別のプロジェクトに移動 |
| ビデオアセットの削除 | プロジェクトからビデオアセットを削除 |
ビデオアセットの分析
| API | 説明 |
|---|---|
| ビデオアセット分析のリクエスト | ビデオアセットを分析し、ビデオ分析結果であるインデックスを作成 |
| ビデオアセット分析状態の照会 | プロジェクトに登録したビデオアセットの分析状態を照会 |
| ビデオアセット分析のキャンセル | 実行中ビデオアセット分析リクエストをキャンセル |
インデックスの管理
| API | 説明 |
|---|---|
| インデックスリストの照会 | ビデオアセットのインデックスリストを照会 |
| インデックスの詳細照会 | ビデオアセットのインデックスの詳細情報を照会 |
| インデックスの削除 | ビデオアセットのインデックスを削除 |
人物タブ管理
| API | 説明 |
|---|---|
| 人物タグの登録 | ワークスペースに人物タグを登録 |
| 人物タグリストの照会 | ワークスペースの人物タグリストを照会 |
| 人物タグの削除 | ワークスペースから人物タグを削除 |
人物管理
| API | 説明 |
|---|---|
| 人物の登録 | ワークスペースに新規人物を登録 |
| 人物の詳細照会 | 人物の詳細情報を照会 |
| 人物情報の更新 | 人物名、説明などの情報を更新 |
| 人物更新タグの設定 | 人物にタグを設定 |
| 人物更新タグの削除 | 人物からタグを削除 |
| 人物更新サムネイルの設定 | 人物サムネイルを設定 |
| 人物更新サムネイルの削除 | 人物サムネイルを削除 |
| 人物の削除 | ワークスペースから人物を削除 |
| 人物リストの照会 | ワークスペースの人物リストを照会 |
| サムネイル Presigned URLの発行 | 人物サムネイルアップロードのための Presigned URLを発行 |
| サムネイルアップロード状態の照会 | サムネイルアップロード完了状態を照会 |
シーンの検索
| API | 説明 |
|---|---|
| 検索アセット Presigned URLの発行 | シーン検索のためのクエリアセットアップロード Presigned URLを発行 |
| 検索アセットアップロード状態の照会 | アップロードされたクエリアセットのアップロードは完了したか確認 |
| シーン検索のリクエスト | ビデオ内で条件に合ったシーンを検索 |
| シーン検索結果の照会 | シーン検索リクエストの結果(シーンリスト)を照会 |
Media Intelligence関連リソース
Media Intelligence APIについてユーザーの理解に役立つよう、さまざまな関連リソースを提供しています。
-
Media Intelligence APIの使用方法
- 署名(シグネチャー)の作成: リクエストヘッダに追加する署名の作成方法
- API Gatewayご利用ガイド: リクエストヘッダに追加する API Keyを発行
- Sub Accountご利用ガイド: リクエストヘッダに追加する Access Keyの発行方法
- Ncloudの共通レスポンスステータスコード: Media Intelligenceサービスで使用される NAVERクラウドプラットフォームの共通レスポンスステータスコード情報
-
Media Intelligenceサービスの使用方法
- Media Intelligenceご利用ガイド: NAVERクラウドプラットフォームコンソールにて Media Intelligenceを使用する方法
- Ncloud使用環境ガイド: VPC、Classic環境とサポートの有無に関するご利用ガイド
- 料金の紹介、特徴、詳細機能: Media Intelligenceの料金体系、特徴、詳細機能のサマリー
- サービスのお知らせ: Media Intelligenceに関するお知らせ
- よくある質問: Media Intelligenceに関するよくあるご質問
- お問い合わせ: APIガイドだけでは不明な点が解消されない場合、直接問い合わせ