software.amazon.awssdk.services.kendra.model

Interface DescribeQuerySuggestionsConfigResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<DescribeQuerySuggestionsConfigResponse.Builder,DescribeQuerySuggestionsConfigResponse>, KendraResponse.Builder, SdkBuilder<DescribeQuerySuggestionsConfigResponse.Builder,DescribeQuerySuggestionsConfigResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

DescribeQuerySuggestionsConfigResponse

public static interface DescribeQuerySuggestionsConfigResponse.Builder
extends KendraResponse.Builder, SdkPojo, CopyableBuilder<DescribeQuerySuggestionsConfigResponse.Builder,DescribeQuerySuggestionsConfigResponse>

Method Summary

Modifier and Type	Method and Description
DescribeQuerySuggestionsConfigResponse.Builder	includeQueriesWithoutUserInformation(Boolean includeQueriesWithoutUserInformation) TRUE to use all queries, otherwise use only queries that include user information to generate the query suggestions.
DescribeQuerySuggestionsConfigResponse.Builder	lastClearTime(Instant lastClearTime) The date-time query suggestions for an index was last cleared.
DescribeQuerySuggestionsConfigResponse.Builder	lastSuggestionsBuildTime(Instant lastSuggestionsBuildTime) The date-time query suggestions for an index was last updated.
DescribeQuerySuggestionsConfigResponse.Builder	minimumNumberOfQueryingUsers(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.
DescribeQuerySuggestionsConfigResponse.Builder	minimumQueryCount(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.
DescribeQuerySuggestionsConfigResponse.Builder	mode(Mode mode) Whether query suggestions are currently in ENABLED mode or LEARN_ONLY mode.
DescribeQuerySuggestionsConfigResponse.Builder	mode(String mode) Whether query suggestions are currently in ENABLED mode or LEARN_ONLY mode.
DescribeQuerySuggestionsConfigResponse.Builder	queryLogLookBackWindowInDays(Integer queryLogLookBackWindowInDays) How recent your queries are in your query log time window (in days).
DescribeQuerySuggestionsConfigResponse.Builder	status(QuerySuggestionsStatus status) Whether the status of query suggestions settings is currently ACTIVE or UPDATING.
DescribeQuerySuggestionsConfigResponse.Builder	status(String status) Whether the status of query suggestions settings is currently ACTIVE or UPDATING.
DescribeQuerySuggestionsConfigResponse.Builder	totalSuggestionsCount(Integer totalSuggestionsCount) The current total count of query suggestions for an index.

Methods inherited from interface software.amazon.awssdk.services.kendra.model.KendraResponse.Builder

build, responseMetadata, responseMetadata

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

mode

DescribeQuerySuggestionsConfigResponse.Builder mode(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Mode, Mode

mode

DescribeQuerySuggestionsConfigResponse.Builder mode(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Mode, Mode

status

DescribeQuerySuggestionsConfigResponse.Builder status(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

QuerySuggestionsStatus, QuerySuggestionsStatus

status

DescribeQuerySuggestionsConfigResponse.Builder status(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

QuerySuggestionsStatus, QuerySuggestionsStatus

queryLogLookBackWindowInDays

DescribeQuerySuggestionsConfigResponse.Builder queryLogLookBackWindowInDays(Integer queryLogLookBackWindowInDays)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

includeQueriesWithoutUserInformation

DescribeQuerySuggestionsConfigResponse.Builder includeQueriesWithoutUserInformation(Boolean includeQueriesWithoutUserInformation)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

minimumNumberOfQueryingUsers

DescribeQuerySuggestionsConfigResponse.Builder minimumNumberOfQueryingUsers(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

minimumQueryCount

DescribeQuerySuggestionsConfigResponse.Builder minimumQueryCount(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

lastSuggestionsBuildTime

DescribeQuerySuggestionsConfigResponse.Builder lastSuggestionsBuildTime(Instant lastSuggestionsBuildTime)

The date-time query suggestions for an index was last updated.

Parameters:

lastSuggestionsBuildTime - The date-time query suggestions for an index was last updated.

Returns:

Returns a reference to this object so that method calls can be chained together.

lastClearTime

DescribeQuerySuggestionsConfigResponse.Builder lastClearTime(Instant lastClearTime)

The date-time 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.

Parameters:

lastClearTime - The date-time 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:

Returns a reference to this object so that method calls can be chained together.

totalSuggestionsCount

DescribeQuerySuggestionsConfigResponse.Builder totalSuggestionsCount(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.