Package software.amazon.awssdk.services.kendra.model

Interface RetrieveRequest.Builder

    • Method Detail

      • indexId

        RetrieveRequest.Builder indexId​(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.

      • queryText

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

      • attributeFilter

        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.

        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.

      • requestedDocumentAttributes

        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.

        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.

      • requestedDocumentAttributes

        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.

        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.

      • documentRelevanceOverrideConfigurations

        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.

        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.

      • documentRelevanceOverrideConfigurations

        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.

        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.

      • documentRelevanceOverrideConfigurations

        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 the DocumentRelevanceConfiguration.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).

        Parameters:
        documentRelevanceOverrideConfigurations - a consumer that will call methods on DocumentRelevanceConfiguration.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #documentRelevanceOverrideConfigurations(java.util.Collection)

      • pageNumber

        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.

        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.

      • pageSize

        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.

        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.

      • userContext

        RetrieveRequest.Builder userContext​(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.