openai-1.0.0: Servant bindings to OpenAI
Safe HaskellSafe-Inferred
LanguageHaskell2010

OpenAI.V1.FineTuning.Jobs

Description

/v1/fine_tuning/jobs
Synopsis

Main types

data CreateFineTuningJob Source #

Request body for /v1/fine_tuning/jobs

Instances

Instances details
ToJSON CreateFineTuningJob Source # 
Instance details

Defined in OpenAI.V1.FineTuning.Jobs

Generic CreateFineTuningJob Source # 
Instance details

Defined in OpenAI.V1.FineTuning.Jobs

Associated Types

type Rep CreateFineTuningJob :: Type -> Type #

Show CreateFineTuningJob Source # 
Instance details

Defined in OpenAI.V1.FineTuning.Jobs

type Rep CreateFineTuningJob Source # 
Instance details

Defined in OpenAI.V1.FineTuning.Jobs

data JobObject Source #

The fine_tuning.job object represents a fine-tuning job that has been created through the API.

Instances

Instances details
FromJSON JobObject Source # 
Instance details

Defined in OpenAI.V1.FineTuning.Jobs

Generic JobObject Source # 
Instance details

Defined in OpenAI.V1.FineTuning.Jobs

Associated Types

type Rep JobObject :: Type -> Type #

Show JobObject Source # 
Instance details

Defined in OpenAI.V1.FineTuning.Jobs

type Rep JobObject Source # 
Instance details

Defined in OpenAI.V1.FineTuning.Jobs

type Rep JobObject = D1 ('MetaData "JobObject" "OpenAI.V1.FineTuning.Jobs" "openai-1.0.0-DWUl3td9tpcnv1wfBaSVp" 'False) (C1 ('MetaCons "JobObject" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FineTuningJobID) :*: S1 ('MetaSel ('Just "created_at") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 POSIXTime)) :*: (S1 ('MetaSel ('Just "error") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Error)) :*: S1 ('MetaSel ('Just "fine_tuned_model") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Model)))) :*: ((S1 ('MetaSel ('Just "finished_at") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe POSIXTime)) :*: S1 ('MetaSel ('Just "hyperparameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Hyperparameters)) :*: (S1 ('MetaSel ('Just "model") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Model) :*: S1 ('MetaSel ('Just "object") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))) :*: (((S1 ('MetaSel ('Just "organization_id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "result_files") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Vector FileID))) :*: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Status) :*: S1 ('MetaSel ('Just "trained_tokens") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Natural)))) :*: ((S1 ('MetaSel ('Just "training_file") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FileID) :*: S1 ('MetaSel ('Just "validation_file") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe FileID))) :*: (S1 ('MetaSel ('Just "integrations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Vector Integration))) :*: (S1 ('MetaSel ('Just "seed") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Integer) :*: S1 ('MetaSel ('Just "estimated_finish") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe POSIXTime))))))))

data EventObject Source #

Fine-tuning job event object

Constructors

EventObject 

data CheckpointObject Source #

The fine_tuning.job.checkpoint object represents a model checkpoint for a fine-tuning job that is ready to use

Instances

Instances details
FromJSON CheckpointObject Source # 
Instance details

Defined in OpenAI.V1.FineTuning.Jobs

Generic CheckpointObject Source # 
Instance details

Defined in OpenAI.V1.FineTuning.Jobs

Associated Types

type Rep CheckpointObject :: Type -> Type #

Show CheckpointObject Source # 
Instance details

Defined in OpenAI.V1.FineTuning.Jobs

type Rep CheckpointObject Source # 
Instance details

Defined in OpenAI.V1.FineTuning.Jobs

Other types

data AutoOr a Source #

A type that can also be the string "auto"

Constructors

Auto 
Specific a 

Instances

Instances details
FromJSON a => FromJSON (AutoOr a) Source # 
Instance details

Defined in OpenAI.V1.AutoOr

ToJSON a => ToJSON (AutoOr a) Source # 
Instance details

Defined in OpenAI.V1.AutoOr

IsString a => IsString (AutoOr a) Source # 
Instance details

Defined in OpenAI.V1.AutoOr

Methods

fromString :: String -> AutoOr a #

Generic (AutoOr a) Source # 
Instance details

Defined in OpenAI.V1.AutoOr

Associated Types

type Rep (AutoOr a) :: Type -> Type #

Methods

from :: AutoOr a -> Rep (AutoOr a) x #

to :: Rep (AutoOr a) x -> AutoOr a #

Show a => Show (AutoOr a) Source # 
Instance details

Defined in OpenAI.V1.AutoOr

Methods

showsPrec :: Int -> AutoOr a -> ShowS #

show :: AutoOr a -> String #

showList :: [AutoOr a] -> ShowS #

type Rep (AutoOr a) Source # 
Instance details

Defined in OpenAI.V1.AutoOr

type Rep (AutoOr a) = D1 ('MetaData "AutoOr" "OpenAI.V1.AutoOr" "openai-1.0.0-DWUl3td9tpcnv1wfBaSVp" 'False) (C1 ('MetaCons "Auto" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Specific" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 a)))

data Hyperparameters Source #

The hyperparameters used for the fine-tuning job

Instances

Instances details
FromJSON Hyperparameters Source # 
Instance details

Defined in OpenAI.V1.FineTuning.Jobs

ToJSON Hyperparameters Source # 
Instance details

Defined in OpenAI.V1.FineTuning.Jobs

Generic Hyperparameters Source # 
Instance details

Defined in OpenAI.V1.FineTuning.Jobs

Associated Types

type Rep Hyperparameters :: Type -> Type #

Show Hyperparameters Source # 
Instance details

Defined in OpenAI.V1.FineTuning.Jobs

type Rep Hyperparameters Source # 
Instance details

Defined in OpenAI.V1.FineTuning.Jobs

type Rep Hyperparameters = D1 ('MetaData "Hyperparameters" "OpenAI.V1.FineTuning.Jobs" "openai-1.0.0-DWUl3td9tpcnv1wfBaSVp" 'False) (C1 ('MetaCons "Hyperparameters" 'PrefixI 'True) (S1 ('MetaSel ('Just "batch_size") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (AutoOr Natural))) :*: (S1 ('MetaSel ('Just "learning_rate_multiplier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (AutoOr Double))) :*: S1 ('MetaSel ('Just "n_epochs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (AutoOr Natural))))))

data WAndB Source #

The settings for your integration with Weights and

Constructors

WAndB 

Fields

Instances

Instances details
FromJSON WAndB Source # 
Instance details

Defined in OpenAI.V1.FineTuning.Jobs

ToJSON WAndB Source # 
Instance details

Defined in OpenAI.V1.FineTuning.Jobs

Generic WAndB Source # 
Instance details

Defined in OpenAI.V1.FineTuning.Jobs

Associated Types

type Rep WAndB :: Type -> Type #

Methods

from :: WAndB -> Rep WAndB x #

to :: Rep WAndB x -> WAndB #

Show WAndB Source # 
Instance details

Defined in OpenAI.V1.FineTuning.Jobs

Methods

showsPrec :: Int -> WAndB -> ShowS #

show :: WAndB -> String #

showList :: [WAndB] -> ShowS #

type Rep WAndB Source # 
Instance details

Defined in OpenAI.V1.FineTuning.Jobs

type Rep WAndB = D1 ('MetaData "WAndB" "OpenAI.V1.FineTuning.Jobs" "openai-1.0.0-DWUl3td9tpcnv1wfBaSVp" 'False) (C1 ('MetaCons "WAndB" 'PrefixI 'True) ((S1 ('MetaSel ('Just "project") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "entity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Vector Text))))))

data Integration Source #

An integration to enable for your fine-tuning job

Constructors

Integration_WAndB 

Fields

Instances

Instances details
FromJSON Integration Source # 
Instance details

Defined in OpenAI.V1.FineTuning.Jobs

ToJSON Integration Source # 
Instance details

Defined in OpenAI.V1.FineTuning.Jobs

Generic Integration Source # 
Instance details

Defined in OpenAI.V1.FineTuning.Jobs

Associated Types

type Rep Integration :: Type -> Type #

Show Integration Source # 
Instance details

Defined in OpenAI.V1.FineTuning.Jobs

type Rep Integration Source # 
Instance details

Defined in OpenAI.V1.FineTuning.Jobs

type Rep Integration = D1 ('MetaData "Integration" "OpenAI.V1.FineTuning.Jobs" "openai-1.0.0-DWUl3td9tpcnv1wfBaSVp" 'False) (C1 ('MetaCons "Integration_WAndB" 'PrefixI 'True) (S1 ('MetaSel ('Just "wandb") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 WAndB)))

data Status Source #

The current status of the fine-tuning job

Instances

Instances details
FromJSON Status Source # 
Instance details

Defined in OpenAI.V1.FineTuning.Jobs

Generic Status Source # 
Instance details

Defined in OpenAI.V1.FineTuning.Jobs

Associated Types

type Rep Status :: Type -> Type #

Methods

from :: Status -> Rep Status x #

to :: Rep Status x -> Status #

Show Status Source # 
Instance details

Defined in OpenAI.V1.FineTuning.Jobs

type Rep Status Source # 
Instance details

Defined in OpenAI.V1.FineTuning.Jobs

type Rep Status = D1 ('MetaData "Status" "OpenAI.V1.FineTuning.Jobs" "openai-1.0.0-DWUl3td9tpcnv1wfBaSVp" 'False) ((C1 ('MetaCons "Validating_Files" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "Queued" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Running" 'PrefixI 'False) (U1 :: Type -> Type))) :+: (C1 ('MetaCons "Succeeded" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "Failed" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Cancelled" 'PrefixI 'False) (U1 :: Type -> Type))))

data Level Source #

Log level

Constructors

Info 
Warn 
Error 

Instances

Instances details
FromJSON Level Source # 
Instance details

Defined in OpenAI.V1.FineTuning.Jobs

Generic Level Source # 
Instance details

Defined in OpenAI.V1.FineTuning.Jobs

Associated Types

type Rep Level :: Type -> Type #

Methods

from :: Level -> Rep Level x #

to :: Rep Level x -> Level #

Show Level Source # 
Instance details

Defined in OpenAI.V1.FineTuning.Jobs

Methods

showsPrec :: Int -> Level -> ShowS #

show :: Level -> String #

showList :: [Level] -> ShowS #

type Rep Level Source # 
Instance details

Defined in OpenAI.V1.FineTuning.Jobs

type Rep Level = D1 ('MetaData "Level" "OpenAI.V1.FineTuning.Jobs" "openai-1.0.0-DWUl3td9tpcnv1wfBaSVp" 'False) (C1 ('MetaCons "Info" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "Warn" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Error" 'PrefixI 'False) (U1 :: Type -> Type)))

data Metrics Source #

Metrics at the step number during the fine-tuning job.

Instances

Instances details
FromJSON Metrics Source # 
Instance details

Defined in OpenAI.V1.FineTuning.Jobs

Generic Metrics Source # 
Instance details

Defined in OpenAI.V1.FineTuning.Jobs

Associated Types

type Rep Metrics :: Type -> Type #

Methods

from :: Metrics -> Rep Metrics x #

to :: Rep Metrics x -> Metrics #

Show Metrics Source # 
Instance details

Defined in OpenAI.V1.FineTuning.Jobs

type Rep Metrics Source # 
Instance details

Defined in OpenAI.V1.FineTuning.Jobs

type Rep Metrics = D1 ('MetaData "Metrics" "OpenAI.V1.FineTuning.Jobs" "openai-1.0.0-DWUl3td9tpcnv1wfBaSVp" 'False) (C1 ('MetaCons "Metrics" 'PrefixI 'True) ((S1 ('MetaSel ('Just "step") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Double) :*: (S1 ('MetaSel ('Just "train_loss") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Double) :*: S1 ('MetaSel ('Just "train_mean_token_accuracy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Double))) :*: ((S1 ('MetaSel ('Just "valid_loss") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Double) :*: S1 ('MetaSel ('Just "valid_mean_token_accuracy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Double)) :*: (S1 ('MetaSel ('Just "full_valid_loss") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Double) :*: S1 ('MetaSel ('Just "full_valid_mean_token_accuracy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Double)))))

Servant

type API = "fine_tuning" :> ("jobs" :> ((ReqBody '[JSON] CreateFineTuningJob :> Post '[JSON] JobObject) :<|> ((QueryParam "after" Text :> (QueryParam "limit" Natural :> Get '[JSON] (ListOf JobObject))) :<|> ((Capture "fine_tuning_job_id" FineTuningJobID :> ("events" :> (QueryParam "after" Text :> (QueryParam "limit" Natural :> Get '[JSON] (ListOf EventObject))))) :<|> ((Capture "fine_tuning_job_id" FineTuningJobID :> ("checkpoints" :> (QueryParam "after" Text :> (QueryParam "limit" Natural :> Get '[JSON] (ListOf CheckpointObject))))) :<|> ((Capture "fine_tuning_job_id" FineTuningJobID :> Get '[JSON] JobObject) :<|> (Capture "fine_tuning_job_id" FineTuningJobID :> ("cancel" :> Post '[JSON] JobObject)))))))) Source #

Servant API