Class QueryRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<QueryRequest.Builder,
QueryRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal AttributeFilter
Filters search results by document fields/attributes.static QueryRequest.Builder
builder()
final CollapseConfiguration
Provides configuration to determine how to group results by document attribute value, and how to display them (collapsed or expanded) under a designated primary document for each group.Overrides relevance tuning configurations of fields/attributes set at the index level.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.facets()
An array of documents fields/attributes for faceted search.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final boolean
For responses, this returns true if the service returned a value for the DocumentRelevanceOverrideConfigurations property.final boolean
For responses, this returns true if the service returned a value for the Facets property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the RequestedDocumentAttributes property.final boolean
For responses, this returns true if the service returned a value for the SortingConfigurations property.final String
indexId()
The identifier of the index for the search.final Integer
Query results are returned in pages the size of thePageSize
parameter.final Integer
pageSize()
Sets the number of results that are returned in each page of results.final QueryResultType
Sets the type of query result or response.final String
Sets the type of query result or response.final String
The input query text for the search.An array of document fields/attributes to include in the response.static Class
<? extends QueryRequest.Builder> final SortingConfiguration
Provides information that determines how the results of the query are sorted.final List
<SortingConfiguration> Provides configuration information to determine how the results of a query are sorted.Enables suggested spell corrections for queries.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final UserContext
The user context token or user and group information.final String
Provides an identifier for a specific user.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
indexId
The identifier of the index for the search.
- Returns:
- The identifier of the index for the search.
-
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. For example,
Timeoff AND October AND Category:HR
is counted as 3 tokens:timeoff
,october
,hr
. For more information, see Searching with advanced query syntax in the Amazon Kendra Developer Guide.- 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. For example,
Timeoff AND October AND Category:HR
is counted as 3 tokens:timeoff
,october
,hr
. For more information, see Searching with advanced query syntax in the Amazon Kendra Developer Guide.
-
attributeFilter
Filters search results by document fields/attributes. You can only provide one attribute filter; however, the
AndAllFilters
,NotFilter
, andOrAllFilters
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
, andOrAllFilters
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 theisEmpty()
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
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 theisEmpty()
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
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
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 returnQueryResultType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromqueryResultTypeFilterAsString()
.- Returns:
- Sets the type of query result or response. Only results for the specified type are returned.
- See Also:
-
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 returnQueryResultType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromqueryResultTypeFilterAsString()
.- Returns:
- Sets the type of query result or response. Only results for the specified type are returned.
- See Also:
-
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 theisEmpty()
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
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
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
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
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.
-
hasSortingConfigurations
public final boolean hasSortingConfigurations()For responses, this returns true if the service returned a value for the SortingConfigurations property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
sortingConfigurations
Provides configuration information to determine how the results of a query are sorted.
You can set upto 3 fields that Amazon Kendra should sort the results on, and specify whether the results should be sorted in ascending or descending order. The sort field quota can be increased.
If you don't provide a sorting configuration, the results are sorted by the relevance that Amazon Kendra determines for the result. In the case of ties in sorting the results, the results are sorted by relevance.
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
hasSortingConfigurations()
method.- Returns:
- Provides configuration information to determine how the results of a query are sorted.
You can set upto 3 fields that Amazon Kendra should sort the results on, and specify whether the results should be sorted in ascending or descending order. The sort field quota can be increased.
If you don't provide a sorting configuration, the results are sorted by the relevance that Amazon Kendra determines for the result. In the case of ties in sorting the results, the results are sorted by relevance.
-
userContext
The user context token or user and group information.
- Returns:
- The user context token or user and group information.
-
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 theVisitorId
.- 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 theVisitorId
.
-
spellCorrectionConfiguration
Enables suggested spell corrections for queries.
- Returns:
- Enables suggested spell corrections for queries.
-
collapseConfiguration
Provides configuration to determine how to group results by document attribute value, and how to display them (collapsed or expanded) under a designated primary document for each group.
- Returns:
- Provides configuration to determine how to group results by document attribute value, and how to display them (collapsed or expanded) under a designated primary document for each group.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<QueryRequest.Builder,
QueryRequest> - Specified by:
toBuilder
in classKendraRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-