VPC環境で利用できます。
リクエストした変換タスクの進行状況および結果を照会します。変換の状態がTRANSFORM_COMPLETEDの場合、レスポンスにプリセットごとの変換結果(result.output)が含まれます。変換は非同期で処理されるため、シーン要約活用のリクエストで返された変換タスク IDを使用し、完了状態になるまで照会を行います。
変換結果(result.output)の構造は、リクエストしたプリセットによって異なります。result.presetの値を基準に結果の構造を区別してください。
リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
| メソッド | URI |
|---|---|
| GET | /api/v1/workspaces/{workspace_name}/projects/{project_id}/assets/{asset_id}/scene-summary/transformations/{transformation_id} |
リクエストヘッダ
Media Intelligence APIで共通して使用されるヘッダの詳細は、Media Intelligenceのリクエストヘッダをご参照ください。
リクエストパスパラメータ
パラメータの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
workspace_name |
String | Required | ワークスペース名 |
project_id |
String | Required | プロジェクト ID
|
asset_id |
String | Required | メディアアセット ID |
transformation_id |
String | Required | 変換タスク ID |
リクエスト例
リクエストのサンプルコードは次の通りです。
curl --location --request GET 'https://mi.apigw.ntruss.com/api/v1/workspaces/my-workspace/projects/1234/assets/5678/scene-summary/transformations/2001' \
--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.status |
String | - | 変換の状態
|
result.transformStatusMessage |
String | - | 変換失敗時のエラーの詳細メッセージ
|
result.preset |
String | - | 使用された変換プリセット
|
result.locale |
String | - | 変換結果の言語
|
result.indexId |
Integer | - | 変換に使用されたシーン要約が属するインデックス ID
|
result.presetVersion |
String | - | プリセット変換ポリシーのバージョン
|
result.engineVersion |
String | - | 変換エンジンのバージョン
|
result.outputFields |
Array<String> | - | 適用された出力フィールド
|
result.keywordCount |
Integer | - | 適用されたシーンごとのキーワード数
|
result.paragraphCount |
Integer | - | 適用されたシーンごとの要約段落数
|
result.usage |
Object | - | 使用量情報
|
result.output |
Object | - | プリセットごとの変換結果
|
usage
usageの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
outputTokens |
Integer | - | 課金基準の出力トークン数 |
output (SCENE_DIGEST)
presetがSCENE_DIGESTの場合、outputの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
scenes |
Array | - | シーンごとの要約結果リスト |
scenes[].scene |
Integer | - | シーン ID |
scenes[].startMs |
Integer | - | シーン開始時間(ミリ秒) |
scenes[].endMs |
Integer | - | シーン終了時間(ミリ秒) |
scenes[].title |
String | - | シーンの代表タイトル
|
scenes[].keywords |
Array<String> | - | シーンの重要キーワードリスト
|
scenes[].paragraphs |
Array<String> | - | シーン要約段落リスト
|
output (SCENE_METADATA)
presetがSCENE_METADATAの場合、outputの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
scenes |
Array | - | シーンごとのメタデータリスト |
scenes[].scene |
Integer | - | シーン ID |
scenes[].startMs |
Integer | - | シーン開始時間 (ミリ秒) |
scenes[].endMs |
Integer | - | シーン終了時間 (ミリ秒) |
scenes[].timeRange |
Object | - | 表示用時間およびタイムコード情報
|
scenes[].tags |
Array<String> | - | 検索・フィルタリング用タグリスト |
scenes[].content |
Object | - | 観察ベースのシーンメタデータ: content |
content
contentの説明は次の通りです。すべてのサブフィールドは optionalであり、シーン内で観察されなかった情報は省略されます。今後新しいフィールドが追加される可能性があるため、定義されていないフィールドは無視するように実装してください。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
objects |
Array<String> | - | シーン内の主要なオブジェクト名リスト
|
actions |
Array<String> | - | シーン内で観察される主要な行為リスト |
environment |
Object | - | 背景情報
|
composition |
Object | - | 撮影構図情報
|
persons |
Array<Object> | - | ラベリングされた人物リスト
|
textInScene |
Array<String> | - | シーン内に登場するテキスト(字幕・看板・画面表示など)の原文 |
レスポンスステータスコード
Media Intelligence APIで共通して使用されるレスポンスステータスコードの詳細は、Media Intelligenceのレスポンスステータスコードをご参照ください。
レスポンス例
変換実行中(TRANSFORMING)のレスポンス例です。
{
"code": "0",
"message": "success",
"result": {
"status": "TRANSFORMING",
"transformStatusMessage": null,
"preset": "SCENE_DIGEST",
"locale": "en-US"
}
}
SCENE_DIGESTプリセットの変換完了(TRANSFORM_COMPLETED)のレスポンス例です。
{
"code": "0",
"message": "success",
"result": {
"status": "TRANSFORM_COMPLETED",
"transformStatusMessage": null,
"preset": "SCENE_DIGEST",
"locale": "ko-KR",
"indexId": 1001,
"presetVersion": "1.0.0",
"engineVersion": "1.0.0",
"outputFields": ["title", "keywords", "paragraphs"],
"keywordCount": 5,
"paragraphCount": 1,
"usage": {
"outputTokens": 380
},
"output": {
"scenes": [
{
"scene": 1,
"startMs": 0,
"endMs": 5000,
"title": "MCのインタビューオープニング",
"keywords": ["光化門", "MC", "インタビュー", "広場", "スタート"],
"paragraphs": [
"MCが光化門広場で市民インタビュー番組のスタートを告げる。"
]
},
{
"scene": 2,
"startMs": 5000,
"endMs": 12000,
"title": "市民インタビューの実施",
"keywords": ["市民", "日常", "インタビュー", "街頭", "会話"],
"paragraphs": [
"多様な市民が登場し、それぞれの日常や考えを共有する。"
]
}
]
}
}
}
SCENE_METADATAプリセットの変換完了(TRANSFORM_COMPLETED)のレスポンス例です。
{
"code": "0",
"message": "success",
"result": {
"status": "TRANSFORM_COMPLETED",
"transformStatusMessage": null,
"preset": "SCENE_METADATA",
"locale": "ko-KR",
"indexId": 1001,
"presetVersion": "1.0.0",
"engineVersion": "1.0.0",
"usage": {
"outputTokens": 640
},
"output": {
"scenes": [
{
"scene": 1,
"startMs": 1000,
"endMs": 3000,
"timeRange": {
"startTime": "00:00:01.000",
"endTime": "00:00:03.000",
"startTimecode": "00:00:01:00",
"endTimecode": "00:00:03:00",
"frameRate": 29.97
},
"tags": ["オフィス", "ノート PC", "日中", "業務", "ミディアムショット],
"content": {
"objects": ["ノート PC", "デスク"],
"actions": ["ノート PCの使用", "会話"],
"environment": {
"place": "オフィス",
"locationType": "indoor",
"timeOfDay": "daytime"
},
"composition": {
"shotType": "medium_shot",
"cameraAngle": "eye_level"
},
"persons": [
{
"id": "person_1",
"label": "キム・グリン"
}
],
"textInScene": ["Q4 REPORT"]
}
}
]
}
}
}