Amazonka.Kendra.Types.RelevanceFeedback

Documentation

data RelevanceFeedback

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

ToJSON RelevanceFeedback

Defined in Amazonka.Kendra.Types.RelevanceFeedback

Methods

toJSON :: RelevanceFeedback -> Value

toEncoding :: RelevanceFeedback -> Encoding

toJSONList :: [RelevanceFeedback] -> Value

toEncodingList :: [RelevanceFeedback] -> Encoding

Generic RelevanceFeedback

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

Defined in Amazonka.Kendra.Types.RelevanceFeedback

Methods

readsPrec :: Int -> ReadS RelevanceFeedback

readList :: ReadS [RelevanceFeedback]

readPrec :: ReadPrec RelevanceFeedback

readListPrec :: ReadPrec [RelevanceFeedback]

Show RelevanceFeedback

Defined in Amazonka.Kendra.Types.RelevanceFeedback

Methods

showsPrec :: Int -> RelevanceFeedback -> ShowS

show :: RelevanceFeedback -> String

showList :: [RelevanceFeedback] -> ShowS

NFData RelevanceFeedback

Defined in Amazonka.Kendra.Types.RelevanceFeedback

Methods

rnf :: RelevanceFeedback -> ()

Eq RelevanceFeedback

Defined in Amazonka.Kendra.Types.RelevanceFeedback

Methods

(==) :: RelevanceFeedback -> RelevanceFeedback -> Bool

(/=) :: RelevanceFeedback -> RelevanceFeedback -> Bool

Hashable RelevanceFeedback

Defined in Amazonka.Kendra.Types.RelevanceFeedback

Methods

hashWithSalt :: Int -> RelevanceFeedback -> Int

hash :: RelevanceFeedback -> Int

type Rep RelevanceFeedback

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

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

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

relevanceFeedback_relevanceValue :: Lens' RelevanceFeedback RelevanceType

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