Dela via

Fine Tuning - Create

Tjänst:
Azure AI Services
API-version:
2024-10-21

Skapar ett jobb som finjusterar en angiven modell från en viss träningsfil. Svaret innehåller information om det köade jobbet, inklusive jobbstatus och hyperparametrar. Namnet på den finjusterade modellen läggs till i svaret när det är klart.

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

URI-parametrar

Name I Obligatorisk Typ Description
endpoint
 path True

string (url)

Cognitive Services-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-kontonamn).
api-version
 query True

string

Den begärda API-versionen.

Begärandehuvud

Name Obligatorisk Typ Description
api-key True

string

Ange din Azure OpenAI-kontonyckel för Cognitive Services här.

Begärandetext

Name Obligatorisk Typ Description
model True

string

minLength: 1

Identifieraren (modell-ID) för basmodellen som används för den här finjusteraren.
training_file True

string

minLength: 1

Den filidentitet (fil-ID) som används för att träna den här finjusterade modellen.
hyperparameters

FineTuningHyperParameters

FineTuningHyperParameters
Hyperparameterinställningarna som används i ett finjusterat jobb.
seed

integer (int32)

Det frö som används för finjusteringsjobbet. Att skicka in samma parametrar för start- och jobb bör ge samma resultat, men kan skilja sig i sällsynta fall. Om ett frö inte har angetts genereras ett för dig.
suffix

string

Suffixet som används för att identifiera den finjusterade modellen. Suffixet kan innehålla upp till 40 tecken (a-z, A-Z, 0-9 och _) som läggs till i ditt finjusterade modellnamn.
validation_file

string

Den filidentitet (fil-ID) som används för att utvärdera den finjusterade modellen under träningen.

Svar

Name Typ Description
201 Created

FineTuningJob

Finjusteringen har skapats.

Sidhuvuden

Location: string
Other Status Codes

ErrorResponse

Ett fel uppstod.

Säkerhet

api-key

Ange din Azure OpenAI-kontonyckel för Cognitive Services här.

Typ: apiKey
I: header

Exempel

Creating a fine tuning job.

Exempelbegäran

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


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

Exempelsvar

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

Definitioner

Name Description
Error

Fel
ErrorCode

ErrorCode
ErrorResponse

ErrorResponse
FineTuningHyperParameters

FineTuningHyperParameters
FineTuningJob

FineTuningJob
FineTuningJobCreation

FineTuningJobCreation
FineTuningJobError

FineTuningJobError
FineTuningState

FineTuningState
InnerError

InnerError
InnerErrorCode

InnerErrorCode
TypeDiscriminator

TypeDiscriminator

Error

Objekt

Fel

Name Typ Description
code

ErrorCode

ErrorCode
Felkoder enligt definitionen i Microsoft REST-riktlinjerna (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
details

Error[]

Felinformationen om den är tillgänglig.
innererror

InnerError

InnerError
Inre fel enligt definitionen i Microsoft REST-riktlinjerna (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
message

string

minLength: 1

Meddelandet om det här felet.
target

string

Platsen där felet inträffade om det var tillgängligt.

ErrorCode

Uppräkning

ErrorCode

Värde Description
conflict

Den begärda åtgärden står i konflikt med det aktuella resurstillståndet.
invalidPayload

Begärandedata är ogiltiga för den här åtgärden.
forbidden

Åtgärden är förbjuden för den aktuella användaren/API-nyckeln.
notFound

Det går inte att hitta resursen.
unexpectedEntityState

Åtgärden kan inte köras i den aktuella resursens tillstånd.
itemDoesAlreadyExist

Objektet finns redan.
serviceUnavailable

Tjänsten är inte tillgänglig för närvarande.
internalFailure

Internt fel. Försök igen.
quotaExceeded

Kvoten har överskridits.
jsonlValidationFailed

Verifieringen av jsonl-data misslyckades.
fileImportFailed

Det gick inte att importera filen.
tooManyRequests

För många begäranden. Försök igen senare.
unauthorized

Den aktuella användar-/API-nyckeln har inte behörighet för åtgärden.
contentFilter

Bildgenereringen misslyckades till följd av vårt säkerhetssystem.

ErrorResponse

Objekt

ErrorResponse

Name Typ Description
error

Error

Fel
Felinnehåll enligt definitionen i Microsoft REST-riktlinjerna (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

FineTuningHyperParameters

Objekt

FineTuningHyperParameters

Name Typ Description
batch_size

integer (int32)

Batchstorleken som ska användas för träning. Batchstorleken är antalet träningsexempel som används för att träna ett enda framåt- och bakåtpass. I allmänhet har vi upptäckt att större batchstorlekar tenderar att fungera bättre för större datamängder. Standardvärdet samt det maximala värdet för den här egenskapen är specifika för en basmodell.
learning_rate_multiplier

number (double)

Den inlärningsfrekvensmultiplikator som ska användas för träning. Den finjusterande inlärningsfrekvensen är den ursprungliga inlärningsfrekvensen som används för förträning multiplicerat med det här värdet. Större inlärningsfrekvenser tenderar att fungera bättre med större batchstorlekar. Vi rekommenderar att du experimenterar med värden i intervallet 0,02 till 0,2 för att se vad som ger bäst resultat.
n_epochs

integer (int32)

Antalet epoker som modellen ska tränas för. En epok refererar till en fullständig cykel genom träningsdatauppsättningen.

FineTuningJob

Objekt

FineTuningJob

Name Typ Description
created_at

integer (unixtime)

En tidsstämpel när det här jobbet eller objektet skapades (i unix-epoker).
error

FineTuningJobError

FineTuningJobError
För finjusteringsjobb som har misslyckats innehåller detta mer information om orsaken till felet.
estimated_finish

integer (int32)

Unix-tidsstämpeln (i sekunder) för när finjusteringsjobbet beräknas vara klart. Värdet är null om finjusteringsjobbet inte körs.
fine_tuned_model

string

Identifieraren (modell-ID) för den resulterande finjusterade modellen. Den här egenskapen fylls bara i för lyckade finjusterade körningar. Använd den här identifieraren för att skapa en distribution för slutsatsdragning.
finished_at

integer (int32)

En tidsstämpel när det här jobbet eller objektet har slutförts (i unix-epoker).
hyperparameters

FineTuningHyperParameters

FineTuningHyperParameters
Hyperparameterinställningarna som används i ett finjusterat jobb.
id

string

Identiteten för det här objektet.
model

string

minLength: 1

Identifieraren (modell-ID) för basmodellen som används för finjusteringen.
object

TypeDiscriminator

TypeDiscriminator
Definierar typen av ett objekt.
organisation_id

string

Organisations-ID:t för detta finjusterande jobb. Används inte i Azure OpenAI. endast för OpenAI.
result_files

string[]

Resultatfilidentiteterna (fil-ID) som innehåller tränings- och utvärderingsmått i csv-format. Filen är endast tillgänglig för slutförda finjusteringskörningar.
seed

integer (int32)

Det frö som används för finjusteringsjobbet.
status

FineTuningState

FineTuningState
Tillståndet för ett finjusterande objekt eller finjusteringsjobb.
suffix

string

Suffixet som används för att identifiera den finjusterade modellen. Suffixet kan innehålla upp till 40 tecken (a-z, A-Z, 0-9 och _) som läggs till i ditt finjusterade modellnamn.
trained_tokens

integer (int32)

Det totala antalet fakturerbara token som bearbetas av det här finjusteringsjobbet.
training_file

string

minLength: 1

Filen som används för träning.
validation_file

string

Filen som används för att utvärdera den finjusterade modellen under träningen.

FineTuningJobCreation

Objekt

FineTuningJobCreation

Name Typ Description
hyperparameters

FineTuningHyperParameters

FineTuningHyperParameters
Hyperparameterinställningarna som används i ett finjusterat jobb.
model

string

minLength: 1

Identifieraren (modell-ID) för basmodellen som används för den här finjusteraren.
seed

integer (int32)

Det frö som används för finjusteringsjobbet. Att skicka in samma parametrar för start- och jobb bör ge samma resultat, men kan skilja sig i sällsynta fall. Om ett frö inte har angetts genereras ett för dig.
suffix

string

Suffixet som används för att identifiera den finjusterade modellen. Suffixet kan innehålla upp till 40 tecken (a-z, A-Z, 0-9 och _) som läggs till i ditt finjusterade modellnamn.
training_file

string

minLength: 1

Den filidentitet (fil-ID) som används för att träna den här finjusterade modellen.
validation_file

string

Den filidentitet (fil-ID) som används för att utvärdera den finjusterade modellen under träningen.

FineTuningJobError

Objekt

FineTuningJobError

Name Typ Description
code

string

Felkoden som kan läsas av datorn..
message

string

Det mänskliga läsbara felmeddelandet.
param

string

Parametern som var ogiltig, vanligtvis training_file eller validation_file. Det här fältet är null om felet inte var parameterspecifikt.

FineTuningState

Uppräkning

FineTuningState

Värde Description
created

Åtgärden skapades. Det här tillståndet returneras inte av Azure OpenAI och exponeras endast för kompatibilitet. Den kan kategoriseras som ett inaktivt tillstånd.
pending

Åtgärden har ännu inte placerats i kö för att bearbetas i framtiden. Den kan kategoriseras som ett inaktivt tillstånd.
running

Åtgärden har börjat bearbetas. Det kan kategoriseras som ett aktivt tillstånd.
succeeded

Åtgärden har bearbetats och är klar för förbrukning. Den kan kategoriseras som ett terminaltillstånd.
cancelled

Åtgärden har avbrutits och är ofullständig. Den kan kategoriseras som ett terminaltillstånd.
failed

Åtgärden har slutfört bearbetningen med ett fel och kan inte förbrukas ytterligare. Den kan kategoriseras som ett terminaltillstånd.

InnerError

Objekt

InnerError

Name Typ Description
code

InnerErrorCode

InnerErrorCode
Inre felkoder enligt definitionen i Microsoft REST-riktlinjerna (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
innererror

InnerError

InnerError
Inre fel enligt definitionen i Microsoft REST-riktlinjerna (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

InnerErrorCode

Uppräkning

InnerErrorCode

Värde Description
invalidPayload

Begärandedata är ogiltiga för den här åtgärden.

TypeDiscriminator

Uppräkning

TypeDiscriminator

Värde Description
list

Det här objektet representerar en lista över andra objekt.
fine_tuning.job

Det här objektet representerar ett finjusterat jobb.
file

Det här objektet representerar en fil.
fine_tuning.job.event

Det här objektet representerar en händelse av ett finjusteringsjobb.
fine_tuning.job.checkpoint

Det här objektet representerar en kontrollpunkt för ett finjusteringsjobb.
model

Det här objektet representerar en modell (kan vara en basmodell eller finjustera jobbresultatet).
batch

Det här objektet representerar en batch.
upload

Det här objektet representerar en filuppladdning.
upload.part

Det här objektet representerar en del av en filuppladdning.