取消 Batch - ChatfireAPI

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

Authorization: Bearer ********************

Path 参数

batch_id

string

必需

此参数为批处理任务的唯一标识符，用于指定需要检索的 Batch

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

返回响应

🟢200成功

application/json

Body

id

string

批处理的唯一标识符。

必需

object

string

对象类型，这里为 "batch"。

必需

endpoint

string

批处理使用的 API 端点。

必需

errors

null

必需

input_file_id

string

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

必需

completion_window

string

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

必需

status

string

批处理的当前状态。

必需

output_file_id

null

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

必需

error_file_id

null

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

必需

created_at

integer

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

必需

in_progress_at

integer

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

必需

expires_at

integer

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

必需

finalizing_at

null

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

必需

completed_at

null

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

必需

failed_at

null

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

必需

expired_at

null

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

必需

cancelling_at

integer

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

必需

cancelled_at

null

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

必需

request_counts

object

batch 请求计数。

必需

total

integer

批处理中的请求总数。

必需

completed

integer

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

必需

failed

integer

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

必需

metadata

object

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

必需

customer_id

string

必需

batch_description

string

必需

示例

{
  "id": "batch_abc123",
  "object": "batch",
  "endpoint": "/v1/chat/completions",
  "errors": null,
  "input_file_id": "file-abc123",
  "completion_window": "24h",
  "status": "cancelling",
  "output_file_id": null,
  "error_file_id": null,
  "created_at": 1711471533,
  "in_progress_at": 1711471538,
  "expires_at": 1711557933,
  "finalizing_at": null,
  "completed_at": null,
  "failed_at": null,
  "expired_at": null,
  "cancelling_at": 1711475133,
  "cancelled_at": null,
  "request_counts": {
    "total": 100,
    "completed": 23,
    "failed": 1
  },
  "metadata": {
    "customer_id": "user_123456789",
    "batch_description": "Nightly eval job",
  }
}