Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Kendra.Types.RelevanceFeedback

Description

Synopsis

data RelevanceFeedback = RelevanceFeedback' {
- resultId :: Text
- relevanceValue :: RelevanceType
}
newRelevanceFeedback :: Text -> RelevanceType -> RelevanceFeedback
relevanceFeedback_resultId :: Lens' RelevanceFeedback Text
relevanceFeedback_relevanceValue :: Lens' RelevanceFeedback RelevanceType

Documentation

data RelevanceFeedback Source #

Provides feedback on how relevant a document is to a search. Your application uses the SubmitFeedback API to provide relevance information.

See: newRelevanceFeedback smart constructor.

Constructors

RelevanceFeedback'
Fields resultId :: Text The identifier of the search result that the user provided relevance feedback for. relevanceValue :: RelevanceType Whether to document was relevant or not relevant to the search.

Instances

Instances details

ToJSON RelevanceFeedback Source #
Instance details Defined in Amazonka.Kendra.Types.RelevanceFeedback Methods toJSON :: RelevanceFeedback -> Value # toEncoding :: RelevanceFeedback -> Encoding # toJSONList :: [RelevanceFeedback] -> Value # toEncodingList :: [RelevanceFeedback] -> Encoding #
Generic RelevanceFeedback Source #
Instance details Defined in Amazonka.Kendra.Types.RelevanceFeedback Associated Types type Rep RelevanceFeedback :: Type -> Type # Methods from :: RelevanceFeedback -> Rep RelevanceFeedback x # to :: Rep RelevanceFeedback x -> RelevanceFeedback #
Read RelevanceFeedback Source #
Instance details Defined in Amazonka.Kendra.Types.RelevanceFeedback Methods readsPrec :: Int -> ReadS RelevanceFeedback # readList :: ReadS [RelevanceFeedback] # readPrec :: ReadPrec RelevanceFeedback # readListPrec :: ReadPrec [RelevanceFeedback] #
Show RelevanceFeedback Source #
Instance details Defined in Amazonka.Kendra.Types.RelevanceFeedback Methods showsPrec :: Int -> RelevanceFeedback -> ShowS # show :: RelevanceFeedback -> String # showList :: [RelevanceFeedback] -> ShowS #
NFData RelevanceFeedback Source #
Instance details Defined in Amazonka.Kendra.Types.RelevanceFeedback Methods rnf :: RelevanceFeedback -> () #
Eq RelevanceFeedback Source #
Instance details Defined in Amazonka.Kendra.Types.RelevanceFeedback Methods (==) :: RelevanceFeedback -> RelevanceFeedback -> Bool # (/=) :: RelevanceFeedback -> RelevanceFeedback -> Bool #
Hashable RelevanceFeedback Source #
Instance details Defined in Amazonka.Kendra.Types.RelevanceFeedback Methods hashWithSalt :: Int -> RelevanceFeedback -> Int # hash :: RelevanceFeedback -> Int #
type Rep RelevanceFeedback Source #
Instance details Defined in Amazonka.Kendra.Types.RelevanceFeedback type Rep RelevanceFeedback = D1 ('MetaData "RelevanceFeedback" "Amazonka.Kendra.Types.RelevanceFeedback" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "RelevanceFeedback'" 'PrefixI 'True) (S1 ('MetaSel ('Just "resultId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "relevanceValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 RelevanceType)))

newRelevanceFeedback Source #

Arguments

:: Text	`$sel:resultId:RelevanceFeedback'`
-> RelevanceType	`$sel:relevanceValue:RelevanceFeedback'`
-> RelevanceFeedback

Create a value of RelevanceFeedback with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:resultId:RelevanceFeedback', relevanceFeedback_resultId - The identifier of the search result that the user provided relevance feedback for.

$sel:relevanceValue:RelevanceFeedback', relevanceFeedback_relevanceValue - Whether to document was relevant or not relevant to the search.

relevanceFeedback_resultId :: Lens' RelevanceFeedback Text Source #

The identifier of the search result that the user provided relevance feedback for.

relevanceFeedback_relevanceValue :: Lens' RelevanceFeedback RelevanceType Source #

Whether to document was relevant or not relevant to the search.