public static interface QueryRequest.Builder extends KendraRequest.Builder, SdkPojo, CopyableBuilder<QueryRequest.Builder,QueryRequest>
| Modifier and Type | Method and Description |
|---|---|
QueryRequest.Builder |
attributeFilter(AttributeFilter attributeFilter)
Filters search results by document fields/attributes.
|
default QueryRequest.Builder |
attributeFilter(Consumer<AttributeFilter.Builder> attributeFilter)
Filters search results by document fields/attributes.
|
QueryRequest.Builder |
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.
|
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.
|
QueryRequest.Builder |
documentRelevanceOverrideConfigurations(Collection<DocumentRelevanceConfiguration> documentRelevanceOverrideConfigurations)
Overrides relevance tuning configurations of fields/attributes set at the index level.
|
QueryRequest.Builder |
documentRelevanceOverrideConfigurations(Consumer<DocumentRelevanceConfiguration.Builder>... documentRelevanceOverrideConfigurations)
Overrides relevance tuning configurations of fields/attributes set at the index level.
|
QueryRequest.Builder |
documentRelevanceOverrideConfigurations(DocumentRelevanceConfiguration... documentRelevanceOverrideConfigurations)
Overrides relevance tuning configurations of fields/attributes set at the index level.
|
QueryRequest.Builder |
facets(Collection<Facet> facets)
An array of documents fields/attributes for faceted search.
|
QueryRequest.Builder |
facets(Consumer<Facet.Builder>... facets)
An array of documents fields/attributes for faceted search.
|
QueryRequest.Builder |
facets(Facet... facets)
An array of documents fields/attributes for faceted search.
|
QueryRequest.Builder |
indexId(String indexId)
The identifier of the index for the search.
|
QueryRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) |
QueryRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) |
QueryRequest.Builder |
pageNumber(Integer pageNumber)
Query results are returned in pages the size of the
PageSize parameter. |
QueryRequest.Builder |
pageSize(Integer pageSize)
Sets the number of results that are returned in each page of results.
|
QueryRequest.Builder |
queryResultTypeFilter(QueryResultType queryResultTypeFilter)
Sets the type of query result or response.
|
QueryRequest.Builder |
queryResultTypeFilter(String queryResultTypeFilter)
Sets the type of query result or response.
|
QueryRequest.Builder |
queryText(String queryText)
The input query text for the search.
|
QueryRequest.Builder |
requestedDocumentAttributes(Collection<String> requestedDocumentAttributes)
An array of document fields/attributes to include in the response.
|
QueryRequest.Builder |
requestedDocumentAttributes(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.
|
QueryRequest.Builder |
sortingConfiguration(SortingConfiguration sortingConfiguration)
Provides information that determines how the results of the query are sorted.
|
QueryRequest.Builder |
sortingConfigurations(Collection<SortingConfiguration> sortingConfigurations)
Provides configuration information to determine how the results of a query are sorted.
|
QueryRequest.Builder |
sortingConfigurations(Consumer<SortingConfiguration.Builder>... sortingConfigurations)
Provides configuration information to determine how the results of a query are sorted.
|
QueryRequest.Builder |
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.
|
QueryRequest.Builder |
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.
|
QueryRequest.Builder |
userContext(UserContext userContext)
The user context token or user and group information.
|
QueryRequest.Builder |
visitorId(String visitorId)
Provides an identifier for a specific user.
|
buildoverrideConfigurationequalsBySdkFields, sdkFieldscopyapplyMutation, buildQueryRequest.Builder indexId(String indexId)
The identifier of the index for the search.
indexId - The identifier of the index for the search.QueryRequest.Builder queryText(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.
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.QueryRequest.Builder attributeFilter(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.
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.
default QueryRequest.Builder attributeFilter(Consumer<AttributeFilter.Builder> 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.
AttributeFilter.Builder avoiding the
need to create one manually via AttributeFilter.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its
result is passed to attributeFilter(AttributeFilter).
attributeFilter - a consumer that will call methods on AttributeFilter.BuilderattributeFilter(AttributeFilter)QueryRequest.Builder facets(Collection<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.
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.QueryRequest.Builder facets(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.
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.QueryRequest.Builder facets(Consumer<Facet.Builder>... 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
via Facet.builder().
When the Consumer completes,
SdkBuilder.build() is called immediately and its
result is passed to #facets(List.
facets - a consumer that will call methods on
Facet.Builder#facets(java.util.Collection) QueryRequest.Builder requestedDocumentAttributes(Collection<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.
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.QueryRequest.Builder requestedDocumentAttributes(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.
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.QueryRequest.Builder queryResultTypeFilter(String queryResultTypeFilter)
Sets the type of query result or response. Only results for the specified type are returned.
queryResultTypeFilter - Sets the type of query result or response. Only results for the specified type are returned.QueryResultType,
QueryResultTypeQueryRequest.Builder queryResultTypeFilter(QueryResultType queryResultTypeFilter)
Sets the type of query result or response. Only results for the specified type are returned.
queryResultTypeFilter - Sets the type of query result or response. Only results for the specified type are returned.QueryResultType,
QueryResultTypeQueryRequest.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.
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.
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.
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.
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 via
DocumentRelevanceConfiguration.builder().
When the Consumer completes,
SdkBuilder.build() is called
immediately and its result is passed to #documentRelevanceOverrideConfigurations(List.
documentRelevanceOverrideConfigurations - a consumer that will call methods on
DocumentRelevanceConfiguration.Builder#documentRelevanceOverrideConfigurations(java.util.Collection) QueryRequest.Builder pageNumber(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.
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.QueryRequest.Builder pageSize(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.
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.QueryRequest.Builder sortingConfiguration(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.
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.
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 via SortingConfiguration.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and
its result is passed to sortingConfiguration(SortingConfiguration).
sortingConfiguration - a consumer that will call methods on SortingConfiguration.BuildersortingConfiguration(SortingConfiguration)QueryRequest.Builder sortingConfigurations(Collection<SortingConfiguration> 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.
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.
QueryRequest.Builder sortingConfigurations(SortingConfiguration... 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.
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.
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 via SortingConfiguration.builder().
When the Consumer completes,
SdkBuilder.build() is called
immediately and its result is passed to #sortingConfigurations(List.
sortingConfigurations - a consumer that will call methods on
SortingConfiguration.Builder#sortingConfigurations(java.util.Collection) QueryRequest.Builder userContext(UserContext userContext)
The user context token or user and group information.
userContext - The user context token or user and group information.default QueryRequest.Builder userContext(Consumer<UserContext.Builder> 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 via UserContext.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its result
is passed to userContext(UserContext).
userContext - a consumer that will call methods on UserContext.BuilderuserContext(UserContext)QueryRequest.Builder visitorId(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.
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.QueryRequest.Builder spellCorrectionConfiguration(SpellCorrectionConfiguration spellCorrectionConfiguration)
Enables suggested spell corrections for queries.
spellCorrectionConfiguration - Enables suggested spell corrections for queries.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 via SpellCorrectionConfiguration.builder().
When the Consumer completes, SdkBuilder.build() is called
immediately and its result is passed to spellCorrectionConfiguration(SpellCorrectionConfiguration).
spellCorrectionConfiguration - a consumer that will call methods on SpellCorrectionConfiguration.BuilderspellCorrectionConfiguration(SpellCorrectionConfiguration)QueryRequest.Builder 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.
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.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 via CollapseConfiguration.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and
its result is passed to collapseConfiguration(CollapseConfiguration).
collapseConfiguration - a consumer that will call methods on CollapseConfiguration.BuildercollapseConfiguration(CollapseConfiguration)QueryRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration in interface AwsRequest.BuilderQueryRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration in interface AwsRequest.BuilderCopyright © 2023. All rights reserved.