Interface QueryRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<QueryRequest.Builder,
,QueryRequest> KendraRequest.Builder
,SdkBuilder<QueryRequest.Builder,
,QueryRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
QueryRequest
-
Method Summary
Modifier and TypeMethodDescriptiondefault QueryRequest.Builder
attributeFilter
(Consumer<AttributeFilter.Builder> attributeFilter) Filters search results by document fields/attributes.attributeFilter
(AttributeFilter attributeFilter) Filters search results by document fields/attributes.default QueryRequest.Builder
collapseConfiguration
(Consumer<CollapseConfiguration.Builder> 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.collapseConfiguration
(CollapseConfiguration 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.documentRelevanceOverrideConfigurations
(Collection<DocumentRelevanceConfiguration> documentRelevanceOverrideConfigurations) Overrides relevance tuning configurations of fields/attributes set at the index level.documentRelevanceOverrideConfigurations
(Consumer<DocumentRelevanceConfiguration.Builder>... documentRelevanceOverrideConfigurations) Overrides relevance tuning configurations of fields/attributes set at the index level.documentRelevanceOverrideConfigurations
(DocumentRelevanceConfiguration... documentRelevanceOverrideConfigurations) Overrides relevance tuning configurations of fields/attributes set at the index level.facets
(Collection<Facet> facets) An array of documents fields/attributes for faceted search.facets
(Consumer<Facet.Builder>... facets) An array of documents fields/attributes for faceted search.An array of documents fields/attributes for faceted search.The identifier of the index for the search.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.pageNumber
(Integer pageNumber) Query results are returned in pages the size of thePageSize
parameter.Sets the number of results that are returned in each page of results.queryResultTypeFilter
(String queryResultTypeFilter) Sets the type of query result or response.queryResultTypeFilter
(QueryResultType queryResultTypeFilter) Sets the type of query result or response.The input query text for the search.requestedDocumentAttributes
(String... requestedDocumentAttributes) An array of document fields/attributes to include in the response.requestedDocumentAttributes
(Collection<String> requestedDocumentAttributes) An array of document fields/attributes to include in the response.default QueryRequest.Builder
sortingConfiguration
(Consumer<SortingConfiguration.Builder> sortingConfiguration) Provides information that determines how the results of the query are sorted.sortingConfiguration
(SortingConfiguration sortingConfiguration) Provides information that determines how the results of the query are sorted.sortingConfigurations
(Collection<SortingConfiguration> sortingConfigurations) Provides configuration information to determine how the results of a query are sorted.sortingConfigurations
(Consumer<SortingConfiguration.Builder>... sortingConfigurations) Provides configuration information to determine how the results of a query are sorted.sortingConfigurations
(SortingConfiguration... sortingConfigurations) Provides configuration information to determine how the results of a query are sorted.default QueryRequest.Builder
spellCorrectionConfiguration
(Consumer<SpellCorrectionConfiguration.Builder> spellCorrectionConfiguration) Enables suggested spell corrections for queries.spellCorrectionConfiguration
(SpellCorrectionConfiguration spellCorrectionConfiguration) Enables suggested spell corrections for queries.default QueryRequest.Builder
userContext
(Consumer<UserContext.Builder> userContext) The user context token or user and group information.userContext
(UserContext userContext) The user context token or user and group information.Provides an identifier for a specific user.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.kendra.model.KendraRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
indexId
The identifier of the index for the search.
- Parameters:
indexId
- The identifier of the index for the search.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
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.- Parameters:
attributeFilter
- Filters search results by document fields/attributes. You can only provide one attribute filter; however, theAndAllFilters
,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:
- Returns a reference to this object so that method calls can be chained together.
-
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
This is a convenience method that creates an instance of theAttributeFilter
parameter means you can create a set of filtering rules that a document must satisfy to be included in the query results.AttributeFilter.Builder
avoiding the need to create one manually viaAttributeFilter.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toattributeFilter(AttributeFilter)
.- Parameters:
attributeFilter
- a consumer that will call methods onAttributeFilter.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
This is a convenience method that creates an instance of theFacet.Builder
avoiding the need to create one manually viaFacet.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tofacets(List<Facet>)
.- Parameters:
facets
- a consumer that will call methods onFacet.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
queryResultTypeFilter
Sets the type of query result or response. Only results for the specified type are returned.
- Parameters:
queryResultTypeFilter
- Sets the type of query result or response. Only results for the specified type are returned.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
queryResultTypeFilter
Sets the type of query result or response. Only results for the specified type are returned.
- Parameters:
queryResultTypeFilter
- Sets the type of query result or response. Only results for the specified type are returned.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
documentRelevanceOverrideConfigurations
QueryRequest.Builder documentRelevanceOverrideConfigurations(Collection<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.
- Parameters:
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
documentRelevanceOverrideConfigurations
QueryRequest.Builder documentRelevanceOverrideConfigurations(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.
- Parameters:
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
documentRelevanceOverrideConfigurations
QueryRequest.Builder documentRelevanceOverrideConfigurations(Consumer<DocumentRelevanceConfiguration.Builder>... 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.
This is a convenience method that creates an instance of theDocumentRelevanceConfiguration.Builder
avoiding the need to create one manually viaDocumentRelevanceConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed todocumentRelevanceOverrideConfigurations(List<DocumentRelevanceConfiguration>)
.- Parameters:
documentRelevanceOverrideConfigurations
- a consumer that will call methods onDocumentRelevanceConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.- Parameters:
pageNumber
- Query results are returned in pages the size of thePageSize
parameter. By default, Amazon Kendra returns the first page of results. Use this parameter to get result pages after the first one.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
sortingConfiguration
default QueryRequest.Builder sortingConfiguration(Consumer<SortingConfiguration.Builder> 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.
This is a convenience method that creates an instance of theSortingConfiguration.Builder
avoiding the need to create one manually viaSortingConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tosortingConfiguration(SortingConfiguration)
.- Parameters:
sortingConfiguration
- a consumer that will call methods onSortingConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
- Parameters:
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
sortingConfigurations
QueryRequest.Builder sortingConfigurations(Consumer<SortingConfiguration.Builder>... 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.
This is a convenience method that creates an instance of theSortingConfiguration.Builder
avoiding the need to create one manually viaSortingConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tosortingConfigurations(List<SortingConfiguration>)
.- Parameters:
sortingConfigurations
- a consumer that will call methods onSortingConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
userContext
The user context token or user and group information.
- Parameters:
userContext
- The user context token or user and group information.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
userContext
The user context token or user and group information.
This is a convenience method that creates an instance of theUserContext.Builder
avoiding the need to create one manually viaUserContext.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed touserContext(UserContext)
.- Parameters:
userContext
- a consumer that will call methods onUserContext.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
.- Parameters:
visitorId
- Provides an identifier for a specific user. TheVisitorId
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:
- Returns a reference to this object so that method calls can be chained together.
-
spellCorrectionConfiguration
QueryRequest.Builder spellCorrectionConfiguration(SpellCorrectionConfiguration spellCorrectionConfiguration) Enables suggested spell corrections for queries.
- Parameters:
spellCorrectionConfiguration
- Enables suggested spell corrections for queries.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
spellCorrectionConfiguration
default QueryRequest.Builder spellCorrectionConfiguration(Consumer<SpellCorrectionConfiguration.Builder> spellCorrectionConfiguration) Enables suggested spell corrections for queries.
This is a convenience method that creates an instance of theSpellCorrectionConfiguration.Builder
avoiding the need to create one manually viaSpellCorrectionConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tospellCorrectionConfiguration(SpellCorrectionConfiguration)
.- Parameters:
spellCorrectionConfiguration
- a consumer that will call methods onSpellCorrectionConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
collapseConfiguration
default QueryRequest.Builder collapseConfiguration(Consumer<CollapseConfiguration.Builder> 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.
This is a convenience method that creates an instance of theCollapseConfiguration.Builder
avoiding the need to create one manually viaCollapseConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tocollapseConfiguration(CollapseConfiguration)
.- Parameters:
collapseConfiguration
- a consumer that will call methods onCollapseConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
overrideConfiguration
Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
QueryRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-