機能の概要
このAPIは、指定されたバッチタスクの状態とファイル情報を照会するために使用されます。バッチタスクの一意の識別子を渡すことで、そのタスクの現在の実行状態と関連ファイルの詳細を取得できます。現在、Alibaba Cloud Qwenシリーズモデルのみサポートしています。
呼び出しの説明
インターフェース制約
- 呼び出し元はAPIキーを保有している必要があります。詳細については、AI APIキーの管理をご参照ください。
リクエストパス
GET {BASE_URL}/api/v1/batches/{batch_id}
リクエストヘッダー
名前 |
必須 |
サンプル値 |
説明 |
|---|---|---|---|
| Authorization | はい | Bearer {token} | 認証情報 |
| Content-Type | いいえ | application/json | リクエストボディの形式 |
リクエストパラメータ
Pathパラメータ
名前 |
型 |
必須 |
サンプル値 |
説明 |
|---|---|---|---|---|
| batch_id | string | はい | batch_abc123 | バッチタスクID |
Queryパラメータ
このAPIにはQueryパラメータはありません。
Bodyパラメータ
このAPIにはBodyパラメータはありません。
実行結果
パラメータ
名前 |
型 |
説明 |
|---|---|---|
| success | boolean | リクエストが成功したかどうか |
| code | string | 戻り値コード |
| message | string | 戻り値メッセージ |
| data | object | 業務データ |
dataフィールドの説明
名前 |
型 |
説明 |
|---|---|---|
| id | string | バッチタスクの一意のID |
| status | string | バッチタスクの状態 |
| fileInfo | object | 関連するファイル情報 |
リクエスト例
curl --request GET '{BASE_URL}/api/v1/batches/batch_abc123' \
--header 'Authorization: Bearer {token}'
レスポンス例
{
"success": true,
"code": "200",
"message": "successful",
"data": {
"id": "batch_abc123",
"status": "completed",
"fileInfo": {
"id": "file-xyz789",
"filename": "output.jsonl"
}
}
}