OpenAI.V1.VectorStores.Files

/v1/vector_stores/:vector_store_id/files

Main types

newtype VectorStoreFileID

Vector store file ID

Constructors

VectorStoreFileID

Fields

• text :: Text

Instances

FromJSON VectorStoreFileID

Defined in OpenAI.V1.VectorStores.Files

Methods

parseJSON :: Value -> Parser VectorStoreFileID

parseJSONList :: Value -> Parser [VectorStoreFileID]

omittedField :: Maybe VectorStoreFileID

ToJSON VectorStoreFileID

Defined in OpenAI.V1.VectorStores.Files

Methods

toJSON :: VectorStoreFileID -> Value

toEncoding :: VectorStoreFileID -> Encoding

toJSONList :: [VectorStoreFileID] -> Value

toEncodingList :: [VectorStoreFileID] -> Encoding

omitField :: VectorStoreFileID -> Bool

IsString VectorStoreFileID

Defined in OpenAI.V1.VectorStores.Files

Methods

fromString :: String -> VectorStoreFileID

Show VectorStoreFileID

Defined in OpenAI.V1.VectorStores.Files

Methods

showsPrec :: Int -> VectorStoreFileID -> ShowS

show :: VectorStoreFileID -> String

showList :: [VectorStoreFileID] -> ShowS

ToHttpApiData VectorStoreFileID

Defined in OpenAI.V1.VectorStores.Files

Methods

toUrlPiece :: VectorStoreFileID -> Text

toEncodedUrlPiece :: VectorStoreFileID -> Builder

toHeader :: VectorStoreFileID -> ByteString

toQueryParam :: VectorStoreFileID -> Text

toEncodedQueryParam :: VectorStoreFileID -> Builder

data CreateVectorStoreFile

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

Constructors

CreateVectorStoreFile

Fields

• file_id :: FileID
• chunking_strategy :: Maybe ChunkingStrategy

Instances

ToJSON CreateVectorStoreFile

Defined in OpenAI.V1.VectorStores.Files

Methods

toJSON :: CreateVectorStoreFile -> Value

toEncoding :: CreateVectorStoreFile -> Encoding

toJSONList :: [CreateVectorStoreFile] -> Value

toEncodingList :: [CreateVectorStoreFile] -> Encoding

omitField :: CreateVectorStoreFile -> Bool

Generic CreateVectorStoreFile

Defined in OpenAI.V1.VectorStores.Files

Associated Types

type Rep CreateVectorStoreFile :: Type -> Type

Methods

from :: CreateVectorStoreFile -> Rep CreateVectorStoreFile x

to :: Rep CreateVectorStoreFile x -> CreateVectorStoreFile

Show CreateVectorStoreFile

Defined in OpenAI.V1.VectorStores.Files

Methods

showsPrec :: Int -> CreateVectorStoreFile -> ShowS

show :: CreateVectorStoreFile -> String

showList :: [CreateVectorStoreFile] -> ShowS

type Rep CreateVectorStoreFile

Defined in OpenAI.V1.VectorStores.Files

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

Default CreateVectorStoreFile

data VectorStoreFileObject

A list of files attached to a vector store

Constructors

VectorStoreFileObject

Fields

• id :: VectorStoreFileID
• object :: Text
• usage_bytes :: Natural
• created_at :: POSIXTime
• vector_store_id :: VectorStoreID
• status :: Status
• last_error :: Maybe Error
• chunking_strategy :: ChunkingStrategy

Instances

FromJSON VectorStoreFileObject

Defined in OpenAI.V1.VectorStores.Files

Methods

parseJSON :: Value -> Parser VectorStoreFileObject

parseJSONList :: Value -> Parser [VectorStoreFileObject]

omittedField :: Maybe VectorStoreFileObject

Generic VectorStoreFileObject

Defined in OpenAI.V1.VectorStores.Files

Associated Types

type Rep VectorStoreFileObject :: Type -> Type

Methods

from :: VectorStoreFileObject -> Rep VectorStoreFileObject x

to :: Rep VectorStoreFileObject x -> VectorStoreFileObject

Show VectorStoreFileObject

Defined in OpenAI.V1.VectorStores.Files

Methods

showsPrec :: Int -> VectorStoreFileObject -> ShowS

show :: VectorStoreFileObject -> String

showList :: [VectorStoreFileObject] -> ShowS

type Rep VectorStoreFileObject

Defined in OpenAI.V1.VectorStores.Files

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

Servant API