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

Fine Tuning - Create

参考

服务:: Azure AI Services

API 版本:: 2024-10-21

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

POST {endpoint}/openai/fine_tuning/jobs?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 帐户密钥。

请求正文

名称	必需	类型	说明
model	True	string	用于此微调的基本模型的标识符（model-id）。
training_file	True	string	用于训练此微调模型的文件标识（file-id）。
hyperparameters		FineTuningHyperParameters	FineTuningHyperParameters 微调作业中使用的超参数设置。
seed		integer	用于微调作业的种子。传入相同的种子和作业参数应产生相同的结果，但在极少数情况下可能会有所不同。如果未指定种子，将为你生成一个种子。
suffix		string	用于标识微调模型的后缀。后缀最多可包含 40 个字符（a-z、A-Z、0-9 和 _），这些字符将添加到微调的模型名称中。
validation_file		string	用于在训练期间评估微调模型的文件标识（file-id）。

响应

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

名称

类型

说明

201 Created

FineTuningJob

已成功创建微调。

标头

Location: string

Other Status Codes

ErrorResponse

发生错误。

安全性

api-key

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

类型: apiKey
在: header

示例

Creating a fine tuning job.

示例请求

HTTP

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


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

示例响应

状态代码:: 201

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

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

定义

名称	说明
Error	错误
ErrorCode	ErrorCode
ErrorResponse	ErrorResponse
FineTuningHyperParameters	FineTuningHyperParameters
FineTuningJob	FineTuningJob
FineTuningJobCreation	FineTuningJobCreation
FineTuningJobError	FineTuningJobError
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 纪元中）。
error	FineTuningJobError	FineTuningJobError 对于失败的微调作业，这将包含有关失败原因的详细信息。
estimated_finish	integer	估计微调作业完成时间的 Unix 时间戳（以秒为单位）。如果微调作业未运行，该值将为 null。
fine_tuned_model	string	生成的微调模型的标识符（model-id）。仅填充此属性以成功完成微调运行。使用此标识符创建用于推理的部署。
finished_at	integer	此作业或项成功完成时的时间戳（在 unix 纪元中）。
hyperparameters	FineTuningHyperParameters	FineTuningHyperParameters 微调作业中使用的超参数设置。
id	string	此项的标识。
model	string	用于微调的基本模型的标识符（model-id）。
object	TypeDiscriminator	TypeDiscriminator 定义对象的类型。
organisation_id	string	此微调作业的组织 ID。 Azure OpenAI 上未使用;仅 OpenAI 的兼容性。
result_files	string[]	结果文件标识（文件 ID），其中包含 csv 格式的训练和评估指标。该文件仅适用于成功完成的微调运行。
seed	integer	用于微调作业的种子。
status	FineTuningState	FineTuningState 微调对象或微调作业的状态。
suffix	string	用于标识微调模型的后缀。后缀最多可包含 40 个字符（a-z、A-Z、0-9 和 _），这些字符将添加到微调的模型名称中。
trained_tokens	integer	此微调作业处理的可计费令牌总数。
training_file	string	用于训练的文件。
validation_file	string	用于在训练期间评估微调模型的文件。

FineTuningJobCreation

名称	类型	说明
hyperparameters	FineTuningHyperParameters	FineTuningHyperParameters 微调作业中使用的超参数设置。
model	string	用于此微调的基本模型的标识符（model-id）。
seed	integer	用于微调作业的种子。传入相同的种子和作业参数应产生相同的结果，但在极少数情况下可能会有所不同。如果未指定种子，将为你生成一个种子。
suffix	string	用于标识微调模型的后缀。后缀最多可包含 40 个字符（a-z、A-Z、0-9 和 _），这些字符将添加到微调的模型名称中。
training_file	string	用于训练此微调模型的文件标识（file-id）。
validation_file	string	用于在训练期间评估微调模型的文件标识（file-id）。

FineTuningJobError

名称	类型	说明
code	string	计算机可读错误代码。
message	string	人工可读错误消息。
param	string	无效的参数通常training_file或validation_file。如果失败不特定于参数，则此字段将为 null。

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

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

通过

Fine Tuning - Create

URI 参数

请求头

请求正文

响应

安全性

api-key

示例

Creating a fine tuning job.

示例请求

示例响应

定义

Error

ErrorCode

ErrorResponse

FineTuningHyperParameters

FineTuningJob

FineTuningJobCreation

FineTuningJobError

FineTuningState

InnerError

InnerErrorCode

TypeDiscriminator

其他资源