创建批处理任务

创建批处理任务

curl --request POST \
  --url https://open.bigmodel.cn/api/paas/v4/batches \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "input_file_id": "<string>",
  "endpoint": "/v4/chat/completions",
  "auto_delete_input_file": true,
  "metadata": {}
}
'

import requests

url = "https://open.bigmodel.cn/api/paas/v4/batches"

payload = {
    "input_file_id": "<string>",
    "endpoint": "/v4/chat/completions",
    "auto_delete_input_file": True,
    "metadata": {}
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    input_file_id: '<string>',
    endpoint: '/v4/chat/completions',
    auto_delete_input_file: true,
    metadata: {}
  })
};

fetch('https://open.bigmodel.cn/api/paas/v4/batches', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

HttpResponse<String> response = Unirest.post("https://open.bigmodel.cn/api/paas/v4/batches")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"input_file_id\": \"<string>\",\n  \"endpoint\": \"/v4/chat/completions\",\n  \"auto_delete_input_file\": true,\n  \"metadata\": {}\n}")
  .asString();

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://open.bigmodel.cn/api/paas/v4/batches"

	payload := strings.NewReader("{\n  \"input_file_id\": \"<string>\",\n  \"endpoint\": \"/v4/chat/completions\",\n  \"auto_delete_input_file\": true,\n  \"metadata\": {}\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://open.bigmodel.cn/api/paas/v4/batches",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'input_file_id' => '<string>',
    'endpoint' => '/v4/chat/completions',
    'auto_delete_input_file' => true,
    'metadata' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "id": "<string>",
  "object": "<string>",
  "endpoint": "<string>",
  "input_file_id": "<string>",
  "completion_window": "<string>",
  "status": "<string>",
  "output_file_id": "<string>",
  "error_file_id": "<string>",
  "created_at": 123,
  "in_progress_at": 123,
  "expires_at": 123,
  "finalizing_at": 123,
  "completed_at": 123,
  "failed_at": 123,
  "expired_at": 123,
  "cancelling_at": 123,
  "cancelled_at": 123,
  "request_counts": 123,
  "total": 123,
  "completed": 123,
  "failed": 123,
  "metadata": {}
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

POST

paas

batches

创建批处理任务

curl --request POST \
  --url https://open.bigmodel.cn/api/paas/v4/batches \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "input_file_id": "<string>",
  "endpoint": "/v4/chat/completions",
  "auto_delete_input_file": true,
  "metadata": {}
}
'

import requests

url = "https://open.bigmodel.cn/api/paas/v4/batches"

payload = {
    "input_file_id": "<string>",
    "endpoint": "/v4/chat/completions",
    "auto_delete_input_file": True,
    "metadata": {}
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    input_file_id: '<string>',
    endpoint: '/v4/chat/completions',
    auto_delete_input_file: true,
    metadata: {}
  })
};

fetch('https://open.bigmodel.cn/api/paas/v4/batches', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

HttpResponse<String> response = Unirest.post("https://open.bigmodel.cn/api/paas/v4/batches")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"input_file_id\": \"<string>\",\n  \"endpoint\": \"/v4/chat/completions\",\n  \"auto_delete_input_file\": true,\n  \"metadata\": {}\n}")
  .asString();

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://open.bigmodel.cn/api/paas/v4/batches"

	payload := strings.NewReader("{\n  \"input_file_id\": \"<string>\",\n  \"endpoint\": \"/v4/chat/completions\",\n  \"auto_delete_input_file\": true,\n  \"metadata\": {}\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://open.bigmodel.cn/api/paas/v4/batches",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'input_file_id' => '<string>',
    'endpoint' => '/v4/chat/completions',
    'auto_delete_input_file' => true,
    'metadata' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "id": "<string>",
  "object": "<string>",
  "endpoint": "<string>",
  "input_file_id": "<string>",
  "completion_window": "<string>",
  "status": "<string>",
  "output_file_id": "<string>",
  "error_file_id": "<string>",
  "created_at": 123,
  "in_progress_at": 123,
  "expires_at": 123,
  "finalizing_at": 123,
  "completed_at": 123,
  "failed_at": 123,
  "expired_at": 123,
  "cancelling_at": 123,
  "cancelled_at": 123,
  "request_counts": 123,
  "total": 123,
  "completed": 123,
  "failed": 123,
  "metadata": {}
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

Authorizations

Authorization

string

header

required

标准的 HTTP Bearer 认证方式，在 API Keys 页面获取密钥。

Body

application/json

input_file_id

string

required

上传文件的 ID，该文件包含Batch的请求。输入文件必须是 .Jsonl 格式，并且文件上传时的目的必须标记为"batch"。

endpoint

enum<string>

required

Batch 中所有请求将使用的端点。目前支持 /v4/chat/completions。

Available options:

/v4/chat/completions

auto_delete_input_file

boolean

default:true

是否自动删除batch原始文件，默认为True：True：执行自动删除。False：保留原始batch文件。

metadata

object | null

用于存储与 Batch 相关的数据，如客户ID、描述或其他任务管理和跟踪所需的额外信息。可附加到对象上的键值对集合最多为 16 个。每个键的长度最多为 64 个字符，每个值的长度最多为 512 个字符。

Response

业务处理成功

string

批处理的唯一标识符。

object

string

对象类型，这里为 batch。

endpoint

string

批处理使用的 API 端点。

input_file_id

string

批处理使用的输入文件的ID。

completion_window

string

批处理应在此时间框架内完成的期限。

status

string

批处理的当前状态。

output_file_id

string

包含成功执行请求的输出的文件ID。

error_file_id

string

包含出现错误的请求的输出的文件ID。

created_at

integer

创建批处理的Unix时间戳（秒）。

in_progress_at

integer

批处理开始处理的Unix时间戳（秒）。

expires_at

integer

批处理将过期的Unix时间戳（秒）。

finalizing_at

integer

批处理开始最终处理的Unix时间戳（秒）。

completed_at

integer

批处理完成的Unix时间戳（秒）。

failed_at

integer

批处理失败的Unix时间戳（秒）。

expired_at

integer

批处理过期的Unix时间戳（秒）。

cancelling_at

integer

批处理开始取消的Unix时间戳（秒）。

cancelled_at

integer

批处理取消完成的Unix时间戳（秒）。

request_counts

integer

batch 请求计数。

total

integer

批处理中的请求总数。

completed

integer

批处理中已成功完成的请求数量。

failed

integer

批处理中失败的请求数量。

metadata

object

可附加到对象上的 16 个键值对的集合。这有助于以结构化格式存储对象的附加信息。键的长度最多为 64 个字符，值的长度最多为 512 个字符。

API 指引

模型 API

工具 API

Managed Agents API (Beta)

Agent API

文件 API

批处理 API

知识库 API

实时 API

Authorizations

Body

Response