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

Class DescribeQuerySuggestionsConfigResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.kendra.model.KendraResponse
software.amazon.awssdk.services.kendra.model.DescribeQuerySuggestionsConfigResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribeQuerySuggestionsConfigResponse.Builder,DescribeQuerySuggestionsConfigResponse>
@Generated("software.amazon.awssdk:codegen") public final class DescribeQuerySuggestionsConfigResponse extends KendraResponse implements ToCopyableBuilder<DescribeQuerySuggestionsConfigResponse.Builder,DescribeQuerySuggestionsConfigResponse>

  • Method Details

    • mode

      public final Mode mode()

      Whether query suggestions are currently in ENABLED mode or LEARN_ONLY mode.

      By default, Amazon Kendra enables query suggestions.LEARN_ONLY turns off query suggestions for your users. You can change the mode using the UpdateQuerySuggestionsConfig API.

      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:
      Whether query suggestions are currently in ENABLED mode or LEARN_ONLY mode.

      By default, Amazon Kendra enables query suggestions.LEARN_ONLY turns off query suggestions for your users. You can change the mode using the UpdateQuerySuggestionsConfig API.

      See Also:

    • modeAsString

      public final String modeAsString()

      Whether query suggestions are currently in ENABLED mode or LEARN_ONLY mode.

      By default, Amazon Kendra enables query suggestions.LEARN_ONLY turns off query suggestions for your users. You can change the mode using the UpdateQuerySuggestionsConfig API.

      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:
      Whether query suggestions are currently in ENABLED mode or LEARN_ONLY mode.

      By default, Amazon Kendra enables query suggestions.LEARN_ONLY turns off query suggestions for your users. You can change the mode using the UpdateQuerySuggestionsConfig API.

      See Also:

    • status

      public final QuerySuggestionsStatus status()

      Whether the status of query suggestions settings is currently ACTIVE or UPDATING.

      Active means the current settings apply and Updating means your changed settings are in the process of applying.

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

      Returns:
      Whether the status of query suggestions settings is currently ACTIVE or UPDATING.

      Active means the current settings apply and Updating means your changed settings are in the process of applying.

      See Also:

    • statusAsString

      public final String statusAsString()

      Whether the status of query suggestions settings is currently ACTIVE or UPDATING.

      Active means the current settings apply and Updating means your changed settings are in the process of applying.

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

      Returns:
      Whether the status of query suggestions settings is currently ACTIVE or UPDATING.

      Active means the current settings apply and Updating means your changed settings are in the process of applying.

      See Also:

    • queryLogLookBackWindowInDays

      public final Integer queryLogLookBackWindowInDays()

      How recent your queries are in your query log time window (in days).

      Returns:
      How recent your queries are in your query log time window (in days).

    • includeQueriesWithoutUserInformation

      public final Boolean includeQueriesWithoutUserInformation()

      TRUE to use all queries, otherwise use only queries that include user information to generate the query suggestions.

      Returns:
      TRUE to use all queries, otherwise use only queries that include user information to generate the query suggestions.

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

      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.

    • minimumQueryCount

      public final Integer minimumQueryCount()

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

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

    • lastSuggestionsBuildTime

      public final Instant lastSuggestionsBuildTime()

      The Unix timestamp when query suggestions for an index was last updated.

      Amazon Kendra automatically updates suggestions every 24 hours, after you change a setting or after you apply a block list.

      Returns:
      The Unix timestamp when query suggestions for an index was last updated.

      Amazon Kendra automatically updates suggestions every 24 hours, after you change a setting or after you apply a block list.

    • lastClearTime

      public final Instant lastClearTime()

      The Unix timestamp when query suggestions for an index was last cleared.

      After you clear suggestions, Amazon Kendra learns new suggestions based on new queries added to the query log from the time you cleared suggestions. Amazon Kendra only considers re-occurences of a query from the time you cleared suggestions.

      Returns:
      The Unix timestamp when query suggestions for an index was last cleared.

      After you clear suggestions, Amazon Kendra learns new suggestions based on new queries added to the query log from the time you cleared suggestions. Amazon Kendra only considers re-occurences of a query from the time you cleared suggestions.

    • totalSuggestionsCount

      public final Integer totalSuggestionsCount()

      The current total count of query suggestions for an index.

      This count can change when you update your query suggestions settings, if you filter out certain queries from suggestions using a block list, and as the query log accumulates more queries for Amazon Kendra to learn from.

      If the count is much lower than you expected, it could be because Amazon Kendra needs more queries in the query history to learn from or your current query suggestions settings are too strict.

      Returns:
      The current total count of query suggestions for an index.

      This count can change when you update your query suggestions settings, if you filter out certain queries from suggestions using a block list, and as the query log accumulates more queries for Amazon Kendra to learn from.

      If the count is much lower than you expected, it could be because Amazon Kendra needs more queries in the query history to learn from or your current query suggestions settings are too strict.

    • attributeSuggestionsConfig

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

      public DescribeQuerySuggestionsConfigResponse.Builder 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<DescribeQuerySuggestionsConfigResponse.Builder,DescribeQuerySuggestionsConfigResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static DescribeQuerySuggestionsConfigResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends DescribeQuerySuggestionsConfigResponse.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • 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: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. 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 SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      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.