| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
Pinecone.Vectors
Contents
Description
Vectors
Synopsis
- newtype Namespace = Namespace {}
- data UpsertVectors = UpsertVectors {
- vectors :: Vector VectorObject
- namespace :: Maybe Namespace
- _UpsertVectors :: UpsertVectors
- data UpsertStats = UpsertStats {}
- data Vectors = Vectors {}
- data UpdateVector = UpdateVector {}
- _UpdateVector :: UpdateVector
- data DeleteVectors = DeleteVectors {}
- _DeleteVectors :: DeleteVectors
- data VectorIDs = VectorIDs {
- vectors :: Vector Text
- pagination :: Maybe Pagination
- namespace :: Namespace
- usage :: Usage
- data Record = Record {}
- _Record :: Record
- data VectorObject = VectorObject {}
- data SparseValues = SparseValues {}
- data Usage = Usage {}
- type API = ("vectors" :> (("upsert" :> (ReqBody '[JSON] UpsertVectors :> Post '[JSON] UpsertStats)) :<|> (("fetch" :> (QueryParams "ids" Text :> (QueryParam "namespace" Namespace :> Get '[JSON] Vectors))) :<|> (("update" :> (ReqBody '[JSON] UpdateVector :> Post '[JSON] NoContent)) :<|> (("delete" :> (ReqBody '[JSON] DeleteVectors :> Post '[JSON] NoContent)) :<|> ("list" :> (QueryParam "prefix" Text :> (QueryParam "limit" Natural :> (QueryParam "paginationToken" Text :> (QueryParam "namespace" Namespace :> Get '[JSON] VectorIDs)))))))))) :<|> ("records" :> ("namespaces" :> (Capture "namespace" Namespace :> ("upsert" :> (ReqBody '[JSON] Record :> PostCreated '[JSON] NoContent)))))
Main types
The namespace of a record
Instances
| FromJSON Namespace Source # | |
Defined in Pinecone.Vectors | |
| ToJSON Namespace Source # | |
| IsString Namespace Source # | |
Defined in Pinecone.Vectors Methods fromString :: String -> Namespace # | |
| Show Namespace Source # | |
| Eq Namespace Source # | |
| ToHttpApiData Namespace Source # | |
Defined in Pinecone.Vectors Methods toUrlPiece :: Namespace -> Text # toEncodedUrlPiece :: Namespace -> Builder # toHeader :: Namespace -> ByteString # toQueryParam :: Namespace -> Text # toEncodedQueryParam :: Namespace -> Builder # | |
data UpsertVectors Source #
Request body for /vectors/upsert
Constructors
| UpsertVectors | |
Fields
| |
Instances
_UpsertVectors :: UpsertVectors Source #
Default UpsertVectors
data UpsertStats Source #
Response body for /vectors/upsert
Constructors
| UpsertStats | |
Fields | |
Instances
| FromJSON UpsertStats Source # | |||||
Defined in Pinecone.Vectors | |||||
| ToJSON UpsertStats Source # | |||||
Defined in Pinecone.Vectors Methods toJSON :: UpsertStats -> Value # toEncoding :: UpsertStats -> Encoding # toJSONList :: [UpsertStats] -> Value # toEncodingList :: [UpsertStats] -> Encoding # omitField :: UpsertStats -> Bool # | |||||
| Generic UpsertStats Source # | |||||
Defined in Pinecone.Vectors Associated Types
| |||||
| Show UpsertStats Source # | |||||
Defined in Pinecone.Vectors Methods showsPrec :: Int -> UpsertStats -> ShowS # show :: UpsertStats -> String # showList :: [UpsertStats] -> ShowS # | |||||
| Eq UpsertStats Source # | |||||
Defined in Pinecone.Vectors | |||||
| type Rep UpsertStats Source # | |||||
Defined in Pinecone.Vectors type Rep UpsertStats = D1 ('MetaData "UpsertStats" "Pinecone.Vectors" "pinecone-1.0.0-FtIUEL1n6VI5sRXEYSiB7n" 'False) (C1 ('MetaCons "UpsertStats" 'PrefixI 'True) (S1 ('MetaSel ('Just "upsertedCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Natural))) | |||||
Response body for /vectors/fetch
Constructors
| Vectors | |
Instances
| FromJSON Vectors Source # | |||||
Defined in Pinecone.Vectors | |||||
| ToJSON Vectors Source # | |||||
| Generic Vectors Source # | |||||
Defined in Pinecone.Vectors Associated Types
| |||||
| Show Vectors Source # | |||||
| Eq Vectors Source # | |||||
| type Rep Vectors Source # | |||||
Defined in Pinecone.Vectors type Rep Vectors = D1 ('MetaData "Vectors" "Pinecone.Vectors" "pinecone-1.0.0-FtIUEL1n6VI5sRXEYSiB7n" 'False) (C1 ('MetaCons "Vectors" 'PrefixI 'True) (S1 ('MetaSel ('Just "vectors") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map Text VectorObject)) :*: (S1 ('MetaSel ('Just "namespace") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Namespace) :*: S1 ('MetaSel ('Just "usage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Usage))))) | |||||
data UpdateVector Source #
Request body for /vectors/update
Constructors
| UpdateVector | |
Instances
| FromJSON UpdateVector Source # | |||||
Defined in Pinecone.Vectors | |||||
| ToJSON UpdateVector Source # | |||||
Defined in Pinecone.Vectors Methods toJSON :: UpdateVector -> Value # toEncoding :: UpdateVector -> Encoding # toJSONList :: [UpdateVector] -> Value # toEncodingList :: [UpdateVector] -> Encoding # omitField :: UpdateVector -> Bool # | |||||
| Generic UpdateVector Source # | |||||
Defined in Pinecone.Vectors Associated Types
| |||||
| Show UpdateVector Source # | |||||
Defined in Pinecone.Vectors Methods showsPrec :: Int -> UpdateVector -> ShowS # show :: UpdateVector -> String # showList :: [UpdateVector] -> ShowS # | |||||
| Eq UpdateVector Source # | |||||
Defined in Pinecone.Vectors | |||||
| type Rep UpdateVector Source # | |||||
Defined in Pinecone.Vectors type Rep UpdateVector = D1 ('MetaData "UpdateVector" "Pinecone.Vectors" "pinecone-1.0.0-FtIUEL1n6VI5sRXEYSiB7n" 'False) (C1 ('MetaCons "UpdateVector" 'PrefixI 'True) ((S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "values") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Vector Double)))) :*: (S1 ('MetaSel ('Just "sparseValues") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe SparseValues)) :*: (S1 ('MetaSel ('Just "setMetadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Map Text Scalar))) :*: S1 ('MetaSel ('Just "namespace") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Namespace)))))) | |||||
_UpdateVector :: UpdateVector Source #
Default UpdateVector
data DeleteVectors Source #
Request body for /vectors/delete
Constructors
| DeleteVectors | |
Instances
| FromJSON DeleteVectors Source # | |||||
Defined in Pinecone.Vectors Methods parseJSON :: Value -> Parser DeleteVectors # parseJSONList :: Value -> Parser [DeleteVectors] # | |||||
| ToJSON DeleteVectors Source # | |||||
Defined in Pinecone.Vectors Methods toJSON :: DeleteVectors -> Value # toEncoding :: DeleteVectors -> Encoding # toJSONList :: [DeleteVectors] -> Value # toEncodingList :: [DeleteVectors] -> Encoding # omitField :: DeleteVectors -> Bool # | |||||
| Generic DeleteVectors Source # | |||||
Defined in Pinecone.Vectors Associated Types
| |||||
| Show DeleteVectors Source # | |||||
Defined in Pinecone.Vectors Methods showsPrec :: Int -> DeleteVectors -> ShowS # show :: DeleteVectors -> String # showList :: [DeleteVectors] -> ShowS # | |||||
| Eq DeleteVectors Source # | |||||
Defined in Pinecone.Vectors Methods (==) :: DeleteVectors -> DeleteVectors -> Bool # (/=) :: DeleteVectors -> DeleteVectors -> Bool # | |||||
| type Rep DeleteVectors Source # | |||||
Defined in Pinecone.Vectors type Rep DeleteVectors = D1 ('MetaData "DeleteVectors" "Pinecone.Vectors" "pinecone-1.0.0-FtIUEL1n6VI5sRXEYSiB7n" 'False) (C1 ('MetaCons "DeleteVectors" 'PrefixI 'True) ((S1 ('MetaSel ('Just "ids") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Vector Text))) :*: S1 ('MetaSel ('Just "deleteAll") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "namespace") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Namespace)) :*: S1 ('MetaSel ('Just "filter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Filter))))) | |||||
_DeleteVectors :: DeleteVectors Source #
Default DeleteVectors
Response body for /vectors/list
Constructors
| VectorIDs | |
Fields
| |
Instances
| FromJSON VectorIDs Source # | |||||
Defined in Pinecone.Vectors | |||||
| Generic VectorIDs Source # | |||||
Defined in Pinecone.Vectors Associated Types
| |||||
| Show VectorIDs Source # | |||||
| Eq VectorIDs Source # | |||||
| type Rep VectorIDs Source # | |||||
Defined in Pinecone.Vectors type Rep VectorIDs = D1 ('MetaData "VectorIDs" "Pinecone.Vectors" "pinecone-1.0.0-FtIUEL1n6VI5sRXEYSiB7n" 'False) (C1 ('MetaCons "VectorIDs" 'PrefixI 'True) ((S1 ('MetaSel ('Just "vectors") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Vector Text)) :*: S1 ('MetaSel ('Just "pagination") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Pagination))) :*: (S1 ('MetaSel ('Just "namespace") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Namespace) :*: S1 ('MetaSel ('Just "usage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Usage)))) | |||||
Record to upsert
Instances
| FromJSON Record Source # | |||||
Defined in Pinecone.Vectors | |||||
| ToJSON Record Source # | |||||
| Generic Record Source # | |||||
Defined in Pinecone.Vectors Associated Types
| |||||
| Show Record Source # | |||||
| Eq Record Source # | |||||
| type Rep Record Source # | |||||
Defined in Pinecone.Vectors type Rep Record = D1 ('MetaData "Record" "Pinecone.Vectors" "pinecone-1.0.0-FtIUEL1n6VI5sRXEYSiB7n" 'False) (C1 ('MetaCons "Record" 'PrefixI 'True) (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: (S1 ('MetaSel ('Just "text") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "metadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Map Text Scalar)))))) | |||||
Other types
data VectorObject Source #
A vector
Constructors
| VectorObject | |
Instances
| FromJSON VectorObject Source # | |||||
Defined in Pinecone.Vectors | |||||
| ToJSON VectorObject Source # | |||||
Defined in Pinecone.Vectors Methods toJSON :: VectorObject -> Value # toEncoding :: VectorObject -> Encoding # toJSONList :: [VectorObject] -> Value # toEncodingList :: [VectorObject] -> Encoding # omitField :: VectorObject -> Bool # | |||||
| Generic VectorObject Source # | |||||
Defined in Pinecone.Vectors Associated Types
| |||||
| Show VectorObject Source # | |||||
Defined in Pinecone.Vectors Methods showsPrec :: Int -> VectorObject -> ShowS # show :: VectorObject -> String # showList :: [VectorObject] -> ShowS # | |||||
| Eq VectorObject Source # | |||||
Defined in Pinecone.Vectors | |||||
| type Rep VectorObject Source # | |||||
Defined in Pinecone.Vectors type Rep VectorObject = D1 ('MetaData "VectorObject" "Pinecone.Vectors" "pinecone-1.0.0-FtIUEL1n6VI5sRXEYSiB7n" 'False) (C1 ('MetaCons "VectorObject" 'PrefixI 'True) ((S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "values") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Vector Double)))) :*: (S1 ('MetaSel ('Just "sparseValues") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe SparseValues)) :*: S1 ('MetaSel ('Just "metadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Map Text Scalar)))))) | |||||
data SparseValues Source #
Vector sparse data
Constructors
| SparseValues | |
Instances
| FromJSON SparseValues Source # | |||||
Defined in Pinecone.Vectors | |||||
| ToJSON SparseValues Source # | |||||
Defined in Pinecone.Vectors Methods toJSON :: SparseValues -> Value # toEncoding :: SparseValues -> Encoding # toJSONList :: [SparseValues] -> Value # toEncodingList :: [SparseValues] -> Encoding # omitField :: SparseValues -> Bool # | |||||
| Generic SparseValues Source # | |||||
Defined in Pinecone.Vectors Associated Types
| |||||
| Show SparseValues Source # | |||||
Defined in Pinecone.Vectors Methods showsPrec :: Int -> SparseValues -> ShowS # show :: SparseValues -> String # showList :: [SparseValues] -> ShowS # | |||||
| Eq SparseValues Source # | |||||
Defined in Pinecone.Vectors | |||||
| type Rep SparseValues Source # | |||||
Defined in Pinecone.Vectors type Rep SparseValues = D1 ('MetaData "SparseValues" "Pinecone.Vectors" "pinecone-1.0.0-FtIUEL1n6VI5sRXEYSiB7n" 'False) (C1 ('MetaCons "SparseValues" 'PrefixI 'True) (S1 ('MetaSel ('Just "indices") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Vector Natural)) :*: S1 ('MetaSel ('Just "values") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Vector Double)))) | |||||
Usage
Servant
type API = ("vectors" :> (("upsert" :> (ReqBody '[JSON] UpsertVectors :> Post '[JSON] UpsertStats)) :<|> (("fetch" :> (QueryParams "ids" Text :> (QueryParam "namespace" Namespace :> Get '[JSON] Vectors))) :<|> (("update" :> (ReqBody '[JSON] UpdateVector :> Post '[JSON] NoContent)) :<|> (("delete" :> (ReqBody '[JSON] DeleteVectors :> Post '[JSON] NoContent)) :<|> ("list" :> (QueryParam "prefix" Text :> (QueryParam "limit" Natural :> (QueryParam "paginationToken" Text :> (QueryParam "namespace" Namespace :> Get '[JSON] VectorIDs)))))))))) :<|> ("records" :> ("namespaces" :> (Capture "namespace" Namespace :> ("upsert" :> (ReqBody '[JSON] Record :> PostCreated '[JSON] NoContent))))) Source #
Servant API