查询批处理任务列表

查询批处理任务列表

curl --request GET \
  --url https://api.ppinfra.com/openai/v1/batches

GET

https://api.ppinfra.com

openai

batches

查询批处理任务列表

curl --request GET \
  --url https://api.ppinfra.com/openai/v1/batches

查询所有可用的批处理任务列表。

请求头

Content-Type

string

required

枚举值: application/json

Authorization

string

required

Bearer 身份验证格式，例如：Bearer {{API 密钥}}。

响应

data

array

required

批处理任务对象数组。

显示 properties

string

required

批处理任务的唯一标识符。

object

string

required

对象类型，恒为 batch。

endpoint

string

required

批处理任务用于处理请求的 API 端点。

input_file_id

string

required

包含批处理请求的输入文件 ID。

output_file_id

string

required

包含批处理结果的输出文件 ID。在批处理完成之前为空。

error_file_id

string

required

包含批处理过程中发生的错误的错误文件 ID。在出现错误之前为空。

completion_window

string

required

批处理完成的时间窗口。当前固定为 48h。

in_progress_at

string | null

批处理开始处理的时间戳。若尚未开始则为 null。

expires_at

string | null

批处理到期的时间戳。若未设置则为 null。

finalizing_at

string | null

批处理开始进入最终化阶段的时间戳。若尚未进入则为 null。

completed_at

string | null

批处理完成的时间戳。若尚未完成则为 null。

failed_at

string | null

批处理失败的时间戳。若未失败则为 null。

expired_at

string | null

批处理过期的时间戳。若未过期则为 null。

cancelling_at

string | null

批处理开始取消的时间戳。若未在取消中则为 null。

cancelled_at

string | null

批处理被取消的时间戳。若未被取消则为 null。

status

string

required

批处理任务的当前状态。可用状态：

VALIDATING - 在批处理开始前正在验证输入文件
PROGRESS - 批处理进行中
COMPLETED - 批处理成功完成
FAILED - 批处理失败
EXPIRED - 批处理超过截止时间
CANCELLING - 正在取消批处理
CANCELLED - 批处理已取消

errors

string

批处理过程中发生错误时的错误信息。

version

integer

required

批处理任务的版本号。

created_at

string

required

批处理任务的创建时间戳。

updated_at

string | null

批处理任务最近一次更新的时间戳。若从未更新则为 null。

created_by

string

required

创建该批处理任务的用户唯一标识符。

created_by_key_id

string

required

用于创建该批处理任务的 API Key ID。

remark

string

批处理任务的可选备注信息。

total

integer

required

批处理中的请求总数。

completed

integer

required

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

failed

integer

required

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

metadata

object | null

与批处理任务关联的附加元数据。若无则为 null。

request_counts

object

required

请求计数的详细信息。

显示 properties

total

integer

required

批处理中的请求总数。

completed

integer

required

成功完成的请求数量。

failed

integer

required

失败的请求数量。

first_id

string

required

列表中第一个批处理任务的 ID。

has_more

boolean

required

指示在该列表之外是否还有更多批处理任务。

last_id

string

required

列表中最后一个批处理任务的 ID。

object

string

required

对象类型，恒为 list。

取消批处理任务上传文件

⌘I

基础

大语言

图像

视频

音频

联网搜索

任务

请求头

响应

基础

大语言

图像

视频

音频

联网搜索

任务

​请求头

​响应

请求头

响应