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(value="software.amazon.awssdk:codegen")
public final class DescribeQuerySuggestionsConfigResponse
extends KendraResponse
implements ToCopyableBuilder<DescribeQuerySuggestionsConfigResponse.Builder,DescribeQuerySuggestionsConfigResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeQuerySuggestionsConfigResponse.Builder

Method Summary

Modifier and Type	Method and Description
AttributeSuggestionsDescribeConfig	attributeSuggestionsConfig() Configuration information for the document fields/attributes that you want to base query suggestions on.
static DescribeQuerySuggestionsConfigResponse.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Boolean	includeQueriesWithoutUserInformation() TRUE to use all queries, otherwise use only queries that include user information to generate the query suggestions.
Instant	lastClearTime() The Unix timestamp when query suggestions for an index was last cleared.
Instant	lastSuggestionsBuildTime() The Unix timestamp when query suggestions for an index was last updated.
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.
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.
Mode	mode() Whether query suggestions are currently in ENABLED mode or LEARN_ONLY mode.
String	modeAsString() Whether query suggestions are currently in ENABLED mode or LEARN_ONLY mode.
Integer	queryLogLookBackWindowInDays() How recent your queries are in your query log time window (in days).
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeQuerySuggestionsConfigResponse.Builder>	serializableBuilderClass()
QuerySuggestionsStatus	status() Whether the status of query suggestions settings is currently ACTIVE or UPDATING.
String	statusAsString() Whether the status of query suggestions settings is currently ACTIVE or UPDATING.
DescribeQuerySuggestionsConfigResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.
Integer	totalSuggestionsCount() The current total count of query suggestions for an index.

Methods inherited from class software.amazon.awssdk.services.kendra.model.KendraResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

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.

toBuilder

public DescribeQuerySuggestionsConfigResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeQuerySuggestionsConfigResponse.Builder,DescribeQuerySuggestionsConfigResponse>

Overrides:

toBuilder in class AwsResponse

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo