Media Intelligenceの概要

Prev Next

VPC環境で利用できます。

Media Intelligenceは、従来手動で操作していたメディア(映像、写真)分析を自動化した NAVERクラウドプラットフォームのメディア AI分析サービスです。Media Intelligenceサービスは、プロジェクト管理、メディアアセットの管理・分析、インデックス管理関連の APIを RETSTful形式で提供します。

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)からの経過時間(ミリ秒)
  • API Gatewayサーバとの時間差が5分以上の場合は無効なリクエストとみなす
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 リクエストデータの形式
  • application/json

レスポンス

共通レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

responseError
responseErrorは API呼び出し失敗情報を定義します。responseErrorの説明は次の通りです。

フィールド タイプ 必須の有無 説明
code String Required エラーコード
message String Required エラーメッセージ

レスポンスステータスコード

レスポンスステータスコードの説明は次の通りです。

レスポンスステータスコード

レスポンスステータスコードの説明は次の通りです。

HTTPステータスコード コード メッセージ 説明
200 0 success リクエスト処理成功
400 10001 Invalid Request. リクエストパラメータエラー
400 10014 Select the asset you want to analyze. 分析対象のメディアがない
400 10016 Select the bucket to integrate (folder selection not available). フォルダ項目は登録不可
400 10023 You can request up to 10 assets 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 assetIds should be provided, not both. projectIdsまたは assetIdsのいずれか一方のみ提供すること
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 asset file does not exist. メディアアセットファイルが存在しない
404 10025 The project does not exist. プロジェクトが存在しない
404 10030 The workspace does not exist. ワークスペースが存在しない
404 10038 Unanalyzed assets can't be canceled. 分析されていないアセットはキャンセルできない
404 40002 The asset 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 asset. メディアアセットを分析中
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についてユーザーの理解に役立つよう、さまざまな関連リソースを提供しています。