software.amazon.awssdk.services.kendra.model

Class QueryRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<QueryRequest.Builder,QueryRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	QueryRequest.Builder

Method Summary

Modifier and Type	Method and Description
AttributeFilter	attributeFilter() Filters search results by document fields/attributes.
static QueryRequest.Builder	builder()
List<DocumentRelevanceConfiguration>	documentRelevanceOverrideConfigurations() Overrides relevance tuning configurations of fields/attributes set at the index level.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<Facet>	facets() An array of documents fields/attributes for faceted search.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasDocumentRelevanceOverrideConfigurations() For responses, this returns true if the service returned a value for the DocumentRelevanceOverrideConfigurations property.
boolean	hasFacets() For responses, this returns true if the service returned a value for the Facets property.
int	hashCode()
boolean	hasRequestedDocumentAttributes() For responses, this returns true if the service returned a value for the RequestedDocumentAttributes property.
String	indexId() The identifier of the index for the search.
Integer	pageNumber() Query results are returned in pages the size of the PageSize parameter.
Integer	pageSize() Sets the number of results that are returned in each page of results.
QueryResultType	queryResultTypeFilter() Sets the type of query result or response.
String	queryResultTypeFilterAsString() Sets the type of query result or response.
String	queryText() The input query text for the search.
List<String>	requestedDocumentAttributes() An array of document fields/attributes to include in the response.
List<SdkField<?>>	sdkFields()
static Class<? extends QueryRequest.Builder>	serializableBuilderClass()
SortingConfiguration	sortingConfiguration() Provides information that determines how the results of the query are sorted.
SpellCorrectionConfiguration	spellCorrectionConfiguration() Enables suggested spell corrections for queries.
QueryRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
UserContext	userContext() The user context token or user and group information.
String	visitorId() Provides an identifier for a specific user.

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 for the search.

Returns:

The identifier of the index for the search.

queryText

public final String queryText()

The input query text for the search. Amazon Kendra truncates queries at 30 token words, which excludes punctuation and stop words. Truncation still applies if you use Boolean or more advanced, complex queries.

Returns:

The input query text for the search. Amazon Kendra truncates queries at 30 token words, which excludes punctuation and stop words. Truncation still applies if you use Boolean or more advanced, complex queries.

attributeFilter

public final AttributeFilter attributeFilter()

Filters search results by document fields/attributes. You can only provide one attribute filter; however, the AndAllFilters, NotFilter, and OrAllFilters parameters contain a list of other filters.

The AttributeFilter parameter means you can create a set of filtering rules that a document must satisfy to be included in the query results.

Returns:

Filters search results by document fields/attributes. You can only provide one attribute filter; however, the AndAllFilters, NotFilter, and OrAllFilters parameters contain a list of other filters.

The AttributeFilter parameter means you can create a set of filtering rules that a document must satisfy to be included in the query results.

hasFacets

public final boolean hasFacets()

For responses, this returns true if the service returned a value for the Facets 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.

facets

public final List<Facet> facets()

An array of documents fields/attributes for faceted search. Amazon Kendra returns a count for each field key specified. This helps your users narrow their search.

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 hasFacets() method.

Returns:

An array of documents fields/attributes for faceted search. Amazon Kendra returns a count for each field key specified. This helps your users narrow their search.

hasRequestedDocumentAttributes

public final boolean hasRequestedDocumentAttributes()

For responses, this returns true if the service returned a value for the RequestedDocumentAttributes 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.

requestedDocumentAttributes

public final List<String> requestedDocumentAttributes()

An array of document fields/attributes to include in the response. You can limit the response to include certain document fields. By default, all document attributes are included in the response.

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 hasRequestedDocumentAttributes() method.

Returns:

An array of document fields/attributes to include in the response. You can limit the response to include certain document fields. By default, all document attributes are included in the response.

queryResultTypeFilter

public final QueryResultType queryResultTypeFilter()

Sets the type of query result or response. Only results for the specified type are returned.

If the service returns an enum value that is not available in the current SDK version, queryResultTypeFilter will return QueryResultType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from queryResultTypeFilterAsString().

Returns:

Sets the type of query result or response. Only results for the specified type are returned.

See Also:

QueryResultType

queryResultTypeFilterAsString

public final String queryResultTypeFilterAsString()

Sets the type of query result or response. Only results for the specified type are returned.

If the service returns an enum value that is not available in the current SDK version, queryResultTypeFilter will return QueryResultType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from queryResultTypeFilterAsString().

Returns:

Sets the type of query result or response. Only results for the specified type are returned.

See Also:

QueryResultType

hasDocumentRelevanceOverrideConfigurations

public final boolean hasDocumentRelevanceOverrideConfigurations()

For responses, this returns true if the service returned a value for the DocumentRelevanceOverrideConfigurations 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.

documentRelevanceOverrideConfigurations

public final List<DocumentRelevanceConfiguration> documentRelevanceOverrideConfigurations()

Overrides relevance tuning configurations of fields/attributes set at the index level.

If you use this API to override the relevance tuning configured at the index level, but there is no relevance tuning configured at the index level, then Amazon Kendra does not apply any relevance tuning.

If there is relevance tuning configured for fields at the index level, and you use this API to override only some of these fields, then for the fields you did not override, the importance is set to 1.

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 hasDocumentRelevanceOverrideConfigurations() method.

Returns:

Overrides relevance tuning configurations of fields/attributes set at the index level.

If you use this API to override the relevance tuning configured at the index level, but there is no relevance tuning configured at the index level, then Amazon Kendra does not apply any relevance tuning.

If there is relevance tuning configured for fields at the index level, and you use this API to override only some of these fields, then for the fields you did not override, the importance is set to 1.

pageNumber

public final Integer pageNumber()

Query results are returned in pages the size of the PageSize parameter. By default, Amazon Kendra returns the first page of results. Use this parameter to get result pages after the first one.

Returns:

Query results are returned in pages the size of the PageSize parameter. By default, Amazon Kendra returns the first page of results. Use this parameter to get result pages after the first one.

pageSize

public final Integer pageSize()

Sets the number of results that are returned in each page of results. The default page size is 10. The maximum number of results returned is 100. If you ask for more than 100 results, only 100 are returned.

Returns:

Sets the number of results that are returned in each page of results. The default page size is 10. The maximum number of results returned is 100. If you ask for more than 100 results, only 100 are returned.

sortingConfiguration

public final SortingConfiguration sortingConfiguration()

Provides information that determines how the results of the query are sorted. You can set the field that Amazon Kendra should sort the results on, and specify whether the results should be sorted in ascending or descending order. In the case of ties in sorting the results, the results are sorted by relevance.

If you don't provide sorting configuration, the results are sorted by the relevance that Amazon Kendra determines for the result.

Returns:

Provides information that determines how the results of the query are sorted. You can set the field that Amazon Kendra should sort the results on, and specify whether the results should be sorted in ascending or descending order. In the case of ties in sorting the results, the results are sorted by relevance.

If you don't provide sorting configuration, the results are sorted by the relevance that Amazon Kendra determines for the result.

userContext

public final UserContext userContext()

The user context token or user and group information.

Returns:

The user context token or user and group information.

visitorId

public final String visitorId()

Provides an identifier for a specific user. The VisitorId should be a unique identifier, such as a GUID. Don't use personally identifiable information, such as the user's email address, as the VisitorId.

Returns:

Provides an identifier for a specific user. The VisitorId should be a unique identifier, such as a GUID. Don't use personally identifiable information, such as the user's email address, as the VisitorId.

spellCorrectionConfiguration

public final SpellCorrectionConfiguration spellCorrectionConfiguration()

Enables suggested spell corrections for queries.

Returns:

Enables suggested spell corrections for queries.

toBuilder

public QueryRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<QueryRequest.Builder,QueryRequest>

Specified by:

toBuilder in class KendraRequest

builder

public static QueryRequest.Builder builder()

serializableBuilderClass

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