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

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

Updates the settings of query suggestions for an index.

Amazon Kendra supports partial updates, so you only need to provide the fields you want to update.

If an update is currently processing (i.e. 'happening'), you need to wait for the update to finish before making another update.

Updates to query suggestions settings might not take effect right away. The time for your updated settings to take effect depends on the updates made and the number of search queries in your index.

You can still enable/disable query suggestions at any time.

UpdateQuerySuggestionsConfig is currently not supported in the Amazon Web Services GovCloud (US-West) region.

Synopsis

data UpdateQuerySuggestionsConfig = UpdateQuerySuggestionsConfig' {
- includeQueriesWithoutUserInformation :: Maybe Bool
- minimumNumberOfQueryingUsers :: Maybe Natural
- minimumQueryCount :: Maybe Natural
- mode :: Maybe Mode
- queryLogLookBackWindowInDays :: Maybe Int
- indexId :: Text
}
newUpdateQuerySuggestionsConfig :: Text -> UpdateQuerySuggestionsConfig
updateQuerySuggestionsConfig_includeQueriesWithoutUserInformation :: Lens' UpdateQuerySuggestionsConfig (Maybe Bool)
updateQuerySuggestionsConfig_minimumNumberOfQueryingUsers :: Lens' UpdateQuerySuggestionsConfig (Maybe Natural)
updateQuerySuggestionsConfig_minimumQueryCount :: Lens' UpdateQuerySuggestionsConfig (Maybe Natural)
updateQuerySuggestionsConfig_mode :: Lens' UpdateQuerySuggestionsConfig (Maybe Mode)
updateQuerySuggestionsConfig_queryLogLookBackWindowInDays :: Lens' UpdateQuerySuggestionsConfig (Maybe Int)
updateQuerySuggestionsConfig_indexId :: Lens' UpdateQuerySuggestionsConfig Text
data UpdateQuerySuggestionsConfigResponse = UpdateQuerySuggestionsConfigResponse' {
}
newUpdateQuerySuggestionsConfigResponse :: UpdateQuerySuggestionsConfigResponse

Creating a Request

data UpdateQuerySuggestionsConfig Source #

See: newUpdateQuerySuggestionsConfig smart constructor.

Constructors

UpdateQuerySuggestionsConfig'

Fields

includeQueriesWithoutUserInformation :: Maybe Bool
TRUE to include queries without user information (i.e. all queries, irrespective of the user), otherwise FALSE to only include queries with user information.
If you pass user information to Amazon Kendra along with the queries, you can set this flag to FALSE and instruct Amazon Kendra to only consider queries with user information.
If you set to FALSE, Amazon Kendra only considers queries searched at least MinimumQueryCount times across MinimumNumberOfQueryingUsers unique users for suggestions.
If you set to TRUE, Amazon Kendra ignores all user information and learns from all queries.
minimumNumberOfQueryingUsers :: Maybe Natural
The minimum number of unique users who must search a query in order for the query to be eligible to suggest to your users.
Increasing this number might decrease the number of suggestions. However, this ensures a query is searched by many users and is truly popular to suggest to users.
How you tune this setting depends on your specific needs.
minimumQueryCount :: Maybe Natural
The the minimum number of times a query must be searched in order to be eligible to suggest to your users.
Decreasing this number increases the number of suggestions. However, this affects the quality of suggestions as it sets a low bar for a query to be considered popular to suggest to users.
How you tune this setting depends on your specific needs.
mode :: Maybe Mode
Set the mode to ENABLED or LEARN_ONLY.
By default, Amazon Kendra enables query suggestions. LEARN_ONLY mode allows you to turn off query suggestions. You can to update this at any time.
In LEARN_ONLY mode, Amazon Kendra continues to learn from new queries to keep suggestions up to date for when you are ready to switch to ENABLED mode again.
queryLogLookBackWindowInDays :: Maybe Int
How recent your queries are in your query log time window.
The time window is the number of days from current day to past days.
By default, Amazon Kendra sets this to 180.
indexId :: Text
The identifier of the index with query suggestions you want to update.

Instances

Instances details

ToJSON UpdateQuerySuggestionsConfig Source #
Instance details Defined in Amazonka.Kendra.UpdateQuerySuggestionsConfig Methods toJSON :: UpdateQuerySuggestionsConfig -> Value # toEncoding :: UpdateQuerySuggestionsConfig -> Encoding # toJSONList :: [UpdateQuerySuggestionsConfig] -> Value # toEncodingList :: [UpdateQuerySuggestionsConfig] -> Encoding #
ToHeaders UpdateQuerySuggestionsConfig Source #
Instance details Defined in Amazonka.Kendra.UpdateQuerySuggestionsConfig Methods toHeaders :: UpdateQuerySuggestionsConfig -> [Header] #
ToPath UpdateQuerySuggestionsConfig Source #
Instance details Defined in Amazonka.Kendra.UpdateQuerySuggestionsConfig Methods toPath :: UpdateQuerySuggestionsConfig -> ByteString #
ToQuery UpdateQuerySuggestionsConfig Source #
Instance details Defined in Amazonka.Kendra.UpdateQuerySuggestionsConfig Methods toQuery :: UpdateQuerySuggestionsConfig -> QueryString #
AWSRequest UpdateQuerySuggestionsConfig Source #
Instance details Defined in Amazonka.Kendra.UpdateQuerySuggestionsConfig Associated Types type AWSResponse UpdateQuerySuggestionsConfig # Methods request :: (Service -> Service) -> UpdateQuerySuggestionsConfig -> Request UpdateQuerySuggestionsConfig # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateQuerySuggestionsConfig -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateQuerySuggestionsConfig))) #
Generic UpdateQuerySuggestionsConfig Source #
Instance details Defined in Amazonka.Kendra.UpdateQuerySuggestionsConfig Associated Types type Rep UpdateQuerySuggestionsConfig :: Type -> Type # Methods from :: UpdateQuerySuggestionsConfig -> Rep UpdateQuerySuggestionsConfig x # to :: Rep UpdateQuerySuggestionsConfig x -> UpdateQuerySuggestionsConfig #
Read UpdateQuerySuggestionsConfig Source #
Instance details Defined in Amazonka.Kendra.UpdateQuerySuggestionsConfig Methods readsPrec :: Int -> ReadS UpdateQuerySuggestionsConfig # readList :: ReadS [UpdateQuerySuggestionsConfig] # readPrec :: ReadPrec UpdateQuerySuggestionsConfig # readListPrec :: ReadPrec [UpdateQuerySuggestionsConfig] #
Show UpdateQuerySuggestionsConfig Source #
Instance details Defined in Amazonka.Kendra.UpdateQuerySuggestionsConfig Methods showsPrec :: Int -> UpdateQuerySuggestionsConfig -> ShowS # show :: UpdateQuerySuggestionsConfig -> String # showList :: [UpdateQuerySuggestionsConfig] -> ShowS #
NFData UpdateQuerySuggestionsConfig Source #
Instance details Defined in Amazonka.Kendra.UpdateQuerySuggestionsConfig Methods rnf :: UpdateQuerySuggestionsConfig -> () #
Eq UpdateQuerySuggestionsConfig Source #
Instance details Defined in Amazonka.Kendra.UpdateQuerySuggestionsConfig Methods (==) :: UpdateQuerySuggestionsConfig -> UpdateQuerySuggestionsConfig -> Bool # (/=) :: UpdateQuerySuggestionsConfig -> UpdateQuerySuggestionsConfig -> Bool #
Hashable UpdateQuerySuggestionsConfig Source #
Instance details Defined in Amazonka.Kendra.UpdateQuerySuggestionsConfig Methods hashWithSalt :: Int -> UpdateQuerySuggestionsConfig -> Int # hash :: UpdateQuerySuggestionsConfig -> Int #
type AWSResponse UpdateQuerySuggestionsConfig Source #
Instance details Defined in Amazonka.Kendra.UpdateQuerySuggestionsConfig type AWSResponse UpdateQuerySuggestionsConfig = UpdateQuerySuggestionsConfigResponse
type Rep UpdateQuerySuggestionsConfig Source #
Instance details Defined in Amazonka.Kendra.UpdateQuerySuggestionsConfig type Rep UpdateQuerySuggestionsConfig = D1 ('MetaData "UpdateQuerySuggestionsConfig" "Amazonka.Kendra.UpdateQuerySuggestionsConfig" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "UpdateQuerySuggestionsConfig'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "includeQueriesWithoutUserInformation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "minimumNumberOfQueryingUsers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "minimumQueryCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))) :: (S1 ('MetaSel ('Just "mode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Mode)) :: (S1 ('MetaSel ('Just "queryLogLookBackWindowInDays") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "indexId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newUpdateQuerySuggestionsConfig Source #

Arguments

:: Text	`$sel:indexId:UpdateQuerySuggestionsConfig'`
-> UpdateQuerySuggestionsConfig

Create a value of UpdateQuerySuggestionsConfig 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:includeQueriesWithoutUserInformation:UpdateQuerySuggestionsConfig', updateQuerySuggestionsConfig_includeQueriesWithoutUserInformation - TRUE to include queries without user information (i.e. all queries, irrespective of the user), otherwise FALSE to only include queries with user information.

If you pass user information to Amazon Kendra along with the queries, you can set this flag to FALSE and instruct Amazon Kendra to only consider queries with user information.

If you set to FALSE, Amazon Kendra only considers queries searched at least MinimumQueryCount times across MinimumNumberOfQueryingUsers unique users for suggestions.

If you set to TRUE, Amazon Kendra ignores all user information and learns from all queries.

$sel:minimumNumberOfQueryingUsers:UpdateQuerySuggestionsConfig', updateQuerySuggestionsConfig_minimumNumberOfQueryingUsers - The minimum number of unique users who must search a query in order for the query to be eligible to suggest to your users.

Increasing this number might decrease the number of suggestions. However, this ensures a query is searched by many users and is truly popular to suggest to users.

How you tune this setting depends on your specific needs.

$sel:minimumQueryCount:UpdateQuerySuggestionsConfig', updateQuerySuggestionsConfig_minimumQueryCount - The the minimum number of times a query must be searched in order to be eligible to suggest to your users.

Decreasing this number increases the number of suggestions. However, this affects the quality of suggestions as it sets a low bar for a query to be considered popular to suggest to users.

How you tune this setting depends on your specific needs.

$sel:mode:UpdateQuerySuggestionsConfig', updateQuerySuggestionsConfig_mode - Set the mode to ENABLED or LEARN_ONLY.

By default, Amazon Kendra enables query suggestions. LEARN_ONLY mode allows you to turn off query suggestions. You can to update this at any time.

In LEARN_ONLY mode, Amazon Kendra continues to learn from new queries to keep suggestions up to date for when you are ready to switch to ENABLED mode again.

$sel:queryLogLookBackWindowInDays:UpdateQuerySuggestionsConfig', updateQuerySuggestionsConfig_queryLogLookBackWindowInDays - How recent your queries are in your query log time window.

The time window is the number of days from current day to past days.

By default, Amazon Kendra sets this to 180.

$sel:indexId:UpdateQuerySuggestionsConfig', updateQuerySuggestionsConfig_indexId - The identifier of the index with query suggestions you want to update.

Request Lenses

updateQuerySuggestionsConfig_includeQueriesWithoutUserInformation :: Lens' UpdateQuerySuggestionsConfig (Maybe Bool) Source #

TRUE to include queries without user information (i.e. all queries, irrespective of the user), otherwise FALSE to only include queries with user information.

If you pass user information to Amazon Kendra along with the queries, you can set this flag to FALSE and instruct Amazon Kendra to only consider queries with user information.

If you set to FALSE, Amazon Kendra only considers queries searched at least MinimumQueryCount times across MinimumNumberOfQueryingUsers unique users for suggestions.

If you set to TRUE, Amazon Kendra ignores all user information and learns from all queries.

updateQuerySuggestionsConfig_minimumNumberOfQueryingUsers :: Lens' UpdateQuerySuggestionsConfig (Maybe Natural) Source #

The minimum number of unique users who must search a query in order for the query to be eligible to suggest to your users.

Increasing this number might decrease the number of suggestions. However, this ensures a query is searched by many users and is truly popular to suggest to users.

How you tune this setting depends on your specific needs.

updateQuerySuggestionsConfig_minimumQueryCount :: Lens' UpdateQuerySuggestionsConfig (Maybe Natural) Source #

The the minimum number of times a query must be searched in order to be eligible to suggest to your users.

Decreasing this number increases the number of suggestions. However, this affects the quality of suggestions as it sets a low bar for a query to be considered popular to suggest to users.

How you tune this setting depends on your specific needs.

updateQuerySuggestionsConfig_mode :: Lens' UpdateQuerySuggestionsConfig (Maybe Mode) Source #

Set the mode to ENABLED or LEARN_ONLY.

By default, Amazon Kendra enables query suggestions. LEARN_ONLY mode allows you to turn off query suggestions. You can to update this at any time.

In LEARN_ONLY mode, Amazon Kendra continues to learn from new queries to keep suggestions up to date for when you are ready to switch to ENABLED mode again.

updateQuerySuggestionsConfig_queryLogLookBackWindowInDays :: Lens' UpdateQuerySuggestionsConfig (Maybe Int) Source #

How recent your queries are in your query log time window.

The time window is the number of days from current day to past days.

By default, Amazon Kendra sets this to 180.

updateQuerySuggestionsConfig_indexId :: Lens' UpdateQuerySuggestionsConfig Text Source #

The identifier of the index with query suggestions you want to update.

Destructuring the Response

data UpdateQuerySuggestionsConfigResponse Source #

See: newUpdateQuerySuggestionsConfigResponse smart constructor.

Constructors

UpdateQuerySuggestionsConfigResponse'

Instances

Instances details

Generic UpdateQuerySuggestionsConfigResponse Source #
Instance details Defined in Amazonka.Kendra.UpdateQuerySuggestionsConfig Associated Types type Rep UpdateQuerySuggestionsConfigResponse :: Type -> Type # Methods from :: UpdateQuerySuggestionsConfigResponse -> Rep UpdateQuerySuggestionsConfigResponse x # to :: Rep UpdateQuerySuggestionsConfigResponse x -> UpdateQuerySuggestionsConfigResponse #
Read UpdateQuerySuggestionsConfigResponse Source #
Instance details Defined in Amazonka.Kendra.UpdateQuerySuggestionsConfig Methods readsPrec :: Int -> ReadS UpdateQuerySuggestionsConfigResponse # readList :: ReadS [UpdateQuerySuggestionsConfigResponse] # readPrec :: ReadPrec UpdateQuerySuggestionsConfigResponse # readListPrec :: ReadPrec [UpdateQuerySuggestionsConfigResponse] #
Show UpdateQuerySuggestionsConfigResponse Source #
Instance details Defined in Amazonka.Kendra.UpdateQuerySuggestionsConfig Methods showsPrec :: Int -> UpdateQuerySuggestionsConfigResponse -> ShowS # show :: UpdateQuerySuggestionsConfigResponse -> String # showList :: [UpdateQuerySuggestionsConfigResponse] -> ShowS #
NFData UpdateQuerySuggestionsConfigResponse Source #
Instance details Defined in Amazonka.Kendra.UpdateQuerySuggestionsConfig Methods rnf :: UpdateQuerySuggestionsConfigResponse -> () #
Eq UpdateQuerySuggestionsConfigResponse Source #
Instance details Defined in Amazonka.Kendra.UpdateQuerySuggestionsConfig Methods (==) :: UpdateQuerySuggestionsConfigResponse -> UpdateQuerySuggestionsConfigResponse -> Bool # (/=) :: UpdateQuerySuggestionsConfigResponse -> UpdateQuerySuggestionsConfigResponse -> Bool #
type Rep UpdateQuerySuggestionsConfigResponse Source #
Instance details Defined in Amazonka.Kendra.UpdateQuerySuggestionsConfig type Rep UpdateQuerySuggestionsConfigResponse = D1 ('MetaData "UpdateQuerySuggestionsConfigResponse" "Amazonka.Kendra.UpdateQuerySuggestionsConfig" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "UpdateQuerySuggestionsConfigResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newUpdateQuerySuggestionsConfigResponse :: UpdateQuerySuggestionsConfigResponse Source #

Create a value of UpdateQuerySuggestionsConfigResponse with all optional fields omitted.

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