Safe Haskell	Safe-Inferred
Language	Haskell2010

OpenAI.V1.Uploads

Contents

Main types
Other types
Servant

Description

/v1/uploads

Synopsis

newtype UploadID = UploadID {
- text :: Text
}
data CreateUpload = CreateUpload {
- filename :: Text
- purpose :: Purpose
- bytes :: Natural
- mime_type :: Text
}
_CreateUpload :: CreateUpload
data AddUploadPart = AddUploadPart {
- data_ :: FilePath
}
_AddUploadPart :: AddUploadPart
data CompleteUpload = CompleteUpload {
- part_ids :: Vector Text
- md5 :: Maybe Text
}
_CompleteUpload :: CompleteUpload
data UploadObject file = UploadObject {
- id :: UploadID
- created_at :: POSIXTime
- filename :: Text
- bytes :: Natural
- purpose :: Purpose
- status :: Status
- expires_at :: POSIXTime
- object :: Text
- file :: file
}
data PartObject = PartObject {
- id :: Text
- created_at :: POSIXTime
- upload_id :: UploadID
- object :: Text
}
data Status
- = Pending
- | Completed
- | Cancelled
- | Expired
type API = "uploads" :> ((ReqBody '[JSON] CreateUpload :> Post '[JSON] (UploadObject (Maybe Void))) :<|> ((Capture "upload_id" UploadID :> ("parts" :> (MultipartForm Tmp AddUploadPart :> Post '[JSON] PartObject))) :<|> ((Capture "upload_id" UploadID :> ("complete" :> (ReqBody '[JSON] CompleteUpload :> Post '[JSON] (UploadObject FileObject)))) :<|> (Capture "upload_id" UploadID :> ("cancel" :> Post '[JSON] (UploadObject (Maybe Void)))))))

Main types

newtype UploadID Source #

Upload ID

Constructors

UploadID
Fields text :: Text

Instances

Instances details

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

data CreateUpload Source #

Request body for /v1/uploads

Constructors

CreateUpload
Fields filename :: Text purpose :: Purpose bytes :: Natural mime_type :: Text

Instances

Instances details

FromJSON CreateUpload Source #
Instance details Defined in OpenAI.V1.Uploads Methods parseJSON :: Value -> Parser CreateUpload # parseJSONList :: Value -> Parser [CreateUpload] # omittedField :: Maybe CreateUpload #
ToJSON CreateUpload Source #
Instance details Defined in OpenAI.V1.Uploads Methods toJSON :: CreateUpload -> Value # toEncoding :: CreateUpload -> Encoding # toJSONList :: [CreateUpload] -> Value # toEncodingList :: [CreateUpload] -> Encoding # omitField :: CreateUpload -> Bool #
Generic CreateUpload Source #
Instance details Defined in OpenAI.V1.Uploads Associated Types type Rep CreateUpload :: Type -> Type # Methods from :: CreateUpload -> Rep CreateUpload x # to :: Rep CreateUpload x -> CreateUpload #
Show CreateUpload Source #
Instance details Defined in OpenAI.V1.Uploads Methods showsPrec :: Int -> CreateUpload -> ShowS # show :: CreateUpload -> String # showList :: [CreateUpload] -> ShowS #
type Rep CreateUpload Source #
Instance details Defined in OpenAI.V1.Uploads type Rep CreateUpload = D1 ('MetaData "CreateUpload" "OpenAI.V1.Uploads" "openai-1.1.0-EEKZCo0ctK66abGa8yEhZh" 'False) (C1 ('MetaCons "CreateUpload" 'PrefixI 'True) ((S1 ('MetaSel ('Just "filename") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :: S1 ('MetaSel ('Just "purpose") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Purpose)) :: (S1 ('MetaSel ('Just "bytes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Natural) :*: S1 ('MetaSel ('Just "mime_type") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text))))

_CreateUpload :: CreateUpload Source #

Default CreateUpload

data AddUploadPart Source #

Request body for /v1/uploads/:upload_id/parts

Constructors

AddUploadPart
Fields data_ :: FilePath

Instances

Instances details

FromJSON AddUploadPart Source #
Instance details Defined in OpenAI.V1.Uploads Methods parseJSON :: Value -> Parser AddUploadPart # parseJSONList :: Value -> Parser [AddUploadPart] # omittedField :: Maybe AddUploadPart #
ToJSON AddUploadPart Source #
Instance details Defined in OpenAI.V1.Uploads Methods toJSON :: AddUploadPart -> Value # toEncoding :: AddUploadPart -> Encoding # toJSONList :: [AddUploadPart] -> Value # toEncodingList :: [AddUploadPart] -> Encoding # omitField :: AddUploadPart -> Bool #
Generic AddUploadPart Source #
Instance details Defined in OpenAI.V1.Uploads Associated Types type Rep AddUploadPart :: Type -> Type # Methods from :: AddUploadPart -> Rep AddUploadPart x # to :: Rep AddUploadPart x -> AddUploadPart #
Show AddUploadPart Source #
Instance details Defined in OpenAI.V1.Uploads Methods showsPrec :: Int -> AddUploadPart -> ShowS # show :: AddUploadPart -> String # showList :: [AddUploadPart] -> ShowS #
ToMultipart Tmp AddUploadPart Source #
Instance details Defined in OpenAI.V1.Uploads Methods toMultipart :: AddUploadPart -> MultipartData Tmp #
type Rep AddUploadPart Source #
Instance details Defined in OpenAI.V1.Uploads type Rep AddUploadPart = D1 ('MetaData "AddUploadPart" "OpenAI.V1.Uploads" "openai-1.1.0-EEKZCo0ctK66abGa8yEhZh" 'False) (C1 ('MetaCons "AddUploadPart" 'PrefixI 'True) (S1 ('MetaSel ('Just "data_") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FilePath)))

_AddUploadPart :: AddUploadPart Source #

Default AddUploadPart

data CompleteUpload Source #

Request body for /v1/uploads/:upload_id/complete

Constructors

CompleteUpload
Fields part_ids :: Vector Text md5 :: Maybe Text

Instances

Instances details

FromJSON CompleteUpload Source #
Instance details Defined in OpenAI.V1.Uploads Methods parseJSON :: Value -> Parser CompleteUpload # parseJSONList :: Value -> Parser [CompleteUpload] # omittedField :: Maybe CompleteUpload #
ToJSON CompleteUpload Source #
Instance details Defined in OpenAI.V1.Uploads Methods toJSON :: CompleteUpload -> Value # toEncoding :: CompleteUpload -> Encoding # toJSONList :: [CompleteUpload] -> Value # toEncodingList :: [CompleteUpload] -> Encoding # omitField :: CompleteUpload -> Bool #
Generic CompleteUpload Source #
Instance details Defined in OpenAI.V1.Uploads Associated Types type Rep CompleteUpload :: Type -> Type # Methods from :: CompleteUpload -> Rep CompleteUpload x # to :: Rep CompleteUpload x -> CompleteUpload #
Show CompleteUpload Source #
Instance details Defined in OpenAI.V1.Uploads Methods showsPrec :: Int -> CompleteUpload -> ShowS # show :: CompleteUpload -> String # showList :: [CompleteUpload] -> ShowS #
type Rep CompleteUpload Source #
Instance details Defined in OpenAI.V1.Uploads type Rep CompleteUpload = D1 ('MetaData "CompleteUpload" "OpenAI.V1.Uploads" "openai-1.1.0-EEKZCo0ctK66abGa8yEhZh" 'False) (C1 ('MetaCons "CompleteUpload" 'PrefixI 'True) (S1 ('MetaSel ('Just "part_ids") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Vector Text)) :*: S1 ('MetaSel ('Just "md5") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))))

_CompleteUpload :: CompleteUpload Source #

Default CompleteUpload

data UploadObject file Source #

The Upload object can accept byte chunks in the form of Parts.

Constructors

UploadObject
Fields id :: UploadID created_at :: POSIXTime filename :: Text bytes :: Natural purpose :: Purpose status :: Status expires_at :: POSIXTime object :: Text file :: file

Instances

Instances details

FromJSON (UploadObject FileObject) Source #
Instance details Defined in OpenAI.V1.Uploads Methods parseJSON :: Value -> Parser (UploadObject FileObject) # parseJSONList :: Value -> Parser [UploadObject FileObject] # omittedField :: Maybe (UploadObject FileObject) #
FromJSON (UploadObject (Maybe Void)) Source #
Instance details Defined in OpenAI.V1.Uploads Methods parseJSON :: Value -> Parser (UploadObject (Maybe Void)) # parseJSONList :: Value -> Parser [UploadObject (Maybe Void)] # omittedField :: Maybe (UploadObject (Maybe Void)) #
ToJSON (UploadObject FileObject) Source #
Instance details Defined in OpenAI.V1.Uploads Methods toJSON :: UploadObject FileObject -> Value # toEncoding :: UploadObject FileObject -> Encoding # toJSONList :: [UploadObject FileObject] -> Value # toEncodingList :: [UploadObject FileObject] -> Encoding # omitField :: UploadObject FileObject -> Bool #
ToJSON (UploadObject (Maybe Void)) Source #
Instance details Defined in OpenAI.V1.Uploads Methods toJSON :: UploadObject (Maybe Void) -> Value # toEncoding :: UploadObject (Maybe Void) -> Encoding # toJSONList :: [UploadObject (Maybe Void)] -> Value # toEncodingList :: [UploadObject (Maybe Void)] -> Encoding # omitField :: UploadObject (Maybe Void) -> Bool #
Generic (UploadObject file) Source #
Instance details Defined in OpenAI.V1.Uploads Associated Types type Rep (UploadObject file) :: Type -> Type # Methods from :: UploadObject file -> Rep (UploadObject file) x # to :: Rep (UploadObject file) x -> UploadObject file #
Show file => Show (UploadObject file) Source #
Instance details Defined in OpenAI.V1.Uploads Methods showsPrec :: Int -> UploadObject file -> ShowS # show :: UploadObject file -> String # showList :: [UploadObject file] -> ShowS #
type Rep (UploadObject file) Source #
Instance details Defined in OpenAI.V1.Uploads type Rep (UploadObject file) = D1 ('MetaData "UploadObject" "OpenAI.V1.Uploads" "openai-1.1.0-EEKZCo0ctK66abGa8yEhZh" 'False) (C1 ('MetaCons "UploadObject" 'PrefixI 'True) (((S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UploadID) :: S1 ('MetaSel ('Just "created_at") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 POSIXTime)) :: (S1 ('MetaSel ('Just "filename") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :: S1 ('MetaSel ('Just "bytes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Natural))) :: ((S1 ('MetaSel ('Just "purpose") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Purpose) :: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Status)) :: (S1 ('MetaSel ('Just "expires_at") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 POSIXTime) :: (S1 ('MetaSel ('Just "object") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :: S1 ('MetaSel ('Just "file") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 file))))))

data PartObject Source #

The upload part represents a chunk of bytes we can add to an upload object

Constructors

PartObject
Fields id :: Text created_at :: POSIXTime upload_id :: UploadID object :: Text

Instances

Instances details

FromJSON PartObject Source #
Instance details Defined in OpenAI.V1.Uploads Methods parseJSON :: Value -> Parser PartObject # parseJSONList :: Value -> Parser [PartObject] # omittedField :: Maybe PartObject #
ToJSON PartObject Source #
Instance details Defined in OpenAI.V1.Uploads Methods toJSON :: PartObject -> Value # toEncoding :: PartObject -> Encoding # toJSONList :: [PartObject] -> Value # toEncodingList :: [PartObject] -> Encoding # omitField :: PartObject -> Bool #
Generic PartObject Source #
Instance details Defined in OpenAI.V1.Uploads Associated Types type Rep PartObject :: Type -> Type # Methods from :: PartObject -> Rep PartObject x # to :: Rep PartObject x -> PartObject #
Show PartObject Source #
Instance details Defined in OpenAI.V1.Uploads Methods showsPrec :: Int -> PartObject -> ShowS # show :: PartObject -> String # showList :: [PartObject] -> ShowS #
type Rep PartObject Source #
Instance details Defined in OpenAI.V1.Uploads type Rep PartObject = D1 ('MetaData "PartObject" "OpenAI.V1.Uploads" "openai-1.1.0-EEKZCo0ctK66abGa8yEhZh" 'False) (C1 ('MetaCons "PartObject" 'PrefixI 'True) ((S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :: S1 ('MetaSel ('Just "created_at") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 POSIXTime)) :: (S1 ('MetaSel ('Just "upload_id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UploadID) :*: S1 ('MetaSel ('Just "object") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text))))

Other types

data Status Source #

The status of the Upload

Constructors

Pending
Completed
Cancelled
Expired

Instances

Instances details

FromJSON Status Source #
Instance details Defined in OpenAI.V1.Uploads Methods parseJSON :: Value -> Parser Status # parseJSONList :: Value -> Parser [Status] # omittedField :: Maybe Status #
ToJSON Status Source #
Instance details Defined in OpenAI.V1.Uploads Methods toJSON :: Status -> Value # toEncoding :: Status -> Encoding # toJSONList :: [Status] -> Value # toEncodingList :: [Status] -> Encoding # omitField :: Status -> Bool #
Generic Status Source #
Instance details Defined in OpenAI.V1.Uploads 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.Uploads Methods showsPrec :: Int -> Status -> ShowS # show :: Status -> String # showList :: [Status] -> ShowS #
type Rep Status Source #
Instance details Defined in OpenAI.V1.Uploads type Rep Status = D1 ('MetaData "Status" "OpenAI.V1.Uploads" "openai-1.1.0-EEKZCo0ctK66abGa8yEhZh" 'False) ((C1 ('MetaCons "Pending" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Completed" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "Cancelled" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Expired" 'PrefixI 'False) (U1 :: Type -> Type)))

Servant

type API = "uploads" :> ((ReqBody '[JSON] CreateUpload :> Post '[JSON] (UploadObject (Maybe Void))) :<|> ((Capture "upload_id" UploadID :> ("parts" :> (MultipartForm Tmp AddUploadPart :> Post '[JSON] PartObject))) :<|> ((Capture "upload_id" UploadID :> ("complete" :> (ReqBody '[JSON] CompleteUpload :> Post '[JSON] (UploadObject FileObject)))) :<|> (Capture "upload_id" UploadID :> ("cancel" :> Post '[JSON] (UploadObject (Maybe Void))))))) Source #

Servant API