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

Files - Upload

Service:

Azure AI Services

API Version:

2024-02-01

通过从本地计算机上传数据创建新的文件实体。 例如，上传的文件可用于训练或评估微调后的模型。

POST {endpoint}/openai/files?api-version=2024-02-01

URI 参数

名称	在	必需	类型	说明
file	formData	True	file	获取或设置要上传到 Azure OpenAI 的文件。
purpose	formData	True	Purpose	已上传的文档的预期用途。 使用“fine-tune”进行微调。 这样，我们就可以验证已上传文件的格式。
endpoint	path	True	string url	支持的认知服务终结点 (协议和主机名，例如： https://aoairesource.openai.azure.com。将“aoairesource”替换为 Azure OpenAI 帐户名称) 。
api-version	query	True	string	请求的 API 版本。

请求头

Media Types: "multipart/form-data"

名称	必需	类型	说明
api-key	True	string	在此处提供认知服务 Azure OpenAI 帐户密钥。

响应

名称	类型	说明
201 Created	File	已成功创建文件。 Headers Location: string
Other Status Codes	ErrorResponse	出现了错误。

安全性

api-key

在此处提供认知服务 Azure OpenAI 帐户密钥。

Type: apiKey
In: header

示例

Upload a file.

Sample Request

HTTP

POST https://aoairesource.openai.azure.com/openai/files?api-version=2024-02-01

Sample Response

Status code:

201

location: https://aoairesource.openai.azure.com/openai/files/file-181a1cbdcdcf4677ada87f63a0928099

Response Body

{
  "purpose": "fine-tune",
  "filename": "puppy.jsonl",
  "id": "file-181a1cbdcdcf4677ada87f63a0928099",
  "status": "notRunning",
  "created_at": 1646126127,
  "object": "file"
}

定义

名称	说明
Error	错误
ErrorCode	ErrorCode
ErrorResponse	ErrorResponse
File	文件
FileState	FileState
InnerError	InnerError
InnerErrorCode	InnerErrorCode
Purpose	目的
TypeDiscriminator	TypeDiscriminator

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

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

ErrorResponse

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

File

文件

名称	类型	说明
bytes	integer	(可用时，此文件的大小可以为 null) 。 不支持大于 2^53-1 的文件大小，以确保与 JavaScript 整数兼容。
created_at	integer	创建此作业或项时的时间戳 (unix) ep。
filename	string	文件的名称。
id	string	此项的标识。
object	TypeDiscriminator	TypeDiscriminator 定义 对象的类型。
purpose	Purpose	目的 已上传的文档的预期用途。 使用“fine-tune”进行微调。 这样，我们就可以验证已上传文件的格式。
status	FileState	FileState 文件的状态。
status_details	string	错误消息，其中包含此文件处理失败时的详细信息。

FileState

FileState

名称	类型	说明
deleted	string	该实体已被删除，但仍可能被删除前的其他实体引用。 它可以归类为终端状态。
deleting	string	实体是要删除的进程。 此状态不会由 Azure OpenAI 返回，只是为了兼容而公开。 它可以归类为活动状态。
error	string	操作已完成处理但失败，无法进一步使用。 它可以归类为终端状态。
pending	string	操作已创建，并且不会排队等待将来处理。 它可以归类为非活动状态。
processed	string	操作已成功处理并已准备好使用。 它可以归类为终端状态。
running	string	已开始处理操作。 它可以归类为活动状态。
uploaded	string	文件已上传，但尚未处理。 此状态不会由 Azure OpenAI 返回，只是为了兼容而公开。 它可以归类为非活动状态。

InnerError

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

InnerErrorCode

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

Purpose

目的

名称	类型	说明
fine-tune	string	此文件包含微调作业的训练数据。
fine-tune-results	string	此文件包含微调作业的结果。

TypeDiscriminator

TypeDiscriminator

名称	类型	说明
file	string	此对象表示文件。
fine-tune	string	此对象表示微调作业。
fine-tune-event	string	此对象表示微调作业的事件。
fine_tuning.job	string	此对象表示微调作业。
fine_tuning.job.event	string	此对象表示微调作业的事件。
list	string	此对象表示其他对象的列表。
model	string	此对象表示模型 (可以是基础模型或微调作业结果) 。