pinecone-1.0.0: Servant bindings to Pinecone
Safe HaskellNone
LanguageHaskell2010

Pinecone.Search

Description

Search

Synopsis

Main types

data SearchWithVector Source #

Request body for /query

Constructors

SearchWithVector 

Fields

Instances

Instances details
FromJSON SearchWithVector Source # 
Instance details

Defined in Pinecone.Search

Methods

parseJSON :: Value -> Parser SearchWithVector #

parseJSONList :: Value -> Parser [SearchWithVector] #

omittedField :: Maybe SearchWithVector #

ToJSON SearchWithVector Source # 
Instance details

Defined in Pinecone.Search

Methods

toJSON :: SearchWithVector -> Value #

toEncoding :: SearchWithVector -> Encoding #

toJSONList :: [SearchWithVector] -> Value #

toEncodingList :: [SearchWithVector] -> Encoding #

omitField :: SearchWithVector -> Bool #

Generic SearchWithVector Source # 
Instance details

Defined in Pinecone.Search

Associated Types

type Rep SearchWithVector 
Instance details

Defined in Pinecone.Search

type Rep SearchWithVector = D1 ('MetaData "SearchWithVector" "Pinecone.Search" "pinecone-1.0.0-FtIUEL1n6VI5sRXEYSiB7n" 'False) (C1 ('MetaCons "SearchWithVector" 'PrefixI 'True) (((S1 ('MetaSel ('Just "topK") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Natural) :*: S1 ('MetaSel ('Just "namespace") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Namespace))) :*: (S1 ('MetaSel ('Just "filter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Filter)) :*: S1 ('MetaSel ('Just "includeValues") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)))) :*: ((S1 ('MetaSel ('Just "includeMetadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "vector") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Vector Double)))) :*: (S1 ('MetaSel ('Just "sparseVector") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe SparseValues)) :*: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))))))

Methods

from :: SearchWithVector -> Rep SearchWithVector x #

to :: Rep SearchWithVector x -> SearchWithVector #

Show SearchWithVector Source # 
Instance details

Defined in Pinecone.Search

Methods

showsPrec :: Int -> SearchWithVector -> ShowS #

show :: SearchWithVector -> String #

showList :: [SearchWithVector] -> ShowS #

Eq SearchWithVector Source # 
Instance details

Defined in Pinecone.Search

Methods

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

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

type Rep SearchWithVector Source # 
Instance details

Defined in Pinecone.Search

type Rep SearchWithVector = D1 ('MetaData "SearchWithVector" "Pinecone.Search" "pinecone-1.0.0-FtIUEL1n6VI5sRXEYSiB7n" 'False) (C1 ('MetaCons "SearchWithVector" 'PrefixI 'True) (((S1 ('MetaSel ('Just "topK") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Natural) :*: S1 ('MetaSel ('Just "namespace") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Namespace))) :*: (S1 ('MetaSel ('Just "filter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Filter)) :*: S1 ('MetaSel ('Just "includeValues") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)))) :*: ((S1 ('MetaSel ('Just "includeMetadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "vector") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Vector Double)))) :*: (S1 ('MetaSel ('Just "sparseVector") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe SparseValues)) :*: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))))))

_SearchWithVector :: SearchWithVector Source #

Default SearchWithVector

data Matches Source #

Response body for /query

Constructors

Matches 

Fields

Instances

Instances details
FromJSON Matches Source # 
Instance details

Defined in Pinecone.Search

Methods

parseJSON :: Value -> Parser Matches #

parseJSONList :: Value -> Parser [Matches] #

omittedField :: Maybe Matches #

ToJSON Matches Source # 
Instance details

Defined in Pinecone.Search

Methods

toJSON :: Matches -> Value #

toEncoding :: Matches -> Encoding #

toJSONList :: [Matches] -> Value #

toEncodingList :: [Matches] -> Encoding #

omitField :: Matches -> Bool #

Generic Matches Source # 
Instance details

Defined in Pinecone.Search

Associated Types

type Rep Matches 
Instance details

Defined in Pinecone.Search

type Rep Matches = D1 ('MetaData "Matches" "Pinecone.Search" "pinecone-1.0.0-FtIUEL1n6VI5sRXEYSiB7n" 'False) (C1 ('MetaCons "Matches" 'PrefixI 'True) (S1 ('MetaSel ('Just "matches") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Vector Match)) :*: (S1 ('MetaSel ('Just "namespace") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Namespace) :*: S1 ('MetaSel ('Just "usage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Usage))))

Methods

from :: Matches -> Rep Matches x #

to :: Rep Matches x -> Matches #

Show Matches Source # 
Instance details

Defined in Pinecone.Search

Methods

showsPrec :: Int -> Matches -> ShowS #

show :: Matches -> String #

showList :: [Matches] -> ShowS #

Eq Matches Source # 
Instance details

Defined in Pinecone.Search

Methods

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

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

type Rep Matches Source # 
Instance details

Defined in Pinecone.Search

type Rep Matches = D1 ('MetaData "Matches" "Pinecone.Search" "pinecone-1.0.0-FtIUEL1n6VI5sRXEYSiB7n" 'False) (C1 ('MetaCons "Matches" 'PrefixI 'True) (S1 ('MetaSel ('Just "matches") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Vector Match)) :*: (S1 ('MetaSel ('Just "namespace") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Namespace) :*: S1 ('MetaSel ('Just "usage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Usage))))

data SearchWithText Source #

A search request for records in a specific namespace.

Constructors

SearchWithText 

Fields

Instances

Instances details
FromJSON SearchWithText Source # 
Instance details

Defined in Pinecone.Search

Methods

parseJSON :: Value -> Parser SearchWithText #

parseJSONList :: Value -> Parser [SearchWithText] #

omittedField :: Maybe SearchWithText #

ToJSON SearchWithText Source # 
Instance details

Defined in Pinecone.Search

Methods

toJSON :: SearchWithText -> Value #

toEncoding :: SearchWithText -> Encoding #

toJSONList :: [SearchWithText] -> Value #

toEncodingList :: [SearchWithText] -> Encoding #

omitField :: SearchWithText -> Bool #

Generic SearchWithText Source # 
Instance details

Defined in Pinecone.Search

Associated Types

type Rep SearchWithText 
Instance details

Defined in Pinecone.Search

type Rep SearchWithText = D1 ('MetaData "SearchWithText" "Pinecone.Search" "pinecone-1.0.0-FtIUEL1n6VI5sRXEYSiB7n" 'False) (C1 ('MetaCons "SearchWithText" 'PrefixI 'True) (S1 ('MetaSel ('Just "query") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Query) :*: (S1 ('MetaSel ('Just "fields") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Vector Text))) :*: S1 ('MetaSel ('Just "rerank") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Rerank)))))

Methods

from :: SearchWithText -> Rep SearchWithText x #

to :: Rep SearchWithText x -> SearchWithText #

Show SearchWithText Source # 
Instance details

Defined in Pinecone.Search

Methods

showsPrec :: Int -> SearchWithText -> ShowS #

show :: SearchWithText -> String #

showList :: [SearchWithText] -> ShowS #

Eq SearchWithText Source # 
Instance details

Defined in Pinecone.Search

Methods

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

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

type Rep SearchWithText Source # 
Instance details

Defined in Pinecone.Search

type Rep SearchWithText = D1 ('MetaData "SearchWithText" "Pinecone.Search" "pinecone-1.0.0-FtIUEL1n6VI5sRXEYSiB7n" 'False) (C1 ('MetaCons "SearchWithText" 'PrefixI 'True) (S1 ('MetaSel ('Just "query") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Query) :*: (S1 ('MetaSel ('Just "fields") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Vector Text))) :*: S1 ('MetaSel ('Just "rerank") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Rerank)))))

_SearchWithText :: SearchWithText Source #

Default SearchWithText

data Hits Source #

A successful search namespace response.

Constructors

Hits 

Fields

Instances

Instances details
FromJSON Hits Source # 
Instance details

Defined in Pinecone.Search

Methods

parseJSON :: Value -> Parser Hits #

parseJSONList :: Value -> Parser [Hits] #

omittedField :: Maybe Hits #

ToJSON Hits Source # 
Instance details

Defined in Pinecone.Search

Methods

toJSON :: Hits -> Value #

toEncoding :: Hits -> Encoding #

toJSONList :: [Hits] -> Value #

toEncodingList :: [Hits] -> Encoding #

omitField :: Hits -> Bool #

Generic Hits Source # 
Instance details

Defined in Pinecone.Search

Associated Types

type Rep Hits 
Instance details

Defined in Pinecone.Search

type Rep Hits = D1 ('MetaData "Hits" "Pinecone.Search" "pinecone-1.0.0-FtIUEL1n6VI5sRXEYSiB7n" 'False) (C1 ('MetaCons "Hits" 'PrefixI 'True) (S1 ('MetaSel ('Just "usage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Usage) :*: S1 ('MetaSel ('Just "hits") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Vector Hit))))

Methods

from :: Hits -> Rep Hits x #

to :: Rep Hits x -> Hits #

Show Hits Source # 
Instance details

Defined in Pinecone.Search

Methods

showsPrec :: Int -> Hits -> ShowS #

show :: Hits -> String #

showList :: [Hits] -> ShowS #

Eq Hits Source # 
Instance details

Defined in Pinecone.Search

Methods

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

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

type Rep Hits Source # 
Instance details

Defined in Pinecone.Search

type Rep Hits = D1 ('MetaData "Hits" "Pinecone.Search" "pinecone-1.0.0-FtIUEL1n6VI5sRXEYSiB7n" 'False) (C1 ('MetaCons "Hits" 'PrefixI 'True) (S1 ('MetaSel ('Just "usage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Usage) :*: S1 ('MetaSel ('Just "hits") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Vector Hit))))

Other types

data Match Source #

Match for a vector

Constructors

Match 

Fields

Instances

Instances details
FromJSON Match Source # 
Instance details

Defined in Pinecone.Search

Methods

parseJSON :: Value -> Parser Match #

parseJSONList :: Value -> Parser [Match] #

omittedField :: Maybe Match #

ToJSON Match Source # 
Instance details

Defined in Pinecone.Search

Methods

toJSON :: Match -> Value #

toEncoding :: Match -> Encoding #

toJSONList :: [Match] -> Value #

toEncodingList :: [Match] -> Encoding #

omitField :: Match -> Bool #

Generic Match Source # 
Instance details

Defined in Pinecone.Search

Associated Types

type Rep Match 
Instance details

Defined in Pinecone.Search

type Rep Match = D1 ('MetaData "Match" "Pinecone.Search" "pinecone-1.0.0-FtIUEL1n6VI5sRXEYSiB7n" 'False) (C1 ('MetaCons "Match" 'PrefixI 'True) ((S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "score") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Double))) :*: (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)))))))

Methods

from :: Match -> Rep Match x #

to :: Rep Match x -> Match #

Show Match Source # 
Instance details

Defined in Pinecone.Search

Methods

showsPrec :: Int -> Match -> ShowS #

show :: Match -> String #

showList :: [Match] -> ShowS #

Eq Match Source # 
Instance details

Defined in Pinecone.Search

Methods

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

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

type Rep Match Source # 
Instance details

Defined in Pinecone.Search

type Rep Match = D1 ('MetaData "Match" "Pinecone.Search" "pinecone-1.0.0-FtIUEL1n6VI5sRXEYSiB7n" 'False) (C1 ('MetaCons "Match" 'PrefixI 'True) ((S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "score") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Double))) :*: (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 Query Source #

The query inputs to search with

Constructors

Query 

Fields

Instances

Instances details
FromJSON Query Source # 
Instance details

Defined in Pinecone.Search

Methods

parseJSON :: Value -> Parser Query #

parseJSONList :: Value -> Parser [Query] #

omittedField :: Maybe Query #

ToJSON Query Source # 
Instance details

Defined in Pinecone.Search

Methods

toJSON :: Query -> Value #

toEncoding :: Query -> Encoding #

toJSONList :: [Query] -> Value #

toEncodingList :: [Query] -> Encoding #

omitField :: Query -> Bool #

Generic Query Source # 
Instance details

Defined in Pinecone.Search

Associated Types

type Rep Query 
Instance details

Defined in Pinecone.Search

type Rep Query = D1 ('MetaData "Query" "Pinecone.Search" "pinecone-1.0.0-FtIUEL1n6VI5sRXEYSiB7n" 'False) (C1 ('MetaCons "Query" 'PrefixI 'True) ((S1 ('MetaSel ('Just "top_k") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Natural) :*: S1 ('MetaSel ('Just "filter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Filter))) :*: (S1 ('MetaSel ('Just "input") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "vector") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe VectorQuery)))))

Methods

from :: Query -> Rep Query x #

to :: Rep Query x -> Query #

Show Query Source # 
Instance details

Defined in Pinecone.Search

Methods

showsPrec :: Int -> Query -> ShowS #

show :: Query -> String #

showList :: [Query] -> ShowS #

Eq Query Source # 
Instance details

Defined in Pinecone.Search

Methods

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

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

type Rep Query Source # 
Instance details

Defined in Pinecone.Search

type Rep Query = D1 ('MetaData "Query" "Pinecone.Search" "pinecone-1.0.0-FtIUEL1n6VI5sRXEYSiB7n" 'False) (C1 ('MetaCons "Query" 'PrefixI 'True) ((S1 ('MetaSel ('Just "top_k") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Natural) :*: S1 ('MetaSel ('Just "filter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Filter))) :*: (S1 ('MetaSel ('Just "input") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "vector") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe VectorQuery)))))

_Query :: Query Source #

Default Query

data VectorQuery Source #

Vector query

Constructors

VectorQuery 

Fields

Instances

Instances details
FromJSON VectorQuery Source # 
Instance details

Defined in Pinecone.Search

Methods

parseJSON :: Value -> Parser VectorQuery #

parseJSONList :: Value -> Parser [VectorQuery] #

omittedField :: Maybe VectorQuery #

ToJSON VectorQuery Source # 
Instance details

Defined in Pinecone.Search

Methods

toJSON :: VectorQuery -> Value #

toEncoding :: VectorQuery -> Encoding #

toJSONList :: [VectorQuery] -> Value #

toEncodingList :: [VectorQuery] -> Encoding #

omitField :: VectorQuery -> Bool #

Generic VectorQuery Source # 
Instance details

Defined in Pinecone.Search

Associated Types

type Rep VectorQuery 
Instance details

Defined in Pinecone.Search

type Rep VectorQuery = D1 ('MetaData "VectorQuery" "Pinecone.Search" "pinecone-1.0.0-FtIUEL1n6VI5sRXEYSiB7n" 'False) (C1 ('MetaCons "VectorQuery" 'PrefixI 'True) (S1 ('MetaSel ('Just "values") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Vector Double))) :*: (S1 ('MetaSel ('Just "sparse_values") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Vector Double))) :*: S1 ('MetaSel ('Just "sparse_indices") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Vector Natural))))))

Methods

from :: VectorQuery -> Rep VectorQuery x #

to :: Rep VectorQuery x -> VectorQuery #

Show VectorQuery Source # 
Instance details

Defined in Pinecone.Search

Methods

showsPrec :: Int -> VectorQuery -> ShowS #

show :: VectorQuery -> String #

showList :: [VectorQuery] -> ShowS #

Eq VectorQuery Source # 
Instance details

Defined in Pinecone.Search

Methods

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

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

type Rep VectorQuery Source # 
Instance details

Defined in Pinecone.Search

type Rep VectorQuery = D1 ('MetaData "VectorQuery" "Pinecone.Search" "pinecone-1.0.0-FtIUEL1n6VI5sRXEYSiB7n" 'False) (C1 ('MetaCons "VectorQuery" 'PrefixI 'True) (S1 ('MetaSel ('Just "values") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Vector Double))) :*: (S1 ('MetaSel ('Just "sparse_values") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Vector Double))) :*: S1 ('MetaSel ('Just "sparse_indices") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Vector Natural))))))

data Rerank Source #

Parameters for reranking the initial search results

Constructors

Rerank 

Fields

Instances

Instances details
FromJSON Rerank Source # 
Instance details

Defined in Pinecone.Search

Methods

parseJSON :: Value -> Parser Rerank #

parseJSONList :: Value -> Parser [Rerank] #

omittedField :: Maybe Rerank #

ToJSON Rerank Source # 
Instance details

Defined in Pinecone.Search

Methods

toJSON :: Rerank -> Value #

toEncoding :: Rerank -> Encoding #

toJSONList :: [Rerank] -> Value #

toEncodingList :: [Rerank] -> Encoding #

omitField :: Rerank -> Bool #

Generic Rerank Source # 
Instance details

Defined in Pinecone.Search

Associated Types

type Rep Rerank 
Instance details

Defined in Pinecone.Search

type Rep Rerank = D1 ('MetaData "Rerank" "Pinecone.Search" "pinecone-1.0.0-FtIUEL1n6VI5sRXEYSiB7n" 'False) (C1 ('MetaCons "Rerank" 'PrefixI 'True) ((S1 ('MetaSel ('Just "model") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "rank_fields") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Vector Text))) :*: (S1 ('MetaSel ('Just "top_n") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "parameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Map Text Value))) :*: S1 ('MetaSel ('Just "query") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))))))

Methods

from :: Rerank -> Rep Rerank x #

to :: Rep Rerank x -> Rerank #

Show Rerank Source # 
Instance details

Defined in Pinecone.Search

Methods

showsPrec :: Int -> Rerank -> ShowS #

show :: Rerank -> String #

showList :: [Rerank] -> ShowS #

Eq Rerank Source # 
Instance details

Defined in Pinecone.Search

Methods

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

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

type Rep Rerank Source # 
Instance details

Defined in Pinecone.Search

type Rep Rerank = D1 ('MetaData "Rerank" "Pinecone.Search" "pinecone-1.0.0-FtIUEL1n6VI5sRXEYSiB7n" 'False) (C1 ('MetaCons "Rerank" 'PrefixI 'True) ((S1 ('MetaSel ('Just "model") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "rank_fields") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Vector Text))) :*: (S1 ('MetaSel ('Just "top_n") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "parameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Map Text Value))) :*: S1 ('MetaSel ('Just "query") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))))))

data Hit Source #

Hit for the search document request

Constructors

Hit 

Fields

Instances

Instances details
FromJSON Hit Source # 
Instance details

Defined in Pinecone.Search

Methods

parseJSON :: Value -> Parser Hit #

parseJSONList :: Value -> Parser [Hit] #

omittedField :: Maybe Hit #

ToJSON Hit Source # 
Instance details

Defined in Pinecone.Search

Methods

toJSON :: Hit -> Value #

toEncoding :: Hit -> Encoding #

toJSONList :: [Hit] -> Value #

toEncodingList :: [Hit] -> Encoding #

omitField :: Hit -> Bool #

Generic Hit Source # 
Instance details

Defined in Pinecone.Search

Associated Types

type Rep Hit 
Instance details

Defined in Pinecone.Search

type Rep Hit = D1 ('MetaData "Hit" "Pinecone.Search" "pinecone-1.0.0-FtIUEL1n6VI5sRXEYSiB7n" 'False) (C1 ('MetaCons "Hit" 'PrefixI 'True) (S1 ('MetaSel ('Just "_id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: (S1 ('MetaSel ('Just "_score") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Double) :*: S1 ('MetaSel ('Just "fields") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Value))))

Methods

from :: Hit -> Rep Hit x #

to :: Rep Hit x -> Hit #

Show Hit Source # 
Instance details

Defined in Pinecone.Search

Methods

showsPrec :: Int -> Hit -> ShowS #

show :: Hit -> String #

showList :: [Hit] -> ShowS #

Eq Hit Source # 
Instance details

Defined in Pinecone.Search

Methods

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

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

type Rep Hit Source # 
Instance details

Defined in Pinecone.Search

type Rep Hit = D1 ('MetaData "Hit" "Pinecone.Search" "pinecone-1.0.0-FtIUEL1n6VI5sRXEYSiB7n" 'False) (C1 ('MetaCons "Hit" 'PrefixI 'True) (S1 ('MetaSel ('Just "_id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: (S1 ('MetaSel ('Just "_score") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Double) :*: S1 ('MetaSel ('Just "fields") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Value))))

data Usage Source #

Usage

Constructors

Usage 

Fields

Instances

Instances details
FromJSON Usage Source # 
Instance details

Defined in Pinecone.Search

Methods

parseJSON :: Value -> Parser Usage #

parseJSONList :: Value -> Parser [Usage] #

omittedField :: Maybe Usage #

ToJSON Usage Source # 
Instance details

Defined in Pinecone.Search

Methods

toJSON :: Usage -> Value #

toEncoding :: Usage -> Encoding #

toJSONList :: [Usage] -> Value #

toEncodingList :: [Usage] -> Encoding #

omitField :: Usage -> Bool #

Generic Usage Source # 
Instance details

Defined in Pinecone.Search

Associated Types

type Rep Usage 
Instance details

Defined in Pinecone.Search

type Rep Usage = D1 ('MetaData "Usage" "Pinecone.Search" "pinecone-1.0.0-FtIUEL1n6VI5sRXEYSiB7n" 'False) (C1 ('MetaCons "Usage" 'PrefixI 'True) (S1 ('MetaSel ('Just "read_units") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "embed_total_tokens") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "rerank_units") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Natural)))))

Methods

from :: Usage -> Rep Usage x #

to :: Rep Usage x -> Usage #

Show Usage Source # 
Instance details

Defined in Pinecone.Search

Methods

showsPrec :: Int -> Usage -> ShowS #

show :: Usage -> String #

showList :: [Usage] -> ShowS #

Eq Usage Source # 
Instance details

Defined in Pinecone.Search

Methods

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

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

type Rep Usage Source # 
Instance details

Defined in Pinecone.Search

type Rep Usage = D1 ('MetaData "Usage" "Pinecone.Search" "pinecone-1.0.0-FtIUEL1n6VI5sRXEYSiB7n" 'False) (C1 ('MetaCons "Usage" 'PrefixI 'True) (S1 ('MetaSel ('Just "read_units") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "embed_total_tokens") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "rerank_units") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Natural)))))

Servant

type API = ("query" :> (ReqBody '[JSON] SearchWithVector :> Post '[JSON] Matches)) :<|> ("records" :> ("namespaces" :> (Capture "namespace" Namespace :> ("search" :> (ReqBody '[JSON] SearchWithText :> Post '[JSON] Hits))))) Source #

Servant API