你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Batch - Create

参考

服务:: Azure AI Services

API 版本:: 2024-07-01-preview

从上传的请求文件创建和执行批处理。响应包括排队作业的详细信息，包括作业状态。完成后，结果文件的 ID 将添加到响应中。

POST {endpoint}/openai/batches?api-version=2024-07-01-preview

URI 参数

名称	在	必需	类型	说明
endpoint	path	True	string url	支持的认知服务终结点（协议和主机名，例如：https://aoairesource.openai.azure.com。将“aoairesource”替换为 Azure OpenAI 帐户名称。
api-version	query	True	string	请求的 API 版本。

请求正文

名称	必需	类型	说明
completion_window	True	string	批处理的处理时间范围。
endpoint	True	string	批处理使用的 API 终结点。
input_file_id	True	string	如果批处理的输入文件，则为 ID。
metadata		object	可以附加到批处理的一组键值对。这可用于以结构化格式存储有关批的其他信息。

响应

名称	类型	说明
201 Created	Batch	已成功创建批处理。
Other Status Codes	ErrorResponse	发生错误。

安全性

api-key

API 密钥身份验证

类型: apiKey
在: header

OAuth2Auth

OAuth2 身份验证

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

作用域

名称	说明
https://cognitiveservices.azure.com/.default

示例

Creating a batch.

示例请求

HTTP

POST https://aoairesource.openai.azure.com/openai/batches?api-version=2024-07-01-preview

示例响应

状态代码:: 201

{
  "object": "batch",
  "id": "batch_72a2792ef7d24ba7b82c7fe4a37e379f",
  "endpoint": "/chat/completions",
  "errors": null,
  "input_file_id": "file-b4fa7277f3eb4722ac18b90f46102c3f",
  "completion_window": "24h",
  "status": "validating",
  "output_file_id": null,
  "error_file_id": null,
  "created_at": 1646126127,
  "in_progress_at": null,
  "expires_at": null,
  "finalizing_at": null,
  "completed_at": null,
  "failed_at": null,
  "expired_at": null,
  "cancelling_at": null,
  "cancelled_at": null,
  "request_counts": {
    "total": 0,
    "completed": 0,
    "failed": 0
  },
  "metadata": {
    "batch_description": "Evaluation job"
  }
}

定义

名称	说明
Batch	批
BatchCreateRequest	BatchCreateRequest
BatchErrorData	BatchErrorData
BatchErrors	BatchErrors
BatchRequestCounts	BatchRequestCounts
BatchStatus	BatchStatus
Error	错误
ErrorCode	ErrorCode
ErrorResponse	ErrorResponse
InnerError	InnerError
InnerErrorCode	InnerErrorCode
TypeDiscriminator	TypeDiscriminator

Batch

批

名称	类型	说明
cancelled_at	integer	取消此批时的时间戳（在 unix 纪元中）。
cancelling_at	integer	此批处理开始取消时的时间戳（在 unix 纪元中）。
completed_at	integer	此批完成时的时间戳（在 unix 纪元中）。
completion_window	string	批处理的处理时间范围。
created_at	integer	创建此批时的时间戳（在 unix 纪元中）。
endpoint	string	批处理使用的 API 终结点。
error_file_id	string	包含出现错误的请求输出的文件的 ID。
errors	BatchErrors	BatchErrors 对于失败的批处理，这将包含有关失败原因的详细信息。
expired_at	integer	此批过期时的时间戳（在 unix 纪元中）。
expires_at	integer	此批到期时的时间戳（在 unix 纪元中）。
failed_at	integer	此批处理失败时的时间戳（在 unix 纪元中）。
finalizing_at	integer	此批开始完成时的时间戳（在 unix 纪元中）。
id	string	此项的标识。
in_progress_at	integer	此批处理开始进行时的时间戳（在 unix 纪元中）。
input_file_id	string	批处理的输入文件的 ID。
metadata	object	可以附加到批处理的一组键值对。这可用于以结构化格式存储有关批的其他信息。
object	TypeDiscriminator	TypeDiscriminator 定义对象的类型。
output_file_id	string	包含成功执行请求的输出的文件的 ID。
request_counts	BatchRequestCounts	BatchRequestCounts 请求对批处理中不同状态进行计数。
status	BatchStatus	BatchStatus 批处理的状态。

BatchCreateRequest

名称	类型	说明
completion_window	string	批处理的处理时间范围。
endpoint	string	批处理使用的 API 终结点。
input_file_id	string	如果批处理的输入文件，则为 ID。
metadata	object	可以附加到批处理的一组键值对。这可用于以结构化格式存储有关批的其他信息。

BatchErrorData

名称	类型	说明
code	string	标识错误类型的错误代码。
line	string	发生错误的输入文件的行号（如果适用）（可以为 null）。
message	string	提供有关错误的更多详细信息的用户可读消息。
param	string	导致错误的参数的名称（如果适用）（可以为 null）。

BatchErrors

名称	类型	说明
data	BatchErrorData	BatchErrorData 批处理中失败的错误信息。
object	string	errors 对象的类型。这始终是“list”。

BatchRequestCounts

名称	类型	说明
completed	integer	批处理中成功完成的请求数。
failed	integer	批处理中失败的请求数。
total	integer	批处理中的请求总数。

BatchStatus

名称	类型	说明
cancelled	string	批处理已取消。
cancelling	string	已启动批处理取消。
completed	string	批处理已完成，结果已准备就绪。
expired	string	批处理无法在 24 小时内完成。
failed	string	输入文件未能通过验证过程。
finalizing	string	批处理已完成，结果正在准备中。
in_progress	string	输入文件已成功验证，并且当前正在执行批处理。
validating	string	在批处理开始之前，正在验证输入文件。

Error

错误

名称	类型	说明
code	ErrorCode	ErrorCode Microsoft REST 准则（https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses）中定义的错误代码。
details	Error[]	错误详细信息（如果可用）。
innererror	InnerError	InnerError Microsoft REST 准则（https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses）中定义的内部错误。
message	string	此错误的消息。
target	string	发生错误的位置（如果可用）。

ErrorCode

名称	类型	说明
conflict	string	请求的操作与当前资源状态冲突。
contentFilter	string	由于我们的安全系统，映像生成失败。
fileImportFailed	string	导入文件失败。
forbidden	string	当前用户/API 密钥禁止此操作。
internalFailure	string	内部错误。请重试。
invalidPayload	string	此操作的请求数据无效。
itemDoesAlreadyExist	string	该项已存在。
jsonlValidationFailed	string	jsonl 数据的验证失败。
notFound	string	找不到资源。
quotaExceeded	string	超出配额。
serviceUnavailable	string	该服务当前不可用。
tooManyRequests	string	请求过多。请稍后重试。
unauthorized	string	当前用户/API 密钥未获得操作的授权。
unexpectedEntityState	string	无法以当前资源的状态执行该操作。

ErrorResponse

名称	类型	说明
error	Error	错误 Microsoft REST 准则（https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses）中定义的错误内容。

InnerError

名称	类型	说明
code	InnerErrorCode	InnerErrorCode Microsoft REST 准则（https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses）中定义的内部错误代码。
innererror	InnerError	InnerError Microsoft REST 准则（https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses）中定义的内部错误。

InnerErrorCode

名称	类型	说明
invalidPayload	string	此操作的请求数据无效。

TypeDiscriminator

名称	类型	说明
batch	string	此对象表示批处理。
file	string	此对象表示文件。
fine_tuning.job	string	此对象表示微调作业。
fine_tuning.job.checkpoint	string	此对象表示微调作业的检查点。
fine_tuning.job.event	string	此对象表示微调作业的事件。
list	string	此对象表示其他对象的列表。
model	string	此对象表示模型（可以是基础模型或微调作业结果）。

通过