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

Class DescribeQuerySuggestionsConfigResponse

    • Method Detail

      • 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:
        Mode

      • 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:
        Mode

      • 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:
        QuerySuggestionsStatus

      • 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:
        QuerySuggestionsStatus

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

      • 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