public static interface QueryRequest.Builder extends KendraRequest.Builder, SdkPojo, CopyableBuilder<QueryRequest.Builder,QueryRequest>
| Modifier and Type | Method and Description |
|---|---|
QueryRequest.Builder |
attributeFilter(AttributeFilter attributeFilter)
Enables filtered searches based on document attributes.
|
default QueryRequest.Builder |
attributeFilter(Consumer<AttributeFilter.Builder> attributeFilter)
Enables filtered searches based on document attributes.
|
QueryRequest.Builder |
documentRelevanceOverrideConfigurations(Collection<DocumentRelevanceConfiguration> documentRelevanceOverrideConfigurations)
Overrides relevance tuning configurations of fields or attributes set at the index level.
|
QueryRequest.Builder |
documentRelevanceOverrideConfigurations(Consumer<DocumentRelevanceConfiguration.Builder>... documentRelevanceOverrideConfigurations)
Overrides relevance tuning configurations of fields or attributes set at the index level.
|
QueryRequest.Builder |
documentRelevanceOverrideConfigurations(DocumentRelevanceConfiguration... documentRelevanceOverrideConfigurations)
Overrides relevance tuning configurations of fields or attributes set at the index level.
|
QueryRequest.Builder |
facets(Collection<Facet> facets)
An array of documents attributes.
|
QueryRequest.Builder |
facets(Consumer<Facet.Builder>... facets)
An array of documents attributes.
|
QueryRequest.Builder |
facets(Facet... facets)
An array of documents attributes.
|
QueryRequest.Builder |
indexId(String indexId)
The unique identifier of the index to 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.
|
QueryRequest.Builder |
queryResultTypeFilter(String queryResultTypeFilter)
Sets the type of query.
|
QueryRequest.Builder |
queryText(String queryText)
The text to search for.
|
QueryRequest.Builder |
requestedDocumentAttributes(Collection<String> requestedDocumentAttributes)
An array of document attributes to include in the response.
|
QueryRequest.Builder |
requestedDocumentAttributes(String... requestedDocumentAttributes)
An array of document 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.
|
default QueryRequest.Builder |
userContext(Consumer<UserContext.Builder> userContext)
The user context token.
|
QueryRequest.Builder |
userContext(UserContext userContext)
The user context token.
|
QueryRequest.Builder |
visitorId(String visitorId)
Provides an identifier for a specific user.
|
buildoverrideConfigurationequalsBySdkFields, sdkFieldscopyapplyMutation, buildQueryRequest.Builder indexId(String indexId)
The unique identifier of the index to search. The identifier is returned in the response from the
CreateIndex operation.
indexId - The unique identifier of the index to search. The identifier is returned in the response from the
CreateIndex operation.QueryRequest.Builder queryText(String queryText)
The text to search for.
queryText - The text to search for.QueryRequest.Builder attributeFilter(AttributeFilter attributeFilter)
Enables filtered searches based on document attributes. You can only provide one attribute filter; however,
the AndAllFilters, NotFilter, and OrAllFilters parameters contain a
list of other filters.
The AttributeFilter parameter enables you to create a set of filtering rules that a document
must satisfy to be included in the query results.
attributeFilter - Enables filtered searches based on document attributes. You can only provide one attribute filter;
however, the AndAllFilters, NotFilter, and OrAllFilters
parameters contain a list of other filters.
The AttributeFilter parameter enables you to 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)
Enables filtered searches based on document attributes. You can only provide one attribute filter; however,
the AndAllFilters, NotFilter, and OrAllFilters parameters contain a
list of other filters.
The AttributeFilter parameter enables you to 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 attributes. Amazon Kendra returns a count for each attribute key specified. You can use this information to help narrow the search for your user.
facets - An array of documents attributes. Amazon Kendra returns a count for each attribute key specified. You
can use this information to help narrow the search for your user.QueryRequest.Builder facets(Facet... facets)
An array of documents attributes. Amazon Kendra returns a count for each attribute key specified. You can use this information to help narrow the search for your user.
facets - An array of documents attributes. Amazon Kendra returns a count for each attribute key specified. You
can use this information to help narrow the search for your user.QueryRequest.Builder facets(Consumer<Facet.Builder>... facets)
An array of documents attributes. Amazon Kendra returns a count for each attribute key specified. You can use this information to help narrow the search for your user.
This is a convenience that creates an instance of theList.Builder avoiding the need to create
one manually via List#builder() .
When the Consumer completes, List.Builder#build() is called immediately and its result
is passed to #facets(List) .facets - a consumer that will call methods on List.Builder #facets(List) QueryRequest.Builder requestedDocumentAttributes(Collection<String> requestedDocumentAttributes)
An array of document attributes to include in the response. No other document attributes are included in the response. By default all document attributes are included in the response.
requestedDocumentAttributes - An array of document attributes to include in the response. No other document attributes are included
in the response. By default all document attributes are included in the response.QueryRequest.Builder requestedDocumentAttributes(String... requestedDocumentAttributes)
An array of document attributes to include in the response. No other document attributes are included in the response. By default all document attributes are included in the response.
requestedDocumentAttributes - An array of document attributes to include in the response. No other document attributes are included
in the response. By default all document attributes are included in the response.QueryRequest.Builder queryResultTypeFilter(String queryResultTypeFilter)
Sets the type of query. Only results for the specified query type are returned.
queryResultTypeFilter - Sets the type of query. Only results for the specified query type are returned.QueryResultType,
QueryResultTypeQueryRequest.Builder queryResultTypeFilter(QueryResultType queryResultTypeFilter)
Sets the type of query. Only results for the specified query type are returned.
queryResultTypeFilter - Sets the type of query. Only results for the specified query type are returned.QueryResultType,
QueryResultTypeQueryRequest.Builder documentRelevanceOverrideConfigurations(Collection<DocumentRelevanceConfiguration> documentRelevanceOverrideConfigurations)
Overrides relevance tuning configurations of fields or 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 at the index level, but you do not use this API to override any relevance tuning in the index, then Amazon Kendra uses the relevance tuning that is configured at the index level.
If there is relevance tuning configured for fields at the index level, but 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 or 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 at the index level, but you do not use this API to override any relevance tuning in the index, then Amazon Kendra uses the relevance tuning that is configured at the index level.
If there is relevance tuning configured for fields at the index level, but 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 or 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 at the index level, but you do not use this API to override any relevance tuning in the index, then Amazon Kendra uses the relevance tuning that is configured at the index level.
If there is relevance tuning configured for fields at the index level, but 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 or 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 at the index level, but you do not use this API to override any relevance tuning in the index, then Amazon Kendra uses the relevance tuning that is configured at the index level.
If there is relevance tuning configured for fields at the index level, but 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 or 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 at the index level, but you do not use this API to override any relevance tuning in the index, then Amazon Kendra uses the relevance tuning that is configured at the index level.
If there is relevance tuning configured for fields at the index level, but 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 that creates an instance of theList.Builder
avoiding the need to create one manually via List#builder() .
When the Consumer completes, List.Builder#build() is called
immediately and its result is passed to #documentRelevanceOverrideConfigurations(List) .documentRelevanceOverrideConfigurations - a consumer that will call methods on List.Builder #documentRelevanceOverrideConfigurations(List) 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 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 userContext(UserContext userContext)
The user context token.
userContext - The user context token.default QueryRequest.Builder userContext(Consumer<UserContext.Builder> userContext)
The user context token.
This is a convenience 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 overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration in interface AwsRequest.BuilderQueryRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration in interface AwsRequest.BuilderCopyright © 2021. All rights reserved.