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環境で利用できます。

インデクシングが完了したインデックスを対象に、VLMベースのシーン要約をリクエストします。シーン要約が完了すると、シーンごとの自然言語によるテキスト要約が作成されます。

参考

シーン要約をリクエストする際は、下記の内容をご確認ください。

  • シーン要約はインデックスに基づいて実行されます。インデクシングが完了したインデックスでのみ、シーン要約をリクエストできます。
  • 最初の分析は、必ずシーン全体を対象として実行します。全体分析が完了した後にのみ、特定のシーンを指定した一部だけ再分析することができます。
  • 同一アセットにつき、シーン要約は1つのインデックスでのみ実行できます。
  • シーン要約実行中は、メタデータ変更(人物ラベル付け、スクリプト編集など)が制限されます。

リクエスト

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

メソッド URI
POST /api/v1/workspaces/{workspace_name}/projects/{project_id}/assets/{asset_id}/indexes/{index_id}/scene-summaries

リクエストヘッダ

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

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

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

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

リクエストボディ

リクエストボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
sceneIds Array<Integer> Optional 再分析対象シーン IDリスト
  • 最初の全体分析が完了している場合にのみ利用可能
  • 入力がない場合は、インデックス内の全シーンを対象に分析
  • 入力時、指定されたシーンのみを再分析し、そのシーンの要約のみを更新(既存の他のシーン要約は維持)

リクエスト例

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

curl --location --request POST 'https://mi.apigw.ntruss.com/api/v1/workspaces/my-workspace/projects/1234/assets/5678/indexes/1001/scene-summaries' \
--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' \
--data '{
    "sceneIds": [1, 3, 5]
}'

レスポンス

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
code String - API処理結果コード
message String - API処理結果メッセージ
result Object - シーン要約のリクエスト情報
result.sceneSummaryId Integer - シーン要約のリクエスト ID
result.indexId Integer - 分析対象インデックス ID
result.targetSceneIds Array<Integer> - 分析対象シーン IDリスト
  • すべて分析の場合、null
result.createdTime String - 分析リクエストの作成日時
  • ISO 8601形式
result.createdUserName String - 分析をリクエストしたユーザー名

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

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

レスポンス例

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

{
    "code": "0",
    "message": "success",
    "result": {
        "sceneSummaryId": 101,
        "indexId": 1001,
        "targetSceneIds": null,
        "createdTime": "2026-04-17T10:30:00",
        "createdUserName": "username"
    }
}