-- | Rerank
module Pinecone.Rerank
    ( -- * Main types
      RerankResults(..)
    , _RerankResults
    , Documents(..)

      -- * Other types
    , Document(..)
    , Usage(..)

      -- * Servant
    , API
    ) where

import Pinecone.Metadata (Scalar)
import Pinecone.Prelude
import Pinecone.Vectors (Record)

-- | Rerank documents for the given query
data RerankResults = RerankResults
    { RerankResults -> Text
model :: Text
    , RerankResults -> Text
query :: Text
    , RerankResults -> Vector Record
documents :: Vector Record
    , RerankResults -> Maybe Natural
top_n :: Maybe Natural
    , RerankResults -> Bool
return_documents :: Bool
    , RerankResults -> Map Text Scalar
parameters :: Map Text Scalar
    } deriving stock (RerankResults -> RerankResults -> Bool
(RerankResults -> RerankResults -> Bool)
-> (RerankResults -> RerankResults -> Bool) -> Eq RerankResults
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
$c== :: RerankResults -> RerankResults -> Bool
== :: RerankResults -> RerankResults -> Bool
$c/= :: RerankResults -> RerankResults -> Bool
/= :: RerankResults -> RerankResults -> Bool
Eq, (forall x. RerankResults -> Rep RerankResults x)
-> (forall x. Rep RerankResults x -> RerankResults)
-> Generic RerankResults
forall x. Rep RerankResults x -> RerankResults
forall x. RerankResults -> Rep RerankResults x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cfrom :: forall x. RerankResults -> Rep RerankResults x
from :: forall x. RerankResults -> Rep RerankResults x
$cto :: forall x. Rep RerankResults x -> RerankResults
to :: forall x. Rep RerankResults x -> RerankResults
Generic, Int -> RerankResults -> ShowS
[RerankResults] -> ShowS
RerankResults -> String
(Int -> RerankResults -> ShowS)
-> (RerankResults -> String)
-> ([RerankResults] -> ShowS)
-> Show RerankResults
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
$cshowsPrec :: Int -> RerankResults -> ShowS
showsPrec :: Int -> RerankResults -> ShowS
$cshow :: RerankResults -> String
show :: RerankResults -> String
$cshowList :: [RerankResults] -> ShowS
showList :: [RerankResults] -> ShowS
Show)
      deriving anyclass (Maybe RerankResults
Value -> Parser [RerankResults]
Value -> Parser RerankResults
(Value -> Parser RerankResults)
-> (Value -> Parser [RerankResults])
-> Maybe RerankResults
-> FromJSON RerankResults
forall a.
(Value -> Parser a)
-> (Value -> Parser [a]) -> Maybe a -> FromJSON a
$cparseJSON :: Value -> Parser RerankResults
parseJSON :: Value -> Parser RerankResults
$cparseJSONList :: Value -> Parser [RerankResults]
parseJSONList :: Value -> Parser [RerankResults]
$comittedField :: Maybe RerankResults
omittedField :: Maybe RerankResults
FromJSON)

data RerankResults_ = RerankResults_
    { RerankResults_ -> Text
model :: Text
    , RerankResults_ -> Text
query :: Text
    , RerankResults_ -> Vector Record
documents :: Vector Record
    , RerankResults_ -> Maybe Natural
top_n :: Maybe Natural
    , RerankResults_ -> Bool
return_documents :: Bool
    , RerankResults_ -> Vector Text
rank_fields :: Vector Text
    , RerankResults_ -> Map Text Scalar
parameters :: Map Text Scalar
    } deriving stock (RerankResults_ -> RerankResults_ -> Bool
(RerankResults_ -> RerankResults_ -> Bool)
-> (RerankResults_ -> RerankResults_ -> Bool) -> Eq RerankResults_
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
$c== :: RerankResults_ -> RerankResults_ -> Bool
== :: RerankResults_ -> RerankResults_ -> Bool
$c/= :: RerankResults_ -> RerankResults_ -> Bool
/= :: RerankResults_ -> RerankResults_ -> Bool
Eq, (forall x. RerankResults_ -> Rep RerankResults_ x)
-> (forall x. Rep RerankResults_ x -> RerankResults_)
-> Generic RerankResults_
forall x. Rep RerankResults_ x -> RerankResults_
forall x. RerankResults_ -> Rep RerankResults_ x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cfrom :: forall x. RerankResults_ -> Rep RerankResults_ x
from :: forall x. RerankResults_ -> Rep RerankResults_ x
$cto :: forall x. Rep RerankResults_ x -> RerankResults_
to :: forall x. Rep RerankResults_ x -> RerankResults_
Generic, Int -> RerankResults_ -> ShowS
[RerankResults_] -> ShowS
RerankResults_ -> String
(Int -> RerankResults_ -> ShowS)
-> (RerankResults_ -> String)
-> ([RerankResults_] -> ShowS)
-> Show RerankResults_
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
$cshowsPrec :: Int -> RerankResults_ -> ShowS
showsPrec :: Int -> RerankResults_ -> ShowS
$cshow :: RerankResults_ -> String
show :: RerankResults_ -> String
$cshowList :: [RerankResults_] -> ShowS
showList :: [RerankResults_] -> ShowS
Show)
      deriving anyclass (Maybe RerankResults_
Value -> Parser [RerankResults_]
Value -> Parser RerankResults_
(Value -> Parser RerankResults_)
-> (Value -> Parser [RerankResults_])
-> Maybe RerankResults_
-> FromJSON RerankResults_
forall a.
(Value -> Parser a)
-> (Value -> Parser [a]) -> Maybe a -> FromJSON a
$cparseJSON :: Value -> Parser RerankResults_
parseJSON :: Value -> Parser RerankResults_
$cparseJSONList :: Value -> Parser [RerankResults_]
parseJSONList :: Value -> Parser [RerankResults_]
$comittedField :: Maybe RerankResults_
omittedField :: Maybe RerankResults_
FromJSON, [RerankResults_] -> Value
[RerankResults_] -> Encoding
RerankResults_ -> Bool
RerankResults_ -> Value
RerankResults_ -> Encoding
(RerankResults_ -> Value)
-> (RerankResults_ -> Encoding)
-> ([RerankResults_] -> Value)
-> ([RerankResults_] -> Encoding)
-> (RerankResults_ -> Bool)
-> ToJSON RerankResults_
forall a.
(a -> Value)
-> (a -> Encoding)
-> ([a] -> Value)
-> ([a] -> Encoding)
-> (a -> Bool)
-> ToJSON a
$ctoJSON :: RerankResults_ -> Value
toJSON :: RerankResults_ -> Value
$ctoEncoding :: RerankResults_ -> Encoding
toEncoding :: RerankResults_ -> Encoding
$ctoJSONList :: [RerankResults_] -> Value
toJSONList :: [RerankResults_] -> Value
$ctoEncodingList :: [RerankResults_] -> Encoding
toEncodingList :: [RerankResults_] -> Encoding
$comitField :: RerankResults_ -> Bool
omitField :: RerankResults_ -> Bool
ToJSON)

instance ToJSON RerankResults where
    toJSON :: RerankResults -> Value
toJSON RerankResults{Bool
Maybe Natural
Map Text Scalar
Text
Vector Record
$sel:model:RerankResults :: RerankResults -> Text
$sel:query:RerankResults :: RerankResults -> Text
$sel:documents:RerankResults :: RerankResults -> Vector Record
$sel:top_n:RerankResults :: RerankResults -> Maybe Natural
$sel:return_documents:RerankResults :: RerankResults -> Bool
$sel:parameters:RerankResults :: RerankResults -> Map Text Scalar
model :: Text
query :: Text
documents :: Vector Record
top_n :: Maybe Natural
return_documents :: Bool
parameters :: Map Text Scalar
..} = RerankResults_ -> Value
forall a. ToJSON a => a -> Value
toJSON RerankResults_{Bool
Maybe Natural
Map Text Scalar
Text
Vector Text
Vector Record
$sel:model:RerankResults_ :: Text
$sel:query:RerankResults_ :: Text
$sel:documents:RerankResults_ :: Vector Record
$sel:top_n:RerankResults_ :: Maybe Natural
$sel:return_documents:RerankResults_ :: Bool
$sel:rank_fields:RerankResults_ :: Vector Text
$sel:parameters:RerankResults_ :: Map Text Scalar
model :: Text
query :: Text
documents :: Vector Record
top_n :: Maybe Natural
return_documents :: Bool
parameters :: Map Text Scalar
rank_fields :: Vector Text
..}
      where
        rank_fields :: Vector Text
rank_fields = [ Item (Vector Text)
"text" ]

-- | Default `RerankResults`
_RerankResults :: RerankResults
_RerankResults :: RerankResults
_RerankResults = RerankResults
    { $sel:top_n:RerankResults :: Maybe Natural
top_n = Maybe Natural
forall a. Maybe a
Nothing
    }

-- | The result of a reranking request.
data Documents = Documents
    { Documents -> Text
model :: Text
    , Documents -> Vector Document
data_ :: Vector Document
    , Documents -> Usage
usage :: Usage
    } deriving stock (Documents -> Documents -> Bool
(Documents -> Documents -> Bool)
-> (Documents -> Documents -> Bool) -> Eq Documents
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
$c== :: Documents -> Documents -> Bool
== :: Documents -> Documents -> Bool
$c/= :: Documents -> Documents -> Bool
/= :: Documents -> Documents -> Bool
Eq, (forall x. Documents -> Rep Documents x)
-> (forall x. Rep Documents x -> Documents) -> Generic Documents
forall x. Rep Documents x -> Documents
forall x. Documents -> Rep Documents x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cfrom :: forall x. Documents -> Rep Documents x
from :: forall x. Documents -> Rep Documents x
$cto :: forall x. Rep Documents x -> Documents
to :: forall x. Rep Documents x -> Documents
Generic, Int -> Documents -> ShowS
[Documents] -> ShowS
Documents -> String
(Int -> Documents -> ShowS)
-> (Documents -> String)
-> ([Documents] -> ShowS)
-> Show Documents
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
$cshowsPrec :: Int -> Documents -> ShowS
showsPrec :: Int -> Documents -> ShowS
$cshow :: Documents -> String
show :: Documents -> String
$cshowList :: [Documents] -> ShowS
showList :: [Documents] -> ShowS
Show)

instance FromJSON Documents where
    parseJSON :: Value -> Parser Documents
parseJSON = Options -> Value -> Parser Documents
forall a.
(Generic a, GFromJSON Zero (Rep a)) =>
Options -> Value -> Parser a
genericParseJSON Options
aesonOptions

instance ToJSON Documents where
    toJSON :: Documents -> Value
toJSON = Options -> Documents -> Value
forall a.
(Generic a, GToJSON' Value Zero (Rep a)) =>
Options -> a -> Value
genericToJSON Options
aesonOptions

-- | A ranked document with a relevance score and an index position.
data Document = Document
    { Document -> Natural
index :: Natural
    , Document -> Double
score :: Double
    , Document -> Maybe Record
document :: Maybe Record
    } deriving stock (Document -> Document -> Bool
(Document -> Document -> Bool)
-> (Document -> Document -> Bool) -> Eq Document
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
$c== :: Document -> Document -> Bool
== :: Document -> Document -> Bool
$c/= :: Document -> Document -> Bool
/= :: Document -> Document -> Bool
Eq, (forall x. Document -> Rep Document x)
-> (forall x. Rep Document x -> Document) -> Generic Document
forall x. Rep Document x -> Document
forall x. Document -> Rep Document x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cfrom :: forall x. Document -> Rep Document x
from :: forall x. Document -> Rep Document x
$cto :: forall x. Rep Document x -> Document
to :: forall x. Rep Document x -> Document
Generic, Int -> Document -> ShowS
[Document] -> ShowS
Document -> String
(Int -> Document -> ShowS)
-> (Document -> String) -> ([Document] -> ShowS) -> Show Document
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
$cshowsPrec :: Int -> Document -> ShowS
showsPrec :: Int -> Document -> ShowS
$cshow :: Document -> String
show :: Document -> String
$cshowList :: [Document] -> ShowS
showList :: [Document] -> ShowS
Show)
      deriving anyclass (Maybe Document
Value -> Parser [Document]
Value -> Parser Document
(Value -> Parser Document)
-> (Value -> Parser [Document])
-> Maybe Document
-> FromJSON Document
forall a.
(Value -> Parser a)
-> (Value -> Parser [a]) -> Maybe a -> FromJSON a
$cparseJSON :: Value -> Parser Document
parseJSON :: Value -> Parser Document
$cparseJSONList :: Value -> Parser [Document]
parseJSONList :: Value -> Parser [Document]
$comittedField :: Maybe Document
omittedField :: Maybe Document
FromJSON, [Document] -> Value
[Document] -> Encoding
Document -> Bool
Document -> Value
Document -> Encoding
(Document -> Value)
-> (Document -> Encoding)
-> ([Document] -> Value)
-> ([Document] -> Encoding)
-> (Document -> Bool)
-> ToJSON Document
forall a.
(a -> Value)
-> (a -> Encoding)
-> ([a] -> Value)
-> ([a] -> Encoding)
-> (a -> Bool)
-> ToJSON a
$ctoJSON :: Document -> Value
toJSON :: Document -> Value
$ctoEncoding :: Document -> Encoding
toEncoding :: Document -> Encoding
$ctoJSONList :: [Document] -> Value
toJSONList :: [Document] -> Value
$ctoEncodingList :: [Document] -> Encoding
toEncodingList :: [Document] -> Encoding
$comitField :: Document -> Bool
omitField :: Document -> Bool
ToJSON)

-- | Usage statistics for the model inference.
data Usage = Usage
    { Usage -> Natural
rerank_units :: Natural
    } deriving stock (Usage -> Usage -> Bool
(Usage -> Usage -> Bool) -> (Usage -> Usage -> Bool) -> Eq Usage
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
$c== :: Usage -> Usage -> Bool
== :: Usage -> Usage -> Bool
$c/= :: Usage -> Usage -> Bool
/= :: Usage -> Usage -> Bool
Eq, (forall x. Usage -> Rep Usage x)
-> (forall x. Rep Usage x -> Usage) -> Generic Usage
forall x. Rep Usage x -> Usage
forall x. Usage -> Rep Usage x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cfrom :: forall x. Usage -> Rep Usage x
from :: forall x. Usage -> Rep Usage x
$cto :: forall x. Rep Usage x -> Usage
to :: forall x. Rep Usage x -> Usage
Generic, Int -> Usage -> ShowS
[Usage] -> ShowS
Usage -> String
(Int -> Usage -> ShowS)
-> (Usage -> String) -> ([Usage] -> ShowS) -> Show Usage
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
$cshowsPrec :: Int -> Usage -> ShowS
showsPrec :: Int -> Usage -> ShowS
$cshow :: Usage -> String
show :: Usage -> String
$cshowList :: [Usage] -> ShowS
showList :: [Usage] -> ShowS
Show)
      deriving anyclass (Maybe Usage
Value -> Parser [Usage]
Value -> Parser Usage
(Value -> Parser Usage)
-> (Value -> Parser [Usage]) -> Maybe Usage -> FromJSON Usage
forall a.
(Value -> Parser a)
-> (Value -> Parser [a]) -> Maybe a -> FromJSON a
$cparseJSON :: Value -> Parser Usage
parseJSON :: Value -> Parser Usage
$cparseJSONList :: Value -> Parser [Usage]
parseJSONList :: Value -> Parser [Usage]
$comittedField :: Maybe Usage
omittedField :: Maybe Usage
FromJSON, [Usage] -> Value
[Usage] -> Encoding
Usage -> Bool
Usage -> Value
Usage -> Encoding
(Usage -> Value)
-> (Usage -> Encoding)
-> ([Usage] -> Value)
-> ([Usage] -> Encoding)
-> (Usage -> Bool)
-> ToJSON Usage
forall a.
(a -> Value)
-> (a -> Encoding)
-> ([a] -> Value)
-> ([a] -> Encoding)
-> (a -> Bool)
-> ToJSON a
$ctoJSON :: Usage -> Value
toJSON :: Usage -> Value
$ctoEncoding :: Usage -> Encoding
toEncoding :: Usage -> Encoding
$ctoJSONList :: [Usage] -> Value
toJSONList :: [Usage] -> Value
$ctoEncodingList :: [Usage] -> Encoding
toEncodingList :: [Usage] -> Encoding
$comitField :: Usage -> Bool
omitField :: Usage -> Bool
ToJSON)

-- | Servant API
type API =
    "rerank" :> ReqBody '[JSON] RerankResults :> Post '[JSON] Documents