Fine Tuning - Create

Riferimento

Servizio:: Azure AI Services

Versione API:: 2024-10-21

Crea un processo che ottimizza un modello specificato da un determinato file di training. La risposta include i dettagli del processo accodato, inclusi lo stato del processo e i parametri hyper. Il nome del modello ottimizzato viene aggiunto alla risposta al termine.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
endpoint	path	True	string (url)	Endpoint di Servizi cognitivi supportati (protocollo e nome host, ad esempio: https://aoairesource.openai.azure.com. Sostituire "aoairesource" con il nome dell'account Azure OpenAI.
api-version	query	True	string	Versione dell'API richiesta.

Intestazione della richiesta

Nome	Necessario	Tipo	Descrizione
api-key	True	string	Specificare qui la chiave dell'account OpenAI di Servizi cognitivi di Azure.

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
model	True	string minLength: 1	Identificatore (model-id) del modello di base usato per l'ottimizzazione.
training_file	True	string minLength: 1	Identità del file (ID file) usata per il training di questo modello ottimizzato.
hyperparameters		FineTuningHyperParameters	FineTuningHyperParameters Impostazioni del parametro hyper usate in un processo di ottimizzazione.
seed		integer (int32)	Valore di inizializzazione utilizzato per il processo di ottimizzazione. Il passaggio degli stessi parametri di inizializzazione e processo dovrebbe produrre gli stessi risultati, ma può differire in rari casi. Se non viene specificato un valore di inizializzazione, ne verrà generato uno automaticamente.
suffix		string	Suffisso usato per identificare il modello ottimizzato. Il suffisso può contenere fino a 40 caratteri (a-z, A-Z, 0-9 e _) che verranno aggiunti al nome del modello ottimizzato.
validation_file		string	Identità del file (ID file) usata per valutare il modello ottimizzato durante il training.

Risposte

Nome	Tipo	Descrizione
201 Created	FineTuningJob	L'ottimizzazione è stata creata correttamente. Intestazioni Location: string
Other Status Codes	ErrorResponse	Si è verificato un errore.

Nome

Tipo

Descrizione

201 Created

FineTuningJob

L'ottimizzazione è stata creata correttamente.

Intestazioni

Location: string

Other Status Codes

ErrorResponse

Si è verificato un errore.

Sicurezza

api-key

Specificare qui la chiave dell'account OpenAI di Servizi cognitivi di Azure.

Tipo: apiKey
In: header

Esempio

Creating a fine tuning job.

Esempio di richiesta

HTTP

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


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

Risposta di esempio

Codice di stato:: 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"
}

Definizioni

Nome	Descrizione
Error	Errore
ErrorCode	ErrorCode
ErrorResponse	ErrorResponse
FineTuningHyperParameters	FineTuningHyperParameters
FineTuningJob	FineTuningJob
FineTuningJobCreation	FineTuningJobCreation
FineTuningJobError	FineTuningJobError
FineTuningState	FineTuningState
InnerError	InnerError
InnerErrorCode	InnerErrorCode
TypeDiscriminator	TypeDiscriminator

Error

Object

Errore

Nome	Tipo	Descrizione
code	ErrorCode	ErrorCode Codici di errore definiti nelle linee guida di Microsoft REST (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
details	Error[]	Dettagli dell'errore, se disponibile.
innererror	InnerError	InnerError Errore interno come definito nelle linee guida di Microsoft REST (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
message	string minLength: 1	Messaggio di questo errore.
target	string	Posizione in cui si è verificato l'errore, se disponibile.

ErrorCode

Enumerazione

ErrorCode

Valore	Descrizione
conflict	L'operazione richiesta è in conflitto con lo stato della risorsa corrente.
contentFilter	La generazione di immagini non è riuscita a causa del nostro sistema di sicurezza.
fileImportFailed	Importazione del file non riuscita.
forbidden	L'operazione non è consentita per la chiave utente/API corrente.
internalFailure	Errore interno. Riprovare.
invalidPayload	I dati della richiesta non sono validi per questa operazione.
itemDoesAlreadyExist	L'elemento esiste già.
jsonlValidationFailed	La convalida dei dati jsonl non è riuscita.
notFound	La risorsa non viene trovata.
quotaExceeded	Quota superata.
serviceUnavailable	Il servizio non è attualmente disponibile.
tooManyRequests	Troppe richieste. Riprovare più tardi.
unauthorized	La chiave utente/API corrente non è autorizzata per l'operazione.
unexpectedEntityState	L'operazione non può essere eseguita nello stato della risorsa corrente.

ErrorResponse

Object

ErrorResponse

Nome	Tipo	Descrizione
error	Error	Errore Contenuto degli errori come definito nelle linee guida microsoft REST (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

FineTuningHyperParameters

Object

FineTuningHyperParameters

Nome	Tipo	Descrizione
batch_size	integer (int32)	Dimensioni del batch da usare per il training. Le dimensioni del batch sono il numero di esempi di training usati per eseguire il training di un singolo passaggio avanti e indietro. In generale, è stato rilevato che le dimensioni dei batch più grandi tendono a funzionare meglio per set di dati di dimensioni maggiori. Il valore predefinito e il valore massimo per questa proprietà sono specifici di un modello di base.
learning_rate_multiplier	number (double)	Moltiplicatore della frequenza di apprendimento da usare per il training. La frequenza di apprendimento di ottimizzazione è la velocità di apprendimento originale usata per il pre-training moltiplicato per questo valore. I tassi di apprendimento più elevati tendono a ottenere prestazioni migliori con dimensioni batch maggiori. È consigliabile provare con i valori compresi nell'intervallo da 0,02 a 0,2 per vedere quali risultati producono i risultati migliori.
n_epochs	integer (int32)	Numero di periodi per cui eseguire il training del modello. Un periodo fa riferimento a un ciclo completo attraverso il set di dati di training.

FineTuningJob

Object

FineTuningJob

Nome	Tipo	Descrizione
created_at	integer (unixtime)	Timestamp quando questo processo o elemento è stato creato (in periodi UNIX).
error	FineTuningJobError	FineTuningJobError Per i processi di ottimizzazione non riusciti, verranno fornite altre informazioni sulla causa dell'errore.
estimated_finish	integer (int32)	Timestamp Unix (in secondi) per il completamento del processo di ottimizzazione. Il valore sarà Null se il processo di ottimizzazione non è in esecuzione.
fine_tuned_model	string	Identificatore (model-id) del modello ottimizzato risultante. Questa proprietà viene popolata solo per le esecuzioni completate correttamente. Usare questo identificatore per creare una distribuzione per l'inferenza.
finished_at	integer (int32)	Timestamp quando il processo o l'elemento è stato completato correttamente (in periodi unix).
hyperparameters	FineTuningHyperParameters	FineTuningHyperParameters Impostazioni del parametro hyper usate in un processo di ottimizzazione.
id	string	Identità dell'elemento.
model	string minLength: 1	Identificatore (model-id) del modello di base usato per l'ottimizzazione.
object	TypeDiscriminator	TypeDiscriminator Definisce il tipo di un oggetto .
organisation_id	string	Id organizzazione di questo lavoro di ottimizzazione. Non usato in Azure OpenAI; compatibilità solo per OpenAI.
result_files	string[]	Identità dei file di risultato (id file) contenenti metriche di training e valutazione in formato csv. Il file è disponibile solo per le esecuzioni completate correttamente.
seed	integer (int32)	Valore di inizializzazione utilizzato per il processo di ottimizzazione.
status	FineTuningState	FineTuningState Stato di un oggetto di finetunes o di un processo di ottimizzazione.
suffix	string	Suffisso usato per identificare il modello ottimizzato. Il suffisso può contenere fino a 40 caratteri (a-z, A-Z, 0-9 e _) che verranno aggiunti al nome del modello ottimizzato.
trained_tokens	integer (int32)	Numero totale di token fatturabili elaborati da questo processo di ottimizzazione.
training_file	string minLength: 1	File utilizzato per il training.
validation_file	string	File utilizzato per valutare il modello ottimizzato durante il training.

FineTuningJobCreation

Object

FineTuningJobCreation

Nome	Tipo	Descrizione
hyperparameters	FineTuningHyperParameters	FineTuningHyperParameters Impostazioni del parametro hyper usate in un processo di ottimizzazione.
model	string minLength: 1	Identificatore (model-id) del modello di base usato per l'ottimizzazione.
seed	integer (int32)	Valore di inizializzazione utilizzato per il processo di ottimizzazione. Il passaggio degli stessi parametri di inizializzazione e processo dovrebbe produrre gli stessi risultati, ma può differire in rari casi. Se non viene specificato un valore di inizializzazione, ne verrà generato uno automaticamente.
suffix	string	Suffisso usato per identificare il modello ottimizzato. Il suffisso può contenere fino a 40 caratteri (a-z, A-Z, 0-9 e _) che verranno aggiunti al nome del modello ottimizzato.
training_file	string minLength: 1	Identità del file (ID file) usata per il training di questo modello ottimizzato.
validation_file	string	Identità del file (ID file) usata per valutare il modello ottimizzato durante il training.

FineTuningJobError

Object

FineTuningJobError

Nome	Tipo	Descrizione
code	string	Codice errore leggibile dal computer.
message	string	Messaggio di errore leggibile.
param	string	Parametro non valido, in genere training_file o validation_file. Questo campo sarà Null se l'errore non era specifico del parametro.

FineTuningState

Enumerazione

FineTuningState

Valore	Descrizione
cancelled	L'operazione è stata annullata ed è incompleta. Può essere categorizzato come stato terminale.
created	L'operazione è stata creata. Questo stato non viene restituito da Azure OpenAI ed esposto solo per la compatibilità. Può essere categorizzato come stato inattivo.
failed	L'operazione ha completato l'elaborazione con un errore e non può essere ulteriormente utilizzata. Può essere categorizzato come stato terminale.
pending	L'operazione non è ancora in coda da elaborare in futuro. Può essere categorizzato come stato inattivo.
running	L'operazione è stata avviata per l'elaborazione. Può essere categorizzato come stato attivo.
succeeded	L'operazione è stata elaborata correttamente ed è pronta per l'utilizzo. Può essere categorizzato come stato terminale.

InnerError

Object

InnerError

Nome	Tipo	Descrizione
code	InnerErrorCode	InnerErrorCode Codici di errore interni definiti nelle linee guida di Microsoft REST (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
innererror	InnerError	InnerError Errore interno come definito nelle linee guida di Microsoft REST (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

InnerErrorCode

Enumerazione

InnerErrorCode

Valore	Descrizione
invalidPayload	I dati della richiesta non sono validi per questa operazione.

TypeDiscriminator

Enumerazione

TypeDiscriminator

Valore	Descrizione
batch	Questo oggetto rappresenta un batch.
file	Questo oggetto rappresenta un file.
fine_tuning.job	Questo oggetto rappresenta un processo di ottimizzazione.
fine_tuning.job.checkpoint	Questo oggetto rappresenta un checkpoint di un processo di ottimizzazione.
fine_tuning.job.event	Questo oggetto rappresenta un evento di un processo di ottimizzazione fine.
list	Questo oggetto rappresenta un elenco di altri oggetti.
model	Questo oggetto rappresenta un modello (può essere un modello di base o ottimizzare il risultato del processo).
upload	Questo oggetto rappresenta un caricamento di file.
upload.part	Questo oggetto rappresenta parte di un caricamento di file.

Condividi tramite

Fine Tuning - Create

Parametri dell'URI

Intestazione della richiesta

Corpo della richiesta

Risposte

Sicurezza

api-key

Esempio

Creating a fine tuning job.

Esempio di richiesta

Risposta di esempio

Definizioni

Error

ErrorCode

ErrorResponse

FineTuningHyperParameters

FineTuningJob

FineTuningJobCreation

FineTuningJobError

FineTuningState

InnerError

InnerErrorCode

TypeDiscriminator

Risorse aggiuntive