openai-2.2.1: Servant bindings to OpenAI
Safe HaskellNone
LanguageHaskell2010

OpenAI.V1.Files

Description

/v1/files
Synopsis

Main types

newtype FileID Source #

File ID

Constructors

FileID 

Fields

Instances

Instances details
FromJSON FileID Source # 
Instance details

Defined in OpenAI.V1.Files

Methods

parseJSON :: Value -> Parser FileID #

parseJSONList :: Value -> Parser [FileID] #

omittedField :: Maybe FileID #

ToJSON FileID Source # 
Instance details

Defined in OpenAI.V1.Files

Methods

toJSON :: FileID -> Value #

toEncoding :: FileID -> Encoding #

toJSONList :: [FileID] -> Value #

toEncodingList :: [FileID] -> Encoding #

omitField :: FileID -> Bool #

IsString FileID Source # 
Instance details

Defined in OpenAI.V1.Files

Methods

fromString :: String -> FileID #

Show FileID Source # 
Instance details

Defined in OpenAI.V1.Files

Methods

showsPrec :: Int -> FileID -> ShowS #

show :: FileID -> String #

showList :: [FileID] -> ShowS #

ToHttpApiData FileID Source # 
Instance details

Defined in OpenAI.V1.Files

Methods

toUrlPiece :: FileID -> Text #

toEncodedUrlPiece :: FileID -> Builder #

toHeader :: FileID -> ByteString #

toQueryParam :: FileID -> Text #

toEncodedQueryParam :: FileID -> Builder #

data UploadFile Source #

UploadFile body

Constructors

UploadFile 

Fields

Instances

Instances details
Generic UploadFile Source # 
Instance details

Defined in OpenAI.V1.Files

Associated Types

type Rep UploadFile 
Instance details

Defined in OpenAI.V1.Files

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

Methods

from :: UploadFile -> Rep UploadFile x #

to :: Rep UploadFile x -> UploadFile #

Show UploadFile Source # 
Instance details

Defined in OpenAI.V1.Files

Methods

showsPrec :: Int -> UploadFile -> ShowS #

show :: UploadFile -> String #

showList :: [UploadFile] -> ShowS #

ToMultipart Tmp UploadFile Source # 
Instance details

Defined in OpenAI.V1.Files

Methods

toMultipart :: UploadFile -> MultipartData Tmp #

type Rep UploadFile Source # 
Instance details

Defined in OpenAI.V1.Files

type Rep UploadFile = D1 ('MetaData "UploadFile" "OpenAI.V1.Files" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" '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 Source #

Default UploadFile

data FileObject Source #

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

Constructors

FileObject 

Fields

Instances

Instances details
FromJSON FileObject Source # 
Instance details

Defined in OpenAI.V1.Files

Methods

parseJSON :: Value -> Parser FileObject #

parseJSONList :: Value -> Parser [FileObject] #

omittedField :: Maybe FileObject #

ToJSON FileObject Source # 
Instance details

Defined in OpenAI.V1.Files

Methods

toJSON :: FileObject -> Value #

toEncoding :: FileObject -> Encoding #

toJSONList :: [FileObject] -> Value #

toEncodingList :: [FileObject] -> Encoding #

omitField :: FileObject -> Bool #

Generic FileObject Source # 
Instance details

Defined in OpenAI.V1.Files

Associated Types

type Rep FileObject 
Instance details

Defined in OpenAI.V1.Files

type Rep FileObject = D1 ('MetaData "FileObject" "OpenAI.V1.Files" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" '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)))))

Methods

from :: FileObject -> Rep FileObject x #

to :: Rep FileObject x -> FileObject #

Show FileObject Source # 
Instance details

Defined in OpenAI.V1.Files

Methods

showsPrec :: Int -> FileObject -> ShowS #

show :: FileObject -> String #

showList :: [FileObject] -> ShowS #

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) #

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 #

type Rep FileObject Source # 
Instance details

Defined in OpenAI.V1.Files

type Rep FileObject = D1 ('MetaData "FileObject" "OpenAI.V1.Files" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" '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 Source #

Sort order by the created_at timestamp of the objects

Constructors

Desc 
Asc 

Instances

Instances details
FromJSON Order Source # 
Instance details

Defined in OpenAI.V1.Order

Methods

parseJSON :: Value -> Parser Order #

parseJSONList :: Value -> Parser [Order] #

omittedField :: Maybe Order #

ToJSON Order Source # 
Instance details

Defined in OpenAI.V1.Order

Methods

toJSON :: Order -> Value #

toEncoding :: Order -> Encoding #

toJSONList :: [Order] -> Value #

toEncodingList :: [Order] -> Encoding #

omitField :: Order -> Bool #

Generic Order Source # 
Instance details

Defined in OpenAI.V1.Order

Associated Types

type Rep Order 
Instance details

Defined in OpenAI.V1.Order

type Rep Order = D1 ('MetaData "Order" "OpenAI.V1.Order" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" 'False) (C1 ('MetaCons "Desc" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Asc" 'PrefixI 'False) (U1 :: Type -> Type))

Methods

from :: Order -> Rep Order x #

to :: Rep Order x -> Order #

Show Order Source # 
Instance details

Defined in OpenAI.V1.Order

Methods

showsPrec :: Int -> Order -> ShowS #

show :: Order -> String #

showList :: [Order] -> ShowS #

ToHttpApiData Order Source # 
Instance details

Defined in OpenAI.V1.Order

Methods

toUrlPiece :: Order -> Text #

toEncodedUrlPiece :: Order -> Builder #

toHeader :: Order -> ByteString #

toQueryParam :: Order -> Text #

toEncodedQueryParam :: Order -> Builder #

type Rep Order Source # 
Instance details

Defined in OpenAI.V1.Order

type Rep Order = D1 ('MetaData "Order" "OpenAI.V1.Order" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" 'False) (C1 ('MetaCons "Desc" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Asc" 'PrefixI 'False) (U1 :: Type -> Type))

data Purpose Source #

The intended purpose of the uploaded file.

Constructors

Assistants 
Assistants_Output 
Batch 
Batch_Output 
Fine_Tune 
Fine_Tune_Results 
Vision 

Instances

Instances details
FromJSON Purpose Source # 
Instance details

Defined in OpenAI.V1.Files

Methods

parseJSON :: Value -> Parser Purpose #

parseJSONList :: Value -> Parser [Purpose] #

omittedField :: Maybe Purpose #

ToJSON Purpose Source # 
Instance details

Defined in OpenAI.V1.Files

Methods

toJSON :: Purpose -> Value #

toEncoding :: Purpose -> Encoding #

toJSONList :: [Purpose] -> Value #

toEncodingList :: [Purpose] -> Encoding #

omitField :: Purpose -> Bool #

Generic Purpose Source # 
Instance details

Defined in OpenAI.V1.Files

Associated Types

type Rep Purpose 
Instance details

Defined in OpenAI.V1.Files

type Rep Purpose = D1 ('MetaData "Purpose" "OpenAI.V1.Files" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" '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))))

Methods

from :: Purpose -> Rep Purpose x #

to :: Rep Purpose x -> Purpose #

Show Purpose Source # 
Instance details

Defined in OpenAI.V1.Files

Methods

showsPrec :: Int -> Purpose -> ShowS #

show :: Purpose -> String #

showList :: [Purpose] -> ShowS #

ToHttpApiData Purpose Source # 
Instance details

Defined in OpenAI.V1.Files

Methods

toUrlPiece :: Purpose -> Text #

toEncodedUrlPiece :: Purpose -> Builder #

toHeader :: Purpose -> ByteString #

toQueryParam :: Purpose -> Text #

toEncodedQueryParam :: Purpose -> Builder #

type Rep Purpose Source # 
Instance details

Defined in OpenAI.V1.Files

type Rep Purpose = D1 ('MetaData "Purpose" "OpenAI.V1.Files" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" '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 Source #

Deletion status

Constructors

DeletionStatus 

Fields

Instances

Instances details
FromJSON DeletionStatus Source # 
Instance details

Defined in OpenAI.V1.DeletionStatus

Methods

parseJSON :: Value -> Parser DeletionStatus #

parseJSONList :: Value -> Parser [DeletionStatus] #

omittedField :: Maybe DeletionStatus #

ToJSON DeletionStatus Source # 
Instance details

Defined in OpenAI.V1.DeletionStatus

Methods

toJSON :: DeletionStatus -> Value #

toEncoding :: DeletionStatus -> Encoding #

toJSONList :: [DeletionStatus] -> Value #

toEncodingList :: [DeletionStatus] -> Encoding #

omitField :: DeletionStatus -> Bool #

Generic DeletionStatus Source # 
Instance details

Defined in OpenAI.V1.DeletionStatus

Associated Types

type Rep DeletionStatus 
Instance details

Defined in OpenAI.V1.DeletionStatus

type Rep DeletionStatus = D1 ('MetaData "DeletionStatus" "OpenAI.V1.DeletionStatus" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" '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))))

Methods

from :: DeletionStatus -> Rep DeletionStatus x #

to :: Rep DeletionStatus x -> DeletionStatus #

Show DeletionStatus Source # 
Instance details

Defined in OpenAI.V1.DeletionStatus

Methods

showsPrec :: Int -> DeletionStatus -> ShowS #

show :: DeletionStatus -> String #

showList :: [DeletionStatus] -> ShowS #

type Rep DeletionStatus Source # 
Instance details

Defined in OpenAI.V1.DeletionStatus

type Rep DeletionStatus = D1 ('MetaData "DeletionStatus" "OpenAI.V1.DeletionStatus" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" '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)))))) Source #

Servant API