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

Description

Documentation

data DocumentMetadataConfiguration Source #

Specifies the properties, such as relevance tuning and searchability, of an index field.

See: newDocumentMetadataConfiguration smart constructor.

Constructors

DocumentMetadataConfiguration'
Fields relevance :: Maybe Relevance Provides tuning parameters to determine how the field affects the search results. search :: Maybe Search Provides information about how the field is used during a search. name :: Text The name of the index field. type' :: DocumentAttributeValueType The data type of the index field.

Instances

Instances details

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

newDocumentMetadataConfiguration Source #

Arguments

:: Text	`$sel:name:DocumentMetadataConfiguration'`
-> DocumentAttributeValueType	`$sel:type':DocumentMetadataConfiguration'`
-> DocumentMetadataConfiguration

Create a value of DocumentMetadataConfiguration 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:relevance:DocumentMetadataConfiguration', documentMetadataConfiguration_relevance - Provides tuning parameters to determine how the field affects the search results.

$sel:search:DocumentMetadataConfiguration', documentMetadataConfiguration_search - Provides information about how the field is used during a search.

$sel:name:DocumentMetadataConfiguration', documentMetadataConfiguration_name - The name of the index field.

$sel:type':DocumentMetadataConfiguration', documentMetadataConfiguration_type - The data type of the index field.

documentMetadataConfiguration_relevance :: Lens' DocumentMetadataConfiguration (Maybe Relevance) Source #

Provides tuning parameters to determine how the field affects the search results.

documentMetadataConfiguration_search :: Lens' DocumentMetadataConfiguration (Maybe Search) Source #

Provides information about how the field is used during a search.

documentMetadataConfiguration_name :: Lens' DocumentMetadataConfiguration Text Source #

The name of the index field.

documentMetadataConfiguration_type :: Lens' DocumentMetadataConfiguration DocumentAttributeValueType Source #

The data type of the index field.