@Generated(value="software.amazon.awssdk:codegen") public final class RetrieveRequest extends KendraRequest implements ToCopyableBuilder<RetrieveRequest.Builder,RetrieveRequest>
| Modifier and Type | Class and Description |
|---|---|
static interface |
RetrieveRequest.Builder |
| Modifier and Type | Method and Description |
|---|---|
AttributeFilter |
attributeFilter()
Filters search results by document fields/attributes.
|
static RetrieveRequest.Builder |
builder() |
List<DocumentRelevanceConfiguration> |
documentRelevanceOverrideConfigurations()
Overrides relevance tuning configurations of fields/attributes set at the index level.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
boolean |
hasDocumentRelevanceOverrideConfigurations()
For responses, this returns true if the service returned a value for the DocumentRelevanceOverrideConfigurations
property.
|
int |
hashCode() |
boolean |
hasRequestedDocumentAttributes()
For responses, this returns true if the service returned a value for the RequestedDocumentAttributes property.
|
String |
indexId()
The identifier of the index to retrieve relevant passages for the search.
|
Integer |
pageNumber()
Retrieved relevant passages are returned in pages the size of the
PageSize parameter. |
Integer |
pageSize()
Sets the number of retrieved relevant passages that are returned in each page of results.
|
String |
queryText()
The input query text to retrieve relevant passages for the search.
|
List<String> |
requestedDocumentAttributes()
A list of document fields/attributes to include in the response.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends RetrieveRequest.Builder> |
serializableBuilderClass() |
RetrieveRequest.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
UserContext |
userContext()
The user context token or user and group information.
|
overrideConfigurationclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final String indexId()
The identifier of the index to retrieve relevant passages for the search.
public final 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.
public final 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.
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.
public final boolean hasRequestedDocumentAttributes()
isEmpty() 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.public final List<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.
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.
public final boolean hasDocumentRelevanceOverrideConfigurations()
isEmpty()
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.public final List<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.
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.
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.
public final 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.
PageSize parameter. By
default, Amazon Kendra returns the first page of results. Use this parameter to get result pages after
the first one.public final 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.
public final UserContext userContext()
The user context token or user and group information.
public RetrieveRequest.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<RetrieveRequest.Builder,RetrieveRequest>toBuilder in class KendraRequestpublic static RetrieveRequest.Builder builder()
public static Class<? extends RetrieveRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField in class SdkRequestCopyright © 2023. All rights reserved.