pinecone-1.0.0: Servant bindings to Pinecone
Safe HaskellNone
LanguageHaskell2010

Pinecone.Embed

Description

Embed

Synopsis

Main types

data GenerateVectors Source #

Generate embeddings for inputs

Constructors

GenerateVectors 

Fields

Instances

Instances details
FromJSON GenerateVectors Source # 
Instance details

Defined in Pinecone.Embed

Methods

parseJSON :: Value -> Parser GenerateVectors #

parseJSONList :: Value -> Parser [GenerateVectors] #

omittedField :: Maybe GenerateVectors #

ToJSON GenerateVectors Source # 
Instance details

Defined in Pinecone.Embed

Methods

toJSON :: GenerateVectors -> Value #

toEncoding :: GenerateVectors -> Encoding #

toJSONList :: [GenerateVectors] -> Value #

toEncodingList :: [GenerateVectors] -> Encoding #

omitField :: GenerateVectors -> Bool #

Generic GenerateVectors Source # 
Instance details

Defined in Pinecone.Embed

Associated Types

type Rep GenerateVectors 
Instance details

Defined in Pinecone.Embed

type Rep GenerateVectors = D1 ('MetaData "GenerateVectors" "Pinecone.Embed" "pinecone-1.0.0-FtIUEL1n6VI5sRXEYSiB7n" 'False) (C1 ('MetaCons "GenerateVectors" 'PrefixI 'True) (S1 ('MetaSel ('Just "model") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: (S1 ('MetaSel ('Just "inputs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Vector Text)) :*: S1 ('MetaSel ('Just "parameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map Text Scalar)))))

Methods

from :: GenerateVectors -> Rep GenerateVectors x #

to :: Rep GenerateVectors x -> GenerateVectors #

Show GenerateVectors Source # 
Instance details

Defined in Pinecone.Embed

Methods

showsPrec :: Int -> GenerateVectors -> ShowS #

show :: GenerateVectors -> String #

showList :: [GenerateVectors] -> ShowS #

Eq GenerateVectors Source # 
Instance details

Defined in Pinecone.Embed

Methods

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

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

type Rep GenerateVectors Source # 
Instance details

Defined in Pinecone.Embed

type Rep GenerateVectors = D1 ('MetaData "GenerateVectors" "Pinecone.Embed" "pinecone-1.0.0-FtIUEL1n6VI5sRXEYSiB7n" 'False) (C1 ('MetaCons "GenerateVectors" 'PrefixI 'True) (S1 ('MetaSel ('Just "model") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: (S1 ('MetaSel ('Just "inputs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Vector Text)) :*: S1 ('MetaSel ('Just "parameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map Text Scalar)))))

_GenerateVectors :: GenerateVectors Source #

Default GenerateVectors

data Embeddings Source #

Embeddings generated for the input.

Constructors

Embeddings 

Fields

Instances

Instances details
FromJSON Embeddings Source # 
Instance details

Defined in Pinecone.Embed

Methods

parseJSON :: Value -> Parser Embeddings #

parseJSONList :: Value -> Parser [Embeddings] #

omittedField :: Maybe Embeddings #

ToJSON Embeddings Source # 
Instance details

Defined in Pinecone.Embed

Methods

toJSON :: Embeddings -> Value #

toEncoding :: Embeddings -> Encoding #

toJSONList :: [Embeddings] -> Value #

toEncodingList :: [Embeddings] -> Encoding #

omitField :: Embeddings -> Bool #

Generic Embeddings Source # 
Instance details

Defined in Pinecone.Embed

Associated Types

type Rep Embeddings 
Instance details

Defined in Pinecone.Embed

type Rep Embeddings = D1 ('MetaData "Embeddings" "Pinecone.Embed" "pinecone-1.0.0-FtIUEL1n6VI5sRXEYSiB7n" 'False) (C1 ('MetaCons "Embeddings" 'PrefixI 'True) ((S1 ('MetaSel ('Just "model") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "vector_type") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 VectorType)) :*: (S1 ('MetaSel ('Just "data_") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Vector Embedding)) :*: S1 ('MetaSel ('Just "usage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Usage))))

Methods

from :: Embeddings -> Rep Embeddings x #

to :: Rep Embeddings x -> Embeddings #

Show Embeddings Source # 
Instance details

Defined in Pinecone.Embed

Methods

showsPrec :: Int -> Embeddings -> ShowS #

show :: Embeddings -> String #

showList :: [Embeddings] -> ShowS #

Eq Embeddings Source # 
Instance details

Defined in Pinecone.Embed

Methods

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

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

type Rep Embeddings Source # 
Instance details

Defined in Pinecone.Embed

type Rep Embeddings = D1 ('MetaData "Embeddings" "Pinecone.Embed" "pinecone-1.0.0-FtIUEL1n6VI5sRXEYSiB7n" 'False) (C1 ('MetaCons "Embeddings" 'PrefixI 'True) ((S1 ('MetaSel ('Just "model") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "vector_type") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 VectorType)) :*: (S1 ('MetaSel ('Just "data_") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Vector Embedding)) :*: S1 ('MetaSel ('Just "usage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Usage))))

Other types

data Input Source #

Input to generate embedding for

Constructors

Input 

Fields

Instances

Instances details
FromJSON Input Source # 
Instance details

Defined in Pinecone.Embed

Methods

parseJSON :: Value -> Parser Input #

parseJSONList :: Value -> Parser [Input] #

omittedField :: Maybe Input #

ToJSON Input Source # 
Instance details

Defined in Pinecone.Embed

Methods

toJSON :: Input -> Value #

toEncoding :: Input -> Encoding #

toJSONList :: [Input] -> Value #

toEncodingList :: [Input] -> Encoding #

omitField :: Input -> Bool #

Generic Input Source # 
Instance details

Defined in Pinecone.Embed

Associated Types

type Rep Input 
Instance details

Defined in Pinecone.Embed

type Rep Input = D1 ('MetaData "Input" "Pinecone.Embed" "pinecone-1.0.0-FtIUEL1n6VI5sRXEYSiB7n" 'False) (C1 ('MetaCons "Input" 'PrefixI 'True) (S1 ('MetaSel ('Just "text") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

Methods

from :: Input -> Rep Input x #

to :: Rep Input x -> Input #

Show Input Source # 
Instance details

Defined in Pinecone.Embed

Methods

showsPrec :: Int -> Input -> ShowS #

show :: Input -> String #

showList :: [Input] -> ShowS #

Eq Input Source # 
Instance details

Defined in Pinecone.Embed

Methods

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

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

type Rep Input Source # 
Instance details

Defined in Pinecone.Embed

type Rep Input = D1 ('MetaData "Input" "Pinecone.Embed" "pinecone-1.0.0-FtIUEL1n6VI5sRXEYSiB7n" 'False) (C1 ('MetaCons "Input" 'PrefixI 'True) (S1 ('MetaSel ('Just "text") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

data VectorType Source #

The index vector type

Constructors

Dense 
Sparse 

Instances

Instances details
FromJSON VectorType Source # 
Instance details

Defined in Pinecone.Embed

Methods

parseJSON :: Value -> Parser VectorType #

parseJSONList :: Value -> Parser [VectorType] #

omittedField :: Maybe VectorType #

ToJSON VectorType Source # 
Instance details

Defined in Pinecone.Embed

Methods

toJSON :: VectorType -> Value #

toEncoding :: VectorType -> Encoding #

toJSONList :: [VectorType] -> Value #

toEncodingList :: [VectorType] -> Encoding #

omitField :: VectorType -> Bool #

Generic VectorType Source # 
Instance details

Defined in Pinecone.Embed

Associated Types

type Rep VectorType 
Instance details

Defined in Pinecone.Embed

type Rep VectorType = D1 ('MetaData "VectorType" "Pinecone.Embed" "pinecone-1.0.0-FtIUEL1n6VI5sRXEYSiB7n" 'False) (C1 ('MetaCons "Dense" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Sparse" 'PrefixI 'False) (U1 :: Type -> Type))

Methods

from :: VectorType -> Rep VectorType x #

to :: Rep VectorType x -> VectorType #

Show VectorType Source # 
Instance details

Defined in Pinecone.Embed

Methods

showsPrec :: Int -> VectorType -> ShowS #

show :: VectorType -> String #

showList :: [VectorType] -> ShowS #

Eq VectorType Source # 
Instance details

Defined in Pinecone.Embed

Methods

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

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

type Rep VectorType Source # 
Instance details

Defined in Pinecone.Embed

type Rep VectorType = D1 ('MetaData "VectorType" "Pinecone.Embed" "pinecone-1.0.0-FtIUEL1n6VI5sRXEYSiB7n" 'False) (C1 ('MetaCons "Dense" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Sparse" 'PrefixI 'False) (U1 :: Type -> Type))

data Embedding Source #

An embedding generated for an input

Constructors

EmbeddingDense 

Fields

EmbeddingSparse 

Fields

Instances

Instances details
FromJSON Embedding Source # 
Instance details

Defined in Pinecone.Embed

Methods

parseJSON :: Value -> Parser Embedding #

parseJSONList :: Value -> Parser [Embedding] #

omittedField :: Maybe Embedding #

ToJSON Embedding Source # 
Instance details

Defined in Pinecone.Embed

Methods

toJSON :: Embedding -> Value #

toEncoding :: Embedding -> Encoding #

toJSONList :: [Embedding] -> Value #

toEncodingList :: [Embedding] -> Encoding #

omitField :: Embedding -> Bool #

Generic Embedding Source # 
Instance details

Defined in Pinecone.Embed

Associated Types

type Rep Embedding 
Instance details

Defined in Pinecone.Embed

type Rep Embedding = D1 ('MetaData "Embedding" "Pinecone.Embed" "pinecone-1.0.0-FtIUEL1n6VI5sRXEYSiB7n" 'False) (C1 ('MetaCons "EmbeddingDense" 'PrefixI 'True) (S1 ('MetaSel ('Just "values") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Vector Double))) :+: C1 ('MetaCons "EmbeddingSparse" 'PrefixI 'True) (S1 ('MetaSel ('Just "sparse_values") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Vector Double)) :*: (S1 ('MetaSel ('Just "sparse_indices") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Vector Natural)) :*: S1 ('MetaSel ('Just "sparse_tokens") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Vector Text)))))

Methods

from :: Embedding -> Rep Embedding x #

to :: Rep Embedding x -> Embedding #

Show Embedding Source # 
Instance details

Defined in Pinecone.Embed

Methods

showsPrec :: Int -> Embedding -> ShowS #

show :: Embedding -> String #

showList :: [Embedding] -> ShowS #

Eq Embedding Source # 
Instance details

Defined in Pinecone.Embed

Methods

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

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

type Rep Embedding Source # 
Instance details

Defined in Pinecone.Embed

type Rep Embedding = D1 ('MetaData "Embedding" "Pinecone.Embed" "pinecone-1.0.0-FtIUEL1n6VI5sRXEYSiB7n" 'False) (C1 ('MetaCons "EmbeddingDense" 'PrefixI 'True) (S1 ('MetaSel ('Just "values") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Vector Double))) :+: C1 ('MetaCons "EmbeddingSparse" 'PrefixI 'True) (S1 ('MetaSel ('Just "sparse_values") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Vector Double)) :*: (S1 ('MetaSel ('Just "sparse_indices") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Vector Natural)) :*: S1 ('MetaSel ('Just "sparse_tokens") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Vector Text)))))

data Usage Source #

Usage statistics for the model inference.

Constructors

Usage 

Fields

Instances

Instances details
FromJSON Usage Source # 
Instance details

Defined in Pinecone.Embed

Methods

parseJSON :: Value -> Parser Usage #

parseJSONList :: Value -> Parser [Usage] #

omittedField :: Maybe Usage #

ToJSON Usage Source # 
Instance details

Defined in Pinecone.Embed

Methods

toJSON :: Usage -> Value #

toEncoding :: Usage -> Encoding #

toJSONList :: [Usage] -> Value #

toEncodingList :: [Usage] -> Encoding #

omitField :: Usage -> Bool #

Generic Usage Source # 
Instance details

Defined in Pinecone.Embed

Associated Types

type Rep Usage 
Instance details

Defined in Pinecone.Embed

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

Methods

from :: Usage -> Rep Usage x #

to :: Rep Usage x -> Usage #

Show Usage Source # 
Instance details

Defined in Pinecone.Embed

Methods

showsPrec :: Int -> Usage -> ShowS #

show :: Usage -> String #

showList :: [Usage] -> ShowS #

Eq Usage Source # 
Instance details

Defined in Pinecone.Embed

Methods

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

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

type Rep Usage Source # 
Instance details

Defined in Pinecone.Embed

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

Servant

type API = "embed" :> (ReqBody '[JSON] GenerateVectors :> Post '[JSON] Embeddings) Source #

Servant API