Safe Haskell	Safe-Inferred
Language	Haskell2010

OpenAI.V1.Batches

Contents

Main types
Other types
Servant

Description

/v1/batches

Synopsis

newtype BatchID = BatchID {
- text :: Text
}
data CreateBatch = CreateBatch {
- input_file_id :: FileID
- endpoint :: Text
- completion_window :: Text
- metadata :: Maybe (Map Text Text)
}
_CreateBatch :: CreateBatch
data BatchObject = BatchObject {
- id :: BatchID
- object :: Text
- endpoint :: Text
- errors :: Maybe (ListOf Error)
- input_file_id :: FileID
- completion_window :: Text
- status :: Status
- output_file_id :: Maybe FileID
- error_file_id :: Maybe FileID
- created_at :: POSIXTime
- in_progress_at :: Maybe POSIXTime
- expires_at :: Maybe POSIXTime
- finalizing_at :: Maybe POSIXTime
- completed_at :: Maybe POSIXTime
- failed_at :: Maybe POSIXTime
- expired_at :: Maybe POSIXTime
- cancelling_at :: Maybe POSIXTime
- cancelled_at :: Maybe POSIXTime
- request_counts :: Maybe Counts
- metadata :: Maybe (Map Text Text)
}
data Status
- = Validating
- | Failed
- | In_Progress
- | Finalizing
- | Completed
- | Expired
- | Cancelling
- | Cancelled
data Counts = Counts {
- total :: Natural
- completed :: Natural
- failed :: Natural
}
type API = "batches" :> ((ReqBody '[JSON] CreateBatch :> Post '[JSON] BatchObject) :<|> ((Capture "batch_id" BatchID :> Get '[JSON] BatchObject) :<|> ((Capture "batch_id" BatchID :> ("cancel" :> Post '[JSON] BatchObject)) :<|> (QueryParam "after" Text :> (QueryParam "limit" Natural :> Get '[JSON] (ListOf BatchObject))))))

Main types

newtype BatchID Source #

Batch ID

Constructors

BatchID
Fields text :: Text

Instances

Instances details

FromJSON BatchID Source #
Instance details Defined in OpenAI.V1.Batches Methods parseJSON :: Value -> Parser BatchID # parseJSONList :: Value -> Parser [BatchID] # omittedField :: Maybe BatchID #
ToJSON BatchID Source #
Instance details Defined in OpenAI.V1.Batches Methods toJSON :: BatchID -> Value # toEncoding :: BatchID -> Encoding # toJSONList :: [BatchID] -> Value # toEncodingList :: [BatchID] -> Encoding # omitField :: BatchID -> Bool #
IsString BatchID Source #
Instance details Defined in OpenAI.V1.Batches Methods fromString :: String -> BatchID #
Show BatchID Source #
Instance details Defined in OpenAI.V1.Batches Methods showsPrec :: Int -> BatchID -> ShowS # show :: BatchID -> String # showList :: [BatchID] -> ShowS #
ToHttpApiData BatchID Source #
Instance details Defined in OpenAI.V1.Batches Methods toUrlPiece :: BatchID -> Text # toEncodedUrlPiece :: BatchID -> Builder # toHeader :: BatchID -> ByteString # toQueryParam :: BatchID -> Text # toEncodedQueryParam :: BatchID -> Builder #

data CreateBatch Source #

Request body for /v1/batches

Constructors

CreateBatch
Fields input_file_id :: FileID endpoint :: Text completion_window :: Text metadata :: Maybe (Map Text Text)

Instances

Instances details

ToJSON CreateBatch Source #
Instance details Defined in OpenAI.V1.Batches Methods toJSON :: CreateBatch -> Value # toEncoding :: CreateBatch -> Encoding # toJSONList :: [CreateBatch] -> Value # toEncodingList :: [CreateBatch] -> Encoding # omitField :: CreateBatch -> Bool #
Generic CreateBatch Source #
Instance details Defined in OpenAI.V1.Batches Associated Types type Rep CreateBatch :: Type -> Type # Methods from :: CreateBatch -> Rep CreateBatch x # to :: Rep CreateBatch x -> CreateBatch #
Show CreateBatch Source #
Instance details Defined in OpenAI.V1.Batches Methods showsPrec :: Int -> CreateBatch -> ShowS # show :: CreateBatch -> String # showList :: [CreateBatch] -> ShowS #
type Rep CreateBatch Source #
Instance details Defined in OpenAI.V1.Batches type Rep CreateBatch = D1 ('MetaData "CreateBatch" "OpenAI.V1.Batches" "openai-1.0.0-DWUl3td9tpcnv1wfBaSVp" 'False) (C1 ('MetaCons "CreateBatch" 'PrefixI 'True) ((S1 ('MetaSel ('Just "input_file_id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FileID) :: S1 ('MetaSel ('Just "endpoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :: (S1 ('MetaSel ('Just "completion_window") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "metadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Map Text Text))))))

_CreateBatch :: CreateBatch Source #

Default CreateBatch

data BatchObject Source #

The batch object

Constructors

BatchObject

Fields

Instances

Instances details

FromJSON BatchObject Source #
Instance details Defined in OpenAI.V1.Batches Methods parseJSON :: Value -> Parser BatchObject # parseJSONList :: Value -> Parser [BatchObject] # omittedField :: Maybe BatchObject #
Generic BatchObject Source #
Instance details Defined in OpenAI.V1.Batches Associated Types type Rep BatchObject :: Type -> Type # Methods from :: BatchObject -> Rep BatchObject x # to :: Rep BatchObject x -> BatchObject #
Show BatchObject Source #
Instance details Defined in OpenAI.V1.Batches Methods showsPrec :: Int -> BatchObject -> ShowS # show :: BatchObject -> String # showList :: [BatchObject] -> ShowS #
type Rep BatchObject Source #
Instance details Defined in OpenAI.V1.Batches type Rep BatchObject = D1 ('MetaData "BatchObject" "OpenAI.V1.Batches" "openai-1.0.0-DWUl3td9tpcnv1wfBaSVp" 'False) (C1 ('MetaCons "BatchObject" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 BatchID) :: S1 ('MetaSel ('Just "object") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :: (S1 ('MetaSel ('Just "endpoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :: (S1 ('MetaSel ('Just "errors") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (ListOf Error))) :: S1 ('MetaSel ('Just "input_file_id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FileID)))) :: ((S1 ('MetaSel ('Just "completion_window") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Status)) :: (S1 ('MetaSel ('Just "output_file_id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe FileID)) :: (S1 ('MetaSel ('Just "error_file_id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe FileID)) :: S1 ('MetaSel ('Just "created_at") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 POSIXTime))))) :: (((S1 ('MetaSel ('Just "in_progress_at") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe POSIXTime)) :: S1 ('MetaSel ('Just "expires_at") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe POSIXTime))) :: (S1 ('MetaSel ('Just "finalizing_at") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe POSIXTime)) :: (S1 ('MetaSel ('Just "completed_at") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe POSIXTime)) :: S1 ('MetaSel ('Just "failed_at") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe POSIXTime))))) :: ((S1 ('MetaSel ('Just "expired_at") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe POSIXTime)) :: S1 ('MetaSel ('Just "cancelling_at") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe POSIXTime))) :: (S1 ('MetaSel ('Just "cancelled_at") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe POSIXTime)) :: (S1 ('MetaSel ('Just "request_counts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Counts)) :*: S1 ('MetaSel ('Just "metadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Map Text Text)))))))))

Other types

data Status Source #

The current status of the batch.

Constructors

Validating
Failed
In_Progress
Finalizing
Completed
Expired
Cancelling
Cancelled

Instances

Instances details

FromJSON Status Source #
Instance details Defined in OpenAI.V1.Batches Methods parseJSON :: Value -> Parser Status # parseJSONList :: Value -> Parser [Status] # omittedField :: Maybe Status #
Generic Status Source #
Instance details Defined in OpenAI.V1.Batches 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.Batches Methods showsPrec :: Int -> Status -> ShowS # show :: Status -> String # showList :: [Status] -> ShowS #
type Rep Status Source #
Instance details Defined in OpenAI.V1.Batches type Rep Status = D1 ('MetaData "Status" "OpenAI.V1.Batches" "openai-1.0.0-DWUl3td9tpcnv1wfBaSVp" 'False) (((C1 ('MetaCons "Validating" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Failed" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "In_Progress" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Finalizing" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "Completed" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Expired" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "Cancelling" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Cancelled" 'PrefixI 'False) (U1 :: Type -> Type))))

data Counts Source #

The request counts for different statuses within the batch.

Constructors

Counts
Fields total :: Natural completed :: Natural failed :: Natural

Instances

Instances details

FromJSON Counts Source #
Instance details Defined in OpenAI.V1.Batches Methods parseJSON :: Value -> Parser Counts # parseJSONList :: Value -> Parser [Counts] # omittedField :: Maybe Counts #
Generic Counts Source #
Instance details Defined in OpenAI.V1.Batches Associated Types type Rep Counts :: Type -> Type # Methods from :: Counts -> Rep Counts x # to :: Rep Counts x -> Counts #
Show Counts Source #
Instance details Defined in OpenAI.V1.Batches Methods showsPrec :: Int -> Counts -> ShowS # show :: Counts -> String # showList :: [Counts] -> ShowS #
type Rep Counts Source #
Instance details Defined in OpenAI.V1.Batches type Rep Counts = D1 ('MetaData "Counts" "OpenAI.V1.Batches" "openai-1.0.0-DWUl3td9tpcnv1wfBaSVp" 'False) (C1 ('MetaCons "Counts" 'PrefixI 'True) (S1 ('MetaSel ('Just "total") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Natural) :: (S1 ('MetaSel ('Just "completed") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Natural) :: S1 ('MetaSel ('Just "failed") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Natural))))

Servant

type API = "batches" :> ((ReqBody '[JSON] CreateBatch :> Post '[JSON] BatchObject) :<|> ((Capture "batch_id" BatchID :> Get '[JSON] BatchObject) :<|> ((Capture "batch_id" BatchID :> ("cancel" :> Post '[JSON] BatchObject)) :<|> (QueryParam "after" Text :> (QueryParam "limit" Natural :> Get '[JSON] (ListOf BatchObject)))))) Source #

Servant API