OpenAI相容-Batch（檔案輸入）

OpenAI Python SDK

import os
from pathlib import Path
from openai import OpenAI
import time

# 初始化用戶端
client = OpenAI(
    # 若沒有配置環境變數，可用阿里雲百鍊API Key將下行替換為：api_key="sk-xxx"，但不建議在生產環境中直接將API Key寫入程式碼到代碼中，以減少API Key泄露風險。
    # 新加坡和北京地區的API Key不同。
    api_key=os.getenv("DASHSCOPE_API_KEY"),
    # 以下是新加坡地區的base_url，如果使用北京地區的模型，需要將base_url替換為：https://dashscope.aliyuncs.com/compatible-mode/v1
    base_url="https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/compatible-mode/v1"  # 阿里雲百鍊服務的base_url
)

def upload_file(file_path):
    print(f"正在上傳包含請求資訊的JSONL檔案...")
    file_object = client.files.create(file=Path(file_path), purpose="batch")
    print(f"檔案上傳成功。得到檔案ID: {file_object.id}\n")
    return file_object.id

def create_batch_job(input_file_id):
    print(f"正在基於檔案ID，建立Batch任務...")
    # 請注意:此處endpoint參數值需和輸入檔案中的url欄位保持一致.測試模型(batch-test-model)填寫/v1/chat/ds-test,Embedding文本向量模型填寫/v1/embeddings,其他模型填寫/v1/chat/completions
    batch = client.batches.create(input_file_id=input_file_id, endpoint="/v1/chat/ds-test", completion_window="24h")
    print(f"Batch任務建立完成。 得到Batch任務ID: {batch.id}\n")
    return batch.id

def check_job_status(batch_id):
    print(f"正在檢查Batch任務狀態...")
    batch = client.batches.retrieve(batch_id=batch_id)
    print(f"Batch任務狀態: {batch.status}\n")
    return batch.status

def get_output_id(batch_id):
    print(f"正在擷取Batch任務中執行成功請求的輸出檔案ID...")
    batch = client.batches.retrieve(batch_id=batch_id)
    print(f"輸出檔案ID: {batch.output_file_id}\n")
    return batch.output_file_id

def get_error_id(batch_id):
    print(f"正在擷取Batch任務中執行錯誤請求的輸出檔案ID...")
    batch = client.batches.retrieve(batch_id=batch_id)
    print(f"錯誤檔案ID: {batch.error_file_id}\n")
    return batch.error_file_id

def download_results(output_file_id, output_file_path):
    print(f"正在列印並下載Batch任務的請求成功結果...")
    content = client.files.content(output_file_id)
    # 列印部分內容以供測試
    print(f"列印請求成功結果的前1000個字元內容: {content.text[:1000]}...\n")
    # 儲存結果檔案至本地
    content.write_to_file(output_file_path)
    print(f"完整的輸出結果已儲存至本地輸出檔案result.jsonl\n")

def download_errors(error_file_id, error_file_path):
    print(f"正在列印並下載Batch任務的請求失敗資訊...")
    content = client.files.content(error_file_id)
    # 列印部分內容以供測試
    print(f"列印請求失敗資訊的前1000個字元內容: {content.text[:1000]}...\n")
    # 儲存錯誤資訊檔至本地
    content.write_to_file(error_file_path)
    print(f"完整的請求失敗資訊已儲存至本地錯誤檔案error.jsonl\n")

def main():
    # 檔案路徑
    input_file_path = "test_model.jsonl"  # 可替換為您的輸入檔案路徑
    output_file_path = "result.jsonl"  # 可替換為您的輸出檔案路徑
    error_file_path = "error.jsonl"  # 可替換為您的錯誤檔案路徑
    try:
        # Step 1: 上傳包含請求資訊的JSONL檔案,得到輸入檔案ID
        input_file_id = upload_file(input_file_path)
        # Step 2: 基於輸入檔案ID,建立Batch任務
        batch_id = create_batch_job(input_file_id)
        # Step 3: 檢查Batch任務狀態直到結束
        status = ""
        while status not in ["completed", "failed", "expired", "cancelled"]:
            status = check_job_status(batch_id)
            print(f"等待任務完成...")
            time.sleep(10)  # 等待10秒後重新查詢狀態
        # 如果任務失敗,則列印錯誤資訊並退出
        if status == "failed":
            batch = client.batches.retrieve(batch_id)
            print(f"Batch任務失敗。錯誤資訊為:{batch.errors}\n")
            print(f"參見錯誤碼文檔: https://www.alibabacloud.com/help/zh/model-studio/developer-reference/error-code")
            return
        # Step 4: 下載結果：如果輸出檔案ID不為空白,則列印請求成功結果的前1000個字元內容，並下載完整的請求成功結果到本地輸出檔案;
        # 如果錯誤檔案ID不為空白,則列印請求失敗資訊的前1000個字元內容,並下載完整的請求失敗資訊到本地錯誤檔案.
        output_file_id = get_output_id(batch_id)
        if output_file_id:
            download_results(output_file_id, output_file_path)
        error_file_id = get_error_id(batch_id)
        if error_file_id:
            download_errors(error_file_id, error_file_path)
            print(f"參見錯誤碼文檔: https://www.alibabacloud.com/help/zh/model-studio/developer-reference/error-code")
    except Exception as e:
        print(f"An error occurred: {e}")
        print(f"參見錯誤碼文檔: https://www.alibabacloud.com/help/zh/model-studio/developer-reference/error-code")

if __name__ == "__main__":
    main()

OpenAI Node.js SDK

/**
 * 阿里雲百鍊 Batch API 測試 - 使用 OpenAI Node.js SDK
 *
 * 安裝依賴：npm install openai
 * 運行：node test-nodejs.js
 */

const OpenAI = require('openai');
const fs = require('fs');

// 新加坡地區的 Base URL
const BASE_URL = 'https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/compatible-mode/v1';
// 如果使用北京地區，使用以下 URL：
// const BASE_URL = 'https://dashscope.aliyuncs.com/compatible-mode/v1';

const apiKey = process.env.DASHSCOPE_API_KEY;
if (!apiKey) {
    console.error('錯誤: 請設定環境變數 DASHSCOPE_API_KEY');
    process.exit(1);
}

// 初始化用戶端
const client = new OpenAI({
    apiKey: apiKey,
    baseURL: BASE_URL
});

async function sleep(ms) {
    return new Promise(resolve => setTimeout(resolve, ms));
}

async function main() {
    try {
        console.log('=== 開始 Batch API 測試 ===\n');

        // Step 1: 上傳檔案
        console.log('步驟 1: 上傳包含請求資訊的 JSONL 檔案...');
        const fileStream = fs.createReadStream('test_model.jsonl');
        const fileObject = await client.files.create({
            file: fileStream,
            purpose: 'batch'
        });
        const fileId = fileObject.id;
        console.log(`✓ 檔案上傳成功，檔案ID: ${fileId}\n`);

        // Step 2: 建立 Batch 任務
        console.log('步驟 2: 建立 Batch 任務...');
        const batch = await client.batches.create({
            input_file_id: fileId,
            endpoint: '/v1/chat/ds-test',  // 測試模型使用 /v1/chat/ds-test
            completion_window: '24h'
        });
        const batchId = batch.id;
        console.log(`✓ Batch 任務建立成功，任務ID: ${batchId}\n`);

        // Step 3: 輪詢任務狀態
        console.log('步驟 3: 等待任務完成...');
        let status = batch.status;
        let pollCount = 0;
        let latestBatch = batch;

        while (!['completed', 'failed', 'expired', 'cancelled'].includes(status)) {
            await sleep(10000); // 等待 10 秒
            latestBatch = await client.batches.retrieve(batchId);
            status = latestBatch.status;
            pollCount++;
            console.log(`  [${pollCount}] 任務狀態: ${status}`);
        }

        console.log(`\n✓ 任務已完成，最終狀態: ${status}\n`);

        // Step 4: 處理結果
        if (status === 'completed') {
            console.log('步驟 4: 下載結果檔案...');

            // 下載成功結果
            const outputFileId = latestBatch.output_file_id;
            if (outputFileId) {
                console.log(`  輸出檔案ID: ${outputFileId}`);
                const content = await client.files.content(outputFileId);
                const text = await content.text();
                console.log('\n--- 成功結果（前 500 字元）---');
                console.log(text.substring(0, Math.min(500, text.length)));
                console.log('...\n');
            }

            // 下載錯誤檔案（如有）
            const errorFileId = latestBatch.error_file_id;
            if (errorFileId) {
                console.log(`  錯誤檔案ID: ${errorFileId}`);
                const errorContent = await client.files.content(errorFileId);
                const errorText = await errorContent.text();
                console.log('\n--- 錯誤資訊 ---');
                console.log(errorText);
            }

            console.log('\n=== 測試成功完成 ===');
        } else if (status === 'failed') {
            console.error('\n✗ Batch 任務失敗');
            if (latestBatch.errors) {
                console.error('錯誤資訊:', latestBatch.errors);
            }
            console.error('\n請參考錯誤碼文檔: https://www.alibabacloud.com/help/zh/model-studio/developer-reference/error-code');
        } else {
            console.log(`\n任務狀態: ${status}`);
        }

    } catch (error) {
        console.error('發生錯誤:', error.message);
        console.error(error);
    }
}

main();

Java（HTTP）

import java.io.*;
import java.net.HttpURLConnection;
import java.net.URL;
import java.nio.file.Files;
import java.nio.file.Paths;
import java.util.Scanner;

/**
 * 阿里雲百鍊 Batch API 測試 - 使用 HTTP API 呼叫
 *
 * 前置條件：
 * 1. 確保已經設定環境變數 DASHSCOPE_API_KEY
 * 2. 準備好測試檔案 test_model.jsonl（在專案根目錄）
 *
 * 地區配置說明：
 * - 北京地區：https://dashscope.aliyuncs.com/compatible-mode/v1
 * - 新加坡地區：https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/compatible-mode/v1
 */
public class BatchAPITest {

    // 新加坡地區的 Base URL
    private static final String BASE_URL = "https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/compatible-mode/v1";
    // 如果使用北京地區，請將上面的 BASE_URL 替換為：
    // private static final String BASE_URL = "https://dashscope.aliyuncs.com/compatible-mode/v1";

    private static String API_KEY;

    public static void main(String[] args) throws Exception {
        // 從環境變數擷取 API Key
        API_KEY = System.getenv("DASHSCOPE_API_KEY");
        if (API_KEY == null || API_KEY.isEmpty()) {
            System.err.println("錯誤: 請設定環境變數 DASHSCOPE_API_KEY");
            System.exit(1);
        }

        System.out.println("=== 開始 Batch API 測試 ===\n");

        try {
            // Step 1: 上傳檔案
            System.out.println("步驟 1: 上傳包含請求資訊的 JSONL 檔案...");
            String fileId = uploadFile("test_model.jsonl");
            System.out.println("✓ 檔案上傳成功，檔案ID: " + fileId + "\n");

            // Step 2: 建立 Batch 任務
            System.out.println("步驟 2: 建立 Batch 任務...");
            String batchId = createBatch(fileId);
            System.out.println("✓ Batch 任務建立成功，任務ID: " + batchId + "\n");

            // Step 3: 輪詢任務狀態
            System.out.println("步驟 3: 等待任務完成...");
            String status = "";
            int pollCount = 0;

            while (!isTerminalStatus(status)) {
                Thread.sleep(10000); // 等待 10 秒
                String batchInfo = getBatch(batchId);
                status = parseStatus(batchInfo);
                pollCount++;
                System.out.println("  [" + pollCount + "] 任務狀態: " + status);

                // Step 4: 如果完成，下載結果
                if ("completed".equals(status)) {
                    System.out.println("\n✓ 任務已完成！\n");
                    System.out.println("步驟 4: 下載結果檔案...");

                    String outputFileId = parseOutputFileId(batchInfo);
                    if (outputFileId != null && !outputFileId.isEmpty()) {
                        System.out.println("  輸出檔案ID: " + outputFileId);
                        String content = getFileContent(outputFileId);
                        System.out.println("\n--- 成功結果（前 500 字元）---");
                        System.out.println(content.substring(0, Math.min(500, content.length())));
                        System.out.println("...\n");
                    }

                    String errorFileId = parseErrorFileId(batchInfo);
                    if (errorFileId != null && !errorFileId.isEmpty() && !"null".equals(errorFileId)) {
                        System.out.println("  錯誤檔案ID: " + errorFileId);
                        String errorContent = getFileContent(errorFileId);
                        System.out.println("\n--- 錯誤資訊 ---");
                        System.out.println(errorContent);
                    }

                    System.out.println("\n=== 測試成功完成 ===");
                    break;
                } else if ("failed".equals(status)) {
                    System.err.println("\n✗ Batch 任務失敗");
                    System.err.println("任務資訊: " + batchInfo);
                    System.err.println("\n請參考錯誤碼文檔: https://www.alibabacloud.com/help/zh/model-studio/developer-reference/error-code");
                    break;
                } else if ("expired".equals(status) || "cancelled".equals(status)) {
                    System.out.println("\n任務狀態: " + status);
                    break;
                }
            }

        } catch (Exception e) {
            System.err.println("發生錯誤: " + e.getMessage());
            e.printStackTrace();
        }
    }

    /**
     * 上傳檔案
     */
    private static String uploadFile(String filePath) throws Exception {
        String boundary = "----WebKitFormBoundary" + System.currentTimeMillis();
        URL url = new URL(BASE_URL + "/files");
        HttpURLConnection conn = (HttpURLConnection) url.openConnection();
        conn.setDoOutput(true);
        conn.setRequestMethod("POST");
        conn.setRequestProperty("Authorization", "Bearer " + API_KEY);
        conn.setRequestProperty("Content-Type", "multipart/form-data; boundary=" + boundary);

        try (DataOutputStream out = new DataOutputStream(conn.getOutputStream())) {
            // 添加 purpose 欄位
            out.writeBytes("--" + boundary + "\r\n");
            out.writeBytes("Content-Disposition: form-data; name=\"purpose\"\r\n\r\n");
            out.writeBytes("batch\r\n");

            // 添加檔案
            out.writeBytes("--" + boundary + "\r\n");
            out.writeBytes("Content-Disposition: form-data; name=\"file\"; filename=\"" + filePath + "\"\r\n");
            out.writeBytes("Content-Type: application/octet-stream\r\n\r\n");

            byte[] fileBytes = Files.readAllBytes(Paths.get(filePath));
            out.write(fileBytes);
            out.writeBytes("\r\n");
            out.writeBytes("--" + boundary + "--\r\n");
        }

        String response = readResponse(conn);
        return parseField(response, "\"id\":\s*\"([^\"]+)\"");
    }

    /**
     * 建立 Batch 任務
     */
    private static String createBatch(String fileId) throws Exception {
        String jsonBody = String.format(
            "{\"input_file_id\":\"%s\",\"endpoint\":\"/v1/chat/ds-test\",\"completion_window\":\"24h\"}",
            fileId
        );

        String response = sendRequest("POST", "/batches", jsonBody);
        return parseField(response, "\"id\":\s*\"([^\"]+)\"");
    }

    /**
     * 擷取 Batch 任務資訊
     */
    private static String getBatch(String batchId) throws Exception {
        return sendRequest("GET", "/batches/" + batchId, null);
    }

    /**
     * 擷取檔案內容
     */
    private static String getFileContent(String fileId) throws Exception {
        return sendRequest("GET", "/files/" + fileId + "/content", null);
    }

    /**
     * 發送 HTTP 要求
     */
    private static String sendRequest(String method, String path, String jsonBody) throws Exception {
        URL url = new URL(BASE_URL + path);
        HttpURLConnection conn = (HttpURLConnection) url.openConnection();
        conn.setRequestMethod(method);
        conn.setRequestProperty("Authorization", "Bearer " + API_KEY);

        if (jsonBody != null) {
            conn.setDoOutput(true);
            conn.setRequestProperty("Content-Type", "application/json");
            try (OutputStream os = conn.getOutputStream()) {
                os.write(jsonBody.getBytes("UTF-8"));
            }
        }

        return readResponse(conn);
    }

    /**
     * 讀取響應
     */
    private static String readResponse(HttpURLConnection conn) throws Exception {
        int responseCode = conn.getResponseCode();
        InputStream is = (responseCode < 400) ? conn.getInputStream() : conn.getErrorStream();

        try (Scanner scanner = new Scanner(is, "UTF-8").useDelimiter("\\A")) {
            return scanner.hasNext() ? scanner.next() : "";
        }
    }

    /**
     * 解析 JSON 欄位（簡單實現）
     */
    private static String parseField(String json, String regex) {
        java.util.regex.Pattern pattern = java.util.regex.Pattern.compile(regex);
        java.util.regex.Matcher matcher = pattern.matcher(json);
        return matcher.find() ? matcher.group(1) : null;
    }

    private static String parseStatus(String json) {
        return parseField(json, "\"status\":\s*\"([^\"]+)\"");
    }

    private static String parseOutputFileId(String json) {
        return parseField(json, "\"output_file_id\":\s*\"([^\"]+)\"");
    }

    private static String parseErrorFileId(String json) {
        return parseField(json, "\"error_file_id\":\s*\"([^\"]+)\"");
    }

    /**
     * 判斷是否為終止狀態
     */
    private static boolean isTerminalStatus(String status) {
        return "completed".equals(status)
            || "failed".equals(status)
            || "expired".equals(status)
            || "cancelled".equals(status);
    }
}

curl (HTTP)

#!/bin/bash
# 阿里雲百鍊 Batch API 測試 - 使用 curl
#
# 前置條件：
# 1. 確保已經設定環境變數 DASHSCOPE_API_KEY
# 2. 準備好測試檔案 test_model.jsonl（在目前的目錄）
#
# 地區配置說明：
# - 北京地區：https://dashscope.aliyuncs.com/compatible-mode/v1
# - 新加坡地區：https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/compatible-mode/v1

API_KEY="${DASHSCOPE_API_KEY}"
BASE_URL="https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/compatible-mode/v1"

# 如果使用北京地區，請將 BASE_URL 替換為：
# BASE_URL="https://dashscope.aliyuncs.com/compatible-mode/v1"

# 檢查 API Key
if [ -z "$API_KEY" ]; then
    echo "錯誤: 請設定環境變數 DASHSCOPE_API_KEY"
    exit 1
fi

echo "=== 開始 Batch API 測試 ==="
echo ""

# Step 1: 上傳檔案
echo "步驟 1: 上傳包含請求資訊的 JSONL 檔案..."
UPLOAD_RESPONSE=$(curl -s -X POST "${BASE_URL}/files" \
  -H "Authorization: Bearer ${API_KEY}" \
  -F 'file=@test_model.jsonl' \
  -F 'purpose=batch')

FILE_ID=$(echo $UPLOAD_RESPONSE | grep -o '"id":"[^"]*"' | head -1 | cut -d'"' -f4)
echo "✓ 檔案上傳成功，檔案ID: ${FILE_ID}"
echo ""

# Step 2: 建立 Batch 任務
echo "步驟 2: 建立 Batch 任務..."
BATCH_RESPONSE=$(curl -s -X POST "${BASE_URL}/batches" \
  -H "Authorization: Bearer ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d "{\"input_file_id\":\"${FILE_ID}\",\"endpoint\":\"/v1/chat/ds-test\",\"completion_window\":\"24h\"}")

BATCH_ID=$(echo $BATCH_RESPONSE | grep -o '"id":"[^"]*"' | head -1 | cut -d'"' -f4)
echo "✓ Batch 任務建立成功，任務ID: ${BATCH_ID}"
echo ""

# Step 3: 輪詢任務狀態
echo "步驟 3: 等待任務完成..."
STATUS=""
POLL_COUNT=0

while [[ "$STATUS" != "completed" && "$STATUS" != "failed" && "$STATUS" != "expired" && "$STATUS" != "cancelled" ]]; do
    sleep 10
    BATCH_INFO=$(curl -s -X GET "${BASE_URL}/batches/${BATCH_ID}" \
      -H "Authorization: Bearer ${API_KEY}")
    STATUS=$(echo $BATCH_INFO | grep -o '"status":"[^"]*"' | cut -d'"' -f4)
    POLL_COUNT=$((POLL_COUNT + 1))
    echo "  [${POLL_COUNT}] 任務狀態: ${STATUS}"
done

echo ""
echo "✓ 任務已完成，最終狀態: ${STATUS}"
echo ""

# Step 4: 下載結果
if [[ "$STATUS" == "completed" ]]; then
    echo "步驟 4: 下載結果檔案..."

    OUTPUT_FILE_ID=$(echo $BATCH_INFO | grep -o '"output_file_id":"[^"]*"' | cut -d'"' -f4)
    if [[ -n "$OUTPUT_FILE_ID" && "$OUTPUT_FILE_ID" != "null" ]]; then
        echo "  輸出檔案ID: ${OUTPUT_FILE_ID}"

        RESULT_CONTENT=$(curl -s -X GET "${BASE_URL}/files/${OUTPUT_FILE_ID}/content" \
          -H "Authorization: Bearer ${API_KEY}")

        echo ""
        echo "--- 成功結果（前 500 字元）---"
        echo "${RESULT_CONTENT:0:500}"
        echo "..."
        echo ""
    fi

    ERROR_FILE_ID=$(echo $BATCH_INFO | grep -o '"error_file_id":"[^"]*"' | cut -d'"' -f4)
    if [[ -n "$ERROR_FILE_ID" && "$ERROR_FILE_ID" != "null" ]]; then
        echo "  錯誤檔案ID: ${ERROR_FILE_ID}"

        ERROR_CONTENT=$(curl -s -X GET "${BASE_URL}/files/${ERROR_FILE_ID}/content" \
          -H "Authorization: Bearer ${API_KEY}")

        echo ""
        echo "--- 錯誤資訊 ---"
        echo "${ERROR_CONTENT}"
    fi

    echo ""
    echo "=== 測試成功完成 ==="
elif [[ "$STATUS" == "failed" ]]; then
    echo ""
    echo "✗ Batch 任務失敗"
    echo "任務資訊: ${BATCH_INFO}"
    echo ""
    echo "請參考錯誤碼文檔: https://www.alibabacloud.com/help/zh/model-studio/developer-reference/error-code"
else
    echo ""
    echo "任務狀態: ${STATUS}"
fi

OpenAI Python SDK

import os
from openai import OpenAI

client = OpenAI(
    # 若沒有配置環境變數，可用阿里雲百鍊API Key將下行替換為：api_key="sk-xxx"。但不建議在生產環境中直接將API Key寫入程式碼到代碼中，以減少API Key泄露風險。
    # 新加坡和北京地區的API Key不同。
    api_key=os.getenv("DASHSCOPE_API_KEY"), 
    # 以下是北京地區base_url，如果使用新加坡地區的模型，需要將base_url替換為：https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/compatible-mode/v1
    # 注意：切換地區時，API Key也需要對應更換
    base_url="https://dashscope.aliyuncs.com/compatible-mode/v1",
)

batch = client.batches.create(
    input_file_id="file-batch-xxx",  # 上傳檔案返回的 id
    endpoint="/v1/chat/completions",  # Embedding文本向量模型填寫"/v1/embeddings",測試模型batch-test-model填寫/v1/chat/ds-test,其他模型填寫/v1/chat/completions
    completion_window="24h", 
    metadata={
            "ds_batch_finish_callback": "https://xxx/xxx"
          }
)
print(batch)

curl(HTTP)

curl -X POST --location "https://dashscope.aliyuncs.com/compatible-mode/v1/batches" \
    -H "Authorization: Bearer $DASHSCOPE_API_KEY" \
    -H "Content-Type: application/json" \
    -d '{
          "input_file_id": "file-batch-xxxxx",
          "endpoint": "/v1/chat/completions",
          "completion_window": "24h",
          "metadata": {
            "ds_batch_finish_callback": "https://xxx/xxx"
          }
        }'