public static interface RetrieveRequest.Builder extends KendraRequest.Builder, SdkPojo, CopyableBuilder<RetrieveRequest.Builder,RetrieveRequest>
| Modifier and Type | Method and Description |
|---|---|
RetrieveRequest.Builder |
attributeFilter(AttributeFilter attributeFilter)
Filters search results by document fields/attributes.
|
default RetrieveRequest.Builder |
attributeFilter(Consumer<AttributeFilter.Builder> attributeFilter)
Filters search results by document fields/attributes.
|
RetrieveRequest.Builder |
documentRelevanceOverrideConfigurations(Collection<DocumentRelevanceConfiguration> documentRelevanceOverrideConfigurations)
Overrides relevance tuning configurations of fields/attributes set at the index level.
|
RetrieveRequest.Builder |
documentRelevanceOverrideConfigurations(Consumer<DocumentRelevanceConfiguration.Builder>... documentRelevanceOverrideConfigurations)
Overrides relevance tuning configurations of fields/attributes set at the index level.
|
RetrieveRequest.Builder |
documentRelevanceOverrideConfigurations(DocumentRelevanceConfiguration... documentRelevanceOverrideConfigurations)
Overrides relevance tuning configurations of fields/attributes set at the index level.
|
RetrieveRequest.Builder |
indexId(String indexId)
The identifier of the index to retrieve relevant passages for the search.
|
RetrieveRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) |
RetrieveRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) |
RetrieveRequest.Builder |
pageNumber(Integer pageNumber)
Retrieved relevant passages are returned in pages the size of the
PageSize parameter. |
RetrieveRequest.Builder |
pageSize(Integer pageSize)
Sets the number of retrieved relevant passages that are returned in each page of results.
|
RetrieveRequest.Builder |
queryText(String queryText)
The input query text to retrieve relevant passages for the search.
|
RetrieveRequest.Builder |
requestedDocumentAttributes(Collection<String> requestedDocumentAttributes)
A list of document fields/attributes to include in the response.
|
RetrieveRequest.Builder |
requestedDocumentAttributes(String... requestedDocumentAttributes)
A list of document fields/attributes to include in the response.
|
default RetrieveRequest.Builder |
userContext(Consumer<UserContext.Builder> userContext)
The user context token or user and group information.
|
RetrieveRequest.Builder |
userContext(UserContext userContext)
The user context token or user and group information.
|
buildoverrideConfigurationequalsBySdkFields, sdkFieldscopyapplyMutation, buildRetrieveRequest.Builder indexId(String indexId)
The identifier of the index to retrieve relevant passages for the search.
indexId - The identifier of the index to retrieve relevant passages for the search.RetrieveRequest.Builder queryText(String queryText)
The input query text to retrieve relevant passages 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 to retrieve relevant passages 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.RetrieveRequest.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 RetrieveRequest.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)RetrieveRequest.Builder requestedDocumentAttributes(Collection<String> requestedDocumentAttributes)
A list of document fields/attributes to include in the response. You can limit the response to include certain document fields. By default, all document fields are included in the response.
requestedDocumentAttributes - A list of document fields/attributes to include in the response. You can limit the response to include
certain document fields. By default, all document fields are included in the response.RetrieveRequest.Builder requestedDocumentAttributes(String... requestedDocumentAttributes)
A list of document fields/attributes to include in the response. You can limit the response to include certain document fields. By default, all document fields are included in the response.
requestedDocumentAttributes - A list of document fields/attributes to include in the response. You can limit the response to include
certain document fields. By default, all document fields are included in the response.RetrieveRequest.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.
RetrieveRequest.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.
RetrieveRequest.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) RetrieveRequest.Builder pageNumber(Integer pageNumber)
Retrieved relevant passages 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 - Retrieved relevant passages 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.RetrieveRequest.Builder pageSize(Integer pageSize)
Sets the number of retrieved relevant passages 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 retrieved relevant passages 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.RetrieveRequest.Builder userContext(UserContext userContext)
The user context token or user and group information.
userContext - The user context token or user and group information.default RetrieveRequest.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)RetrieveRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration in interface AwsRequest.BuilderRetrieveRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration in interface AwsRequest.BuilderCopyright © 2023. All rights reserved.