com.amazonaws.services.kendra.model

Class UpdateQuerySuggestionsConfigRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.kendra.model.UpdateQuerySuggestionsConfigRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class UpdateQuerySuggestionsConfigRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
UpdateQuerySuggestionsConfigRequest()

Method Summary

Modifier and Type	Method and Description
UpdateQuerySuggestionsConfigRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
AttributeSuggestionsUpdateConfig	getAttributeSuggestionsConfig() Configuration information for the document fields/attributes that you want to base query suggestions on.
Boolean	getIncludeQueriesWithoutUserInformation() TRUE to include queries without user information (i.e.
String	getIndexId() The identifier of the index with query suggestions you want to update.
Integer	getMinimumNumberOfQueryingUsers() 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	getMinimumQueryCount() The the minimum number of times a query must be searched in order to be eligible to suggest to your users.
String	getMode() Set the mode to ENABLED or LEARN_ONLY.
Integer	getQueryLogLookBackWindowInDays() How recent your queries are in your query log time window.
int	hashCode()
Boolean	isIncludeQueriesWithoutUserInformation() TRUE to include queries without user information (i.e.
void	setAttributeSuggestionsConfig(AttributeSuggestionsUpdateConfig attributeSuggestionsConfig) Configuration information for the document fields/attributes that you want to base query suggestions on.
void	setIncludeQueriesWithoutUserInformation(Boolean includeQueriesWithoutUserInformation) TRUE to include queries without user information (i.e.
void	setIndexId(String indexId) The identifier of the index with query suggestions you want to update.
void	setMinimumNumberOfQueryingUsers(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.
void	setMinimumQueryCount(Integer minimumQueryCount) The the minimum number of times a query must be searched in order to be eligible to suggest to your users.
void	setMode(String mode) Set the mode to ENABLED or LEARN_ONLY.
void	setQueryLogLookBackWindowInDays(Integer queryLogLookBackWindowInDays) How recent your queries are in your query log time window.
String	toString() Returns a string representation of this object.
UpdateQuerySuggestionsConfigRequest	withAttributeSuggestionsConfig(AttributeSuggestionsUpdateConfig attributeSuggestionsConfig) Configuration information for the document fields/attributes that you want to base query suggestions on.
UpdateQuerySuggestionsConfigRequest	withIncludeQueriesWithoutUserInformation(Boolean includeQueriesWithoutUserInformation) TRUE to include queries without user information (i.e.
UpdateQuerySuggestionsConfigRequest	withIndexId(String indexId) The identifier of the index with query suggestions you want to update.
UpdateQuerySuggestionsConfigRequest	withMinimumNumberOfQueryingUsers(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.
UpdateQuerySuggestionsConfigRequest	withMinimumQueryCount(Integer minimumQueryCount) The the minimum number of times a query must be searched in order to be eligible to suggest to your users.
UpdateQuerySuggestionsConfigRequest	withMode(Mode mode) Set the mode to ENABLED or LEARN_ONLY.
UpdateQuerySuggestionsConfigRequest	withMode(String mode) Set the mode to ENABLED or LEARN_ONLY.
UpdateQuerySuggestionsConfigRequest	withQueryLogLookBackWindowInDays(Integer queryLogLookBackWindowInDays) How recent your queries are in your query log time window.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UpdateQuerySuggestionsConfigRequest

public UpdateQuerySuggestionsConfigRequest()

Method Detail

setIndexId

public void setIndexId(String indexId)

The identifier of the index with query suggestions you want to update.

Parameters:

indexId - The identifier of the index with query suggestions you want to update.

getIndexId

public String getIndexId()

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.

withIndexId

public UpdateQuerySuggestionsConfigRequest withIndexId(String indexId)

The identifier of the index with query suggestions you want to update.

Parameters:

indexId - The identifier of the index with query suggestions you want to update.

Returns:

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

setMode

public void setMode(String 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.

Parameters:

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.

See Also:

Mode

getMode

public String getMode()

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.

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

withMode

public UpdateQuerySuggestionsConfigRequest withMode(String 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.

Parameters:

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.

Returns:

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

See Also:

Mode

withMode

public UpdateQuerySuggestionsConfigRequest withMode(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.

Parameters:

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.

Returns:

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

See Also:

Mode

setQueryLogLookBackWindowInDays

public void setQueryLogLookBackWindowInDays(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.

Parameters:

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.

getQueryLogLookBackWindowInDays

public Integer getQueryLogLookBackWindowInDays()

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.

withQueryLogLookBackWindowInDays

public UpdateQuerySuggestionsConfigRequest withQueryLogLookBackWindowInDays(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.

Parameters:

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:

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

setIncludeQueriesWithoutUserInformation

public void setIncludeQueriesWithoutUserInformation(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.

Parameters:

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.

getIncludeQueriesWithoutUserInformation

public Boolean getIncludeQueriesWithoutUserInformation()

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.

withIncludeQueriesWithoutUserInformation

public UpdateQuerySuggestionsConfigRequest withIncludeQueriesWithoutUserInformation(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.

Parameters:

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:

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

isIncludeQueriesWithoutUserInformation

public Boolean isIncludeQueriesWithoutUserInformation()

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.

setMinimumNumberOfQueryingUsers

public void setMinimumNumberOfQueryingUsers(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.

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.

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.

getMinimumNumberOfQueryingUsers

public Integer getMinimumNumberOfQueryingUsers()

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.

withMinimumNumberOfQueryingUsers

public UpdateQuerySuggestionsConfigRequest withMinimumNumberOfQueryingUsers(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.

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.

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:

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

setMinimumQueryCount

public void setMinimumQueryCount(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.

Parameters:

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.

getMinimumQueryCount

public Integer getMinimumQueryCount()

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.

withMinimumQueryCount

public UpdateQuerySuggestionsConfigRequest withMinimumQueryCount(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.

Parameters:

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:

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

setAttributeSuggestionsConfig

public void setAttributeSuggestionsConfig(AttributeSuggestionsUpdateConfig attributeSuggestionsConfig)

Configuration information for the document fields/attributes that you want to base query suggestions on.

Parameters:

attributeSuggestionsConfig - Configuration information for the document fields/attributes that you want to base query suggestions on.

getAttributeSuggestionsConfig

public AttributeSuggestionsUpdateConfig getAttributeSuggestionsConfig()

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.

withAttributeSuggestionsConfig

public UpdateQuerySuggestionsConfigRequest withAttributeSuggestionsConfig(AttributeSuggestionsUpdateConfig attributeSuggestionsConfig)

Configuration information for the document fields/attributes that you want to base query suggestions on.

Parameters:

attributeSuggestionsConfig - Configuration information for the document fields/attributes that you want to base query suggestions on.

Returns:

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

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public UpdateQuerySuggestionsConfigRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()