Fine Tuning - List

Referência

Serviço:: Azure AI Services

Versão da API:: 2024-10-21

Obtém uma lista de todos os trabalhos de ajuste fino pertencentes ao recurso OpenAI do Azure. Os detalhes que são retornados para cada trabalho de ajuste fino contêm além de seu identificador o modelo base, arquivos de treinamento e validação, hiperparâmetros, carimbos de data/hora, status e eventos. Os eventos são criados quando o status do trabalho muda, por exemplo, em execução ou concluído, e quando os resultados são carregados.

GET {endpoint}/openai/fine_tuning/jobs?api-version=2024-10-21

Com parâmetros opcionais:

GET {endpoint}/openai/fine_tuning/jobs?after={after}&limit={limit}&api-version=2024-10-21

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
endpoint	path	True	string url	Pontos de extremidade de Serviços Cognitivos suportados (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com. Substitua "aoairesource" pelo nome da sua conta do Azure OpenAI).
api-version	query	True	string	A versão da API solicitada.
after	query		string	Identificador do último evento da solicitação de paginação anterior.
limit	query		integer int32	Número de eventos a recuperar. O padrão é 20.

Cabeçalho do Pedido

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

Respostas

Name	Tipo	Description
200 OK	FineTuningJobList	Sucesso
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.

Tipo: apiKey
Em: header

Exemplos

Getting all fine tuning jobs owned by this account.

Pedido de amostra

HTTP

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

Resposta da amostra

Código de estado:: 200

{
  "has_more": false,
  "data": [
    {
      "hyperparameters": {
        "n_epochs": -1
      },
      "status": "succeeded",
      "model": "curie",
      "fine_tuned_model": "curie.ft-72a2792ef7d24ba7b82c7fe4a37e379f",
      "training_file": "file-181a1cbdcdcf4677ada87f63a0928099",
      "result_files": [
        "file-181a1cbdcdcf4677ada87f63a0928099"
      ],
      "finished_at": 1646127311,
      "trained_tokens": 2342,
      "id": "ft-72a2792ef7d24ba7b82c7fe4a37e379f",
      "created_at": 1646126127,
      "object": "fine_tuning.job"
    }
  ],
  "object": "list"
}

Definições

Name	Description
Error	Erro
ErrorCode	Código de erro
ErrorResponse	ErrorResponse
FineTuningHyperParameters	FineTuningHyperParameters
FineTuningJob	FineTuningJob
FineTuningJobError	FineTuningJobError
FineTuningJobList	FineTuningJobList
FineTuningState	FineTuningState
InnerError	InnerError
InnerErrorCode	InnerErrorCode
TypeDiscriminator	TipoDiscriminador

Error

Erro

Name	Tipo	Description
code	ErrorCode	Código de erro Códigos de erro, conforme definido nas diretrizes do Microsoft REST (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 do Microsoft REST (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
message	string	A mensagem deste erro.
target	string	O local onde o erro aconteceu, se disponível.

ErrorCode

Código de erro

Name	Tipo	Description
conflict	string	A operação solicitada entra 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. Por favor, 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 dos dados jsonl.
notFound	string	O recurso não foi encontrado.
quotaExceeded	string	Quota excedida.
serviceUnavailable	string	O serviço não está disponível no momento.
tooManyRequests	string	Demasiados pedidos. 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

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

FineTuningHyperParameters

Name	Tipo	Description
batch_size	integer	O tamanho do lote a ser usado para treinamento. O tamanho do lote é o número de exemplos de treinamento usados para treinar um único passe para frente e para trás. Em geral, descobrimos que lotes maiores tendem a funcionar melhor para conjuntos de dados maiores. O valor padrão, bem como o valor máximo para essa propriedade são específicos para um modelo base.
learning_rate_multiplier	number	O multiplicador da taxa de aprendizagem a utilizar na formação. A taxa de aprendizagem de ajuste fino é a taxa de aprendizagem original usada para pré-treinamento multiplicada por esse valor. Taxas de aprendizagem maiores tendem a ter um melhor desempenho com lotes maiores. Recomendamos 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 épocas para treinar o modelo. Uma época refere-se a um ciclo completo através do conjunto de dados de treinamento.

FineTuningJob

Name	Tipo	Description
created_at	integer	Um carimbo de data/hora quando este trabalho ou item foi criado (em épocas unix).
error	FineTuningJobError	FineTuningJobError Para trabalhos de ajuste fino que falharam, isso conterá mais informações sobre a causa da falha.
estimated_finish	integer	O carimbo de data/hora do Unix (em segundos) para quando o trabalho de ajuste fino é estimado para terminar. O valor será nulo se o trabalho de ajuste fino não estiver em execução.
fine_tuned_model	string	O identificador (model-id) do modelo ajustado resultante. Esta 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 este trabalho ou item foi concluído com êxito (em épocas 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 o ajuste fino.
object	TypeDiscriminator	TipoDiscriminador Define o tipo de um objeto.
organisation_id	string	A organização id deste trabalho de afinação. Não utilizado no Azure OpenAI; compatibilidade apenas para OpenAI.
result_files	string[]	As identidades do arquivo de resultado (file-id) contendo 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.
seed	integer	A semente usada para o trabalho de ajuste fino.
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 seu nome de 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.
validation_file	string	O arquivo que é usado para avaliar o modelo ajustado durante o treinamento.

FineTuningJobError

Name	Tipo	Description
code	string	O código de erro legível por máquina..
message	string	A mensagem de erro legível por humanos.
param	string	O parâmetro que era inválido, geralmente training_file ou validation_file. Este campo será nulo se a falha não for específica do parâmetro.

FineTuningJobList

Name	Tipo	Description
data	FineTuningJob[]	A lista de itens.
has_more	boolean	Um valor que indica se a lista contém mais elementos do que os retornados.
object	TypeDiscriminator	TipoDiscriminador Define o tipo de um objeto.

FineTuningState

Name	Tipo	Description
cancelled	string	A operação foi cancelada e está incompleta. Pode ser categorizado como um estado terminal.
created	string	A operação foi criada. Esse estado não é retornado pelo Azure OpenAI e exposto apenas para compatibilidade. 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. Pode ser categorizado como um estado terminal.
pending	string	A operação ainda não está na fila para ser processada no futuro. Pode ser categorizado como um estado inativo.
running	string	A operação já começou a ser processada. Pode ser categorizado como um estado ativo.
succeeded	string	A operação foi processada com sucesso e está pronta para consumo. Pode ser categorizado como um estado terminal.

InnerError

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

InnerErrorCode

Name	Tipo	Description
invalidPayload	string	Os dados da solicitação são inválidos para esta operação.

TypeDiscriminator

TipoDiscriminador

Name	Tipo	Description
batch	string	Este objeto representa um lote.
file	string	Este objeto representa um arquivo.
fine_tuning.job	string	Este objeto representa um trabalho de ajuste fino.
fine_tuning.job.checkpoint	string	Este objeto representa um ponto de verificação de um trabalho de ajuste fino.
fine_tuning.job.event	string	Este objeto representa um evento de um trabalho de ajuste fino.
list	string	Este objeto representa uma lista de outros objetos.
model	string	Este objeto representa um modelo (pode ser um modelo base ou um resultado de trabalho de ajuste fino).
upload	string	Este objeto representa um upload de arquivo.
upload.part	string	Este objeto representa parte de um upload de arquivo.

Partilhar via