機能説明
OpenAI互換Batches APIを使用して、アップロード済みのJSONLファイルからバッチタスクを作成します。現在はAlibaba Cloud Qwenシリーズモデルのみサポートしています。
呼び出し説明
インターフェース制約
- 呼び出し元はAPIキーを保有している必要があります。詳細については、AI APIキーの管理をご参照ください。
リクエストパス
POST {BASE_URL}/api/v1/batches
リクエストヘッダー
名前 |
必須 |
サンプル値 |
説明 |
|---|---|---|---|
| Authorization | はい | Bearer {token} | 認証情報 |
| Content-Type | いいえ | application/json | リクエストボディの形式 |
リクエストパラメータ
Pathパラメータ
このインターフェースにPathパラメータはありません。
Queryパラメータ
このインターフェースにQueryパラメータはありません。
Bodyパラメータ
名前 |
型 |
必須 |
サンプル値 |
説明 |
|---|---|---|---|---|
| input_file_id | string | はい | file-abc123 | アップロード済みのJSONLファイルID |
| endpoint | string | はい | /v1/chat/completions | バッチタスクのターゲットAPIエンドポイント |
| completion_window | string | はい | 24h | バッチタスクの完了時間窓 |
| metadata | object | いいえ | {"description": "nightly eval job"} | オプションのメタデータオブジェクト |
実行結果
パラメータ
名前 |
型 |
説明 |
|---|---|---|
| success | boolean | リクエストの成功・失敗 |
| code | string | 戻り値コード |
| message | string | 戻り値メッセージ |
| data | object | 業務データ |
dataフィールドの説明
名前 |
型 |
説明 |
|---|---|---|
| id | string | バッチ処理タスクの一意のID |
| object | string | オブジェクトタイプ。例："batch" |
| endpoint | string | バッチ処理タスクの対象APIエンドポイント |
| input_file_id | string | アップロード済みのJSONLファイルID |
| completion_window | string | バッチ処理タスクの完了時間窓 |
| status | string | バッチ処理タスクのステータス |
| created_at | integer | 作成時刻のタイムスタンプ |
リクエスト例
curl --request POST '{BASE_URL}/api/v1/batches' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
--data '{
"input_file_id": "file-abc123",
"endpoint": "/v1/chat/completions",
"completion_window": "24h",
"metadata": {
"description": "nightly eval job"
}
}'
実行結果例
{
"success": true,
"code": "200",
"message": "successful",
"data": {
"id": "batch_abc123",
"object": "batch",
"endpoint": "/v1/chat/completions",
"input_file_id": "file-abc123",
"completion_window": "24h",
"status": "validating",
"created_at": 1711234567
}
}