AI Search Open Platform は、API を介してビデオスナップショットサービスを呼び出し、ビデオからキーフレームを抽出することをサポートしています。OCR、画像解析、またはマルチモーダル埋め込みサービスと組み合わせることで、ビデオコンテンツの詳細な解析と構造化処理が可能になります。
サービス
サービス名 | サービス ID | サービスの説明 | API 呼び出しの QPS 制限 (Alibaba Cloud アカウントと RAM ユーザーを含む) |
ビデオスナップショットサービス 001 | ops-video-snapshot-001 | ビデオスナップショットサービス 001 (ops-video-snapshot-001) は、ビデオからキーフレームをキャプチャするためのビデオコンテンツ抽出機能を提供します。マルチモーダル埋め込みサービスまたは画像解析機能と組み合わせることで、クロスモーダル検索が可能になります。 | 5 説明 より高い QPS を申請するには、チケットを送信してください。 |
認証情報が取得されます。
API を使用して AI Search Open Platform サービスを呼び出す場合、呼び出し元の ID を認証する必要があります。
サービスアクセスアドレスが取得されます。
サービスは、インターネットまたは VPC (仮想プライベートクラウド) 経由で呼び出すことができます。詳細については、「サービス登録アドレスの取得」をご参照ください。
非同期タスクの作成
リクエストメソッド: POST
URL
{host}/v3/openapi/workspaces/{workspace_name}/video-snapshot/{service_id}/asynchost: サービスを呼び出すためのアドレス。API サービスは、インターネットまたは VPC 経由で呼び出すことができます。詳細については、「サービス登録アドレスの取得」をご参照ください。
workspace_name: ワークスペースの名前 (例: default)。
service_id: 組み込みのサービス ID (例: ops-video-snapshot-001)。
リクエストパラメーター
ヘッダーパラメーター
API-KEY 認証
パラメーター | タイプ | 必須 | 説明 | 例 |
Content-Type | String | はい | リクエストタイプ: application/json | application/json |
Authorization | String | はい | API-Key | Bearer OS-d1**2a |
ボディパラメーター
パラメーター | タイプ | 必須 | 説明 |
input | Object(input) | はい | 処理するマルチメディアファイルを指定します。 |
parameters | Object | いいえ | サービスのパラメーターを指定します。 |
output | Object(output) | はい | 出力フォーマットとファイルストレージパスを制御します。 |
input
パラメーター | タイプ | 必須 | 説明 |
content | String | いいえ | ビデオコンテンツの Base64 エンコーディングデータ。サポートされているフォーマットは mp4、avi、mkv、mov、flv、webm です。 説明 input.content と input.oss パラメーターは排他的です。どちらか一方のみを指定できます。
|
oss | String | いいえ | 入力ファイルの OSS パス。例: oss://<BUCKET_NAME>/xxx/xxx.mp4。 |
file_name | String | いいえ | ビデオファイルの名前。設定されていない場合、content 内のファイル名から解析されます。 |
Parameters
パラメーター | タイプ | 必須 | 説明 |
interval | Int | いいえ | キーフレームの間隔。デフォルト値: 1。単位: 秒。 |
format | String | いいえ | フレームキャプチャでサポートされている出力フォーマットは jpg と png です。デフォルトのフォーマットは jpg です。 |
output
パラメーター | タイプ | 必須 | 説明 |
type | String | いいえ | base64: イメージコンテンツを base64 フォーマットで返します。同期呼び出しでのみサポートされます。 oss: スナップショットファイルを OSS に保存します (デフォルト)。 |
oss | String | いいえ | 出力ファイルの OSS パス。このパラメーターは、type が oss に設定されている場合に必須です。 例: |
応答パラメーター
パラメーター | タイプ | 説明 | 例 |
result.task_id | String | ビデオ抽出タスクの一意の ID。 | snapshot-xxxx-abc-123 |
Curl リクエストの例
curl -X POST \
-H "Content-Type: application/json" \
-H "Authorization: Bearer <Your API-KEY>" \
"http://***-hangzhou.opensearch.aliyuncs.com/v3/openapi/workspaces/default/video-snapshot/ops-video-snapshot-001/async"
--data '{
"input":{
"oss" : "oss://<BUCKET_NAME>/test.mp4"
},
"parameters" : {
},
"output": {
"type":"oss",
"oss" :"oss://<BUCKET_NAME>/result/path"
}
}' \
応答の例
{
"request_id":"de81e152284a2d3b1f4315d*******",
"latency":21,
"usage":{},
"result":{
"task_id":"snapshot-20250617102142-110841*******-*******",
"status":"PENDING"
}
}非同期タスクのステータスの取得
リクエストメソッド: GET
URL
{host}/v3/openapi/workspaces/{workspace_name}/video-snapshot/{service_id}/async/task-status?task_id={task_id}host: サービスのエンドポイント。API サービスは、インターネットまたは VPC 経由で呼び出すことができます。詳細については、「サービスアクセスアドレスの取得」をご参照ください。
workspace_name: ワークスペースの名前 (例: default)。
service_id: 組み込みのサービス ID (例: ops-video-snapshot-001)。
リクエストパラメーター
パラメーター | タイプ | 必須 | 説明 | 例 |
service_id | String | はい | サービス ID。 | ops-video-snapshot-001 |
task_id | String | はい | 非同期ビデオスナップショットタスクの作成時の応答から得られるタスク ID。 | snapshot-xxxx-abc-123 |
応答パラメーター
パラメーター | タイプ | 説明 | 例 |
result.task_id | String | ビデオ抽出タスクの一意の ID。 | snapshot-xxxx-abc-123 |
result.status | String | タスクのステータス:
| PENDING |
result.error | String | status=FAIL の場合のエラーメッセージの内容。正常な状態では空です。 | |
result.data | List(SnapshotResult) | ビデオ処理の結果。 | |
usage.image_count | Int | スナップショットから出力されたイメージの数。 |
SnapshotResult
パラメーター | タイプ | 説明 |
frame_index | Int | ビデオ内のフレーム番号。 |
path | String | ファイルの OSS パス。ユーザーが出力として OSS を指定した場合、これは OSS 内のスナップショット結果のストレージパスであり、URL エンコードされています。 |
content | String | イメージの Base64 エンコードされたコンテンツ。content または path のいずれか一方のみが存在し、content は同期タスクの実行時にのみ返されます。 |
frame_time | Float | ビデオ内の現在のスナップショットフレームのタイムスタンプ (秒単位)。 |
Curl リクエストの例
curl -X GET \
-H "Content-Type: application/json" \
-H "Authorization: Bearer <Your API-KEY>" \
"http://***-hangzhou.opensearch.aliyuncs.com/v3/openapi/workspaces/default/video-snapshot/ops-video-snapshot-001/async/task-status?task_id=snapshot-20250617102142-1108418170738252-******" \
応答の例
{
"request_id":"83b423e2e63613a878c369c20******",
"latency":11,
"usage":{
"image":64
},
"result":{
"task_id":"snapshot-20250617102142-1108418170738252-******",
"status":"SUCCESS",
"data":[
{
"frame_index": 0,
"path": "oss://bucket-name/result/path/snapshot-xxxx-abc-123-xxx/snapshot_0.jpg",
"frame_time": 0.0
},
......
{
"frame_index": 1890,
"path": "oss://bucket-name/result/path/snapshot-xxxx-abc-123-xxx/snapshot_63.jpg",
"frame_time": 63.0
}
]
}
}同期ビデオスナップショットタスクの作成
URL
{host}/v3/openapi/workspaces/{workspace_name}/video-snapshot/{service_id}/synchost: サービスを呼び出すためのアドレス。API サービスは、インターネットまたは VPC 経由で呼び出すことができます。詳細については、「サービス登録アドレスの取得」をご参照ください。
workspace_name: ワークスペースの名前 (例: default)。
service_id: 組み込みのサービス ID (例: ops-video-snapshot-001)。
リクエストパラメーター
ヘッダーパラメーター
API-KEY 認証
パラメーター | タイプ | 必須 | 説明 | 例 |
Content-Type | String | はい | リクエストタイプ: application/json | application/json |
Authorization | String | はい | API-Key | Bearer OS-d1**2a |
ボディパラメーター
パラメーター | タイプ | 必須 | 説明 |
input | Object(input) | はい | 処理するマルチメディアファイルを指定します。 |
parameters | Object | いいえ | サービスのパラメーターを指定します。 |
output | Object(output) | はい | 出力フォーマットとファイルストレージパスを制御します。 |
input
パラメーター | タイプ | 必須 | 説明 |
content | String | いいえ | ビデオコンテンツの Base64 エンコーディングデータ。サポートされているフォーマットは mp4、avi、mkv、mov、flv、webm です。 説明 input.content と input.oss パラメーターは排他的です。どちらか一方のみを指定できます。
|
oss | String | いいえ | 入力ファイルの OSS パス。例: oss://<BUCKET_NAME>/xxx/xxx.mp4。 |
file_name | String | いいえ | ビデオファイルの名前。設定されていない場合、content 内のファイル名から解析されます。 |
Parameters
パラメーター | タイプ | 必須 | 説明 |
interval | Int | いいえ | キーフレームの間隔。デフォルト値: 1。単位: 秒。 |
format | String | いいえ | フレームキャプチャでサポートされている出力フォーマットは jpg と png です。デフォルトのフォーマットは jpg です。 |
output
パラメーター | タイプ | 必須 | 説明 |
type | String | いいえ | base64: イメージコンテンツを base64 フォーマットで返します。同期呼び出しでのみサポートされます。 oss: スナップショットファイルを OSS に保存します (デフォルト)。 |
oss | String | いいえ | 出力ファイルの OSS パス。このパラメーターは、type が oss に設定されている場合に必須です。 例: |
応答パラメーター
パラメーター | タイプ | 説明 | 例 |
result.task_id | String | ビデオ抽出タスクの一意の ID。 | snapshot-xxxx-abc-123 |
Curl リクエストの例
curl -X POST \
-H "Content-Type: application/json" \
-H "Authorization: Bearer <Your API-KEY>" \
"http://***-hangzhou.opensearch.aliyuncs.com/v3/openapi/workspaces/default/video-snapshot/ops-video-snapshot-001/sync"
--data '{
"input":{
"oss" : "oss://<BUCKET_NAME>/test.mp4"
},
"parameters" : {
},
"output": {
"type":"oss",
"oss" :"oss://<BUCKET_NAME>/result/path"
}
}' \
応答の例
{
"request_id":"83b423e2e63613a878c369c20******",
"latency":11,
"usage":{
"image":64
},
"result":{
"task_id":"snapshot-20250617102142-1108418170738252-b******",
"status":"SUCCESS",
"data":[
{
"frame_index": 0,
"path": "oss://bucket-name/result/path/snapshot-xxxx-abc-123-xxx/snapshot_0.jpg",
"frame_time": 0.0
},
......
{
"frame_index": 1890,
"path": "oss://bucket-name/result/path/snapshot-xxxx-abc-123-xxx/snapshot_63.jpg",
"frame_time": 63.0
}
]
}
}状態コード
リクエストエラーが発生した場合、出力結果は code と message を通じてエラーの原因を示します。
{
"request_id": "6F33AFB6-A35C-4DA7-AFD2-9EA16CCF****",
"latency": 2.0,
"code": "InvalidParameter",
"http_code": 400,
"message": "JSON parse error: Cannot deserialize value of type `ImageStorage` from String \"xxx\"
}HTTP ステータスコード | エラーコード | 説明 |
200 | - | リクエストは成功です。タスクの失敗シナリオも含まれます。実際のタスクステータスは result.status から判断する必要があります。 |
404 | BadRequest.TaskNotExist | タスクが存在しないために返されるエラーメッセージ。 |
400 | InvalidParameter | 無効なリクエスト。 |
500 | InternalServerError | 内部エラー。 |
状態コードの詳細については、「状態コード」をご参照ください。