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

Class UpdateQuerySuggestionsConfigRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.kendra.model.KendraRequest

software.amazon.awssdk.services.kendra.model.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>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UpdateQuerySuggestionsConfigRequest.Builder

Method Summary

Modifier and Type	Method	Description
AttributeSuggestionsUpdateConfig	attributeSuggestionsConfig()	Configuration information for the document fields/attributes that you want to base query suggestions on.
static UpdateQuerySuggestionsConfigRequest.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 include queries without user information (i.e.
String	indexId()	The identifier of the index with query suggestions you want to update.
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 the minimum number of times a query must be searched in order to be eligible to suggest to your users.
Mode	mode()	Set the mode to ENABLED or LEARN_ONLY.
String	modeAsString()	Set the mode to ENABLED or LEARN_ONLY.
Integer	queryLogLookBackWindowInDays()	How recent your queries are in your query log time window.
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateQuerySuggestionsConfigRequest.Builder>	serializableBuilderClass()
UpdateQuerySuggestionsConfigRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

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:

Mode

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:

Mode

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

public UpdateQuerySuggestionsConfigRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateQuerySuggestionsConfigRequest.Builder,UpdateQuerySuggestionsConfigRequest>

Specified by:

toBuilder in class KendraRequest

builder

public static UpdateQuerySuggestionsConfigRequest.Builder 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)

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 SdkRequest

sdkFields

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

Specified by:

sdkFields in interface SdkPojo