| Safe Haskell | Safe-Inferred |
|---|---|
| Language | Haskell2010 |
Pinecone.Search
Contents
Description
Search
Synopsis
- data SearchWithVector = SearchWithVector {}
- _SearchWithVector :: SearchWithVector
- data Matches = Matches {}
- data SearchWithText = SearchWithText {}
- _SearchWithText :: SearchWithText
- data Hits = Hits {}
- data Match = Match {}
- data Query = Query {}
- _Query :: Query
- data VectorQuery = VectorQuery {
- values :: Maybe (Vector Double)
- sparse_values :: Maybe (Vector Double)
- sparse_indices :: Maybe (Vector Natural)
- data Rerank = Rerank {}
- data Hit = Hit {}
- data Usage = Usage {}
- type API = ("query" :> (ReqBody '[JSON] SearchWithVector :> Post '[JSON] Matches)) :<|> ("records" :> ("namespaces" :> (Capture "namespace" Namespace :> ("search" :> (ReqBody '[JSON] SearchWithText :> Post '[JSON] Hits)))))
Main types
data SearchWithVector Source #
Request body for /query
Constructors
| SearchWithVector | |
Instances
_SearchWithVector :: SearchWithVector Source #
Default SearchWithVector
Response body for /query
Instances
| FromJSON Matches Source # | |
Defined in Pinecone.Search | |
| ToJSON Matches Source # | |
| Generic Matches Source # | |
| Show Matches Source # | |
| Eq Matches Source # | |
| type Rep Matches Source # | |
Defined in Pinecone.Search type Rep Matches = D1 ('MetaData "Matches" "Pinecone.Search" "pinecone-1.0.0-Ex4c0YruToKASgnObHGBW7" '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 | |
Instances
_SearchWithText :: SearchWithText Source #
Default SearchWithText
A successful search namespace response.
Instances
| FromJSON Hits Source # | |
Defined in Pinecone.Search | |
| ToJSON Hits Source # | |
| Generic Hits Source # | |
| Show Hits Source # | |
| Eq Hits Source # | |
| type Rep Hits Source # | |
Defined in Pinecone.Search type Rep Hits = D1 ('MetaData "Hits" "Pinecone.Search" "pinecone-1.0.0-Ex4c0YruToKASgnObHGBW7" '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
Match for a vector
Constructors
| Match | |
Instances
| FromJSON Match Source # | |
Defined in Pinecone.Search | |
| ToJSON Match Source # | |
| Generic Match Source # | |
| Show Match Source # | |
| Eq Match Source # | |
| type Rep Match Source # | |
Defined in Pinecone.Search type Rep Match = D1 ('MetaData "Match" "Pinecone.Search" "pinecone-1.0.0-Ex4c0YruToKASgnObHGBW7" '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))))))) | |
The query inputs to search with
Constructors
| Query | |
Instances
| FromJSON Query Source # | |
Defined in Pinecone.Search | |
| ToJSON Query Source # | |
| Generic Query Source # | |
| Show Query Source # | |
| Eq Query Source # | |
| type Rep Query Source # | |
Defined in Pinecone.Search type Rep Query = D1 ('MetaData "Query" "Pinecone.Search" "pinecone-1.0.0-Ex4c0YruToKASgnObHGBW7" '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))))) | |
data VectorQuery Source #
Vector query
Constructors
| VectorQuery | |
Fields
| |
Instances
Parameters for reranking the initial search results
Constructors
| Rerank | |
Instances
| FromJSON Rerank Source # | |
Defined in Pinecone.Search | |
| ToJSON Rerank Source # | |
| Generic Rerank Source # | |
| Show Rerank Source # | |
| Eq Rerank Source # | |
| type Rep Rerank Source # | |
Defined in Pinecone.Search type Rep Rerank = D1 ('MetaData "Rerank" "Pinecone.Search" "pinecone-1.0.0-Ex4c0YruToKASgnObHGBW7" '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)))))) | |
Hit for the search document request
Instances
| FromJSON Hit Source # | |
Defined in Pinecone.Search | |
| ToJSON Hit Source # | |
| Generic Hit Source # | |
| Show Hit Source # | |
| Eq Hit Source # | |
| type Rep Hit Source # | |
Defined in Pinecone.Search type Rep Hit = D1 ('MetaData "Hit" "Pinecone.Search" "pinecone-1.0.0-Ex4c0YruToKASgnObHGBW7" '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)))) | |
Usage
Constructors
| Usage | |
Fields | |
Instances
| FromJSON Usage Source # | |
Defined in Pinecone.Search | |
| ToJSON Usage Source # | |
| Generic Usage Source # | |
| Show Usage Source # | |
| Eq Usage Source # | |
| type Rep Usage Source # | |
Defined in Pinecone.Search type Rep Usage = D1 ('MetaData "Usage" "Pinecone.Search" "pinecone-1.0.0-Ex4c0YruToKASgnObHGBW7" '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))))) | |