Get scene summary utilization result

Available in VPC

Get the progress and results of the requested conversion job. If the conversion status is TRANSFORM_COMPLETED, the response will include the conversion results for each preset (result.output). Since conversions are processed asynchronously, use the conversion job ID returned by the Request scene summary utilization to check the status until it reaches the completed state.

Request

This section describes the request format. The method and URI are as follows:

Request headers

For information about the headers common to all Media Intelligence APIs, see Media Intelligence request headers.

Request path parameters

The following describes the parameters.

Request example

The request example is as follows:

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'

Response

This section describes the response format.

Response body

The response body includes the following data:

usage

The following describes usage.

output (SCENE_DIGEST)

The following describes the output when preset is set to SCENE_DIGEST.

output (SCENE_METADATA)

The following describes the output when preset is set to SCENE_METADATA.

content

The following describes content. All subfields are optional, and information not observed in the scene is omitted. Since new fields may be added in the future, implement your code to ignore any undefined fields.

Response status codes

For information about the HTTP status codes common to all Media Intelligence APIs, see Media Intelligence response status codes.

Response example

The following is a sample response for a conversion in progress (TRANSFORMING).

{
    "code": "0",
    "message": "success",
    "result": {
        "status": "TRANSFORMING",
        "transformStatusMessage": null,
        "preset": "SCENE_DIGEST",
        "locale": "en-US"
    }
}

The following is a sample response for a completed conversion (TRANSFORM_COMPLETED) of the SCENE_DIGEST preset.

{
    "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": "Host's interview opening",
                    "keywords": ["Gwanghwamun", "host", "interview", "square", "start"],
                    "paragraphs": [
                        "The host announces the start of a citizen interview program at Gwanghwamun Square."
                    ]
                },
                {
                    "scene": 2,
                    "startMs": 5000,
                    "endMs": 12000,
                    "title": "Conducting citizen interviews",
                    "keywords": ["citizens", "daily life", "interview", "street", "conversation"],
                    "paragraphs": [
                        "Various citizens appear and share their daily lives and thoughts."
                    ]
                }
            ]
        }
    }
}

The following is a sample response for a completed conversion (TRANSFORM_COMPLETED) of the SCENE_METADATA preset.

{
    "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": ["office", "laptop", "weekday", "work", "medium shot"],
                    "content": {
                        "objects": ["laptop", "desk"],
                        "actions": ["using laptop", "conversation"],
                        "environment": {
                            "place": "Office",
                            "locationType": "indoor",
                            "timeOfDay": "daytime"
                        },
                        "composition": {
                            "shotType": "medium_shot",
                            "cameraAngle": "eye_level"
                        },
                        "persons": [
                            {
                                "id": "person_1",
                                "label": "Green Kim"
                            }
                        ],
                        "textInScene": ["Q4 REPORT"]
                    }
                }
            ]
        }
    }
}