インデックスの詳細照会

Prev Next

VPC環境で利用できます。

メディアアセットのインデックスの詳細情報を照会します。

リクエスト

メソッド URI
GET /api/v1/workspaces/{workspace_name}/projects/{project_id}/assets/{asset_id}/indexes/{index_id}

リクエストヘッダ

Media Intelligence APIで共通して使用されるヘッダの詳細は、Media Intelligenceのリクエストヘッダをご参照ください。

リクエストパスパラメータ

パラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
workspace_name String Required ワークスペース名
project_id String Required プロジェクト ID
asset_id String Required メディアアセット ID
index_id String Required インデックス ID

リクエストクエリパラメータ

リクエストクエリパラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
confidence_level String Optional 信頼度に基づいた絞り込み条件
  • LOW | MEDIUM (デフォルト) | HIGH
    • LOW: 信頼度が低い検出結果を表示(より多くのキーワードを抽出)
    • MEDIUM: 信頼度が中の検出結果を表示(適度なキーワードを抽出)
    • HIGH: 信頼度が高い検出結果を表示(正確なキーワードを抽出)

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request GET 'https://mi.apigw.ntruss.com/api/v1/workspaces/my-workspace/projects/1234/assets/5678/indexes/1001?confidence_level=MEDIUM' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json'

レスポンス

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
code String Required API処理結果コード
message String Required API処理結果メッセージ
result Object Required 分析結果
result.indexId Integer Required メディアアセット ID
result.type String Required アセットタイプ
  • IMAGE | VIDEO
    • IMAGE: 画像
    • VIDEO: ビデオ
result.createdTime String Required インデックスの作成日時
  • ISO 8601形式
result.createdUserName String Required インデックスを作成したユーザー名
result.updatedTime String Required インデックスの最終更新日時
  • ISO 8601形式
result.updatedUserName String Required インデックスを最後に更新したユーザー名
result.analysisSetting Object Required 分析設定情報
result.analysisSetting.analysisEngine String Required 分析エンジンバージョン
  • Sinossi v1.0
result.analysisSetting.sceneRange String Optional (ビデオ分析時)自動で分割されるシーンの長さ
  • SHORT | MEDIUM (デフォルト) | LONG
    • SHORT(短く): 短い単位で細かく分割してビデオ内の詳細なシーンを精密分析
    • MEDIUM(通常): シーン間の適切な流れを維持しながら、主要な変化を捉える
    • LONG(長く): シーン間の連続性を高め、自然な流れを維持
  • 画像アセットは nullと表示
result.analysisSetting.analysisPersonCount Integer Required 分析時に検出する人物の数
result.analysisSetting.analysisLanguage String Optional ビデオ分析時の基準となる言語
  • このフィールドは今後削除される予定 (代替フィールド: sourceLanguage)
result.analysisSetting.sourceLanguage String Required 分析対象ソースビデオの言語情報
  • ENKO (デフォルト) | EN | KO | JA | ZH-CN | ZH-TW
    • ENKO: 韓国語 + 英語
    • EN: 英語
    • KO: 韓国語
    • JA: 日本語
    • ZH-CN: 中国語 (簡体字)
    • ZH-TW: 中国語 (繁体字)
result.analysisSetting.detectAudioEffects Boolean Optional (ビデオ分析時)分析時に設定した音声効果を追加するかどうか
  • truefalse (デフォルト)
    • true: 有効化すると検出された音声効果に対するキーワードを追加
result.indexDetails Object Required インデックス内容情報
result.indexDetails.durationMs Integer Optional (ビデオ分析時)ビデオの長さ (ミリ秒)
  • 画像アセットは0と表示
result.indexDetails.fps Integer Optional (ビデオ分析時)1秒当たりのフレーム数
  • 画像アセットは0と表示
result.indexDetails.frameCount Integer Optional (ビデオ分析時)フレームの総数
  • 画像アセットは0と表示
result.indexDetails.assetUrl String Required メディアアセットソース URL
result.indexDetails.segments Array Required セグメントリスト

result.indexDetails.segments

フィールド タイプ 必須の有無 説明
start Integer Optional (ビデオ分析時)セグメントの開始フレーム番号
  • 0からスタート
  • 画像アセットは0と表示
end Integer Optional (ビデオ分析時)セグメントの終了フレーム番号
  • 画像アセットは0と表示
startMs Integer Optional (ビデオ分析時)セグメントの開始時間(ミリ秒)
  • 画像アセットは0と表示
endMs Integer Optional (ビデオ分析時)セグメントの終了時間(ミリ秒)
  • 画像アセットは0と表示
scene Integer Optional (ビデオ分析時)シーン番号
  • 画像アセットは0と表示
shot Integer Optional (ビデオ分析時)ショット番号
  • 画像アセットは0と表示
sceneThumbnailUrl String Optional (ビディ分析時)サムネイル画像 URL
  • (有効時間は1時間)
speeches Array Optional 発話情報
keywords Array Required キーワード情報
people Array Required 登場人物情報

result.indexDetails.segments.speeches

フィールド タイプ 必須の有無 説明
id Integer Optional 発話 ID
startMs Integer Optional 発話開始時間(ミリ秒)
endMs Integer Optional 発話終了時間(ミリ秒)
text String Optional 発話内容
pid String Optional 人物 ID
name String Optional 人物名

result.indexDetails.segments.keywords

フィールド タイプ 必須の有無 説明
category String Optional キーワードカテゴリ
group String Optional キーワードグループ
text String Optional キーワードテキスト
score Integer Optional キーワード信頼度スコア

result.indexDetails.segments.people

フィールド タイプ 必須の有無 説明
name String Optional 人物名
pid String Optional 人物 ID
img String Optional 画像 URL

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

Media Intelligence APIで共通して使用されるレスポンスステータスコードの詳細は、Media Intelligenceのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "code": "0",
    "message": "success",
    "result": {
        "indexId": 1001,
        "type": "VIDEO",
        "createdTime": "2025-04-24T16:42:00",
        "createdUserName": "username",
        "updatedTime": "2025-04-24T16:43:08",
        "updatedUserName": "username",
        "analysisSetting": {
            "analysisEngine": "Sinossi v1.0",
            "sceneRange": "MEDIUM",
            "analysisPersonCount": 2,
            "analysisLanguage": "ENKO"
            "sourceLanguage": "ENKO",
            "detectAudioEffects": true    
        },
        "indexDetails": {
            "durationMs": 20054,
            "fps": 29.97,
            "frameCount": 601,
            "assetUrl": "https://kr.object.ncloudstorage.com/maiu-my-storage/videos/1234/interview.mp4",
            "segments": [
                {
                    "start": 0,
                    "end": 275,
                    "startMs": 0,
                    "endMs": 9176,
                    "scene": 1,
                    "shot": 1,
                    "sceneThumbnailUrl": "https://kr.object.ncloudstorage.com/.../1234/1.jpg?X-Amz-..."
                    "speeches": [
                        {
                            "id": 180080,
                            "startMs": 679,
                            "endMs": 10195,
                            "text": "こんにちは。本日はインタビューにご協力いただき、ありがとうございます。",
                            "pid": "1",
                            "name": "話者1"
                        }
                    ],
                    "keywords": [
                        {
                            "category": "行動",
                            "group": "事務/オーフィス/イベント",
                            "text": "ニュースキャスター",
                            "score": 87.23
                        },
                        {
                            "category": "ビデオ制作技法",
                            "group": "撮影技法",
                            "text": "インタビュー",
                            "score": 85.12
                        }
                    ],
                    "people": []
                },
                {
                    "start": 275,
                    "end": 467,
                    "startMs": 9176,
                    "endMs": 15583,
                    "scene": 2,
                    "shot": 2,
                    "sceneThumbnailUrl": "https://kr.object.ncloudstorage.com/.../1234/2.jpg?X-Amz-..."
                    "speeches": [
                        {
                            "id": 180081,
                            "startMs": 10195,
                            "endMs": 20000,
                            "text": "お招きいただきありがとうございます。お会いできて嬉しいです。"
                            "pid": "2",
                            "name": "話者2"
                        }
                    ],
                    "keywords": [
                        {
                            "category": "場所",
                            "group": "商業施設",
                            "text": "放送スタジオ",
                            "score": 80.26
                        }
                    ],
                    "people": [
                        {
                            "name": "人物2",
                            "pid": "9876543210987654321",
                            "img": "https://kr.object.ncloudstorage.com/maiu-my-storage/indexer/1001/people/9876543210987654321.jpg?"
                        }
                    ]
                },
                {
                    "start": 467,
                    "end": 601,
                    "startMs": 15583,
                    "endMs": 20054,
                    "scene": 2,
                    "shot": 3,
                    "sceneThumbnailUrl": "https://kr.object.ncloudstorage.com/.../12345/2.jpg?X-Amz-..."
                    "speeches": [],
                    "keywords": [
                        {
                            "category": "オブジェクト",
                            "group": "ファッション",
                            "text": "腕時計",
                            "score": 85.81
                        }
                    ],
                    "people": [
                        {
                            "name": "人物1",
                            "pid": "1234567890123456789",
                            "img": "https://kr.object.ncloudstorage.com/maiu-my-storage/indexer/1001/people/1234567890123456789.jpg"
                        }
                    ]
                }
            ]
        }
    }
}