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.LexV2Models.Types.KendraConfiguration

Description

Documentation

data KendraConfiguration Source #

Provides configuration information for the AMAZON.KendraSearchIntent intent. When you use this intent, Amazon Lex searches the specified Amazon Kendra index and returns documents from the index that match the user's utterance.

See: newKendraConfiguration smart constructor.

Constructors

KendraConfiguration'

Fields

queryFilterString :: Maybe Text
A query filter that Amazon Lex sends to Amazon Kendra to filter the response from a query. The filter is in the format defined by Amazon Kendra. For more information, see Filtering queries.
queryFilterStringEnabled :: Maybe Bool
Determines whether the AMAZON.KendraSearchIntent intent uses a custom query string to query the Amazon Kendra index.
kendraIndex :: Text
The Amazon Resource Name (ARN) of the Amazon Kendra index that you want the AMAZON.KendraSearchIntent intent to search. The index must be in the same account and Region as the Amazon Lex bot.

Instances

Instances details

FromJSON KendraConfiguration Source #
Instance details Defined in Amazonka.LexV2Models.Types.KendraConfiguration Methods parseJSON :: Value -> Parser KendraConfiguration # parseJSONList :: Value -> Parser [KendraConfiguration] #
ToJSON KendraConfiguration Source #
Instance details Defined in Amazonka.LexV2Models.Types.KendraConfiguration Methods toJSON :: KendraConfiguration -> Value # toEncoding :: KendraConfiguration -> Encoding # toJSONList :: [KendraConfiguration] -> Value # toEncodingList :: [KendraConfiguration] -> Encoding #
Generic KendraConfiguration Source #
Instance details Defined in Amazonka.LexV2Models.Types.KendraConfiguration Associated Types type Rep KendraConfiguration :: Type -> Type # Methods from :: KendraConfiguration -> Rep KendraConfiguration x # to :: Rep KendraConfiguration x -> KendraConfiguration #
Read KendraConfiguration Source #
Instance details Defined in Amazonka.LexV2Models.Types.KendraConfiguration Methods readsPrec :: Int -> ReadS KendraConfiguration # readList :: ReadS [KendraConfiguration] # readPrec :: ReadPrec KendraConfiguration # readListPrec :: ReadPrec [KendraConfiguration] #
Show KendraConfiguration Source #
Instance details Defined in Amazonka.LexV2Models.Types.KendraConfiguration Methods showsPrec :: Int -> KendraConfiguration -> ShowS # show :: KendraConfiguration -> String # showList :: [KendraConfiguration] -> ShowS #
NFData KendraConfiguration Source #
Instance details Defined in Amazonka.LexV2Models.Types.KendraConfiguration Methods rnf :: KendraConfiguration -> () #
Eq KendraConfiguration Source #
Instance details Defined in Amazonka.LexV2Models.Types.KendraConfiguration Methods (==) :: KendraConfiguration -> KendraConfiguration -> Bool # (/=) :: KendraConfiguration -> KendraConfiguration -> Bool #
Hashable KendraConfiguration Source #
Instance details Defined in Amazonka.LexV2Models.Types.KendraConfiguration Methods hashWithSalt :: Int -> KendraConfiguration -> Int # hash :: KendraConfiguration -> Int #
type Rep KendraConfiguration Source #
Instance details Defined in Amazonka.LexV2Models.Types.KendraConfiguration type Rep KendraConfiguration = D1 ('MetaData "KendraConfiguration" "Amazonka.LexV2Models.Types.KendraConfiguration" "amazonka-lexv2-models-2.0-5mExjJXBfuO6j0ascNcayE" 'False) (C1 ('MetaCons "KendraConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "queryFilterString") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "queryFilterStringEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "kendraIndex") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newKendraConfiguration Source #

Arguments

:: Text	`$sel:kendraIndex:KendraConfiguration'`
-> KendraConfiguration

Create a value of KendraConfiguration 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:queryFilterString:KendraConfiguration', kendraConfiguration_queryFilterString - A query filter that Amazon Lex sends to Amazon Kendra to filter the response from a query. The filter is in the format defined by Amazon Kendra. For more information, see Filtering queries.

$sel:queryFilterStringEnabled:KendraConfiguration', kendraConfiguration_queryFilterStringEnabled - Determines whether the AMAZON.KendraSearchIntent intent uses a custom query string to query the Amazon Kendra index.

$sel:kendraIndex:KendraConfiguration', kendraConfiguration_kendraIndex - The Amazon Resource Name (ARN) of the Amazon Kendra index that you want the AMAZON.KendraSearchIntent intent to search. The index must be in the same account and Region as the Amazon Lex bot.

kendraConfiguration_queryFilterString :: Lens' KendraConfiguration (Maybe Text) Source #

A query filter that Amazon Lex sends to Amazon Kendra to filter the response from a query. The filter is in the format defined by Amazon Kendra. For more information, see Filtering queries.

kendraConfiguration_queryFilterStringEnabled :: Lens' KendraConfiguration (Maybe Bool) Source #

Determines whether the AMAZON.KendraSearchIntent intent uses a custom query string to query the Amazon Kendra index.

kendraConfiguration_kendraIndex :: Lens' KendraConfiguration Text Source #

The Amazon Resource Name (ARN) of the Amazon Kendra index that you want the AMAZON.KendraSearchIntent intent to search. The index must be in the same account and Region as the Amazon Lex bot.