Documentation Index

Fetch the complete documentation index at: https://api.ncloud-docs.com/llms.txt

Use this file to discover all available pages before exploring further.

インデックスの照会

Prev Next

VPC環境で利用できます。

メディアアセットの最新のインデックスの詳細情報を照会します。アセットごとに最新のインデックスは1件のみ保持されるため、インデックス IDを指定せずに、アセットの最新のインデックスを照会します。

参考

分析が完了している状態でのみ、インデックスを照会できます。分析が完了していない場合、照会に失敗します。分析の状態は、メディアアセット分析状態の照会で確認できます。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

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

リクエストヘッダ

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

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

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

フィールド タイプ 必須の有無 説明
workspace_name String Required ワークスペース名
project_id String Required プロジェクト ID
asset_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/index?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 - API処理結果コード
message String - API処理結果メッセージ
result Object - 分析結果
result.indexId Integer - インデックス ID
result.type String - アセットのタイプ
  • IMAGE | VIDEO
result.createdTime String - インデックスの作成日時
  • ISO 8601形式
result.createdUserName String - インデックスを作成したユーザー名
result.updatedTime String - インデックスの最終更新日時
  • ISO 8601形式
result.updatedUserName String - インデックスを最後に更新したユーザー名
result.analysisSetting Object - 分析設定情報
result.analysisSetting.analysisEngine String - 分析エンジンバージョン
  • 例: v3.2
result.analysisSetting.sceneRange String Optional (ビデオ分析時)自動的に分割されるシーンの長さ
  • EXTRA_SHORT | SHORT | MEDIUM (デフォルト) | LONG
  • 画像アセットは nullと表示
  • minSceneDurationSec/maxSceneDurationSecで分析した場合、nullと表示
result.analysisSetting.minSceneDurationSec Integer Optional (ビデオ分析時)分析リクエスト時に設定した最小シーン長 (秒)
  • sceneRangeで分析した場合、nullと表示
  • 画像アセットは nullと表示
result.analysisSetting.maxSceneDurationSec Integer Optional (ビデオ分析時)分析リクエスト時に設定した最大シーン長 (秒)
  • sceneRangeで分析した場合、nullと表示
  • 画像アセットは nullと表示
result.analysisSetting.analysisPersonCount Integer - 分析時に検出する人物の数
result.analysisSetting.sourceLanguage String - 分析対象となる元のビデオの言語情報
  • KO (デフォルト) | ENKO | EN | JA | ZH-CN | ZH-TW
result.analysisSetting.detectAudioEffects Boolean Optional (ビデオ分析時)音声効果を追加するか
  • true | false (デフォルト)
result.indexDetails Object - インデックス内容情報
result.indexDetails.durationMs Integer Optional (ビデオ分析時)ビデオの長さ (ミリ秒)
  • 画像アセットは0と表示
result.indexDetails.fps Double Optional (ビデオ分析時)1秒当たりのフレーム数
  • 画像アセットは0と表示
result.indexDetails.frameCount Integer Optional (ビデオ分析時)フレームの総数
  • 画像アセットは0と表示
result.indexDetails.assetUrl String - メディアアセットソース URL
result.indexDetails.segments Array - セグメントリスト

result.indexDetails.segments

segmentsの説明は次の通りです。

フィールド タイプ 必須の有無 説明
start Integer Optional (ビデオ分析時)セグメント開始フレーム番号。画像アセットは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 - キーワード情報
people Array - 登場人物情報
audioEvents Array Optional (ビデオ分析時)音声効果の検出結果
  • 音声効果検出(detectAudioEffectstrue)で分析した場合にのみ提供
  • startMs / endMs: 音声効果区間(ミリ秒)
  • type: 音声効果のタイプ
    • music: BGM
    • laughter: 笑い声
    • clap: 拍手

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

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": "v3.2",
            "sceneRange": "MEDIUM",
            "minSceneDurationSec": null,
            "maxSceneDurationSec": null,
            "analysisPersonCount": 2,
            "sourceLanguage": "KO",
            "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": "平素は NAVERクラウドプラットフォームをご利用いただき、誠にありがとうございます。本日はインタビューにご協力いただき、ありがとうございます。",
                            "pid": "1",
                            "name": "話者1"
                        }
                    ],
                    "keywords": [
                        {
                            "category": "行動",
                            "group": "事務/オーフィス/イベント",
                            "text": "ニュースキャスター",
                            "score": 87.23
                        }
                    ],
                    "people": [],
                    "audioEvents": [
                        {
                            "startMs": 3200,
                            "endMs": 4100,
                            "type": "clap"
                        }
                    ]
                }
            ]
        }
    }
}

シーンの長さを直接指定して分析したインデックス

{
    "code": "0",
    "message": "success",
    "result": {
        "indexId": 1002,
        "type": "VIDEO",
        "createdTime": "2025-04-24T16:42:00",
        "createdUserName": "username",
        "updatedTime": "2025-04-24T16:43:08",
        "updatedUserName": "username",
        "analysisSetting": {
            "analysisEngine": "v3.2",
            "sceneRange": null,
            "minSceneDurationSec": 15,
            "maxSceneDurationSec": 60,
            "analysisPersonCount": 2,
            "sourceLanguage": "KO",
            "detectAudioEffects": false
        },
        "indexDetails": {
            "durationMs": 20054,
            "fps": 29.97,
            "frameCount": 601,
            "assetUrl": "https://kr.object.ncloudstorage.com/maiu-my-storage/videos/1234/interview.mp4",
            "segments": []
        }
    }
}