Safe Haskell	Safe-Inferred
Language	Haskell2010

Pinecone.Rerank

Contents

Main types
Other types
Servant

Description

Rerank

Synopsis

data RerankResults = RerankResults {
- model :: Text
- query :: Text
- documents :: Vector Record
- top_n :: Maybe Natural
- return_documents :: Bool
- parameters :: Map Text Scalar
}
_RerankResults :: RerankResults
data Documents = Documents {
- model :: Text
- data_ :: Vector Document
- usage :: Usage
}
data Document = Document {
- index :: Natural
- score :: Double
- document :: Maybe Record
}
data Usage = Usage {
- rerank_units :: Natural
}
type API = "rerank" :> (ReqBody '[JSON] RerankResults :> Post '[JSON] Documents)

Main types

data RerankResults Source #

Rerank documents for the given query

Constructors

RerankResults
Fields model :: Text query :: Text documents :: Vector Record top_n :: Maybe Natural return_documents :: Bool parameters :: Map Text Scalar

Instances

Instances details

FromJSON RerankResults Source #
Instance details Defined in Pinecone.Rerank Methods parseJSON :: Value -> Parser RerankResults # parseJSONList :: Value -> Parser [RerankResults] # omittedField :: Maybe RerankResults #
ToJSON RerankResults Source #
Instance details Defined in Pinecone.Rerank Methods toJSON :: RerankResults -> Value # toEncoding :: RerankResults -> Encoding # toJSONList :: [RerankResults] -> Value # toEncodingList :: [RerankResults] -> Encoding # omitField :: RerankResults -> Bool #
Generic RerankResults Source #
Instance details Defined in Pinecone.Rerank Associated Types type Rep RerankResults :: Type -> Type # Methods from :: RerankResults -> Rep RerankResults x # to :: Rep RerankResults x -> RerankResults #
Show RerankResults Source #
Instance details Defined in Pinecone.Rerank Methods showsPrec :: Int -> RerankResults -> ShowS # show :: RerankResults -> String # showList :: [RerankResults] -> ShowS #
Eq RerankResults Source #
Instance details Defined in Pinecone.Rerank Methods (==) :: RerankResults -> RerankResults -> Bool # (/=) :: RerankResults -> RerankResults -> Bool #
type Rep RerankResults Source #
Instance details Defined in Pinecone.Rerank type Rep RerankResults = D1 ('MetaData "RerankResults" "Pinecone.Rerank" "pinecone-1.0.0-Ex4c0YruToKASgnObHGBW7" 'False) (C1 ('MetaCons "RerankResults" 'PrefixI 'True) ((S1 ('MetaSel ('Just "model") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :: (S1 ('MetaSel ('Just "query") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :: S1 ('MetaSel ('Just "documents") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Vector Record)))) :: (S1 ('MetaSel ('Just "top_n") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Natural)) :: (S1 ('MetaSel ('Just "return_documents") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: S1 ('MetaSel ('Just "parameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map Text Scalar))))))

_RerankResults :: RerankResults Source #

Default RerankResults

data Documents Source #

The result of a reranking request.

Constructors

Documents
Fields model :: Text data_ :: Vector Document usage :: Usage

Instances

Instances details

FromJSON Documents Source #
Instance details Defined in Pinecone.Rerank Methods parseJSON :: Value -> Parser Documents # parseJSONList :: Value -> Parser [Documents] # omittedField :: Maybe Documents #
ToJSON Documents Source #
Instance details Defined in Pinecone.Rerank Methods toJSON :: Documents -> Value # toEncoding :: Documents -> Encoding # toJSONList :: [Documents] -> Value # toEncodingList :: [Documents] -> Encoding # omitField :: Documents -> Bool #
Generic Documents Source #
Instance details Defined in Pinecone.Rerank Associated Types type Rep Documents :: Type -> Type # Methods from :: Documents -> Rep Documents x # to :: Rep Documents x -> Documents #
Show Documents Source #
Instance details Defined in Pinecone.Rerank Methods showsPrec :: Int -> Documents -> ShowS # show :: Documents -> String # showList :: [Documents] -> ShowS #
Eq Documents Source #
Instance details Defined in Pinecone.Rerank Methods (==) :: Documents -> Documents -> Bool # (/=) :: Documents -> Documents -> Bool #
type Rep Documents Source #
Instance details Defined in Pinecone.Rerank type Rep Documents = D1 ('MetaData "Documents" "Pinecone.Rerank" "pinecone-1.0.0-Ex4c0YruToKASgnObHGBW7" 'False) (C1 ('MetaCons "Documents" 'PrefixI 'True) (S1 ('MetaSel ('Just "model") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :: (S1 ('MetaSel ('Just "data_") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Vector Document)) :: S1 ('MetaSel ('Just "usage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Usage))))

Other types

data Document Source #

A ranked document with a relevance score and an index position.

Constructors

Document
Fields index :: Natural score :: Double document :: Maybe Record

Instances

Instances details

FromJSON Document Source #
Instance details Defined in Pinecone.Rerank Methods parseJSON :: Value -> Parser Document # parseJSONList :: Value -> Parser [Document] # omittedField :: Maybe Document #
ToJSON Document Source #
Instance details Defined in Pinecone.Rerank Methods toJSON :: Document -> Value # toEncoding :: Document -> Encoding # toJSONList :: [Document] -> Value # toEncodingList :: [Document] -> Encoding # omitField :: Document -> Bool #
Generic Document Source #
Instance details Defined in Pinecone.Rerank Associated Types type Rep Document :: Type -> Type # Methods from :: Document -> Rep Document x # to :: Rep Document x -> Document #
Show Document Source #
Instance details Defined in Pinecone.Rerank Methods showsPrec :: Int -> Document -> ShowS # show :: Document -> String # showList :: [Document] -> ShowS #
Eq Document Source #
Instance details Defined in Pinecone.Rerank Methods (==) :: Document -> Document -> Bool # (/=) :: Document -> Document -> Bool #
type Rep Document Source #
Instance details Defined in Pinecone.Rerank type Rep Document = D1 ('MetaData "Document" "Pinecone.Rerank" "pinecone-1.0.0-Ex4c0YruToKASgnObHGBW7" 'False) (C1 ('MetaCons "Document" 'PrefixI 'True) (S1 ('MetaSel ('Just "index") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Natural) :: (S1 ('MetaSel ('Just "score") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Double) :: S1 ('MetaSel ('Just "document") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Record)))))

data Usage Source #

Usage statistics for the model inference.

Constructors

Usage
Fields rerank_units :: Natural

Instances

Instances details

FromJSON Usage Source #
Instance details Defined in Pinecone.Rerank Methods parseJSON :: Value -> Parser Usage # parseJSONList :: Value -> Parser [Usage] # omittedField :: Maybe Usage #
ToJSON Usage Source #
Instance details Defined in Pinecone.Rerank Methods toJSON :: Usage -> Value # toEncoding :: Usage -> Encoding # toJSONList :: [Usage] -> Value # toEncodingList :: [Usage] -> Encoding # omitField :: Usage -> Bool #
Generic Usage Source #
Instance details Defined in Pinecone.Rerank 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.Rerank Methods showsPrec :: Int -> Usage -> ShowS # show :: Usage -> String # showList :: [Usage] -> ShowS #
Eq Usage Source #
Instance details Defined in Pinecone.Rerank Methods (==) :: Usage -> Usage -> Bool # (/=) :: Usage -> Usage -> Bool #
type Rep Usage Source #
Instance details Defined in Pinecone.Rerank type Rep Usage = D1 ('MetaData "Usage" "Pinecone.Rerank" "pinecone-1.0.0-Ex4c0YruToKASgnObHGBW7" 'False) (C1 ('MetaCons "Usage" 'PrefixI 'True) (S1 ('MetaSel ('Just "rerank_units") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Natural)))

Servant

type API = "rerank" :> (ReqBody '[JSON] RerankResults :> Post '[JSON] Documents) Source #

Servant API