software.amazon.awssdk.services.kendra.model

Class GetQuerySuggestionsRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetQuerySuggestionsRequest.Builder,GetQuerySuggestionsRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class GetQuerySuggestionsRequest
extends KendraRequest
implements ToCopyableBuilder<GetQuerySuggestionsRequest.Builder,GetQuerySuggestionsRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetQuerySuggestionsRequest.Builder

Method Summary

Modifier and Type	Method and Description
AttributeSuggestionsGetConfig	attributeSuggestionsConfig() Configuration information for the document fields/attributes that you want to base query suggestions on.
static GetQuerySuggestionsRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasSuggestionTypes() For responses, this returns true if the service returned a value for the SuggestionTypes property.
String	indexId() The identifier of the index you want to get query suggestions from.
Integer	maxSuggestionsCount() The maximum number of query suggestions you want to show to your users.
String	queryText() The text of a user's query to generate query suggestions.
List<SdkField<?>>	sdkFields()
static Class<? extends GetQuerySuggestionsRequest.Builder>	serializableBuilderClass()
List<SuggestionType>	suggestionTypes() The suggestions type to base query suggestions on.
List<String>	suggestionTypesAsStrings() The suggestions type to base query suggestions on.
GetQuerySuggestionsRequest.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 you want to get query suggestions from.

Returns:

The identifier of the index you want to get query suggestions from.

queryText

public final String queryText()

The text of a user's query to generate query suggestions.

A query is suggested if the query prefix matches what a user starts to type as their query.

Amazon Kendra does not show any suggestions if a user types fewer than two characters or more than 60 characters. A query must also have at least one search result and contain at least one word of more than four characters.

Returns:

The text of a user's query to generate query suggestions.

A query is suggested if the query prefix matches what a user starts to type as their query.

Amazon Kendra does not show any suggestions if a user types fewer than two characters or more than 60 characters. A query must also have at least one search result and contain at least one word of more than four characters.

maxSuggestionsCount

public final Integer maxSuggestionsCount()

The maximum number of query suggestions you want to show to your users.

Returns:

The maximum number of query suggestions you want to show to your users.

suggestionTypes

public final List<SuggestionType> suggestionTypes()

The suggestions type to base query suggestions on. The suggestion types are query history or document fields/attributes. You can set one type or the other.

If you set query history as your suggestions type, Amazon Kendra suggests queries relevant to your users based on popular queries in the query history.

If you set document fields/attributes as your suggestions type, Amazon Kendra suggests queries relevant to your users based on the contents of document fields.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSuggestionTypes() method.

Returns:

The suggestions type to base query suggestions on. The suggestion types are query history or document fields/attributes. You can set one type or the other.

If you set query history as your suggestions type, Amazon Kendra suggests queries relevant to your users based on popular queries in the query history.

If you set document fields/attributes as your suggestions type, Amazon Kendra suggests queries relevant to your users based on the contents of document fields.

hasSuggestionTypes

public final boolean hasSuggestionTypes()

For responses, this returns true if the service returned a value for the SuggestionTypes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

suggestionTypesAsStrings

public final List<String> suggestionTypesAsStrings()

The suggestions type to base query suggestions on. The suggestion types are query history or document fields/attributes. You can set one type or the other.

If you set query history as your suggestions type, Amazon Kendra suggests queries relevant to your users based on popular queries in the query history.

If you set document fields/attributes as your suggestions type, Amazon Kendra suggests queries relevant to your users based on the contents of document fields.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSuggestionTypes() method.

Returns:

The suggestions type to base query suggestions on. The suggestion types are query history or document fields/attributes. You can set one type or the other.

If you set query history as your suggestions type, Amazon Kendra suggests queries relevant to your users based on popular queries in the query history.

If you set document fields/attributes as your suggestions type, Amazon Kendra suggests queries relevant to your users based on the contents of document fields.

attributeSuggestionsConfig

public final AttributeSuggestionsGetConfig 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 GetQuerySuggestionsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetQuerySuggestionsRequest.Builder,GetQuerySuggestionsRequest>

Specified by:

toBuilder in class KendraRequest

builder

public static GetQuerySuggestionsRequest.Builder builder()

serializableBuilderClass

public static Class<? extends GetQuerySuggestionsRequest.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