All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.amazonaws.services.kendra.model.RetrieveRequest Maven / Gradle / Ivy

Go to download

The AWS Java SDK for AWSKendraFrontend module holds the client classes that are used for communicating with AWSKendraFrontend Service

There is a newer version: 1.12.780
Show newest version
/*
 * Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
 * the License. A copy of the License is located at
 * 
 * http://aws.amazon.com/apache2.0
 * 
 * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
 * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
 * and limitations under the License.
 */
package com.amazonaws.services.kendra.model;

import java.io.Serializable;
import javax.annotation.Generated;

import com.amazonaws.AmazonWebServiceRequest;

/**
 * 
 * @see AWS API
 *      Documentation
 */
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class RetrieveRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {

    /**
     * 

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

*/ private String indexId; /** *

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

*/ private String queryText; /** *

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

*/ private AttributeFilter attributeFilter; /** *

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

*/ private java.util.List requestedDocumentAttributes; /** *

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

*/ private java.util.List documentRelevanceOverrideConfigurations; /** *

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

*/ private Integer pageNumber; /** *

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

*/ private Integer pageSize; /** *

* The user context token or user and group information. *

*/ private UserContext userContext; /** *

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

* * @param indexId * The identifier of the index to retrieve relevant passages for the search. */ public void setIndexId(String indexId) { this.indexId = indexId; } /** *

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

* * @return The identifier of the index to retrieve relevant passages for the search. */ public String getIndexId() { return this.indexId; } /** *

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

* * @param indexId * The identifier of the index to retrieve relevant passages for the search. * @return Returns a reference to this object so that method calls can be chained together. */ public RetrieveRequest withIndexId(String indexId) { setIndexId(indexId); return this; } /** *

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

* * @param 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. */ public void setQueryText(String queryText) { this.queryText = 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. *

* * @return 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. */ public String getQueryText() { return this.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. *

* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public RetrieveRequest withQueryText(String queryText) { setQueryText(queryText); return this; } /** *

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

* * @param 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. */ public void setAttributeFilter(AttributeFilter attributeFilter) { this.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. *

* * @return 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. */ public AttributeFilter getAttributeFilter() { return this.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. *

* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public RetrieveRequest withAttributeFilter(AttributeFilter attributeFilter) { setAttributeFilter(attributeFilter); return this; } /** *

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

* * @return 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. */ public java.util.List getRequestedDocumentAttributes() { return 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. *

* * @param 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. */ public void setRequestedDocumentAttributes(java.util.Collection requestedDocumentAttributes) { if (requestedDocumentAttributes == null) { this.requestedDocumentAttributes = null; return; } this.requestedDocumentAttributes = new java.util.ArrayList(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 * {@link #setRequestedDocumentAttributes(java.util.Collection)} or * {@link #withRequestedDocumentAttributes(java.util.Collection)} if you want to override the existing values. *

* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public RetrieveRequest withRequestedDocumentAttributes(String... requestedDocumentAttributes) { if (this.requestedDocumentAttributes == null) { setRequestedDocumentAttributes(new java.util.ArrayList(requestedDocumentAttributes.length)); } for (String ele : requestedDocumentAttributes) { this.requestedDocumentAttributes.add(ele); } return this; } /** *

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

* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public RetrieveRequest withRequestedDocumentAttributes(java.util.Collection requestedDocumentAttributes) { setRequestedDocumentAttributes(requestedDocumentAttributes); return this; } /** *

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

* * @return 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. */ public java.util.List getDocumentRelevanceOverrideConfigurations() { return 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. *

* * @param 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. */ public void setDocumentRelevanceOverrideConfigurations(java.util.Collection documentRelevanceOverrideConfigurations) { if (documentRelevanceOverrideConfigurations == null) { this.documentRelevanceOverrideConfigurations = null; return; } this.documentRelevanceOverrideConfigurations = new java.util.ArrayList(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 * {@link #setDocumentRelevanceOverrideConfigurations(java.util.Collection)} or * {@link #withDocumentRelevanceOverrideConfigurations(java.util.Collection)} if you want to override the existing * values. *

* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public RetrieveRequest withDocumentRelevanceOverrideConfigurations(DocumentRelevanceConfiguration... documentRelevanceOverrideConfigurations) { if (this.documentRelevanceOverrideConfigurations == null) { setDocumentRelevanceOverrideConfigurations(new java.util.ArrayList(documentRelevanceOverrideConfigurations.length)); } for (DocumentRelevanceConfiguration ele : documentRelevanceOverrideConfigurations) { this.documentRelevanceOverrideConfigurations.add(ele); } return this; } /** *

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

* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public RetrieveRequest withDocumentRelevanceOverrideConfigurations( java.util.Collection documentRelevanceOverrideConfigurations) { setDocumentRelevanceOverrideConfigurations(documentRelevanceOverrideConfigurations); return this; } /** *

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

* * @param 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. */ public void setPageNumber(Integer pageNumber) { this.pageNumber = 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. *

* * @return 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. */ public Integer getPageNumber() { return this.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. *

* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public RetrieveRequest withPageNumber(Integer pageNumber) { setPageNumber(pageNumber); return this; } /** *

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

* * @param 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 void setPageSize(Integer pageSize) { this.pageSize = 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. *

* * @return 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 Integer getPageSize() { return this.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. *

* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public RetrieveRequest withPageSize(Integer pageSize) { setPageSize(pageSize); return this; } /** *

* The user context token or user and group information. *

* * @param userContext * The user context token or user and group information. */ public void setUserContext(UserContext userContext) { this.userContext = userContext; } /** *

* The user context token or user and group information. *

* * @return The user context token or user and group information. */ public UserContext getUserContext() { return this.userContext; } /** *

* The user context token or user and group information. *

* * @param userContext * The user context token or user and group information. * @return Returns a reference to this object so that method calls can be chained together. */ public RetrieveRequest withUserContext(UserContext userContext) { setUserContext(userContext); return this; } /** * 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. * * @return A string representation of this object. * * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getIndexId() != null) sb.append("IndexId: ").append(getIndexId()).append(","); if (getQueryText() != null) sb.append("QueryText: ").append(getQueryText()).append(","); if (getAttributeFilter() != null) sb.append("AttributeFilter: ").append(getAttributeFilter()).append(","); if (getRequestedDocumentAttributes() != null) sb.append("RequestedDocumentAttributes: ").append(getRequestedDocumentAttributes()).append(","); if (getDocumentRelevanceOverrideConfigurations() != null) sb.append("DocumentRelevanceOverrideConfigurations: ").append(getDocumentRelevanceOverrideConfigurations()).append(","); if (getPageNumber() != null) sb.append("PageNumber: ").append(getPageNumber()).append(","); if (getPageSize() != null) sb.append("PageSize: ").append(getPageSize()).append(","); if (getUserContext() != null) sb.append("UserContext: ").append(getUserContext()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof RetrieveRequest == false) return false; RetrieveRequest other = (RetrieveRequest) obj; if (other.getIndexId() == null ^ this.getIndexId() == null) return false; if (other.getIndexId() != null && other.getIndexId().equals(this.getIndexId()) == false) return false; if (other.getQueryText() == null ^ this.getQueryText() == null) return false; if (other.getQueryText() != null && other.getQueryText().equals(this.getQueryText()) == false) return false; if (other.getAttributeFilter() == null ^ this.getAttributeFilter() == null) return false; if (other.getAttributeFilter() != null && other.getAttributeFilter().equals(this.getAttributeFilter()) == false) return false; if (other.getRequestedDocumentAttributes() == null ^ this.getRequestedDocumentAttributes() == null) return false; if (other.getRequestedDocumentAttributes() != null && other.getRequestedDocumentAttributes().equals(this.getRequestedDocumentAttributes()) == false) return false; if (other.getDocumentRelevanceOverrideConfigurations() == null ^ this.getDocumentRelevanceOverrideConfigurations() == null) return false; if (other.getDocumentRelevanceOverrideConfigurations() != null && other.getDocumentRelevanceOverrideConfigurations().equals(this.getDocumentRelevanceOverrideConfigurations()) == false) return false; if (other.getPageNumber() == null ^ this.getPageNumber() == null) return false; if (other.getPageNumber() != null && other.getPageNumber().equals(this.getPageNumber()) == false) return false; if (other.getPageSize() == null ^ this.getPageSize() == null) return false; if (other.getPageSize() != null && other.getPageSize().equals(this.getPageSize()) == false) return false; if (other.getUserContext() == null ^ this.getUserContext() == null) return false; if (other.getUserContext() != null && other.getUserContext().equals(this.getUserContext()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getIndexId() == null) ? 0 : getIndexId().hashCode()); hashCode = prime * hashCode + ((getQueryText() == null) ? 0 : getQueryText().hashCode()); hashCode = prime * hashCode + ((getAttributeFilter() == null) ? 0 : getAttributeFilter().hashCode()); hashCode = prime * hashCode + ((getRequestedDocumentAttributes() == null) ? 0 : getRequestedDocumentAttributes().hashCode()); hashCode = prime * hashCode + ((getDocumentRelevanceOverrideConfigurations() == null) ? 0 : getDocumentRelevanceOverrideConfigurations().hashCode()); hashCode = prime * hashCode + ((getPageNumber() == null) ? 0 : getPageNumber().hashCode()); hashCode = prime * hashCode + ((getPageSize() == null) ? 0 : getPageSize().hashCode()); hashCode = prime * hashCode + ((getUserContext() == null) ? 0 : getUserContext().hashCode()); return hashCode; } @Override public RetrieveRequest clone() { return (RetrieveRequest) super.clone(); } }




© 2015 - 2025 Weber Informatics LLC | Privacy Policy