Safe Haskell	None
Language	Haskell2010

OpenAI.V1.VectorStores

Contents

Main types
Other types
Servant

Description

/v1/vector_stores

Synopsis

newtype VectorStoreID = VectorStoreID {
- text :: Text
}
data CreateVectorStore = CreateVectorStore {
- file_ids :: Vector FileID
- name :: Maybe Text
- expires_after :: Maybe ExpiresAfter
- chunking_strategy :: Maybe (AutoOr ChunkingStrategy)
- metadata :: Maybe (Map Text Text)
}
_CreateVectorStore :: CreateVectorStore
data ModifyVectorStore = ModifyVectorStore {
- name :: Maybe Text
- expires_after :: Maybe ExpiresAfter
- metadata :: Maybe (Map Text Text)
}
_ModifyVectorStore :: ModifyVectorStore
data VectorStoreObject = VectorStoreObject {
- 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
}
data ExpiresAfter = ExpiresAfter {
- anchor :: Text
- days :: Natural
}
data Status
- = Expired
- | In_Progress
- | Completed
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))))))

Main types

newtype VectorStoreID Source #

Vector store ID

Constructors

VectorStoreID
Fields text :: Text

Instances

Instances details

FromJSON VectorStoreID Source #
Instance details Defined in OpenAI.V1.VectorStores Methods parseJSON :: Value -> Parser VectorStoreID # parseJSONList :: Value -> Parser [VectorStoreID] # omittedField :: Maybe VectorStoreID #
ToJSON VectorStoreID Source #
Instance details Defined in OpenAI.V1.VectorStores Methods toJSON :: VectorStoreID -> Value # toEncoding :: VectorStoreID -> Encoding # toJSONList :: [VectorStoreID] -> Value # toEncodingList :: [VectorStoreID] -> Encoding # omitField :: VectorStoreID -> Bool #
IsString VectorStoreID Source #
Instance details Defined in OpenAI.V1.VectorStores Methods fromString :: String -> VectorStoreID #
Show VectorStoreID Source #
Instance details Defined in OpenAI.V1.VectorStores Methods showsPrec :: Int -> VectorStoreID -> ShowS # show :: VectorStoreID -> String # showList :: [VectorStoreID] -> ShowS #
ToHttpApiData VectorStoreID Source #
Instance details Defined in OpenAI.V1.VectorStores Methods toUrlPiece :: VectorStoreID -> Text # toEncodedUrlPiece :: VectorStoreID -> Builder # toHeader :: VectorStoreID -> ByteString # toQueryParam :: VectorStoreID -> Text # toEncodedQueryParam :: VectorStoreID -> Builder #

data CreateVectorStore Source #

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

Instances details

FromJSON CreateVectorStore Source #

Instance details

Defined in OpenAI.V1.VectorStores

Methods

parseJSON :: Value -> Parser CreateVectorStore #

parseJSONList :: Value -> Parser [CreateVectorStore] #

omittedField :: Maybe CreateVectorStore #

ToJSON CreateVectorStore Source #

Instance details

Defined in OpenAI.V1.VectorStores

Methods

toJSON :: CreateVectorStore -> Value #

toEncoding :: CreateVectorStore -> Encoding #

toJSONList :: [CreateVectorStore] -> Value #

toEncodingList :: [CreateVectorStore] -> Encoding #

omitField :: CreateVectorStore -> Bool #

Generic CreateVectorStore Source #

Instance details

Defined in OpenAI.V1.VectorStores

Associated Types

type Rep CreateVectorStore

Instance details

Defined in OpenAI.V1.VectorStores

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

Methods

from :: CreateVectorStore -> Rep CreateVectorStore x #

to :: Rep CreateVectorStore x -> CreateVectorStore #

Show CreateVectorStore Source #

Instance details

Defined in OpenAI.V1.VectorStores

Methods

showsPrec :: Int -> CreateVectorStore -> ShowS #

show :: CreateVectorStore -> String #

showList :: [CreateVectorStore] -> ShowS #

type Rep CreateVectorStore Source #

Instance details

Defined in OpenAI.V1.VectorStores

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

Default CreateVectorStore

data ModifyVectorStore Source #

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

Instances details

FromJSON ModifyVectorStore Source #

Instance details

Defined in OpenAI.V1.VectorStores

Methods

parseJSON :: Value -> Parser ModifyVectorStore #

parseJSONList :: Value -> Parser [ModifyVectorStore] #

omittedField :: Maybe ModifyVectorStore #

ToJSON ModifyVectorStore Source #

Instance details

Defined in OpenAI.V1.VectorStores

Methods

toJSON :: ModifyVectorStore -> Value #

toEncoding :: ModifyVectorStore -> Encoding #

toJSONList :: [ModifyVectorStore] -> Value #

toEncodingList :: [ModifyVectorStore] -> Encoding #

omitField :: ModifyVectorStore -> Bool #

Generic ModifyVectorStore Source #

Instance details

Defined in OpenAI.V1.VectorStores

Associated Types

type Rep ModifyVectorStore

Instance details

Defined in OpenAI.V1.VectorStores

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

Methods

from :: ModifyVectorStore -> Rep ModifyVectorStore x #

to :: Rep ModifyVectorStore x -> ModifyVectorStore #

Show ModifyVectorStore Source #

Instance details

Defined in OpenAI.V1.VectorStores

Methods

showsPrec :: Int -> ModifyVectorStore -> ShowS #

show :: ModifyVectorStore -> String #

showList :: [ModifyVectorStore] -> ShowS #

type Rep ModifyVectorStore Source #

Instance details

Defined in OpenAI.V1.VectorStores

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

Default ModifyVectorStore

data VectorStoreObject Source #

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

Instances details

FromJSON VectorStoreObject Source #

Instance details

Defined in OpenAI.V1.VectorStores

Methods

parseJSON :: Value -> Parser VectorStoreObject #

parseJSONList :: Value -> Parser [VectorStoreObject] #

omittedField :: Maybe VectorStoreObject #

ToJSON VectorStoreObject Source #

Instance details

Defined in OpenAI.V1.VectorStores

Methods

toJSON :: VectorStoreObject -> Value #

toEncoding :: VectorStoreObject -> Encoding #

toJSONList :: [VectorStoreObject] -> Value #

toEncodingList :: [VectorStoreObject] -> Encoding #

omitField :: VectorStoreObject -> Bool #

Generic VectorStoreObject Source #

Instance details

Defined in OpenAI.V1.VectorStores

Associated Types

type Rep VectorStoreObject

Instance details

Defined in OpenAI.V1.VectorStores

Methods

from :: VectorStoreObject -> Rep VectorStoreObject x #

to :: Rep VectorStoreObject x -> VectorStoreObject #

Show VectorStoreObject Source #

Instance details

Defined in OpenAI.V1.VectorStores

Methods

showsPrec :: Int -> VectorStoreObject -> ShowS #

show :: VectorStoreObject -> String #

showList :: [VectorStoreObject] -> ShowS #

type Rep VectorStoreObject Source #

Instance details

Defined in OpenAI.V1.VectorStores

Other types

data ExpiresAfter Source #

The expiration policy for a vector store.

Constructors

ExpiresAfter
Fields anchor :: Text days :: Natural

Instances

Instances details

FromJSON ExpiresAfter Source #

Instance details

Defined in OpenAI.V1.VectorStores

Methods

parseJSON :: Value -> Parser ExpiresAfter #

parseJSONList :: Value -> Parser [ExpiresAfter] #

omittedField :: Maybe ExpiresAfter #

ToJSON ExpiresAfter Source #

Instance details

Defined in OpenAI.V1.VectorStores

Methods

toJSON :: ExpiresAfter -> Value #

toEncoding :: ExpiresAfter -> Encoding #

toJSONList :: [ExpiresAfter] -> Value #

toEncodingList :: [ExpiresAfter] -> Encoding #

omitField :: ExpiresAfter -> Bool #

Generic ExpiresAfter Source #

Instance details

Defined in OpenAI.V1.VectorStores

Associated Types

type Rep ExpiresAfter

Instance details

Defined in OpenAI.V1.VectorStores

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

Methods

from :: ExpiresAfter -> Rep ExpiresAfter x #

to :: Rep ExpiresAfter x -> ExpiresAfter #

Show ExpiresAfter Source #

Instance details

Defined in OpenAI.V1.VectorStores

Methods

showsPrec :: Int -> ExpiresAfter -> ShowS #

show :: ExpiresAfter -> String #

showList :: [ExpiresAfter] -> ShowS #

type Rep ExpiresAfter Source #

Instance details

Defined in OpenAI.V1.VectorStores

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

The status of the vector store

Constructors

Expired
In_Progress
Completed

Instances

Instances details

FromJSON Status Source #

Instance details

Defined in OpenAI.V1.VectorStores

Methods

parseJSON :: Value -> Parser Status #

parseJSONList :: Value -> Parser [Status] #

omittedField :: Maybe Status #

ToJSON Status Source #

Instance details

Defined in OpenAI.V1.VectorStores

Methods

toJSON :: Status -> Value #

toEncoding :: Status -> Encoding #

toJSONList :: [Status] -> Value #

toEncodingList :: [Status] -> Encoding #

omitField :: Status -> Bool #

Generic Status Source #

Instance details

Defined in OpenAI.V1.VectorStores

Associated Types

type Rep Status
Instance details Defined in OpenAI.V1.VectorStores type Rep Status = D1 ('MetaData "Status" "OpenAI.V1.VectorStores" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" '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)))

Methods

from :: Status -> Rep Status x #

to :: Rep Status x -> Status #

Show Status Source #

Instance details

Defined in OpenAI.V1.VectorStores

Methods

showsPrec :: Int -> Status -> ShowS #

show :: Status -> String #

showList :: [Status] -> ShowS #

type Rep Status Source #

Instance details

Defined in OpenAI.V1.VectorStores

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

Servant API