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

Upload File - Complete

这将完成 Upload,并且返回的 Upload 对象包含一个嵌套文件对象,该对象可供跨平台使用。 可以通过提供部件 ID 的有序列表来定义部件的顺序。 上传的总字节数必须与最初在创建 Upload 对象时指定的大小匹配。 完成上传后,无需添加其他部件。

POST {endpoint}/openai/uploads/{upload-id}/complete?api-version=2024-10-21

URI 参数

名称 必需 类型 说明
endpoint
path True

string (url)

支持的认知服务终结点(协议和主机名,例如:https://aoairesource.openai.azure.com。将“aoairesource”替换为 Azure OpenAI 帐户名称。

upload-id
path True

string

上传的标识符。

api-version
query True

string

请求的 API 版本。

请求头

Media Types: "application/json", "text/json", "application/*+json"

名称 必需 类型 说明
api-key True

string

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

请求正文

Media Types: "application/json", "text/json", "application/*+json"

名称 必需 类型 说明
part_ids True

string[]

IList'1

md5

string

响应

名称 类型 说明
200 OK

UploadResource

成功

Other Status Codes

ErrorResponse

发生错误。

安全性

api-key

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

类型: apiKey
在: header

示例

Complete and validate a large file upload operation.

示例请求

POST https://aoairesource.openai.azure.com/openai/uploads/fine-tune-72a2792ef7d24ba7b82c7fe4a37e379f/complete?api-version=2024-10-21

示例响应

{
  "bytes": 2097152,
  "filename": "training_data_v21.jsonl",
  "purpose": "fine-tune",
  "status": "completed",
  "expires_at": 1646133327,
  "file": {
    "status": "processed",
    "bytes": 140,
    "purpose": "fine-tune",
    "filename": "puppy.jsonl",
    "id": "file-181a1cbdcdcf4677ada87f63a0928099",
    "created_at": 1646126127,
    "object": "file"
  },
  "id": "fine-tune-72a2792ef7d24ba7b82c7fe4a37e379f",
  "created_at": 1646126127,
  "object": "upload"
}

定义

名称 说明
Error

错误

ErrorCode

ErrorCode

ErrorResponse

ErrorResponse

File

文件

FileState

FileState

InnerError

InnerError

InnerErrorCode

InnerErrorCode

Purpose

目的

TypeDiscriminator

TypeDiscriminator

UploadFileCompleteBody

UploadFileCompleteBody

UploadResource

UploadResource

UploadStatus

UploadStatus

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

minLength: 1

此错误的消息。

target

string

发生错误的位置(如果可用)。

ErrorCode

ErrorCode

说明
conflict

请求的操作与当前资源状态冲突。

contentFilter

由于我们的安全系统,映像生成失败。

fileImportFailed

导入文件失败。

forbidden

当前用户/API 密钥禁止此操作。

internalFailure

内部错误。 请重试。

invalidPayload

此操作的请求数据无效。

itemDoesAlreadyExist

该项已存在。

jsonlValidationFailed

jsonl 数据的验证失败。

notFound

找不到资源。

quotaExceeded

超出配额。

serviceUnavailable

该服务当前不可用。

tooManyRequests

请求过多。 请稍后重试。

unauthorized

当前用户/API 密钥未获得操作的授权。

unexpectedEntityState

无法以当前资源的状态执行该操作。

ErrorResponse

ErrorResponse

名称 类型 说明
error

Error

错误
Microsoft REST 准则(https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses)中定义的错误内容。

File

文件

名称 类型 说明
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

此文件处理失败时包含详细信息的错误消息。

FileState

FileState

说明
deleted

该实体已被删除,但仍可能由其他实体引用该删除。 它可以归类为终端状态。

deleting

实体是要删除的进程。 Azure OpenAI 不返回此状态,仅公开以兼容方式公开。 它可以归类为活动状态。

error

该操作已完成处理并失败,不能进一步使用。 它可以归类为终端状态。

pending

该操作已创建,并且不会排队等待将来处理。 它可以归类为非活动状态。

processed

操作已成功处理,可供使用。 它可以归类为终端状态。

running

操作已开始处理。 它可以归类为活动状态。

uploaded

文件已上传,但尚未处理。 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

此操作的请求数据无效。

Purpose

目的

说明
assistants

此文件包含要用于助手的数据。

assistants_output

此文件包含助理的结果。

batch

此文件包含批处理的输入数据。

batch_output

此文件包含批处理的结果。

fine-tune

此文件包含用于微调作业的训练数据。

fine-tune-results

此文件包含微调作业的结果。

TypeDiscriminator

TypeDiscriminator

说明
batch

此对象表示批处理。

file

此对象表示文件。

fine_tuning.job

此对象表示微调作业。

fine_tuning.job.checkpoint

此对象表示微调作业的检查点。

fine_tuning.job.event

此对象表示微调作业的事件。

list

此对象表示其他对象的列表。

model

此对象表示模型(可以是基础模型或微调作业结果)。

upload

此对象表示文件上传。

upload.part

此对象表示文件上传的一部分。

UploadFileCompleteBody

UploadFileCompleteBody

名称 类型 说明
md5

string

part_ids

string[]

IList'1

UploadResource

UploadResource

名称 类型 说明
bytes

integer (int64)

created_at

integer (unixtime)

创建此作业或项时的时间戳(在 unix 纪元中)。

expires_at

integer (unixtime)

file

File

文件
文件是可用于训练和验证的文档。 它也可以是包含结果详细信息的服务生成的文档。

filename

string

id

string

此项的标识。

object

TypeDiscriminator

TypeDiscriminator
定义对象的类型。

purpose

Purpose

目的
上传的文档的预期用途。 使用“微调”进行微调。 这样,我们就可以验证上传的文件的格式。

status

UploadStatus

UploadStatus

UploadStatus

UploadStatus

说明
cancelled
completed
expired
pending