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)	Поддерживаемые конечные точки Cognitive Services (протокол и имя узла, например https://aoairesource.openai.azure.com. Замените aoairesource именем учетной записи Azure OpenAI.
api-version	query	True	string	Запрошенная версия API.

Заголовок запроса

Имя	Обязательно	Тип	Описание
api-key	True	string	Укажите здесь ключ учетной записи Azure OpenAI Для Cognitive Services.

Текст запроса

Имя	Обязательно	Тип	Описание
model	True	string minLength: 1	Идентификатор (model-id) базовой модели, используемой для этой точной настройки.
training_file	True	string minLength: 1	Идентификатор файла (file-id), используемый для обучения этой точно настроенной модели.
hyperparameters		FineTuningHyperParameters	FineTuningHyperParameters Параметры гиперпараметров, используемые в задании точной настройки.
seed		integer (int32)	Начальное значение, используемое для задания тонкой подготовки. Передача одинаковых параметров начального значения и заданий должна иметь одинаковые результаты, но может отличаться в редких случаях. Если начальное значение не указано, он будет создан для вас.
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 Для Cognitive Services.

Тип: 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	Код ошибки
ErrorResponse	ErrorResponse
FineTuningHyperParameters	FineTuningHyperParameters
FineTuningJob	FineTuningJob
FineTuningJobCreation	FineTuningJobCreation
FineTuningJobError	FineTuningJobError
FineTuningState	FineTuningState
InnerError	InnerError
InnerErrorCode	InnerErrorCode
TypeDiscriminator	TypeDiscriminator

Error

Объект

Ошибка

Имя	Тип	Описание
code	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

Перечисление

Код ошибки

Значение	Описание
conflict	Запрошенная операция конфликтует с текущим состоянием ресурса.
invalidPayload	Данные запроса недопустимы для этой операции.
forbidden	Операция запрещена для текущего ключа пользователя или API.
notFound	Ресурс не найден.
unexpectedEntityState	Невозможно выполнить операцию в состоянии текущего ресурса.
itemDoesAlreadyExist	Элемент уже существует.
serviceUnavailable	В настоящее время служба недоступна.
internalFailure	Внутренняя ошибка. Повторите попытку.
quotaExceeded	Превышена квота.
jsonlValidationFailed	Сбой проверки данных jsonl.
fileImportFailed	Сбой импорта файла.
tooManyRequests	Слишком много запросов. Повторите попытку позже.
unauthorized	Текущий ключ пользователя или API не авторизован для операции.
contentFilter	Сбой создания изображений в результате нашей системы безопасности.

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 (int32)	Размер пакета, используемый для обучения. Размер пакета — это количество примеров обучения, используемых для обучения одного и обратного прохода. Как правило, мы обнаружили, что большие размеры пакетов, как правило, лучше работают для больших наборов данных. Значение по умолчанию, а также максимальное значение этого свойства относятся к базовой модели.
learning_rate_multiplier	number (double)	Умножение скорости обучения, используемое для обучения. Скорость обучения точной настройки — это исходная скорость обучения, используемая для предварительного обучения, умноженная на это значение. Более крупные показатели обучения, как правило, лучше работают с большими размерами пакетов. Мы рекомендуем поэкспериментировать со значениями в диапазоне от 0,02 до 0,2, чтобы увидеть, что дает лучшие результаты.
n_epochs	integer (int32)	Количество эпох для обучения модели. Эпоха относится к одному полному циклу через обучающий набор данных.

FineTuningJob

Объект

FineTuningJob

Имя	Тип	Описание
created_at	integer (unixtime)	Метка времени при создании этого задания или элемента (в эпохах UNIX).
error	FineTuningJobError	FineTuningJobError Для заданий тонкой настройки, которые завершились сбоем, это будет содержать дополнительные сведения о причине сбоя.
estimated_finish	integer (int32)	Метка времени Unix (в секундах) для завершения задания тонкой настройки. Значение будет иметь значение NULL, если задание тонкой настройки не выполняется.
fine_tuned_model	string	Идентификатор (идентификатор модели) результирующей точно настроенной модели. Это свойство заполняется только для успешно завершенных точно настроенных запусков. Используйте этот идентификатор для создания развертывания для вывода.
finished_at	integer (int32)	Метка времени, когда это задание или элемент успешно завершены (в эпохах UNIX).
hyperparameters	FineTuningHyperParameters	FineTuningHyperParameters Параметры гиперпараметров, используемые в задании точной настройки.
id	string	Удостоверение этого элемента.
model	string minLength: 1	Идентификатор (model-id) базовой модели, используемой для точной настройки.
object	TypeDiscriminator	TypeDiscriminator Определяет тип объекта.
organisation_id	string	Идентификатор организации этой точной настройки задания. Не используется в Azure OpenAI; совместимость только для OpenAI.
result_files	string[]	Идентификаторы результирующих файлов (file-id), содержащие метрики обучения и оценки в формате CSV. Файл доступен только для успешно завершенных запусков точной настройки.
seed	integer (int32)	Начальное значение, используемое для задания тонкой подготовки.
status	FineTuningState	FineTuningState Состояние объекта finetunes или задания тонкой настройки.
suffix	string	Суффикс, используемый для идентификации точно настроенной модели. Суффикс может содержать до 40 символов (a-z, A-Z, 0-9 и _), которые будут добавлены в имя вашей точной модели.
trained_tokens	integer (int32)	Общее количество оплачиваемых маркеров, обрабатываемых этим заданием тонкой настройки.
training_file	string minLength: 1	Файл, используемый для обучения.
validation_file	string	Файл, используемый для оценки точно настроенной модели во время обучения.

FineTuningJobCreation

Объект

FineTuningJobCreation

Имя	Тип	Описание
hyperparameters	FineTuningHyperParameters	FineTuningHyperParameters Параметры гиперпараметров, используемые в задании точной настройки.
model	string minLength: 1	Идентификатор (model-id) базовой модели, используемой для этой точной настройки.
seed	integer (int32)	Начальное значение, используемое для задания тонкой подготовки. Передача одинаковых параметров начального значения и заданий должна иметь одинаковые результаты, но может отличаться в редких случаях. Если начальное значение не указано, он будет создан для вас.
suffix	string	Суффикс, используемый для идентификации точно настроенной модели. Суффикс может содержать до 40 символов (a-z, A-Z, 0-9 и _), которые будут добавлены в имя вашей точной модели.
training_file	string minLength: 1	Идентификатор файла (file-id), используемый для обучения этой точно настроенной модели.
validation_file	string	Идентификатор файла (file-id), используемый для оценки точно настроенной модели во время обучения.

FineTuningJobError

Объект

FineTuningJobError

Имя	Тип	Описание
code	string	Код ошибки, доступный для чтения компьютером..
message	string	Сообщение об ошибке, доступное для чтения человеком.
param	string	Недопустимый параметр, обычно training_file или validation_file. Это поле будет иметь значение NULL, если сбой не был определенным параметром.

FineTuningState

Перечисление

FineTuningState

Значение	Описание
created	Была создана операция. Это состояние не возвращается Azure OpenAI и предоставляется только для обеспечения совместимости. Его можно классифицировать как неактивное состояние.
pending	Операция еще не будет обработана в будущем. Его можно классифицировать как неактивное состояние.
running	Операция начала обрабатываться. Его можно классифицировать как активное состояние.
succeeded	Операция успешно обработана и готова к использованию. Его можно классифицировать как состояние терминала.
cancelled	Операция отменена и не завершена. Его можно классифицировать как состояние терминала.
failed	Операция завершила обработку с ошибкой и не может быть дополнительно занята. Его можно классифицировать как состояние терминала.

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	Данные запроса недопустимы для этой операции.

TypeDiscriminator

Перечисление

TypeDiscriminator

Значение	Описание
list	Этот объект представляет список других объектов.
fine_tuning.job	Этот объект представляет точное задание настройки.
file	Этот объект представляет файл.
fine_tuning.job.event	Этот объект представляет событие задания тонкой настройки.
fine_tuning.job.checkpoint	Этот объект представляет контрольную точку задания тонкой настройки.
model	Этот объект представляет модель (может быть базовой моделью или результатом точной настройки задания).
batch	Этот объект представляет пакет.
upload	Этот объект представляет отправку файла.
upload.part	Этот объект представляет часть отправки файла.