取消批处理任务

根据批处理任务ID取消正在运行的批量处理任务。见 批量服务。点击 Try it 按钮可快速试用。

POST /paas/v4/batches/{batch_id}/cancel

取消批处理任务

cURL

curl --request POST \
  --url https://open.bigmodel.cn/api/paas/v4/batches/{batch_id}/cancel \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://open.bigmodel.cn/api/paas/v4/batches/{batch_id}/cancel"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://open.bigmodel.cn/api/paas/v4/batches/{batch_id}/cancel', 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/{batch_id}/cancel")
  .header("Authorization", "Bearer <token>")
  .asString();

package main

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

func main() {

	url := "https://open.bigmodel.cn/api/paas/v4/batches/{batch_id}/cancel"

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

	req.Header.Add("Authorization", "Bearer <token>")

	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/{batch_id}/cancel",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

200

{
  "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 页面获取密钥。

Path Parameters

batch_id · string · required

批处理任务ID

Response

200

application/json

业务处理成功

id · 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 个字符。