Alibaba Cloud Model Studio:非同期タスク管理 API

Model Studio の一部のモデル (画像生成や動画生成など) は、処理時間が長いため非同期呼び出しを使用します。一般的なワークフローは次のとおりです。タスクを作成して ID を取得し、その ID を使用して結果をクエリします。Model Studio は、個別の結果をクエリしたり、複数のタスクのステータスをバッチで確認したり、キュー内のタスクをキャンセルしたりするための汎用タスク API を提供します。

前提条件

非同期タスク API は HTTP 経由で呼び出すことができます。

API を呼び出す前に、API キーを取得して設定し、次に API キーを環境変数として設定する必要があります。

非同期タスク結果のクエリ

API の説明：task_id に基づいて、タスクのステータスと結果をクエリします。

レート制限：Alibaba Cloud アカウントあたり 20 QPS （すべての RAM ユーザーを含む）。

リクエストエンドポイント

GET https://dashscope.aliyuncs.com/api/v1/tasks/{task_id}

リクエストパラメーター

レスポンスパラメーター

リクエスト例

curl -X GET 'https://dashscope.aliyuncs.com/api/v1/tasks/73205176-xxxx-xxxx-xxxx-16bd5d902219' \
--header "Authorization: Bearer $DASHSCOPE_API_KEY"

レスポンス例

{
    "request_id": "45ac7f13-xxxx-xxxx-xxxx-e03c35068d83",
    "output": {
        "task_id": "73205176-xxxx-xxxx-xxxx-16bd5d902219",
        "task_status": "SUCCEEDED",
        "submit_time": "2023-12-20 21:36:31.896",
        "scheduled_time": "2023-12-20 21:36:39.009",
        "end_time": "2023-12-20 21:36:45.913",
        "results": [
            {
                "url": "https://dashscope-result-bj.oss-cn-beijing.aliyuncs.com/xxx1.png"
            },
            {
                "url": "https://dashscope-result-bj.oss-cn-beijing.aliyuncs.com/xxx2.png"
            },
            {
                "url": "https://dashscope-result-bj.oss-cn-beijing.aliyuncs.com/xxx3.png"
            },
            {
                "code": "DataInspectionFailed",
                "message": "Output data may contain inappropriate content.",
            }
        ],
        "task_metrics": {
            "TOTAL": 4,
            "SUCCEEDED": 3,
            "FAILED": 1
        }
    },
    "usage": {
        "image_count": 3
    }
}

複数の非同期タスクステータスのクエリ

API の説明：さまざまな条件を使用して複数の非同期タスクをクエリします。1 回のリクエストで複数のタスクステータスを確認します。

レート制限：Alibaba Cloud アカウントあたり 20 QPS (すべての RAM ユーザーを含む)。

リクエストエンドポイント

GET https://dashscope.aliyuncs.com/api/v1/tasks

リクエストパラメーター

レスポンスパラメーター

"data": [
    {
        "api_key_id": "235",
        "caller_parent_id": "1808342417264262",
        "caller_uid": "1808342417264262",
        "end_time": 1682527200093,
        "gmt_create": 1682514589152,
        "model_name": "paraformer-16k-1",
        "region": "cn-hangzhou",
        "request_id": "32b67b58-xxxx-xxxx-xxxx-230f0aee64d9",
        "start_time": 1682515862179,
        "status": "FAILED",
        "task_id": "cf52b16b-xxxx-xxxx-xxxx-17f9c211440c",
        "user_api_unique_key": "apikey:v1:audio:asr:transcription:paraformer-16k-1"
    }
]

リクエスト例

curl -X GET 'https://dashscope.aliyuncs.com/api/v1/tasks/?start_time=xxx&end_time=xxx&status=xxx' \
--header "Authorization: Bearer $DASHSCOPE_API_KEY"

レスポンス例

{
    "total": 2,
    "data": [
        {
            "api_key_id": "15xxxx",
            "caller_parent_id": "xxxxxxxxx",
            "caller_uid": "xxxxxxxxx",
            "gmt_create": 1745568428109,
            "model_name": "wanx2.1-kf2v-plus",
            "region": "cn-beijing",
            "request_id": "1abfc3c8-dd25-98da-ad0b-xxxxxx",
            "start_time": 1745568428138,
            "status": "RUNNING",
            "task_id": "50e2ccea-abc4-43d7-a0dc-xxxxxx",
            "user_api_unique_key": "apikey:v1:aigc:image2video:video-synthesis:wanx2.1-kf2v-plus"
        },
        {
            "api_key_id": "15xxxx",
            "caller_parent_id": "xxxxxxxxx",
            "caller_uid": "xxxxxxxxx",
            "end_time": 1745568302481,
            "gmt_create": 1745568293253,
            "model_name": "wanx2.1-t2i-turbo",
            "region": "cn-beijing",
            "request_id": "f6bf34d9-bf87-9e8b-9ed4-xxxxxx",
            "start_time": 1745568293273,
            "status": "SUCCEEDED",
            "task_id": "3c777dbc-8cc6-4d80-aa90-xxxxxx",
            "user_api_unique_key": "apikey:v1:aigc:text2image:image-synthesis:wanx2.1-t2i-turbo"
        }
    ],
    "total_page": 1,
    "page_no": 1,
    "request_id": "f6756b7e-d0bb-9b74-813a-xxxxxx",
    "page_size": 10
}

非同期タスクのキャンセル

API の説明：非同期タスクをキャンセルします。PENDING 状態 (キューに入れられた、まだ開始されていない) のタスクのみキャンセルできます。

レート制限：Alibaba Cloud アカウントあたり 20 QPS (すべての RAM ユーザーを含む)。

リクエストエンドポイント

POST https://dashscope.aliyuncs.com/api/v1/tasks/{task_id}/cancel

リクエストパラメーター

レスポンスパラメーター

キャンセルリクエストが成功した場合、レスポンスボディにリクエスト ID が JSON 文字列として返されます。成功レスポンスには JSON オブジェクトのフィールドはありません。

エラーレスポンスの場合、次のフィールドが返されます。

リクエストの例

curl -X POST 'https://dashscope.aliyuncs.com/api/v1/tasks/73205176-xxxx-xxxx-xxxx-16bd5d902219/cancel' \
--header "Authorization: Bearer $DASHSCOPE_API_KEY"

レスポンスの例

"45ac7f13-xxxx-xxxx-xxxx-e03c35068d83"

エラーコード