pinecone-1.0.0: Servant bindings to Pinecone
Safe HaskellSafe-Inferred
LanguageHaskell2010

Pinecone.Vectors

Description

Vectors

Synopsis

Main types

newtype Namespace Source #

The namespace of a record

Constructors

Namespace 

Fields

data UpsertVectors Source #

Request body for /vectors/upsert

Constructors

UpsertVectors 

Instances

Instances details
FromJSON UpsertVectors Source # 
Instance details

Defined in Pinecone.Vectors

ToJSON UpsertVectors Source # 
Instance details

Defined in Pinecone.Vectors

Generic UpsertVectors Source # 
Instance details

Defined in Pinecone.Vectors

Associated Types

type Rep UpsertVectors :: Type -> Type #

Show UpsertVectors Source # 
Instance details

Defined in Pinecone.Vectors

Eq UpsertVectors Source # 
Instance details

Defined in Pinecone.Vectors

type Rep UpsertVectors Source # 
Instance details

Defined in Pinecone.Vectors

type Rep UpsertVectors = D1 ('MetaData "UpsertVectors" "Pinecone.Vectors" "pinecone-1.0.0-Ex4c0YruToKASgnObHGBW7" 'False) (C1 ('MetaCons "UpsertVectors" 'PrefixI 'True) (S1 ('MetaSel ('Just "vectors") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Vector VectorObject)) :*: S1 ('MetaSel ('Just "namespace") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Namespace))))

data UpsertStats Source #

Response body for /vectors/upsert

Constructors

UpsertStats 

Instances

Instances details
FromJSON UpsertStats Source # 
Instance details

Defined in Pinecone.Vectors

ToJSON UpsertStats Source # 
Instance details

Defined in Pinecone.Vectors

Generic UpsertStats Source # 
Instance details

Defined in Pinecone.Vectors

Associated Types

type Rep UpsertStats :: Type -> Type #

Show UpsertStats Source # 
Instance details

Defined in Pinecone.Vectors

Eq UpsertStats Source # 
Instance details

Defined in Pinecone.Vectors

type Rep UpsertStats Source # 
Instance details

Defined in Pinecone.Vectors

type Rep UpsertStats = D1 ('MetaData "UpsertStats" "Pinecone.Vectors" "pinecone-1.0.0-Ex4c0YruToKASgnObHGBW7" 'False) (C1 ('MetaCons "UpsertStats" 'PrefixI 'True) (S1 ('MetaSel ('Just "upsertedCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Natural)))

data Vectors Source #

Response body for /vectors/fetch

Instances

Instances details
FromJSON Vectors Source # 
Instance details

Defined in Pinecone.Vectors

ToJSON Vectors Source # 
Instance details

Defined in Pinecone.Vectors

Generic Vectors Source # 
Instance details

Defined in Pinecone.Vectors

Associated Types

type Rep Vectors :: Type -> Type #

Methods

from :: Vectors -> Rep Vectors x #

to :: Rep Vectors x -> Vectors #

Show Vectors Source # 
Instance details

Defined in Pinecone.Vectors

Eq Vectors Source # 
Instance details

Defined in Pinecone.Vectors

Methods

(==) :: Vectors -> Vectors -> Bool #

(/=) :: Vectors -> Vectors -> Bool #

type Rep Vectors Source # 
Instance details

Defined in Pinecone.Vectors

type Rep Vectors = D1 ('MetaData "Vectors" "Pinecone.Vectors" "pinecone-1.0.0-Ex4c0YruToKASgnObHGBW7" '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

Instances

Instances details
FromJSON UpdateVector Source # 
Instance details

Defined in Pinecone.Vectors

ToJSON UpdateVector Source # 
Instance details

Defined in Pinecone.Vectors

Generic UpdateVector Source # 
Instance details

Defined in Pinecone.Vectors

Associated Types

type Rep UpdateVector :: Type -> Type #

Show UpdateVector Source # 
Instance details

Defined in Pinecone.Vectors

Eq UpdateVector Source # 
Instance details

Defined in Pinecone.Vectors

type Rep UpdateVector Source # 
Instance details

Defined in Pinecone.Vectors

data DeleteVectors Source #

Request body for /vectors/delete

Constructors

DeleteVectors 

Instances

Instances details
FromJSON DeleteVectors Source # 
Instance details

Defined in Pinecone.Vectors

ToJSON DeleteVectors Source # 
Instance details

Defined in Pinecone.Vectors

Generic DeleteVectors Source # 
Instance details

Defined in Pinecone.Vectors

Associated Types

type Rep DeleteVectors :: Type -> Type #

Show DeleteVectors Source # 
Instance details

Defined in Pinecone.Vectors

Eq DeleteVectors Source # 
Instance details

Defined in Pinecone.Vectors

type Rep DeleteVectors Source # 
Instance details

Defined in Pinecone.Vectors

type Rep DeleteVectors = D1 ('MetaData "DeleteVectors" "Pinecone.Vectors" "pinecone-1.0.0-Ex4c0YruToKASgnObHGBW7" '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)))))

data VectorIDs Source #

Response body for /vectors/list

Constructors

VectorIDs 

Instances

Instances details
FromJSON VectorIDs Source # 
Instance details

Defined in Pinecone.Vectors

Generic VectorIDs Source # 
Instance details

Defined in Pinecone.Vectors

Associated Types

type Rep VectorIDs :: Type -> Type #

Show VectorIDs Source # 
Instance details

Defined in Pinecone.Vectors

Eq VectorIDs Source # 
Instance details

Defined in Pinecone.Vectors

type Rep VectorIDs Source # 
Instance details

Defined in Pinecone.Vectors

type Rep VectorIDs = D1 ('MetaData "VectorIDs" "Pinecone.Vectors" "pinecone-1.0.0-Ex4c0YruToKASgnObHGBW7" '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))))

data Record Source #

Record to upsert

Constructors

Record 

Fields

Instances

Instances details
FromJSON Record Source # 
Instance details

Defined in Pinecone.Vectors

ToJSON Record Source # 
Instance details

Defined in Pinecone.Vectors

Generic Record Source # 
Instance details

Defined in Pinecone.Vectors

Associated Types

type Rep Record :: Type -> Type #

Methods

from :: Record -> Rep Record x #

to :: Rep Record x -> Record #

Show Record Source # 
Instance details

Defined in Pinecone.Vectors

Eq Record Source # 
Instance details

Defined in Pinecone.Vectors

Methods

(==) :: Record -> Record -> Bool #

(/=) :: Record -> Record -> Bool #

type Rep Record Source # 
Instance details

Defined in Pinecone.Vectors

type Rep Record = D1 ('MetaData "Record" "Pinecone.Vectors" "pinecone-1.0.0-Ex4c0YruToKASgnObHGBW7" '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

Instances details
FromJSON VectorObject Source # 
Instance details

Defined in Pinecone.Vectors

ToJSON VectorObject Source # 
Instance details

Defined in Pinecone.Vectors

Generic VectorObject Source # 
Instance details

Defined in Pinecone.Vectors

Associated Types

type Rep VectorObject :: Type -> Type #

Show VectorObject Source # 
Instance details

Defined in Pinecone.Vectors

Eq VectorObject Source # 
Instance details

Defined in Pinecone.Vectors

type Rep VectorObject Source # 
Instance details

Defined in Pinecone.Vectors

type Rep VectorObject = D1 ('MetaData "VectorObject" "Pinecone.Vectors" "pinecone-1.0.0-Ex4c0YruToKASgnObHGBW7" '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 

Fields

Instances

Instances details
FromJSON SparseValues Source # 
Instance details

Defined in Pinecone.Vectors

ToJSON SparseValues Source # 
Instance details

Defined in Pinecone.Vectors

Generic SparseValues Source # 
Instance details

Defined in Pinecone.Vectors

Associated Types

type Rep SparseValues :: Type -> Type #

Show SparseValues Source # 
Instance details

Defined in Pinecone.Vectors

Eq SparseValues Source # 
Instance details

Defined in Pinecone.Vectors

type Rep SparseValues Source # 
Instance details

Defined in Pinecone.Vectors

type Rep SparseValues = D1 ('MetaData "SparseValues" "Pinecone.Vectors" "pinecone-1.0.0-Ex4c0YruToKASgnObHGBW7" '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))))

data Usage Source #

Usage

Constructors

Usage 

Fields

Instances

Instances details
FromJSON Usage Source # 
Instance details

Defined in Pinecone.Vectors

ToJSON Usage Source # 
Instance details

Defined in Pinecone.Vectors

Generic Usage Source # 
Instance details

Defined in Pinecone.Vectors

Associated Types

type Rep Usage :: Type -> Type #

Methods

from :: Usage -> Rep Usage x #

to :: Rep Usage x -> Usage #

Show Usage Source # 
Instance details

Defined in Pinecone.Vectors

Methods

showsPrec :: Int -> Usage -> ShowS #

show :: Usage -> String #

showList :: [Usage] -> ShowS #

Eq Usage Source # 
Instance details

Defined in Pinecone.Vectors

Methods

(==) :: Usage -> Usage -> Bool #

(/=) :: Usage -> Usage -> Bool #

type Rep Usage Source # 
Instance details

Defined in Pinecone.Vectors

type Rep Usage = D1 ('MetaData "Usage" "Pinecone.Vectors" "pinecone-1.0.0-Ex4c0YruToKASgnObHGBW7" 'False) (C1 ('MetaCons "Usage" 'PrefixI 'True) (S1 ('MetaSel ('Just "readUnits") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Natural)))

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