Fine Tuning - Create

Odwołanie

Usługa:: Azure AI Services

Wersja interfejsu API:: 2024-02-01

Tworzy zadanie, które dostraja określony model z danego pliku szkoleniowego. Odpowiedź zawiera szczegóły zadania w kolejce, w tym stan zadania i parametry funkcji Hyper. Nazwa dostrojonego modelu jest dodawana do odpowiedzi po zakończeniu.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
endpoint	path	True	string url	Obsługiwane punkty końcowe usług Cognitive Services (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com. Zastąp ciąg "aoairesource" nazwą konta usługi Azure OpenAI.
api-version	query	True	string	Żądana wersja interfejsu API.

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
api-key	True	string	Tutaj podaj klucz konta usługi Azure OpenAI w usługach Cognitive Services.

Treść żądania

Nazwa	Wymagane	Typ	Opis
model	True	string	Identyfikator (model-id) modelu podstawowego używanego na potrzeby tej precyzyjnej konfiguracji.
training_file	True	string	Tożsamość pliku (identyfikator pliku), która jest używana do trenowania tego dostosowanego modelu.
hyperparameters		FineTuningHyperParameters	FineTuningHyperParameters Ustawienia hiperparametrów używane w zadaniu dostrajania.
suffix		string	Sufiks używany do identyfikowania dostosowanego modelu. Sufiks może zawierać maksymalnie 40 znaków (a-z, A-Z, 0-9 i _), które zostaną dodane do dostosowanej nazwy modelu.
validation_file		string	Tożsamość pliku (identyfikator pliku), która jest używana do oceny dopasowanego modelu podczas trenowania.

Odpowiedzi

Nazwa	Typ	Opis
201 Created	FineTuningJob	Pomyślnie utworzono dostrojenie. Nagłówki Location: string
Other Status Codes	ErrorResponse	Wystąpił błąd.

Nazwa

Typ

Opis

201 Created

FineTuningJob

Pomyślnie utworzono dostrojenie.

Nagłówki

Location: string

Other Status Codes

ErrorResponse

Wystąpił błąd.

Zabezpieczenia

api-key

Tutaj podaj klucz konta usługi Azure OpenAI w usługach Cognitive Services.

Typ: apiKey
W: header

Przykłady

Creating a fine tune job.

Przykładowe żądanie

HTTP

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


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

Przykładowa odpowiedź

Kod stanu:: 201

location: https://aoairesource.openai.azure.com/openai/fine_tuning/jobs/ft-72a2792ef7d24ba7b82c7fe4a37e379f

{
  "hyperparameters": {
    "n_epochs": 2
  },
  "model": "curie",
  "training_file": "file-181a1cbdcdcf4677ada87f63a0928099",
  "id": "ft-72a2792ef7d24ba7b82c7fe4a37e379f",
  "status": "notRunning",
  "created_at": 1646126127,
  "object": "fine_tuning.job"
}

Definicje

Nazwa	Opis
Error	Błąd
ErrorCode	ErrorCode
ErrorResponse	ErrorResponse
FineTuningHyperParameters	FineTuningHyperParameters
FineTuningJob	FineTuningJob
FineTuningJobCreation	FineTuningJobCreation
FineTuningState	FineTuningState
InnerError	InnerError
InnerErrorCode	InnerErrorCode
TypeDiscriminator	TypeDiscriminator

Error

Błąd

Nazwa	Typ	Opis
code	ErrorCode	ErrorCode Kody błędów zdefiniowane w wytycznych REST firmy Microsoft (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
details	Error[]	Szczegóły błędu, jeśli są dostępne.
innererror	InnerError	InnerError Wewnętrzny błąd zdefiniowany w wytycznych rest firmy Microsoft (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
message	string	Komunikat o tym błędzie.
target	string	Lokalizacja, w której wystąpił błąd, jeśli jest dostępny.

ErrorCode

Nazwa	Typ	Opis
conflict	string	Żądana operacja powoduje konflikt z bieżącym stanem zasobu.
contentFilter	string	Generowanie obrazu nie powiodło się w wyniku naszego systemu bezpieczeństwa.
fileImportFailed	string	Importowanie pliku nie powiodło się.
forbidden	string	Operacja jest zabroniona dla bieżącego klucza użytkownika/interfejsu API.
internalFailure	string	Błąd wewnętrzny. Spróbuj ponownie.
invalidPayload	string	Dane żądania są nieprawidłowe dla tej operacji.
itemDoesAlreadyExist	string	Element już istnieje.
jsonlValidationFailed	string	Walidacja danych jsonl nie powiodła się.
notFound	string	Nie można odnaleźć zasobu.
quotaExceeded	string	Przekroczono limit przydziału.
serviceUnavailable	string	Usługa jest obecnie niedostępna.
tooManyRequests	string	Zbyt wiele żądań. Spróbuj ponownie później.
unauthorized	string	Bieżący klucz użytkownika/interfejsu API nie jest autoryzowany dla operacji.
unexpectedEntityState	string	Nie można wykonać operacji w stanie bieżącego zasobu.

ErrorResponse

Nazwa	Typ	Opis
error	Error	Błąd Zawartość błędu zdefiniowana w wytycznych REST firmy Microsoft (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

FineTuningHyperParameters

Nazwa	Typ	Opis
batch_size	integer	Rozmiar partii do użycia do trenowania. Rozmiar partii to liczba przykładów trenowania używanych do trenowania pojedynczego przekazywania do przodu i do tyłu. Ogólnie rzecz biorąc, odkryliśmy, że większe rozmiary partii zwykle działają lepiej w przypadku większych zestawów danych. Wartość domyślna, a także maksymalna wartość tej właściwości są specyficzne dla modelu podstawowego.
learning_rate_multiplier	number	Mnożnik szybkości nauki używany do trenowania. Szybkość nauki dostrajania jest oryginalnym współczynnikiem uczenia używanym do wstępnego trenowania pomnożonego przez tę wartość. Większe wskaźniki szkoleniowe mają tendencję do lepszego działania z większymi rozmiarami partii. Zalecamy eksperymentowanie z wartościami w zakresie od 0,02 do 0,2, aby zobaczyć, co daje najlepsze wyniki.
n_epochs	integer	Liczba epok do trenowania modelu. Epoka odnosi się do jednego pełnego cyklu w zestawie danych trenowania.

FineTuningJob

Nazwa	Typ	Opis
created_at	integer	Sygnatura czasowa utworzenia tego zadania lub elementu (w epokach unix).
fine_tuned_model	string	Identyfikator (identyfikator modelu) wynikowego dostosowanego modelu. Ta właściwość jest wypełniana tylko w przypadku pomyślnie ukończonych przebiegów dostrajania. Użyj tego identyfikatora, aby utworzyć wdrożenie na potrzeby wnioskowania.
finished_at	integer	Sygnatura czasowa po pomyślnym zakończeniu tego zadania lub elementu (w epokach unix).
hyperparameters	FineTuningHyperParameters	FineTuningHyperParameters Ustawienia hiperparametrów używane w zadaniu dostrajania.
id	string	Tożsamość tego elementu.
model	string	Identyfikator (identyfikator modelu) modelu podstawowego używanego do dostosowania.
object	TypeDiscriminator	TypeDiscriminator Definiuje typ obiektu.
organisation_id	string	Identyfikator organizacji tej dobrze dostosowanej pracy. Nieużywane w usłudze Azure OpenAI; zgodność tylko z interfejsem OpenAI.
result_files	string[]	Tożsamości plików wynikowych (file-id) zawierające metryki trenowania i oceny w formacie csv. Plik jest dostępny tylko dla pomyślnie ukończonych przebiegów dostrajania.
status	FineTuningState	FineTuningState Stan obiektu finetunes lub zadania dostrajania.
suffix	string	Sufiks używany do identyfikowania dostosowanego modelu. Sufiks może zawierać maksymalnie 40 znaków (a-z, A-Z, 0-9 i _), które zostaną dodane do nazwy dostosowanego modelu.
trained_tokens	integer	Łączna liczba rozliczanych tokenów przetworzonych przez to zadanie dostrajania.
training_file	string	Plik używany do trenowania.
validation_file	string	Plik, który jest używany do oceny precyzyjnego modelu podczas trenowania.

FineTuningJobCreation

Nazwa	Typ	Opis
hyperparameters	FineTuningHyperParameters	FineTuningHyperParameters Ustawienia hiperparametrów używane w zadaniu dostrajania.
model	string	Identyfikator (identyfikator modelu) modelu podstawowego używanego na potrzeby tej precyzyjnej konfiguracji.
suffix	string	Sufiks używany do identyfikowania dostosowanego modelu. Sufiks może zawierać maksymalnie 40 znaków (a-z, A-Z, 0-9 i _), które zostaną dodane do nazwy dostosowanego modelu.
training_file	string	Tożsamość pliku (identyfikator pliku), która jest używana do trenowania tego precyzyjnego modelu.
validation_file	string	Tożsamość pliku (identyfikator pliku), która jest używana do oceny precyzyjnego modelu podczas trenowania.

FineTuningState

Nazwa	Typ	Opis
cancelled	string	Operacja została anulowana i jest niekompletna. Można go podzielić na stan terminalu.
created	string	Operacja została utworzona. Ten stan nie jest zwracany przez usługę Azure OpenAI i uwidoczniony tylko pod kątem zgodności. Może być sklasyfikowany jako stan nieaktywny.
failed	string	Operacja zakończyła przetwarzanie z powodu błędu i nie można jej jeszcze bardziej zużyć. Można go podzielić na stan terminalu.
pending	string	Operacja nie jest jeszcze w kolejce do przetworzenia w przyszłości. Może być sklasyfikowany jako stan nieaktywny.
running	string	Operacja została rozpoczęta do przetworzenia. Można go podzielić na aktywny stan.
succeeded	string	Operacja została pomyślnie przetworzona i jest gotowa do użycia. Można go podzielić na stan terminalu.

InnerError

Nazwa	Typ	Opis
code	InnerErrorCode	InnerErrorCode Wewnętrzne kody błędów zgodnie z definicją w wytycznych REST firmy Microsoft (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
innererror	InnerError	InnerError Wewnętrzny błąd zdefiniowany w wytycznych rest firmy Microsoft (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

InnerErrorCode

Nazwa	Typ	Opis
invalidPayload	string	Dane żądania są nieprawidłowe dla tej operacji.

TypeDiscriminator

Nazwa	Typ	Opis
file	string	Ten obiekt reprezentuje plik.
fine-tune	string	Ten obiekt reprezentuje zadanie dostrajania.
fine-tune-event	string	Ten obiekt reprezentuje zdarzenie zadania dostrajania.
fine_tuning.job	string	Ten obiekt reprezentuje zadanie dostrajania.
fine_tuning.job.event	string	Ten obiekt reprezentuje zdarzenie zadania dostrajania.
list	string	Ten obiekt reprezentuje listę innych obiektów.
model	string	Ten obiekt reprezentuje model (może być modelem podstawowym lub dobrym wynikiem zadania).

Udostępnij za pośrednictwem

Fine Tuning - Create

Parametry identyfikatora URI

Nagłówek żądania

Treść żądania

Odpowiedzi

Zabezpieczenia

api-key

Przykłady

Creating a fine tune job.

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

Error

ErrorCode

ErrorResponse

FineTuningHyperParameters

FineTuningJob

FineTuningJobCreation

FineTuningState

InnerError

InnerErrorCode

TypeDiscriminator

Dodatkowe zasoby