com.amazonaws.services.kendra.model

Class RetrieveRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.kendra.model.RetrieveRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class RetrieveRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
RetrieveRequest()

Method Summary

Modifier and Type	Method and Description
RetrieveRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
AttributeFilter	getAttributeFilter() Filters search results by document fields/attributes.
List<DocumentRelevanceConfiguration>	getDocumentRelevanceOverrideConfigurations() Overrides relevance tuning configurations of fields/attributes set at the index level.
String	getIndexId() The identifier of the index to retrieve relevant passages for the search.
Integer	getPageNumber() Retrieved relevant passages are returned in pages the size of the PageSize parameter.
Integer	getPageSize() Sets the number of retrieved relevant passages that are returned in each page of results.
String	getQueryText() The input query text to retrieve relevant passages for the search.
List<String>	getRequestedDocumentAttributes() A list of document fields/attributes to include in the response.
UserContext	getUserContext() The user context token or user and group information.
int	hashCode()
void	setAttributeFilter(AttributeFilter attributeFilter) Filters search results by document fields/attributes.
void	setDocumentRelevanceOverrideConfigurations(Collection<DocumentRelevanceConfiguration> documentRelevanceOverrideConfigurations) Overrides relevance tuning configurations of fields/attributes set at the index level.
void	setIndexId(String indexId) The identifier of the index to retrieve relevant passages for the search.
void	setPageNumber(Integer pageNumber) Retrieved relevant passages are returned in pages the size of the PageSize parameter.
void	setPageSize(Integer pageSize) Sets the number of retrieved relevant passages that are returned in each page of results.
void	setQueryText(String queryText) The input query text to retrieve relevant passages for the search.
void	setRequestedDocumentAttributes(Collection<String> requestedDocumentAttributes) A list of document fields/attributes to include in the response.
void	setUserContext(UserContext userContext) The user context token or user and group information.
String	toString() Returns a string representation of this object.
RetrieveRequest	withAttributeFilter(AttributeFilter attributeFilter) Filters search results by document fields/attributes.
RetrieveRequest	withDocumentRelevanceOverrideConfigurations(Collection<DocumentRelevanceConfiguration> documentRelevanceOverrideConfigurations) Overrides relevance tuning configurations of fields/attributes set at the index level.
RetrieveRequest	withDocumentRelevanceOverrideConfigurations(DocumentRelevanceConfiguration... documentRelevanceOverrideConfigurations) Overrides relevance tuning configurations of fields/attributes set at the index level.
RetrieveRequest	withIndexId(String indexId) The identifier of the index to retrieve relevant passages for the search.
RetrieveRequest	withPageNumber(Integer pageNumber) Retrieved relevant passages are returned in pages the size of the PageSize parameter.
RetrieveRequest	withPageSize(Integer pageSize) Sets the number of retrieved relevant passages that are returned in each page of results.
RetrieveRequest	withQueryText(String queryText) The input query text to retrieve relevant passages for the search.
RetrieveRequest	withRequestedDocumentAttributes(Collection<String> requestedDocumentAttributes) A list of document fields/attributes to include in the response.
RetrieveRequest	withRequestedDocumentAttributes(String... requestedDocumentAttributes) A list of document fields/attributes to include in the response.
RetrieveRequest	withUserContext(UserContext userContext) The user context token or user and group information.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RetrieveRequest

public RetrieveRequest()

Method Detail

setIndexId

public void setIndexId(String indexId)

The identifier of the index to retrieve relevant passages for the search.

Parameters:

indexId - The identifier of the index to retrieve relevant passages for the search.

getIndexId

public String getIndexId()

The identifier of the index to retrieve relevant passages for the search.

Returns:

The identifier of the index to retrieve relevant passages for the search.

withIndexId

public RetrieveRequest withIndexId(String indexId)

The identifier of the index to retrieve relevant passages for the search.

Parameters:

indexId - The identifier of the index to retrieve relevant passages for the search.

Returns:

Returns a reference to this object so that method calls can be chained together.

setQueryText

public void setQueryText(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. 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 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. 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.

getQueryText

public String getQueryText()

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. 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:

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. 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.

withQueryText

public RetrieveRequest withQueryText(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. 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 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. 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.

setAttributeFilter

public void setAttributeFilter(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.

Parameters:

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.

getAttributeFilter

public AttributeFilter getAttributeFilter()

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.

Returns:

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.

withAttributeFilter

public RetrieveRequest withAttributeFilter(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

getRequestedDocumentAttributes

public List<String> getRequestedDocumentAttributes()

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.

Returns:

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.

setRequestedDocumentAttributes

public void setRequestedDocumentAttributes(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.

Parameters:

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.

withRequestedDocumentAttributes

public RetrieveRequest withRequestedDocumentAttributes(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.

NOTE: This method appends the values to the existing list (if any). Use setRequestedDocumentAttributes(java.util.Collection) or withRequestedDocumentAttributes(java.util.Collection) if you want to override the existing values.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

withRequestedDocumentAttributes

public RetrieveRequest withRequestedDocumentAttributes(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

getDocumentRelevanceOverrideConfigurations

public List<DocumentRelevanceConfiguration> getDocumentRelevanceOverrideConfigurations()

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:

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.

setDocumentRelevanceOverrideConfigurations

public void setDocumentRelevanceOverrideConfigurations(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.

withDocumentRelevanceOverrideConfigurations

public RetrieveRequest withDocumentRelevanceOverrideConfigurations(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.

NOTE: This method appends the values to the existing list (if any). Use setDocumentRelevanceOverrideConfigurations(java.util.Collection) or withDocumentRelevanceOverrideConfigurations(java.util.Collection) if you want to override the existing values.

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.

withDocumentRelevanceOverrideConfigurations

public RetrieveRequest withDocumentRelevanceOverrideConfigurations(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.

setPageNumber

public void setPageNumber(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.

Parameters:

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.

getPageNumber

public Integer getPageNumber()

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.

Returns:

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.

withPageNumber

public RetrieveRequest withPageNumber(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

setPageSize

public void setPageSize(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.

Parameters:

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.

getPageSize

public Integer getPageSize()

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.

Returns:

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.

withPageSize

public RetrieveRequest withPageSize(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

setUserContext

public void setUserContext(UserContext userContext)

The user context token or user and group information.

Parameters:

userContext - The user context token or user and group information.

getUserContext

public UserContext getUserContext()

The user context token or user and group information.

Returns:

The user context token or user and group information.

withUserContext

public RetrieveRequest withUserContext(UserContext 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.

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public RetrieveRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()