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.DocumentRelevanceConfiguration

Description

Synopsis

Documentation

data DocumentRelevanceConfiguration Source #

Overrides the document relevance properties of a custom index field.

See: newDocumentRelevanceConfiguration smart constructor.

Constructors

DocumentRelevanceConfiguration'
Fields name :: Text The name of the index field. relevance :: Relevance Provides information for tuning the relevance of a field in a search. When a query includes terms that match the field, the results are given a boost in the response based on these tuning parameters.

Instances

Instances details

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

newDocumentRelevanceConfiguration Source #

Arguments

:: Text	`$sel:name:DocumentRelevanceConfiguration'`
-> Relevance	`$sel:relevance:DocumentRelevanceConfiguration'`
-> DocumentRelevanceConfiguration

Create a value of DocumentRelevanceConfiguration 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:name:DocumentRelevanceConfiguration', documentRelevanceConfiguration_name - The name of the index field.

$sel:relevance:DocumentRelevanceConfiguration', documentRelevanceConfiguration_relevance - Provides information for tuning the relevance of a field in a search. When a query includes terms that match the field, the results are given a boost in the response based on these tuning parameters.

documentRelevanceConfiguration_name :: Lens' DocumentRelevanceConfiguration Text Source #

The name of the index field.

documentRelevanceConfiguration_relevance :: Lens' DocumentRelevanceConfiguration Relevance Source #

Provides information for tuning the relevance of a field in a search. When a query includes terms that match the field, the results are given a boost in the response based on these tuning parameters.