OpenAI.V1.VectorStores

/v1/vector_stores

Main types

newtype VectorStoreID

Vector store ID

Constructors

VectorStoreID

Fields

• text :: Text

Instances

FromJSON VectorStoreID

Defined in OpenAI.V1.VectorStores

Methods

parseJSON :: Value -> Parser VectorStoreID

parseJSONList :: Value -> Parser [VectorStoreID]

omittedField :: Maybe VectorStoreID

ToJSON VectorStoreID

Defined in OpenAI.V1.VectorStores

Methods

toJSON :: VectorStoreID -> Value

toEncoding :: VectorStoreID -> Encoding

toJSONList :: [VectorStoreID] -> Value

toEncodingList :: [VectorStoreID] -> Encoding

omitField :: VectorStoreID -> Bool

IsString VectorStoreID

Defined in OpenAI.V1.VectorStores

Methods

fromString :: String -> VectorStoreID

Show VectorStoreID

Defined in OpenAI.V1.VectorStores

Methods

showsPrec :: Int -> VectorStoreID -> ShowS

show :: VectorStoreID -> String

showList :: [VectorStoreID] -> ShowS

ToHttpApiData VectorStoreID

Defined in OpenAI.V1.VectorStores

Methods

toUrlPiece :: VectorStoreID -> Text

toEncodedUrlPiece :: VectorStoreID -> Builder

toHeader :: VectorStoreID -> ByteString

toQueryParam :: VectorStoreID -> Text

toEncodedQueryParam :: VectorStoreID -> Builder

data CreateVectorStore

Request body for /v1/vector_stores

Constructors

CreateVectorStore

Fields

• file_ids :: Vector FileID
• name :: Maybe Text
• expires_after :: Maybe ExpiresAfter
• chunking_strategy :: Maybe (AutoOr ChunkingStrategy)
• metadata :: Maybe (Map Text Text)

Instances

ToJSON CreateVectorStore

Defined in OpenAI.V1.VectorStores

Methods

toJSON :: CreateVectorStore -> Value

toEncoding :: CreateVectorStore -> Encoding

toJSONList :: [CreateVectorStore] -> Value

toEncodingList :: [CreateVectorStore] -> Encoding

omitField :: CreateVectorStore -> Bool

Generic CreateVectorStore

Defined in OpenAI.V1.VectorStores

Associated Types

type Rep CreateVectorStore :: Type -> Type

Methods

from :: CreateVectorStore -> Rep CreateVectorStore x

to :: Rep CreateVectorStore x -> CreateVectorStore

Show CreateVectorStore

Defined in OpenAI.V1.VectorStores

Methods

showsPrec :: Int -> CreateVectorStore -> ShowS

show :: CreateVectorStore -> String

showList :: [CreateVectorStore] -> ShowS

type Rep CreateVectorStore

Defined in OpenAI.V1.VectorStores

type Rep CreateVectorStore = D1 ('MetaData "CreateVectorStore" "OpenAI.V1.VectorStores" "openai-1.0.0-DWUl3td9tpcnv1wfBaSVp" 'False) (C1 ('MetaCons "CreateVectorStore" 'PrefixI 'True) ((S1 ('MetaSel ('Just "file_ids") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Vector FileID)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "expires_after") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ExpiresAfter)) :*: (S1 ('MetaSel ('Just "chunking_strategy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (AutoOr ChunkingStrategy))) :*: S1 ('MetaSel ('Just "metadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Map Text Text)))))))

_CreateVectorStore :: CreateVectorStore

Default CreateVectorStore

data ModifyVectorStore

Request body for /v1/vector_stores/:vector_store_id

Constructors

ModifyVectorStore

Fields

• name :: Maybe Text
• expires_after :: Maybe ExpiresAfter
• metadata :: Maybe (Map Text Text)

Instances

ToJSON ModifyVectorStore

Defined in OpenAI.V1.VectorStores

Methods

toJSON :: ModifyVectorStore -> Value

toEncoding :: ModifyVectorStore -> Encoding

toJSONList :: [ModifyVectorStore] -> Value

toEncodingList :: [ModifyVectorStore] -> Encoding

omitField :: ModifyVectorStore -> Bool

Generic ModifyVectorStore

Defined in OpenAI.V1.VectorStores

Associated Types

type Rep ModifyVectorStore :: Type -> Type

Methods

from :: ModifyVectorStore -> Rep ModifyVectorStore x

to :: Rep ModifyVectorStore x -> ModifyVectorStore

Show ModifyVectorStore

Defined in OpenAI.V1.VectorStores

Methods

showsPrec :: Int -> ModifyVectorStore -> ShowS

show :: ModifyVectorStore -> String

showList :: [ModifyVectorStore] -> ShowS

type Rep ModifyVectorStore

Defined in OpenAI.V1.VectorStores

type Rep ModifyVectorStore = D1 ('MetaData "ModifyVectorStore" "OpenAI.V1.VectorStores" "openai-1.0.0-DWUl3td9tpcnv1wfBaSVp" 'False) (C1 ('MetaCons "ModifyVectorStore" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "expires_after") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ExpiresAfter)) :*: S1 ('MetaSel ('Just "metadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Map Text Text))))))

_ModifyVectorStore :: ModifyVectorStore

Default ModifyVectorStore

data VectorStoreObject

A vector store is a collection of processed files can be used by the file_search tool.

Constructors

VectorStoreObject

Fields

• id :: VectorStoreID
• object :: Text
• created_at :: POSIXTime
• name :: Maybe Text
• usage_bytes :: Natural
• file_counts :: FileCounts
• status :: Status
• expires_after :: Maybe ExpiresAfter
• expires_at :: Maybe POSIXTime
• last_active_at :: Maybe POSIXTime
• metadata :: Map Text Text

Instances

FromJSON VectorStoreObject

Defined in OpenAI.V1.VectorStores

Methods

parseJSON :: Value -> Parser VectorStoreObject

parseJSONList :: Value -> Parser [VectorStoreObject]

omittedField :: Maybe VectorStoreObject

Generic VectorStoreObject

Defined in OpenAI.V1.VectorStores

Associated Types

type Rep VectorStoreObject :: Type -> Type

Methods

from :: VectorStoreObject -> Rep VectorStoreObject x

to :: Rep VectorStoreObject x -> VectorStoreObject

Show VectorStoreObject

Defined in OpenAI.V1.VectorStores

Methods

showsPrec :: Int -> VectorStoreObject -> ShowS

show :: VectorStoreObject -> String

showList :: [VectorStoreObject] -> ShowS

type Rep VectorStoreObject

Defined in OpenAI.V1.VectorStores

type Rep VectorStoreObject = D1 ('MetaData "VectorStoreObject" "OpenAI.V1.VectorStores" "openai-1.0.0-DWUl3td9tpcnv1wfBaSVp" 'False) (C1 ('MetaCons "VectorStoreObject" 'PrefixI 'True) (((S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 VectorStoreID) :*: S1 ('MetaSel ('Just "object") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "created_at") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 POSIXTime) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "usage_bytes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Natural)))) :*: ((S1 ('MetaSel ('Just "file_counts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FileCounts) :*: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Status) :*: S1 ('MetaSel ('Just "expires_after") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ExpiresAfter)))) :*: (S1 ('MetaSel ('Just "expires_at") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe POSIXTime)) :*: (S1 ('MetaSel ('Just "last_active_at") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe POSIXTime)) :*: S1 ('MetaSel ('Just "metadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map Text Text)))))))

Other types

data ExpiresAfter

The expiration policy for a vector store.

Constructors

ExpiresAfter

Fields

• anchor :: Text
• days :: Natural

Instances

FromJSON ExpiresAfter

Defined in OpenAI.V1.VectorStores

Methods

parseJSON :: Value -> Parser ExpiresAfter

parseJSONList :: Value -> Parser [ExpiresAfter]

omittedField :: Maybe ExpiresAfter

ToJSON ExpiresAfter

Defined in OpenAI.V1.VectorStores

Methods

toJSON :: ExpiresAfter -> Value

toEncoding :: ExpiresAfter -> Encoding

toJSONList :: [ExpiresAfter] -> Value

toEncodingList :: [ExpiresAfter] -> Encoding

omitField :: ExpiresAfter -> Bool

Generic ExpiresAfter

Defined in OpenAI.V1.VectorStores

Associated Types

type Rep ExpiresAfter :: Type -> Type

Methods

from :: ExpiresAfter -> Rep ExpiresAfter x

to :: Rep ExpiresAfter x -> ExpiresAfter

Show ExpiresAfter

Defined in OpenAI.V1.VectorStores

Methods

showsPrec :: Int -> ExpiresAfter -> ShowS

show :: ExpiresAfter -> String

showList :: [ExpiresAfter] -> ShowS

type Rep ExpiresAfter

Defined in OpenAI.V1.VectorStores

type Rep ExpiresAfter = D1 ('MetaData "ExpiresAfter" "OpenAI.V1.VectorStores" "openai-1.0.0-DWUl3td9tpcnv1wfBaSVp" 'False) (C1 ('MetaCons "ExpiresAfter" 'PrefixI 'True) (S1 ('MetaSel ('Just "anchor") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "days") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Natural)))

data Status

The status of the vector store

Constructors

Expired

In_Progress

Completed

Instances

FromJSON Status

Defined in OpenAI.V1.VectorStores

Methods

parseJSON :: Value -> Parser Status

parseJSONList :: Value -> Parser [Status]

omittedField :: Maybe Status

Generic Status

Defined in OpenAI.V1.VectorStores

Associated Types

type Rep Status :: Type -> Type

Methods

from :: Status -> Rep Status x

to :: Rep Status x -> Status

Show Status

Defined in OpenAI.V1.VectorStores

Methods

showsPrec :: Int -> Status -> ShowS

show :: Status -> String

showList :: [Status] -> ShowS

type Rep Status

Defined in OpenAI.V1.VectorStores

type Rep Status = D1 ('MetaData "Status" "OpenAI.V1.VectorStores" "openai-1.0.0-DWUl3td9tpcnv1wfBaSVp" 'False) (C1 ('MetaCons "Expired" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "In_Progress" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Completed" 'PrefixI 'False) (U1 :: Type -> Type)))

Servant

type API = "vector_stores" :> (Header' '[Required, Strict] "OpenAI-Beta" Text :> ((ReqBody '[JSON] CreateVectorStore :> Post '[JSON] VectorStoreObject) :<|> ((QueryParam "limit" Natural :> (QueryParam "order" Order :> (QueryParam "after" Text :> (QueryParam "before" Text :> Get '[JSON] (ListOf VectorStoreObject))))) :<|> ((Capture "vector_store_id" VectorStoreID :> Get '[JSON] VectorStoreObject) :<|> ((Capture "vector_store_id" VectorStoreID :> (ReqBody '[JSON] ModifyVectorStore :> Post '[JSON] VectorStoreObject)) :<|> (Capture "vector_store_id" VectorStoreID :> Delete '[JSON] DeletionStatus))))))

Servant API