Fine Tuning - Create

Referenz

Dienst:: Azure AI Services

API-Version:: 2024-05-01-preview

Erstellt einen Auftrag, der ein angegebenes Modell aus einer bestimmten Trainingsdatei optimiert. Die Antwort enthält Details zum in die Warteschlange eingereihten Auftrag, einschließlich status und Hyperparametern. Der Name des optimierten Modells wird nach Abschluss der Antwort hinzugefügt.

POST {endpoint}/openai/fine_tuning/jobs?api-version=2024-05-01-preview

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string url	Unterstützte Cognitive Services-Endpunkte (Protokoll und Hostname, z. B. . https://aoairesource.openai.azure.com Ersetzen Sie "aoairesource" durch den Namen Ihres Azure OpenAI-Kontos.
api-version	query	True	string	Die angeforderte API-Version.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
api-key	True	string	Geben Sie hier Ihren Azure OpenAI-Kontoschlüssel für Cognitive Services an.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
model	True	string	Der Bezeichner (Modell-ID) des Basismodells, das für diese Feinabstimmung verwendet wird.
training_file	True	string	Die Dateiidentität (File-ID), die zum Trainieren dieses optimierten Modells verwendet wird.
hyperparameters		FineTuningHyperParameters	FineTuningHyperParameters Die Hyperparametereinstellungen, die in einem Feinabstimmungsauftrag verwendet werden.
seed		integer	Der Für den Feinabstimmungsauftrag verwendete Seed. Die Übergabe desselben Seed- und Auftragsparameters sollte zu den gleichen Ergebnissen führen, kann sich jedoch in seltenen Fällen unterscheiden. Wenn kein Seed angegeben ist, wird ein Seed für Sie generiert.
suffix		string	Das Suffix, das zum Identifizieren des optimierten Modells verwendet wird. Das Suffix kann bis zu 40 Zeichen (a-z, A-Z, 0-9, und _) enthalten, die Ihrem optimierten Modellnamen hinzugefügt werden.
validation_file		string	Die Dateiidentität (File-ID), die zum Auswerten des optimierten Modells während des Trainings verwendet wird.

Antworten

Name	Typ	Beschreibung
201 Created	FineTuningJob	Die Feinabstimmung wurde erfolgreich erstellt. Header Location: string
Other Status Codes	ErrorResponse	Ein Fehler ist aufgetreten.

Name

Typ

Beschreibung

201 Created

FineTuningJob

Die Feinabstimmung wurde erfolgreich erstellt.

Header

Location: string

Other Status Codes

ErrorResponse

Ein Fehler ist aufgetreten.

Sicherheit

api-key

Geben Sie hier Ihren Azure OpenAI-Kontoschlüssel für Cognitive Services an.

Typ: apiKey
In: header

Beispiele

Creating a fine tuning job.

Beispielanforderung

HTTP

POST https://aoairesource.openai.azure.com/openai/fine_tuning/jobs?api-version=2024-05-01-preview


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

Beispiel für eine Antwort

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

Definitionen

Name	Beschreibung
Error	Fehler
ErrorCode	ErrorCode
ErrorResponse	ErrorResponse
FineTuningHyperParameters	FineTuningHyperParameters
FineTuningJob	FineTuningJob
FineTuningJobCreation	FineTuningJobCreation
FineTuningState	FineTuningState
InnerError	InnerError
InnerErrorCode	InnerErrorCode
TypeDiscriminator	TypeDiscriminator

Error

Fehler

Name	Typ	Beschreibung
code	ErrorCode	ErrorCode Fehlercodes, wie in den Microsoft REST-Richtlinien (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses) definiert.
details	Error[]	Die Fehlerdetails, falls verfügbar.
innererror	InnerError	InnerError Innerer Fehler, wie in den Microsoft REST-Richtlinien (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses) definiert.
message	string	Die Meldung dieses Fehlers.
target	string	Der Speicherort, an dem der Fehler aufgetreten ist, falls verfügbar.

ErrorCode

Name	Typ	Beschreibung
conflict	string	Der angeforderte Vorgang wird mit dem aktuellen Ressourcenstatus in Konflikt gestellt.
contentFilter	string	Die Bildgenerierung ist aufgrund unseres Sicherheitssystems fehlgeschlagen.
fileImportFailed	string	Fehler beim Importieren der Datei.
forbidden	string	Der Vorgang ist für den aktuellen Benutzer-/API-Schlüssel verboten.
internalFailure	string	Interner Fehler. Versuchen Sie es erneut.
invalidPayload	string	Die Anforderungsdaten sind für diesen Vorgang ungültig.
itemDoesAlreadyExist	string	Das Element ist bereits vorhanden.
jsonlValidationFailed	string	Fehler bei der Überprüfung von JSONL-Daten.
notFound	string	Die Ressource wurde nicht gefunden.
quotaExceeded	string	Kontingent überschritten.
serviceUnavailable	string	Der Dienst ist derzeit nicht verfügbar.
tooManyRequests	string	Too many requests. (Zu viele Anforderungen.) Versuchen Sie es später noch mal.
unauthorized	string	Der aktuelle Benutzer-/API-Schlüssel ist nicht für den Vorgang autorisiert.
unexpectedEntityState	string	Der Vorgang kann nicht im Zustand der aktuellen Ressource ausgeführt werden.

ErrorResponse

Name	Typ	Beschreibung
error	Error	Fehler Fehlerinhalt gemäß der Definition in den Microsoft REST-Richtlinien (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

FineTuningHyperParameters

Name	Typ	Beschreibung
batch_size	integer	Die für das Training zu verwendende Batchgröße. Die Batchgröße ist die Anzahl der Trainingsbeispiele, die zum Trainieren eines einzelnen Vorwärts- und Rückwärtsdurchlaufs verwendet werden. Im Allgemeinen haben wir festgestellt, dass größere Batchgrößen für größere Datasets besser funktionieren. Der Standardwert sowie der Maximalwert für diese Eigenschaft sind spezifisch für ein Basismodell.
learning_rate_multiplier	number	Der Lernratenmultiplikator, der für das Training verwendet werden soll. Die Optimierungslernrate ist die ursprüngliche Lernrate, die für das Vorabtraining verwendet wird, mit diesem Wert multipliziert. Größere Lernraten funktionieren bei größeren Batchgrößen in der Regel besser. Es empfiehlt sich, mit Werten im Bereich 0,02 bis 0,2 zu experimentieren, um zu sehen, was die besten Ergebnisse erzeugt.
n_epochs	integer	Die Anzahl der Epochen zum Trainieren des Modells. Eine Epoche bezeichnet einen vollständigen Zyklus über das Trainingsdataset.

FineTuningJob

Name	Typ	Beschreibung
created_at	integer	Ein Zeitstempel, bei dem dieser Auftrag oder dieses Element erstellt wurde (in Unix-Epochen).
fine_tuned_model	string	Der Bezeichner (Model-ID) des resultierenden, fein abgestimmten Modells. Diese Eigenschaft wird nur für erfolgreich abgeschlossene Feinabstimmungsausführungen aufgefüllt. Verwenden Sie diesen Bezeichner, um eine Bereitstellung für Rückschlüsse zu erstellen.
finished_at	integer	Ein Zeitstempel, wenn dieser Auftrag oder dieses Element erfolgreich abgeschlossen wurde (in Unix-Epochen).
hyperparameters	FineTuningHyperParameters	FineTuningHyperParameters Die Hyperparametereinstellungen, die in einem Feinabstimmungsauftrag verwendet werden.
id	string	Die Identität dieses Elements.
model	string	Der Bezeichner (Model-ID) des Basismodells, das für die Feinabstimmung verwendet wird.
object	TypeDiscriminator	TypeDiscriminator Definiert den Typ eines Objekts.
organisation_id	string	Die Organisations-ID dieses Feinabstimmungsauftrags. In Azure OpenAI nicht verwendet; Nur für OpenAI kompatibel.
result_files	string[]	Die Ergebnisdateiidentitäten (Datei-ID), die Trainings- und Auswertungsmetriken im CSV-Format enthalten. Die Datei ist nur für erfolgreich abgeschlossene Feinabstimmungsausführungen verfügbar.
seed	integer	Der Seed, der für den Feinabstimmungsauftrag verwendet wird.
status	FineTuningState	FineTuningState Der Zustand eines Finetunes-Objekts oder eines Feinabstimmungsauftrags.
suffix	string	Das Suffix, das zum Identifizieren des fein abgestimmten Modells verwendet wird. Das Suffix kann bis zu 40 Zeichen (a-z, A-Z, 0-9,- und _) enthalten, die Ihrem optimierten Modellnamen hinzugefügt werden.
trained_tokens	integer	Die Gesamtzahl der abrechenbaren Token, die von diesem Feinabstimmungsauftrag verarbeitet werden.
training_file	string	Die Datei, die für das Training verwendet wird.
validation_file	string	Die Datei, die verwendet wird, um das fein abgestimmte Modell während des Trainings auszuwerten.

FineTuningJobCreation

Name	Typ	Beschreibung
hyperparameters	FineTuningHyperParameters	FineTuningHyperParameters Die Hyperparametereinstellungen, die in einem Feinabstimmungsauftrag verwendet werden.
model	string	Der Bezeichner (Model-ID) des Basismodells, das für diese Feinabstimmung verwendet wird.
seed	integer	Der Seed, der für den Feinabstimmungsauftrag verwendet wird. Das Übergeben der gleichen Seed- und Auftragsparameter sollte zu den gleichen Ergebnissen führen, kann sich jedoch in seltenen Fällen unterscheiden. Wenn kein Seed angegeben wird, wird ein Seed für Sie generiert.
suffix	string	Das Suffix, das zum Identifizieren des fein abgestimmten Modells verwendet wird. Das Suffix kann bis zu 40 Zeichen (a-z, A-Z, 0-9,- und _) enthalten, die Ihrem optimierten Modellnamen hinzugefügt werden.
training_file	string	Die Dateiidentität (File-ID), die zum Trainieren dieses optimierten Modells verwendet wird.
validation_file	string	Die Dateiidentität (Datei-ID), die zum Auswerten des optimierten Modells während des Trainings verwendet wird.

FineTuningState

Name	Typ	Beschreibung
cancelled	string	Der Vorgang wurde abgebrochen und ist unvollständig. Es kann als Terminalzustand kategorisiert werden.
created	string	Der Vorgang wurde erstellt. Dieser Zustand wird von Azure OpenAI nicht zurückgegeben und nur aus Kompatibilitätsgründen verfügbar gemacht. Es kann als inaktiver Zustand kategorisiert werden.
failed	string	Der Vorgang hat die Verarbeitung mit einem Fehler abgeschlossen und kann nicht weiter genutzt werden. Es kann als Terminalzustand kategorisiert werden.
pending	string	Der Vorgang befindet sich noch nicht in der Warteschlange, um in zukunft verarbeitet zu werden. Es kann als inaktiver Zustand kategorisiert werden.
running	string	Der Vorgang wurde mit der Verarbeitung begonnen. Es kann als aktiver Zustand kategorisiert werden.
succeeded	string	Der Vorgang wurde erfolgreich verarbeitet und ist einsatzbereit. Es kann als Terminalzustand kategorisiert werden.

InnerError

Name	Typ	Beschreibung
code	InnerErrorCode	InnerErrorCode Interne Fehlercodes, wie in den Microsoft REST-Richtlinien (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses) definiert.
innererror	InnerError	InnerError Innerer Fehler, wie in den Microsoft REST-Richtlinien (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses) definiert.

InnerErrorCode

Name	Typ	Beschreibung
invalidPayload	string	Die Anforderungsdaten sind für diesen Vorgang ungültig.

TypeDiscriminator

Name	Typ	Beschreibung
file	string	Dieses Objekt stellt eine Datei dar.
fine_tuning.job	string	Dieses Objekt stellt einen Feinabstimmungsauftrag dar.
fine_tuning.job.checkpoint	string	Dieses Objekt stellt einen Prüfpunkt eines Feinoptimierungsauftrags dar.
fine_tuning.job.event	string	Dieses Objekt stellt ein Ereignis eines Feinoptimierungsauftrags dar.
list	string	Dieses Objekt stellt eine Liste anderer Objekte dar.
model	string	Dieses Objekt stellt ein Modell dar (kann ein Basismodell oder ein Feinabstimmungsauftragsergebnis sein).

Freigeben über

Fine Tuning - Create

URI-Parameter

Anforderungsheader

Anforderungstext

Antworten

Sicherheit

api-key

Beispiele

Creating a fine tuning job.

Beispielanforderung

Beispiel für eine Antwort

Definitionen

Error

ErrorCode

ErrorResponse

FineTuningHyperParameters

FineTuningJob

FineTuningJobCreation

FineTuningState

InnerError

InnerErrorCode

TypeDiscriminator

Zusätzliche Ressourcen