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

パラメーターの渡し方

フィールド

タイプ

必須

説明

例

ヘッダー

Authorization

String

はい

API キー。例: Bearer sk-xxx

Bearer sk-xxx

パス

task_id

String

はい

クエリするタスクの ID。

a8532587-xxxx-xxxx-xxxx-0c46b17950d1

フィールド

タイプ

説明

例

request_id

String

このリクエストの一意な ID。

7574ee8f-xxxx-xxxx-xxxx-11c33ab46e51

output

Object

• タスクが成功した場合、output にはモデルによって生成された結果オブジェクトが含まれます。内容はタスクの種類によって異なります。

• タスクが失敗または部分的に失敗した場合、output は失敗の理由を説明する対応する code と message を返します。

• 複数のサブタスクを含むタスクの場合、output には成功したサブタスクの結果と失敗したサブタスクのエラーメッセージの両方が含まれる場合があります。

-

output.task_id

String

クエリされたタスクの ID。

a8532587-xxxx-xxxx-xxxx-0c46b17950d1

output.task_status

String

タスクのステータス。

• 複数のサブタスクを持つタスクの場合、少なくとも 1 つのサブタスクが成功すれば、タスク全体が成功としてマークされます。

• 失敗したサブタスクについては、特定のエラーが出力に表示されます。

タスクのステータス:

• PENDING

• RUNNING

• SUCCEEDED

• FAILED

• UNKNOWN

output.submit_time

String

タスクが送信された時刻。

2023-12-20 21:36:31.896

output.scheduled_time

String

タスクがスケジュールされた時刻、つまり実行が開始された時刻。

2023-12-20 21:36:39.009

output.end_time

String

タスクが終了した時刻。

2023-12-20 21:36:45.913

output.code

String

エラーコード。タスクが失敗した場合にのみ返されます。

-

output.message

String

エラーメッセージ。タスクが失敗した場合にのみ返されます。

-

output.task_metrics

Object

タスクメトリック。サブタスクのステータスに関する統計が含まれます。

{

"TOTAL": 4, // サブタスクの総数

"SUCCEEDED": 3, // 成功したサブタスクの数

"FAILED": 1 // 失敗したサブタスクの数

}

usage

Object

このリクエストの課金情報。課金情報はタスクによって異なります。

"usage": {"image_count": 1}

パラメーターの渡し方

フィールド

タイプ

必須

説明

例

ヘッダー

Authorization

String

はい

API キー。例: Bearer sk-xxx

Bearer sk-xxx

パラメーター

task_id

String

いいえ

クエリするタスクの ID。

task_id を指定すると、API はそのタスクのステータスのみを返します。複数のタスクをクエリするには、このパラメーターを使用しないでください。

a8532587-xxxx-xxxx-xxxx-0c46b17950d1

start_time

String

いいえ

クエリ範囲の開始時刻。フォーマットは YYYYMMDDhhmmss です。

• 開始時刻を指定しない場合、システムは指定された終了時刻の 24 時間前からデータをクエリします。

• 開始時刻または終了時刻を指定しない場合、システムはデフォルトで過去 24 時間のデータをクエリします。

• 開始時刻と終了時刻の間の時間範囲は 24 時間を超えることはできません。

20230420193058 は 2023 年 4 月 20 日 19:30:58 を表します。

end_time

String

いいえ

クエリ範囲の終了時刻。フォーマットは YYYYMMDDhhmmss です。

• 終了時刻を指定しない場合、システムは指定された開始時刻から 24 時間のデータをクエリします。

• 開始時刻と終了時刻の間の時間範囲は 24 時間を超えることはできません。

model_name

String

いいえ

モデル名。

wanx-v1

status

String

いいえ

タスクのステータス:

• PENDING

• RUNNING

• SUCCEEDED

• FAILED

• CANCELED

• UNKNOWN

page_no

Integer

いいえ

返す結果のページ番号。デフォルト: 1。

-

page_size

Integer

いいえ

各ページで返すエントリ数。デフォルト: 10。

-

フィールド

タイプ

説明

例

request_id

String

このリクエストの一意な ID。

7574ee8f-xxxx-xxxx-xxxx-11c33ab46e51

data

Array

クエリ結果のリスト。

"data": [
    {
        "api_key_id": "235",
        "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"
    }
]

data[].api_key_id

String

API キーの ID。

data[].caller_parent_id

String

Alibaba Cloud アカウントの ID。

data[].caller_uid

String

Alibaba Cloud アカウント ID。

data[].gmt_create

Long

タスクが作成された時刻 (エポックからのミリ秒単位)。

data[].start_time

Long

タスクが開始された時刻 (エポックからのミリ秒単位)。

data[].end_time

Long

タスクが終了した時刻 (エポックからのミリ秒単位)。

data[].region

String

リージョン。例: cn-hangzhou

data[].request_id

String

タスク送信のリクエスト ID。

data[].status

String

タスクのステータス:

• PENDING

• RUNNING

• SUCCEEDED

• FAILED

• CANCELED

• UNKNOWN

data[].task_id

String

タスク ID。

data[].user_api_unique_key

String

API の一意なキー。タスクの送信時にモデルの API パラメーターから作成された一意なインデックスです。

data[].model_name

String

モデル名。

page_no

Integer

現在のページ番号。

"page_no": 1

page_size

Integer

ページあたりのエントリ数。

"page_size": 10

total_page

Integer

総ページ数。

"total_page": 4

total

Integer

総エントリ数。

"total": 39

code

String

呼び出しが失敗したときに返されるエラーコード。

"code": "Throttling.RateQuota"

message

String

呼び出しが失敗したときに返されるエラーメッセージ。

"message": "Requests rate limit exceeded, please try again later."

パラメーターの渡し方

フィールド

タイプ

必須

説明

例

ヘッダー

Authorization

String

はい

API キー。例: Bearer sk-xxx

Bearer sk-xxx

パス

task_id

String

はい

キャンセルするタスクの ID。

a8532587-xxxx-xxxx-xxxx-0c46b17950d1

フィールド

タイプ

説明

例

request_id

String

このリクエストの一意な ID。

7574ee8f-xxxx-xxxx-xxxx-11c33ab46e51

code

String

呼び出しが失敗したときに返されるエラーコード。

"code": "Throttling.RateQuota"

message

String

呼び出しが失敗したときに返されるエラーメッセージ。

"message": "Requests rate limit exceeded, please try again later."