OpenAI.V1.Uploads

/v1/uploads

Main types

newtype UploadID

Upload ID

Constructors

UploadID

Fields

• text :: Text

Instances

FromJSON UploadID

Defined in OpenAI.V1.Uploads

Methods

parseJSON :: Value -> Parser UploadID

parseJSONList :: Value -> Parser [UploadID]

omittedField :: Maybe UploadID

ToJSON UploadID

Defined in OpenAI.V1.Uploads

Methods

toJSON :: UploadID -> Value

toEncoding :: UploadID -> Encoding

toJSONList :: [UploadID] -> Value

toEncodingList :: [UploadID] -> Encoding

omitField :: UploadID -> Bool

IsString UploadID

Defined in OpenAI.V1.Uploads

Methods

fromString :: String -> UploadID

Show UploadID

Defined in OpenAI.V1.Uploads

Methods

showsPrec :: Int -> UploadID -> ShowS

show :: UploadID -> String

showList :: [UploadID] -> ShowS

ToHttpApiData UploadID

Defined in OpenAI.V1.Uploads

Methods

toUrlPiece :: UploadID -> Text

toEncodedUrlPiece :: UploadID -> Builder

toHeader :: UploadID -> ByteString

toQueryParam :: UploadID -> Text

toEncodedQueryParam :: UploadID -> Builder

data CreateUpload

Request body for /v1/uploads

Constructors

CreateUpload

Fields

• filename :: Text
• purpose :: Purpose
• bytes :: Natural
• mime_type :: Text

Instances

ToJSON CreateUpload

Defined in OpenAI.V1.Uploads

Methods

toJSON :: CreateUpload -> Value

toEncoding :: CreateUpload -> Encoding

toJSONList :: [CreateUpload] -> Value

toEncodingList :: [CreateUpload] -> Encoding

omitField :: CreateUpload -> Bool

Generic CreateUpload

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

Defined in OpenAI.V1.Uploads

Methods

showsPrec :: Int -> CreateUpload -> ShowS

show :: CreateUpload -> String

showList :: [CreateUpload] -> ShowS

type Rep CreateUpload

Defined in OpenAI.V1.Uploads

type Rep CreateUpload = D1 ('MetaData "CreateUpload" "OpenAI.V1.Uploads" "openai-1.0.0-DWUl3td9tpcnv1wfBaSVp" '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

Default CreateUpload

data AddUploadPart

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

Constructors

AddUploadPart

Fields

• data_ :: FilePath

Instances

ToMultipart Tmp AddUploadPart

Defined in OpenAI.V1.Uploads

Methods

toMultipart :: AddUploadPart -> MultipartData Tmp

_AddUploadPart :: AddUploadPart

Default AddUploadPart

data CompleteUpload

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

Constructors

CompleteUpload

Fields

• part_ids :: Vector Text
• md5 :: Maybe Text

Instances

ToJSON CompleteUpload

Defined in OpenAI.V1.Uploads

Methods

toJSON :: CompleteUpload -> Value

toEncoding :: CompleteUpload -> Encoding

toJSONList :: [CompleteUpload] -> Value

toEncodingList :: [CompleteUpload] -> Encoding

omitField :: CompleteUpload -> Bool

Generic CompleteUpload

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

Defined in OpenAI.V1.Uploads

Methods

showsPrec :: Int -> CompleteUpload -> ShowS

show :: CompleteUpload -> String

showList :: [CompleteUpload] -> ShowS

type Rep CompleteUpload

Defined in OpenAI.V1.Uploads

type Rep CompleteUpload = D1 ('MetaData "CompleteUpload" "OpenAI.V1.Uploads" "openai-1.0.0-DWUl3td9tpcnv1wfBaSVp" '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

Default CompleteUpload

data UploadObject file

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

FromJSON (UploadObject FileObject)

Defined in OpenAI.V1.Uploads

Methods

parseJSON :: Value -> Parser (UploadObject FileObject)

parseJSONList :: Value -> Parser [UploadObject FileObject]

omittedField :: Maybe (UploadObject FileObject)

FromJSON (UploadObject (Maybe Void))

Defined in OpenAI.V1.Uploads

Methods

parseJSON :: Value -> Parser (UploadObject (Maybe Void))

parseJSONList :: Value -> Parser [UploadObject (Maybe Void)]

omittedField :: Maybe (UploadObject (Maybe Void))

Generic (UploadObject file)

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)

Defined in OpenAI.V1.Uploads

Methods

showsPrec :: Int -> UploadObject file -> ShowS

show :: UploadObject file -> String

showList :: [UploadObject file] -> ShowS

type Rep (UploadObject file)

Defined in OpenAI.V1.Uploads

type Rep (UploadObject file) = D1 ('MetaData "UploadObject" "OpenAI.V1.Uploads" "openai-1.0.0-DWUl3td9tpcnv1wfBaSVp" '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

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

FromJSON PartObject

Defined in OpenAI.V1.Uploads

Methods

parseJSON :: Value -> Parser PartObject

parseJSONList :: Value -> Parser [PartObject]

omittedField :: Maybe PartObject

Generic PartObject

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

Defined in OpenAI.V1.Uploads

Methods

showsPrec :: Int -> PartObject -> ShowS

show :: PartObject -> String

showList :: [PartObject] -> ShowS

type Rep PartObject

Defined in OpenAI.V1.Uploads

type Rep PartObject = D1 ('MetaData "PartObject" "OpenAI.V1.Uploads" "openai-1.0.0-DWUl3td9tpcnv1wfBaSVp" '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

The status of the Upload

Constructors

Pending

Completed

Cancelled

Expired

Instances

FromJSON Status

Defined in OpenAI.V1.Uploads

Methods

parseJSON :: Value -> Parser Status

parseJSONList :: Value -> Parser [Status]

omittedField :: Maybe Status

Generic Status

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

Defined in OpenAI.V1.Uploads

Methods

showsPrec :: Int -> Status -> ShowS

show :: Status -> String

showList :: [Status] -> ShowS

type Rep Status

Defined in OpenAI.V1.Uploads

type Rep Status = D1 ('MetaData "Status" "OpenAI.V1.Uploads" "openai-1.0.0-DWUl3td9tpcnv1wfBaSVp" '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)))))))

Servant API