通过

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

Fine Tuning - Cancel

  • 参考
服务:
Azure AI Services
API 版本:
2024-05-01-preview

取消对给定 fine-tune-id 指定的微调作业的处理。

POST {endpoint}/openai/fine_tuning/jobs/{fine-tuning-job-id}/cancel?api-version=2024-05-01-preview

URI 参数

名称 在 必需 类型 说明
endpoint
 path True

string

url

支持的认知服务终结点 (协议和主机名，例如： https://aoairesource.openai.azure.com。将“aoairesource”替换为 Azure OpenAI 帐户名称) 。
fine-tuning-job-id
 path True

string

微调作业的标识符。
api-version
 query True

string

请求的 API 版本。

请求头

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

string

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

响应

名称 类型 说明
200 OK

FineTuningJob

微调已成功取消
Other Status Codes

ErrorResponse

出现了错误。

安全性

api-key

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

类型: apiKey
在: header

示例

Canceling a fine tuning job.

示例请求

POST https://aoairesource.openai.azure.com/openai/fine_tuning/jobs/ft-72a2792ef7d24ba7b82c7fe4a37e379f/cancel?api-version=2024-05-01-preview

示例响应

状态代码:
200 
{
  "hyperparameters": {
    "n_epochs": -1
  },
  "status": "cancelled",
  "model": "curie",
  "training_file": "file-181a1cbdcdcf4677ada87f63a0928099",
  "finished_at": 1646127311,
  "id": "ft-72a2792ef7d24ba7b82c7fe4a37e379f",
  "created_at": 1646126127,
  "object": "fine_tuning.job"
}

定义

名称 说明
Error

错误
ErrorCode

ErrorCode
ErrorResponse

ErrorResponse
FineTuningHyperParameters

FineTuningHyperParameters
FineTuningJob

FineTuningJob
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

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) 。

FineTuningHyperParameters

FineTuningHyperParameters

名称 类型 说明
batch_size

integer

要用于训练的批大小。 批大小表示用于训练单个前向和后向传递的训练示例的数量。 一般情况下，我们发现较大的批大小往往更适合较大的数据集。 此属性的默认值和最大值特定于基础模型。
learning_rate_multiplier

number

用于训练的学习率乘数。 微调学习率是用于预训练的原始学习率乘以该值。 使用较大的批大小，学习速率越大，性能越好。 建议试验 0.02 到 0.2 范围内的值，以查看产生最佳结果的值。
n_epochs

integer

训练模型的时期数。 一个时期是指训练数据集的一个完整周期。

FineTuningJob

FineTuningJob

名称 类型 说明
created_at

integer

在 unix epochs (创建此作业或项的时间戳) 。
fine_tuned_model

string

标识符 (生成的微调模型的模型 ID) 。 仅为成功完成微调运行填充此属性。 使用此标识符创建用于推理的部署。
finished_at

integer

此作业或项成功完成的时间戳 (unix epochs) 。
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

用于在训练期间评估微调模型的文件。

FineTuningState

FineTuningState

名称 类型 说明
cancelled

string

操作已取消且不完整。 它可以归类为终端状态。
created

string

操作已创建。 此状态不会由 Azure OpenAI 返回，并且仅出于兼容性而公开。 它可以归类为非活动状态。
failed

string

操作已完成处理，但失败，无法进一步使用。 它可以归类为终端状态。
pending

string

该操作尚未排队等待将来处理。 它可以归类为非活动状态。
running

string

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

string

操作已成功处理并已准备好使用。 它可以归类为终端状态。

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

此操作的请求数据无效。

TypeDiscriminator

TypeDiscriminator

名称 类型 说明
file

string

此对象表示文件。
fine_tuning.job

string

此对象表示微调作业。
fine_tuning.job.checkpoint

string

此对象表示微调作业的检查点。
fine_tuning.job.event

string

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

string

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

string

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