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

Files - Import

服务:: Azure AI Services

API 版本:: 2024-10-21

通过从提供的 URL 导入数据来创建新文件实体。例如，上传的文件可用于训练或评估微调的模型。

POST {endpoint}/openai/files/import?api-version=2024-10-21

URI 参数

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

请求头

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

请求正文

名称	必需	类型	说明
content_url	True	string (url)	要从中下载文档的 URL（可以是 Blob 的 SAS URL，也可以是可通过 GET 请求访问的任何其他外部 URL）。
filename	True	string minLength: 1	要上传的 JSON 行文件的名称。如果 `purpose` 设置为“微调”，则每行都是一条 JSON 记录，其中包含表示训练示例的“提示”和“完成”字段。

响应

名称	类型	说明
201 Created	File	文件已成功创建。标头 Location: string
Other Status Codes	ErrorResponse	发生错误。

名称

类型

说明

201 Created

File

文件已成功创建。

标头

Location: string

Other Status Codes

ErrorResponse

发生错误。

安全性

api-key

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

类型: apiKey
在: header

示例

Importing a file with a blob url as source.

示例请求

HTTP

POST https://aoairesource.openai.azure.com/openai/files/import?api-version=2024-10-21


{
  "purpose": "fine-tune",
  "filename": "puppy.jsonl",
  "content_url": "https://www.contoso.com/trainingdata/puppy.jsonl"
}

示例响应

状态代码:: 201

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

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

定义

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

Error

Object

错误

名称	类型	说明
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 minLength: 1	此错误的消息。
target	string	发生错误的位置（如果可用）。

ErrorCode

枚举

ErrorCode

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

ErrorResponse

Object

ErrorResponse

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

File

Object

文件

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

FileImport

Object

FileImport

名称	类型	说明
content_url	string (url)	要从中下载文档的 URL（可以是 Blob 的 SAS URL，也可以是可通过 GET 请求访问的任何其他外部 URL）。
filename	string minLength: 1	要上传的 JSON 行文件的名称。如果 `purpose` 设置为“微调”，则每行都是一条 JSON 记录，其中包含表示训练示例的“提示”和“完成”字段。
purpose	Purpose	目的上传的文档的预期用途。使用“微调”进行微调。这样，我们就可以验证上传的文件的格式。

FileState

枚举

FileState

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

InnerError

Object

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	此操作的请求数据无效。

Purpose

枚举

目的

值	说明
fine-tune	此文件包含用于微调作业的训练数据。
fine-tune-results	此文件包含微调作业的结果。
assistants	此文件包含要用于助手的数据。
assistants_output	此文件包含助理的结果。
batch	此文件包含批处理的输入数据。
batch_output	此文件包含批处理的结果。

TypeDiscriminator

枚举

TypeDiscriminator

值	说明
list	此对象表示其他对象的列表。
fine_tuning.job	此对象表示微调作业。
file	此对象表示文件。
fine_tuning.job.event	此对象表示微调作业的事件。
fine_tuning.job.checkpoint	此对象表示微调作业的检查点。
model	此对象表示模型（可以是基础模型或微调作业结果）。
batch	此对象表示批处理。
upload	此对象表示文件上传。
upload.part	此对象表示文件上传的一部分。