openai-2.2.1: Servant bindings to OpenAI
Safe HaskellNone
LanguageHaskell2010

OpenAI.V1.VectorStores.Files

Description

/v1/vector_stores/:vector_store_id/files
Synopsis

Main types

newtype VectorStoreFileID Source #

Vector store file ID

Constructors

VectorStoreFileID 

Fields

Instances

Instances details
FromJSON VectorStoreFileID Source # 
Instance details

Defined in OpenAI.V1.VectorStores.Files

Methods

parseJSON :: Value -> Parser VectorStoreFileID #

parseJSONList :: Value -> Parser [VectorStoreFileID] #

omittedField :: Maybe VectorStoreFileID #

ToJSON VectorStoreFileID Source # 
Instance details

Defined in OpenAI.V1.VectorStores.Files

Methods

toJSON :: VectorStoreFileID -> Value #

toEncoding :: VectorStoreFileID -> Encoding #

toJSONList :: [VectorStoreFileID] -> Value #

toEncodingList :: [VectorStoreFileID] -> Encoding #

omitField :: VectorStoreFileID -> Bool #

IsString VectorStoreFileID Source # 
Instance details

Defined in OpenAI.V1.VectorStores.Files

Methods

fromString :: String -> VectorStoreFileID #

Show VectorStoreFileID Source # 
Instance details

Defined in OpenAI.V1.VectorStores.Files

Methods

showsPrec :: Int -> VectorStoreFileID -> ShowS #

show :: VectorStoreFileID -> String #

showList :: [VectorStoreFileID] -> ShowS #

ToHttpApiData VectorStoreFileID Source # 
Instance details

Defined in OpenAI.V1.VectorStores.Files

Methods

toUrlPiece :: VectorStoreFileID -> Text #

toEncodedUrlPiece :: VectorStoreFileID -> Builder #

toHeader :: VectorStoreFileID -> ByteString #

toQueryParam :: VectorStoreFileID -> Text #

toEncodedQueryParam :: VectorStoreFileID -> Builder #

data CreateVectorStoreFile Source #

Request body for /v1/vector_stores/:vector_store_id/files

Constructors

CreateVectorStoreFile 

Fields

Instances

Instances details
FromJSON CreateVectorStoreFile Source # 
Instance details

Defined in OpenAI.V1.VectorStores.Files

Methods

parseJSON :: Value -> Parser CreateVectorStoreFile #

parseJSONList :: Value -> Parser [CreateVectorStoreFile] #

omittedField :: Maybe CreateVectorStoreFile #

ToJSON CreateVectorStoreFile Source # 
Instance details

Defined in OpenAI.V1.VectorStores.Files

Methods

toJSON :: CreateVectorStoreFile -> Value #

toEncoding :: CreateVectorStoreFile -> Encoding #

toJSONList :: [CreateVectorStoreFile] -> Value #

toEncodingList :: [CreateVectorStoreFile] -> Encoding #

omitField :: CreateVectorStoreFile -> Bool #

Generic CreateVectorStoreFile Source # 
Instance details

Defined in OpenAI.V1.VectorStores.Files

Associated Types

type Rep CreateVectorStoreFile 
Instance details

Defined in OpenAI.V1.VectorStores.Files

type Rep CreateVectorStoreFile = D1 ('MetaData "CreateVectorStoreFile" "OpenAI.V1.VectorStores.Files" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" 'False) (C1 ('MetaCons "CreateVectorStoreFile" 'PrefixI 'True) (S1 ('MetaSel ('Just "file_id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FileID) :*: S1 ('MetaSel ('Just "chunking_strategy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ChunkingStrategy))))

Methods

from :: CreateVectorStoreFile -> Rep CreateVectorStoreFile x #

to :: Rep CreateVectorStoreFile x -> CreateVectorStoreFile #

Show CreateVectorStoreFile Source # 
Instance details

Defined in OpenAI.V1.VectorStores.Files

Methods

showsPrec :: Int -> CreateVectorStoreFile -> ShowS #

show :: CreateVectorStoreFile -> String #

showList :: [CreateVectorStoreFile] -> ShowS #

type Rep CreateVectorStoreFile Source # 
Instance details

Defined in OpenAI.V1.VectorStores.Files

type Rep CreateVectorStoreFile = D1 ('MetaData "CreateVectorStoreFile" "OpenAI.V1.VectorStores.Files" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" 'False) (C1 ('MetaCons "CreateVectorStoreFile" 'PrefixI 'True) (S1 ('MetaSel ('Just "file_id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FileID) :*: S1 ('MetaSel ('Just "chunking_strategy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ChunkingStrategy))))

_CreateVectorStoreFile :: CreateVectorStoreFile Source #

Default CreateVectorStoreFile

data VectorStoreFileObject Source #

A list of files attached to a vector store

Constructors

VectorStoreFileObject 

Fields

Instances

Instances details
FromJSON VectorStoreFileObject Source # 
Instance details

Defined in OpenAI.V1.VectorStores.Files

Methods

parseJSON :: Value -> Parser VectorStoreFileObject #

parseJSONList :: Value -> Parser [VectorStoreFileObject] #

omittedField :: Maybe VectorStoreFileObject #

ToJSON VectorStoreFileObject Source # 
Instance details

Defined in OpenAI.V1.VectorStores.Files

Methods

toJSON :: VectorStoreFileObject -> Value #

toEncoding :: VectorStoreFileObject -> Encoding #

toJSONList :: [VectorStoreFileObject] -> Value #

toEncodingList :: [VectorStoreFileObject] -> Encoding #

omitField :: VectorStoreFileObject -> Bool #

Generic VectorStoreFileObject Source # 
Instance details

Defined in OpenAI.V1.VectorStores.Files

Associated Types

type Rep VectorStoreFileObject 
Instance details

Defined in OpenAI.V1.VectorStores.Files

type Rep VectorStoreFileObject = D1 ('MetaData "VectorStoreFileObject" "OpenAI.V1.VectorStores.Files" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" 'False) (C1 ('MetaCons "VectorStoreFileObject" 'PrefixI 'True) (((S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 VectorStoreFileID) :*: S1 ('MetaSel ('Just "object") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "usage_bytes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Natural) :*: S1 ('MetaSel ('Just "created_at") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 POSIXTime))) :*: ((S1 ('MetaSel ('Just "vector_store_id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 VectorStoreID) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Status)) :*: (S1 ('MetaSel ('Just "last_error") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Error)) :*: S1 ('MetaSel ('Just "chunking_strategy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ChunkingStrategy)))))

Methods

from :: VectorStoreFileObject -> Rep VectorStoreFileObject x #

to :: Rep VectorStoreFileObject x -> VectorStoreFileObject #

Show VectorStoreFileObject Source # 
Instance details

Defined in OpenAI.V1.VectorStores.Files

Methods

showsPrec :: Int -> VectorStoreFileObject -> ShowS #

show :: VectorStoreFileObject -> String #

showList :: [VectorStoreFileObject] -> ShowS #

type Rep VectorStoreFileObject Source # 
Instance details

Defined in OpenAI.V1.VectorStores.Files

type Rep VectorStoreFileObject = D1 ('MetaData "VectorStoreFileObject" "OpenAI.V1.VectorStores.Files" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" 'False) (C1 ('MetaCons "VectorStoreFileObject" 'PrefixI 'True) (((S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 VectorStoreFileID) :*: S1 ('MetaSel ('Just "object") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "usage_bytes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Natural) :*: S1 ('MetaSel ('Just "created_at") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 POSIXTime))) :*: ((S1 ('MetaSel ('Just "vector_store_id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 VectorStoreID) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Status)) :*: (S1 ('MetaSel ('Just "last_error") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Error)) :*: S1 ('MetaSel ('Just "chunking_strategy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ChunkingStrategy)))))

Servant

type API = "vector_stores" :> (Header' '[Required, Strict] "OpenAI-Beta" Text :> ((Capture "vector_store_id" VectorStoreID :> ("files" :> (ReqBody '[JSON] CreateVectorStoreFile :> Post '[JSON] VectorStoreFileObject))) :<|> ((Capture "vector_store_id" VectorStoreID :> ("files" :> (QueryParam "limit" Natural :> (QueryParam "order" Order :> (QueryParam "after" Text :> (QueryParam "before" Text :> (QueryParam "filter" Status :> Get '[JSON] (ListOf VectorStoreFileObject)))))))) :<|> ((Capture "vector_store_id" VectorStoreID :> ("files" :> (Capture "file_id" VectorStoreFileID :> Get '[JSON] VectorStoreFileObject))) :<|> (Capture "vector_store_id" VectorStoreID :> ("files" :> (Capture "file_id" VectorStoreFileID :> Delete '[JSON] DeletionStatus))))))) Source #

Servant API