Fine Tuning - Create

Referência

Service:: Azure AI Services

API Version:: 2023-12-01-preview

Cria um trabalho que ajusta um modelo especificado de um determinado arquivo de treinamento. A resposta inclui detalhes do trabalho enfileirado, incluindo status de trabalho e hiperparâmetros. O nome do modelo ajustado é adicionado à resposta após a conclusão.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
endpoint	path	True	string url	Pontos de extremidade dos Serviços Cognitivos com suporte (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com. Substitua "aoairesource" pelo nome da conta do Azure OpenAI).
api-version	query	True	string	A versão da API solicitada.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
api-key	True	string	Forneça sua chave de conta do Azure OpenAI dos Serviços Cognitivos aqui.

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
model	True	string	O identificador (id de modelo) do modelo base usado para esse ajuste fino.
training_file	True	string	A identidade do arquivo (id de arquivo) usada para treinar esse modelo ajustado.
hyperparameters		FineTuningHyperParameters	FineTuningHyperParameters As configurações de hiperparâmetro usadas em um trabalho de ajuste fino.
suffix		string	O sufixo usado para identificar o modelo ajustado. O sufixo pode conter até 40 caracteres (a-z, A-Z, 0-9 e _) que serão adicionados ao seu nome de modelo ajustado.
validation_file		string	A identidade do arquivo (id de arquivo) usada para avaliar o modelo ajustado durante o treinamento.

Respostas

Nome	Tipo	Description
201 Created	FineTuningJob	A afinação foi criada com êxito. Headers Location: string
Other Status Codes	ErrorResponse	Ocorreu um erro.

Nome

Tipo

Description

201 Created

FineTuningJob

A afinação foi criada com êxito.

Headers

Location: string

Other Status Codes

ErrorResponse

Ocorreu um erro.

Segurança

api-key

Forneça sua chave de conta do Azure OpenAI dos Serviços Cognitivos aqui.

Type: apiKey
In: header

Exemplos

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"
}

Definições

Nome	Description
Error	Erro
ErrorCode	ErrorCode
ErrorResponse	ErrorResponse
FineTuningHyperParameters	FineTuningHyperParameters
FineTuningJob	FineTuningJob
FineTuningJobCreation	FineTuningJobCreation
FineTuningState	FineTuningState
InnerError	InnerError
InnerErrorCode	InnerErrorCode
TypeDiscriminator	TypeDiscriminator

Error

Erro

Nome	Tipo	Description
code	ErrorCode	ErrorCode Códigos de erro conforme definido nas diretrizes rest da Microsoft (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
details	Error[]	Os detalhes do erro, se disponíveis.
innererror	InnerError	InnerError Erro interno, conforme definido nas diretrizes rest da Microsoft (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
message	string	A mensagem desse erro.
target	string	O local em que o erro ocorreu, se disponível.

ErrorCode

Nome	Tipo	Description
conflict	string	A operação solicitada está em conflito com o estado atual do recurso.
contentFilter	string	A geração de imagens falhou como resultado do nosso sistema de segurança.
fileImportFailed	string	Falha na importação do arquivo.
forbidden	string	A operação é proibida para a chave de usuário/api atual.
internalFailure	string	Erro interno. Tente novamente.
invalidPayload	string	Os dados da solicitação são inválidos para esta operação.
itemDoesAlreadyExist	string	O item já existe.
jsonlValidationFailed	string	Falha na validação de dados jsonl.
notFound	string	O recurso não foi encontrado.
quotaExceeded	string	Cota excedida.
serviceUnavailable	string	No momento, o serviço não está disponível.
tooManyRequests	string	Solicitações demais. Tente novamente mais tarde.
unauthorized	string	A chave de usuário/api atual não está autorizada para a operação.
unexpectedEntityState	string	A operação não pode ser executada no estado do recurso atual.

ErrorResponse

Nome	Tipo	Description
error	Error	Erro Conteúdo do erro conforme definido nas diretrizes rest da Microsoft (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

FineTuningHyperParameters

Nome	Tipo	Description
batch_size	integer	O tamanho do lote que será usado para treinamento. O tamanho do lote é o número de exemplos de treinamento usados para treinar uma única passagem para frente e para trás. Em geral, descobrimos que tamanhos de lote maiores tendem a funcionar melhor para conjuntos de dados maiores. O valor padrão, bem como o valor máximo dessa propriedade, são específicos para um modelo base.
learning_rate_multiplier	number	O multiplicador de taxa de aprendizado a ser usado para treinamento. A taxa de aprendizado de ajuste fino é a taxa de aprendizado original usada para pré-treinamento multiplicada por esse valor. Taxas de aprendizado maiores tendem a ter um desempenho melhor com tamanhos de lote maiores. É recomendável experimentar valores no intervalo de 0,02 a 0,2 para ver o que produz os melhores resultados.
n_epochs	integer	O número de períodos para treinamento do modelo. Um período refere-se a um ciclo completo através do conjunto de dados de treinamento.

FineTuningJob

Nome	Tipo	Description
created_at	integer	Um carimbo de data/hora quando esse trabalho ou item foi criado (em épocas unix).
fine_tuned_model	string	O identificador (model-id) do modelo ajustado resultante. Essa propriedade só é preenchida para execuções de ajuste fino concluídas com êxito. Use esse identificador para criar uma implantação para inferência.
finished_at	integer	Um carimbo de data/hora quando esse trabalho ou item for concluído com êxito (em épocas do unix).
hyperparameters	FineTuningHyperParameters	FineTuningHyperParameters As configurações de hiperparâmetro usadas em um trabalho de ajuste fino.
id	string	A identidade deste item.
model	string	O identificador (model-id) do modelo base usado para a ajuste fino.
object	TypeDiscriminator	TypeDiscriminator Define o tipo de um objeto .
organisation_id	string	A ID da organização deste trabalho de ajuste fino. Não utilizado no OpenAI do Azure; compatibilidade somente para OpenAI.
result_files	string[]	As identidades de arquivo de resultado (id de arquivo) que contêm métricas de treinamento e avaliação no formato csv. O arquivo só está disponível para execuções de ajuste fino concluídas com êxito.
status	FineTuningState	FineTuningState O estado de um objeto finetunes ou trabalho de ajuste fino.
suffix	string	O sufixo usado para identificar o modelo ajustado. O sufixo pode conter até 40 caracteres (a-z, A-Z, 0-9 e _) que serão adicionados ao nome do modelo ajustado.
trained_tokens	integer	O número total de tokens faturáveis processados por esse trabalho de ajuste fino.
training_file	string	O arquivo que é usado para treinamento.
updated_at	integer	Um carimbo de data/hora quando esse trabalho ou item foi modificado por último (em épocas do unix).
validation_file	string	O arquivo que é usado para avaliar o modelo ajustado durante o treinamento.

FineTuningJobCreation

Nome	Tipo	Description
hyperparameters	FineTuningHyperParameters	FineTuningHyperParameters As configurações de hiperparâmetro usadas em um trabalho de ajuste fino.
model	string	O identificador (model-id) do modelo base usado para esse ajuste fino.
suffix	string	O sufixo usado para identificar o modelo ajustado. O sufixo pode conter até 40 caracteres (a-z, A-Z, 0-9 e _) que serão adicionados ao nome do modelo ajustado.
training_file	string	A identidade do arquivo (file-id) usada para treinar esse modelo ajustado.
validation_file	string	A identidade do arquivo (file-id) usada para avaliar o modelo ajustado durante o treinamento.

FineTuningState

Nome	Tipo	Description
cancelled	string	A operação foi cancelada e está incompleta. Ele pode ser categorizado como um estado terminal.
created	string	A operação foi criada. Esse estado não é retornado pelo OpenAI do Azure e exposto apenas para compatibilidade. Ele pode ser categorizado como um estado inativo.
failed	string	A operação concluiu o processamento com uma falha e não pode ser consumida mais. Ele pode ser categorizado como um estado terminal.
pending	string	A operação ainda não está na fila para ser processada no futuro. Ele pode ser categorizado como um estado inativo.
running	string	A operação começou a ser processada. Ele pode ser categorizado como um estado ativo.
succeeded	string	A operação foi processada com êxito e está pronta para consumo. Ele pode ser categorizado como um estado terminal.

InnerError

Nome	Tipo	Description
code	InnerErrorCode	InnerErrorCode Códigos de erro internos, conforme definido nas diretrizes rest da Microsoft (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
innererror	InnerError	InnerError Erro interno, conforme definido nas diretrizes rest da Microsoft (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

InnerErrorCode

Nome	Tipo	Description
invalidPayload	string	Os dados de solicitação são inválidos para essa operação.

TypeDiscriminator

Nome	Tipo	Description
file	string	Esse objeto representa um arquivo.
fine-tune	string	Esse objeto representa um trabalho de ajuste fino.
fine-tune-event	string	Esse objeto representa um evento de um trabalho de ajuste fino.
fine_tuning.job	string	Esse objeto representa um trabalho de ajuste fino.
fine_tuning.job.event	string	Esse objeto representa um evento de um trabalho de ajuste fino.
list	string	Esse objeto representa uma lista de outros objetos.
model	string	Esse objeto representa um modelo (pode ser um modelo base ou ajustar o resultado do trabalho).

Compartilhar via

Fine Tuning - Create

Parâmetros de URI

Cabeçalho da solicitação

Corpo da solicitação

Respostas

Segurança

api-key

Exemplos

Creating a fine tune job.

Sample Request

Sample Response

Definições

Error

ErrorCode

ErrorResponse

FineTuningHyperParameters

FineTuningJob

FineTuningJobCreation

FineTuningState

InnerError

InnerErrorCode

TypeDiscriminator

Recursos adicionais