Class UpdateQuerySuggestionsConfigRequest

All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<UpdateQuerySuggestionsConfigRequest.Builder,UpdateQuerySuggestionsConfigRequest>

@Generated("software.amazon.awssdk:codegen") public final class UpdateQuerySuggestionsConfigRequest extends KendraRequest implements ToCopyableBuilder<UpdateQuerySuggestionsConfigRequest.Builder,UpdateQuerySuggestionsConfigRequest>
  • Method Details

    • indexId

      public final String indexId()

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

      Returns:
      The identifier of the index with query suggestions you want to update.
    • mode

      public final 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.

      If the service returns an enum value that is not available in the current SDK version, mode will return Mode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from modeAsString().

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

      See Also:
    • modeAsString

      public final String modeAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, mode will return Mode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from modeAsString().

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

      See Also:
    • queryLogLookBackWindowInDays

      public final 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.

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

    • includeQueriesWithoutUserInformation

      public final 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.

      Returns:
      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

      public final 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.

      Returns:
      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

      public final 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.

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

    • attributeSuggestionsConfig

      public final AttributeSuggestionsUpdateConfig attributeSuggestionsConfig()

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

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

      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<UpdateQuerySuggestionsConfigRequest.Builder,UpdateQuerySuggestionsConfigRequest>
      Specified by:
      toBuilder in class KendraRequest
      Returns:
      a builder for type T
    • builder

    • serializableBuilderClass

      public static Class<? extends UpdateQuerySuggestionsConfigRequest.Builder> serializableBuilderClass()
    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest
    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest
    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.
    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object
    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value
    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.