OpenAI.V1.Files

/v1/files

Main types

newtype FileID

File ID

Constructors

FileID

Fields

• text :: Text

Instances

FromJSON FileID

Defined in OpenAI.V1.Files

Methods

parseJSON :: Value -> Parser FileID

parseJSONList :: Value -> Parser [FileID]

omittedField :: Maybe FileID

ToJSON FileID

Defined in OpenAI.V1.Files

Methods

toJSON :: FileID -> Value

toEncoding :: FileID -> Encoding

toJSONList :: [FileID] -> Value

toEncodingList :: [FileID] -> Encoding

omitField :: FileID -> Bool

IsString FileID

Defined in OpenAI.V1.Files

Methods

fromString :: String -> FileID

Show FileID

Defined in OpenAI.V1.Files

Methods

showsPrec :: Int -> FileID -> ShowS

show :: FileID -> String

showList :: [FileID] -> ShowS

ToHttpApiData FileID

Defined in OpenAI.V1.Files

Methods

toUrlPiece :: FileID -> Text

toEncodedUrlPiece :: FileID -> Builder

toHeader :: FileID -> ByteString

toQueryParam :: FileID -> Text

toEncodedQueryParam :: FileID -> Builder

data UploadFile

UploadFile body

Constructors

UploadFile

Fields

• file :: FilePath
• purpose :: Purpose

Instances

Generic UploadFile

Defined in OpenAI.V1.Files

Associated Types

type Rep UploadFile :: Type -> Type

Methods

from :: UploadFile -> Rep UploadFile x

to :: Rep UploadFile x -> UploadFile

Show UploadFile

Defined in OpenAI.V1.Files

Methods

showsPrec :: Int -> UploadFile -> ShowS

show :: UploadFile -> String

showList :: [UploadFile] -> ShowS

ToMultipart Tmp UploadFile

Defined in OpenAI.V1.Files

Methods

toMultipart :: UploadFile -> MultipartData Tmp

type Rep UploadFile

Defined in OpenAI.V1.Files

type Rep UploadFile = D1 ('MetaData "UploadFile" "OpenAI.V1.Files" "openai-1.0.0-DWUl3td9tpcnv1wfBaSVp" 'False) (C1 ('MetaCons "UploadFile" 'PrefixI 'True) (S1 ('MetaSel ('Just "file") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FilePath) :*: S1 ('MetaSel ('Just "purpose") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Purpose)))

_UploadFile :: UploadFile

Default UploadFile

data FileObject

The File object represents a document that has been uploaded to OpenAI

Constructors

FileObject

Fields

• id :: FileID
• bytes :: Natural
• created_at :: POSIXTime
• filename :: Text
• object :: Text
• purpose :: Purpose

Instances

FromJSON FileObject

Defined in OpenAI.V1.Files

Methods

parseJSON :: Value -> Parser FileObject

parseJSONList :: Value -> Parser [FileObject]

omittedField :: Maybe FileObject

Generic FileObject

Defined in OpenAI.V1.Files

Associated Types

type Rep FileObject :: Type -> Type

Methods

from :: FileObject -> Rep FileObject x

to :: Rep FileObject x -> FileObject

Show FileObject

Defined in OpenAI.V1.Files

Methods

showsPrec :: Int -> FileObject -> ShowS

show :: FileObject -> String

showList :: [FileObject] -> ShowS

FromJSON (UploadObject FileObject)

Defined in OpenAI.V1.Uploads

Methods

parseJSON :: Value -> Parser (UploadObject FileObject)

parseJSONList :: Value -> Parser [UploadObject FileObject]

omittedField :: Maybe (UploadObject FileObject)

type Rep FileObject

Defined in OpenAI.V1.Files

type Rep FileObject = D1 ('MetaData "FileObject" "OpenAI.V1.Files" "openai-1.0.0-DWUl3td9tpcnv1wfBaSVp" 'False) (C1 ('MetaCons "FileObject" 'PrefixI 'True) ((S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FileID) :*: (S1 ('MetaSel ('Just "bytes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Natural) :*: S1 ('MetaSel ('Just "created_at") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 POSIXTime))) :*: (S1 ('MetaSel ('Just "filename") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: (S1 ('MetaSel ('Just "object") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "purpose") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Purpose)))))

Other types

data Order

Sort order by the created_at timestamp of the objects

Constructors

Desc

Asc

Instances

ToHttpApiData Order

Defined in OpenAI.V1.Order

Methods

toUrlPiece :: Order -> Text

toEncodedUrlPiece :: Order -> Builder

toHeader :: Order -> ByteString

toQueryParam :: Order -> Text

toEncodedQueryParam :: Order -> Builder

data Purpose

The intended purpose of the uploaded file.

Constructors

Assistants

Assistants_Output

Batch

Batch_Output

Fine_Tune

Fine_Tune_Results

Vision

Instances

FromJSON Purpose

Defined in OpenAI.V1.Files

Methods

parseJSON :: Value -> Parser Purpose

parseJSONList :: Value -> Parser [Purpose]

omittedField :: Maybe Purpose

ToJSON Purpose

Defined in OpenAI.V1.Files

Methods

toJSON :: Purpose -> Value

toEncoding :: Purpose -> Encoding

toJSONList :: [Purpose] -> Value

toEncodingList :: [Purpose] -> Encoding

omitField :: Purpose -> Bool

Generic Purpose

Defined in OpenAI.V1.Files

Associated Types

type Rep Purpose :: Type -> Type

Methods

from :: Purpose -> Rep Purpose x

to :: Rep Purpose x -> Purpose

Show Purpose

Defined in OpenAI.V1.Files

Methods

showsPrec :: Int -> Purpose -> ShowS

show :: Purpose -> String

showList :: [Purpose] -> ShowS

ToHttpApiData Purpose

Defined in OpenAI.V1.Files

Methods

toUrlPiece :: Purpose -> Text

toEncodedUrlPiece :: Purpose -> Builder

toHeader :: Purpose -> ByteString

toQueryParam :: Purpose -> Text

toEncodedQueryParam :: Purpose -> Builder

type Rep Purpose

Defined in OpenAI.V1.Files

type Rep Purpose = D1 ('MetaData "Purpose" "OpenAI.V1.Files" "openai-1.0.0-DWUl3td9tpcnv1wfBaSVp" 'False) ((C1 ('MetaCons "Assistants" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "Assistants_Output" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Batch" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "Batch_Output" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Fine_Tune" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "Fine_Tune_Results" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Vision" 'PrefixI 'False) (U1 :: Type -> Type))))

data DeletionStatus

Deletion status

Constructors

DeletionStatus

Fields

• id :: Text
• object :: Text
• deleted :: Bool

Instances

FromJSON DeletionStatus

Defined in OpenAI.V1.DeletionStatus

Methods

parseJSON :: Value -> Parser DeletionStatus

parseJSONList :: Value -> Parser [DeletionStatus]

omittedField :: Maybe DeletionStatus

Generic DeletionStatus

Defined in OpenAI.V1.DeletionStatus

Associated Types

type Rep DeletionStatus :: Type -> Type

Methods

from :: DeletionStatus -> Rep DeletionStatus x

to :: Rep DeletionStatus x -> DeletionStatus

Show DeletionStatus

Defined in OpenAI.V1.DeletionStatus

Methods

showsPrec :: Int -> DeletionStatus -> ShowS

show :: DeletionStatus -> String

showList :: [DeletionStatus] -> ShowS

type Rep DeletionStatus

Defined in OpenAI.V1.DeletionStatus

type Rep DeletionStatus = D1 ('MetaData "DeletionStatus" "OpenAI.V1.DeletionStatus" "openai-1.0.0-DWUl3td9tpcnv1wfBaSVp" 'False) (C1 ('MetaCons "DeletionStatus" 'PrefixI 'True) (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: (S1 ('MetaSel ('Just "object") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "deleted") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool))))

Servant

type API = "files" :> ((MultipartForm Tmp UploadFile :> Post '[JSON] FileObject) :<|> ((QueryParam "purpose" Purpose :> (QueryParam "limit" Natural :> (QueryParam "order" Order :> (QueryParam "after" Text :> Get '[JSON] (ListOf FileObject))))) :<|> ((Capture "file_id" FileID :> Get '[JSON] FileObject) :<|> ((Capture "file_id" FileID :> Delete '[JSON] DeletionStatus) :<|> (Capture "file_id" FileID :> ("content" :> Get '[OctetStream] ByteString))))))

Servant API