批处理 API
创建批处理任务
创建一个新的批量处理任务。见 批量服务。点击 Try it 按钮可快速试用。
post/paas/v4/batches
Request body
input_file_idstring required
上传文件的 ID，该文件包含Batch的请求。输入文件必须是 .Jsonl 格式，并且文件上传时的目的必须标记为"batch"。
endpoint'/v4/chat/completions' required
Batch 中所有请求将使用的端点。目前支持 /v4/chat/completions。
auto_delete_input_fileboolean
是否自动删除batch原始文件，默认为True：True：执行自动删除。False：保留原始batch文件。
metadataobject nullable
用于存储与 Batch 相关的数据，如客户ID、描述或其他任务管理和跟踪所需的额外信息。可附加到对象上的键值对集合最多为 16 个。每个键的长度最多为 64 个字符，每个值的长度最多为 512 个字符。
Response
业务处理成功
idstring
批处理的唯一标识符。
objectstring
对象类型，这里为 batch。
endpointstring
批处理使用的 API 端点。
input_file_idstring
批处理使用的输入文件的ID。
completion_windowstring
批处理应在此时间框架内完成的期限。
statusstring
批处理的当前状态。
output_file_idstring
包含成功执行请求的输出的文件ID。
error_file_idstring
包含出现错误的请求的输出的文件ID。
created_atinteger
创建批处理的Unix时间戳（秒）。
in_progress_atinteger
批处理开始处理的Unix时间戳（秒）。
expires_atinteger
批处理将过期的Unix时间戳（秒）。
finalizing_atinteger
批处理开始最终处理的Unix时间戳（秒）。
completed_atinteger
批处理完成的Unix时间戳（秒）。
failed_atinteger
批处理失败的Unix时间戳（秒）。
expired_atinteger
批处理过期的Unix时间戳（秒）。
cancelling_atinteger
批处理开始取消的Unix时间戳（秒）。
cancelled_atinteger
批处理取消完成的Unix时间戳（秒）。
request_countsinteger
batch 请求计数。
totalinteger
批处理中的请求总数。
completedinteger
批处理中已成功完成的请求数量。
failedinteger
批处理中失败的请求数量。
metadataobject
可附加到对象上的 16 个键值对的集合。这有助于以结构化格式存储对象的附加信息。键的长度最多为 64 个字符，值的长度最多为 512 个字符。