Package software.amazon.awssdk.services.kendra.model

Interface UpdateQuerySuggestionsConfigRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<UpdateQuerySuggestionsConfigRequest.Builder,UpdateQuerySuggestionsConfigRequest>, KendraRequest.Builder, SdkBuilder<UpdateQuerySuggestionsConfigRequest.Builder,UpdateQuerySuggestionsConfigRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
UpdateQuerySuggestionsConfigRequest
public static interface UpdateQuerySuggestionsConfigRequest.Builder extends KendraRequest.Builder, SdkPojo, CopyableBuilder<UpdateQuerySuggestionsConfigRequest.Builder,UpdateQuerySuggestionsConfigRequest>

  • Method Details

    • indexId

      UpdateQuerySuggestionsConfigRequest.Builder indexId(String indexId)

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

      Parameters:
      indexId - The identifier of the index with query suggestions you want to update.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • mode

      UpdateQuerySuggestionsConfigRequest.Builder mode(String 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • mode

      UpdateQuerySuggestionsConfigRequest.Builder mode(Mode 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • queryLogLookBackWindowInDays

      UpdateQuerySuggestionsConfigRequest.Builder queryLogLookBackWindowInDays(Integer 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • includeQueriesWithoutUserInformation

      UpdateQuerySuggestionsConfigRequest.Builder includeQueriesWithoutUserInformation(Boolean 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • minimumNumberOfQueryingUsers

      UpdateQuerySuggestionsConfigRequest.Builder minimumNumberOfQueryingUsers(Integer 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • minimumQueryCount

      UpdateQuerySuggestionsConfigRequest.Builder minimumQueryCount(Integer 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • attributeSuggestionsConfig

      UpdateQuerySuggestionsConfigRequest.Builder attributeSuggestionsConfig(AttributeSuggestionsUpdateConfig attributeSuggestionsConfig)

      Configuration information for the document fields/attributes that you want to base query suggestions on.

      Parameters:
      attributeSuggestionsConfig - Configuration information for the document fields/attributes that you want to base query suggestions on.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • attributeSuggestionsConfig

      default UpdateQuerySuggestionsConfigRequest.Builder attributeSuggestionsConfig(Consumer<AttributeSuggestionsUpdateConfig.Builder> attributeSuggestionsConfig)

      Configuration information for the document fields/attributes that you want to base query suggestions on.

      This is a convenience method that creates an instance of the AttributeSuggestionsUpdateConfig.Builder avoiding the need to create one manually via AttributeSuggestionsUpdateConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to attributeSuggestionsConfig(AttributeSuggestionsUpdateConfig).

      Parameters:
      attributeSuggestionsConfig - a consumer that will call methods on AttributeSuggestionsUpdateConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      UpdateQuerySuggestionsConfigRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      UpdateQuerySuggestionsConfigRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.