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

Fine Tuning - Create

参考

Service:: Azure AI Services

API Version:: 2023-12-01-preview

创建从给定训练文件微调指定模型的作业。响应包括排队作业的详细信息，包括作业状态和超参数。微调模型的名称在完成后将添加到响应中。

POST {endpoint}/openai/fine_tuning/jobs?api-version=2023-12-01-preview

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 帐户密钥。

请求正文

名称	必需	类型	说明
model	True	string	标识符 (用于此微调的基本模型的 model-id) 。
training_file	True	string	文件标识 (用于训练此微调模型的文件 id) 。
hyperparameters		FineTuningHyperParameters	FineTuningHyperParameters 微调作业中使用的超参数设置。
suffix		string	用于标识微调模型的后缀。后缀最多可以包含 40 个字符， (a-z、A-Z、0-9 和 _) ，这些字符将添加到微调的模型名称中。
validation_file		string	文件标识 (用于在训练期间评估微调模型的文件 id) 。

响应

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

名称

类型

说明

201 Created

FineTuningJob

已成功创建微调。

Headers

Location: string

Other Status Codes

ErrorResponse

出现了错误。

安全性

api-key

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

Type: apiKey
In: header

示例

Creating a fine tune job.

Sample Request

HTTP

POST https://aoairesource.openai.azure.com/openai/fine_tuning/jobs?api-version=2023-12-01-preview


{
  "model": "curie",
  "training_file": "file-181a1cbdcdcf4677ada87f63a0928099"
}

Sample Response

Status code:: 201

location: https://aoairesource.openai.azure.com/openai/fine_tuning/jobs/ft-72a2792ef7d24ba7b82c7fe4a37e379f

Response Body

{
  "hyperparameters": {
    "n_epochs": 2
  },
  "model": "curie",
  "training_file": "file-181a1cbdcdcf4677ada87f63a0928099",
  "id": "ft-72a2792ef7d24ba7b82c7fe4a37e379f",
  "status": "notRunning",
  "created_at": 1646126127,
  "updated_at": 1646127311,
  "object": "fine_tuning.job"
}

定义

名称	说明
Error	错误
ErrorCode	ErrorCode
ErrorResponse	ErrorResponse
FineTuningHyperParameters	FineTuningHyperParameters
FineTuningJob	FineTuningJob
FineTuningJobCreation	FineTuningJobCreation
FineTuningState	FineTuningState
InnerError	InnerError
InnerErrorCode	InnerErrorCode
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

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

FineTuningHyperParameters

名称	类型	说明
batch_size	integer	要用于训练的批大小。批大小表示用于训练单个前向和后向传递的训练示例的数量。一般情况下，我们发现较大的批大小往往更适合较大的数据集。此属性的默认值和最大值特定于基础模型。
learning_rate_multiplier	number	用于训练的学习率乘数。微调学习率是用于预训练的原始学习率乘以该值。使用较大的批大小时，学习速率越大，性能越好。建议试验 0.02 到 0.2 范围内的值，以查看产生最佳结果的值。
n_epochs	integer	训练模型的时期数。一个时期是指训练数据集的一个完整周期。

FineTuningJob

名称	类型	说明
created_at	integer	创建此作业或项时的时间戳 (unix) ep。
fine_tuned_model	string	标识符 (生成的微调模型的 model-id) 。此属性仅为成功完成的微调运行填充。使用此标识符创建用于推理的部署。
finished_at	integer	此作业或项成功完成的时间戳 (unix ep) 。
hyperparameters	FineTuningHyperParameters	FineTuningHyperParameters 微调作业中使用的超参数设置。
id	string	此项的标识。
model	string	用于微调的基本模型的标识符 (model-id) 。
object	TypeDiscriminator	TypeDiscriminator 定义对象的类型。
organisation_id	string	此微调作业的组织 ID。在 Azure OpenAI 上未使用;仅适用于 OpenAI 的兼容性。
result_files	string[]	结果文件标识 (包含 csv 格式的训练和评估指标的文件 id) 。该文件仅适用于成功完成的微调运行。
status	FineTuningState	FineTuningState 微调对象或微调作业的状态。
suffix	string	用于标识微调后的模型的后缀。后缀最多可包含 40 个字符， (a-z、A-Z、0-9 和 _) ，这些字符将添加到微调的模型名称中。
trained_tokens	integer	此微调作业处理的可计费令牌总数。
training_file	string	用于训练的文件。
updated_at	integer	在 unix epochs) 中，上次 (修改此作业或项时的时间戳。
validation_file	string	用于在训练期间评估微调后的模型的文件。

FineTuningJobCreation

名称	类型	说明
hyperparameters	FineTuningHyperParameters	FineTuningHyperParameters 微调作业中使用的超参数设置。
model	string	标识符 (用于此微调的基本模型的 model-id) 。
suffix	string	用于标识微调后的模型的后缀。后缀最多可包含 40 个字符， (a-z、A-Z、0-9 和 _) ，这些字符将添加到微调的模型名称中。
training_file	string	文件标识 (用于训练此微调模型的 file-id) 。
validation_file	string	文件标识 (用于在训练期间评估微调模型的文件 id) 。

FineTuningState

名称	类型	说明
cancelled	string	操作已取消且未完成。它可以归类为终端状态。
created	string	操作已创建。此状态不会由 Azure OpenAI 返回，只是为了兼容而公开。它可以归类为非活动状态。
failed	string	操作已完成处理但失败，无法进一步使用。它可以归类为终端状态。
pending	string	该操作尚未排队等待将来处理。它可以归类为非活动状态。
running	string	已开始处理操作。它可以归类为活动状态。
succeeded	string	操作已成功处理并已准备好使用。它可以归类为终端状态。

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

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

通过

Fine Tuning - Create

URI 参数

请求头

请求正文

响应

安全性

api-key

示例

Creating a fine tune job.

Sample Request

Sample Response

定义

Error

ErrorCode

ErrorResponse

FineTuningHyperParameters

FineTuningJob

FineTuningJobCreation

FineTuningState

InnerError

InnerErrorCode

TypeDiscriminator

其他资源