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

Interface QueryRequest.Builder

    • Method Detail

      • indexId

        QueryRequest.Builder indexId​(String indexId)

        The identifier of the index for the search.

        Parameters:
        indexId - The identifier of the index for the search.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • queryText

        QueryRequest.Builder queryText​(String queryText)

        The input query text 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 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

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

      • facets

        QueryRequest.Builder facets​(Collection<Facet> facets)

        An array of documents fields/attributes for faceted search. Amazon Kendra returns a count for each field key specified. This helps your users narrow their search.

        Parameters:
        facets - An array of documents fields/attributes for faceted search. Amazon Kendra returns a count for each field key specified. This helps your users narrow their search.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • facets

        QueryRequest.Builder facets​(Facet... facets)

        An array of documents fields/attributes for faceted search. Amazon Kendra returns a count for each field key specified. This helps your users narrow their search.

        Parameters:
        facets - An array of documents fields/attributes for faceted search. Amazon Kendra returns a count for each field key specified. This helps your users narrow their search.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • facets

        QueryRequest.Builder facets​(Consumer<Facet.Builder>... facets)

        An array of documents fields/attributes for faceted search. Amazon Kendra returns a count for each field key specified. This helps your users narrow their search.

        This is a convenience method that creates an instance of the Facet.Builder avoiding the need to create one manually via Facet.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #facets(List).

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

      • requestedDocumentAttributes

        QueryRequest.Builder requestedDocumentAttributes​(Collection<String> requestedDocumentAttributes)

        An array of document fields/attributes to include in the response. You can limit the response to include certain document fields. By default, all document attributes are included in the response.

        Parameters:
        requestedDocumentAttributes - An array of document fields/attributes to include in the response. You can limit the response to include certain document fields. By default, all document attributes are included in the response.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • requestedDocumentAttributes

        QueryRequest.Builder requestedDocumentAttributes​(String... requestedDocumentAttributes)

        An array of document fields/attributes to include in the response. You can limit the response to include certain document fields. By default, all document attributes are included in the response.

        Parameters:
        requestedDocumentAttributes - An array of document fields/attributes to include in the response. You can limit the response to include certain document fields. By default, all document attributes are included in the response.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • queryResultTypeFilter

        QueryRequest.Builder queryResultTypeFilter​(String queryResultTypeFilter)

        Sets the type of query result or response. Only results for the specified type are returned.

        Parameters:
        queryResultTypeFilter - Sets the type of query result or response. Only results for the specified type are returned.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        QueryResultType, QueryResultType

      • queryResultTypeFilter

        QueryRequest.Builder queryResultTypeFilter​(QueryResultType queryResultTypeFilter)

        Sets the type of query result or response. Only results for the specified type are returned.

        Parameters:
        queryResultTypeFilter - Sets the type of query result or response. Only results for the specified type are returned.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        QueryResultType, QueryResultType

      • documentRelevanceOverrideConfigurations

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

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

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

        QueryRequest.Builder pageNumber​(Integer pageNumber)

        Query results 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 - Query results 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

        QueryRequest.Builder pageSize​(Integer pageSize)

        Sets the number of results 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 results 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.

      • sortingConfiguration

        QueryRequest.Builder sortingConfiguration​(SortingConfiguration sortingConfiguration)

        Provides information that determines how the results of the query are sorted. You can set the field that Amazon Kendra should sort the results on, and specify whether the results should be sorted in ascending or descending order. In the case of ties in sorting the results, the results are sorted by relevance.

        If you don't provide sorting configuration, the results are sorted by the relevance that Amazon Kendra determines for the result.

        Parameters:
        sortingConfiguration - Provides information that determines how the results of the query are sorted. You can set the field that Amazon Kendra should sort the results on, and specify whether the results should be sorted in ascending or descending order. In the case of ties in sorting the results, the results are sorted by relevance.

        If you don't provide sorting configuration, the results are sorted by the relevance that Amazon Kendra determines for the result.

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

      • sortingConfigurations

        QueryRequest.Builder sortingConfigurations​(Collection<SortingConfiguration> sortingConfigurations)

        Provides configuration information to determine how the results of a query are sorted.

        You can set upto 3 fields that Amazon Kendra should sort the results on, and specify whether the results should be sorted in ascending or descending order. The sort field quota can be increased.

        If you don't provide a sorting configuration, the results are sorted by the relevance that Amazon Kendra determines for the result. In the case of ties in sorting the results, the results are sorted by relevance.

        Parameters:
        sortingConfigurations - Provides configuration information to determine how the results of a query are sorted.

        You can set upto 3 fields that Amazon Kendra should sort the results on, and specify whether the results should be sorted in ascending or descending order. The sort field quota can be increased.

        If you don't provide a sorting configuration, the results are sorted by the relevance that Amazon Kendra determines for the result. In the case of ties in sorting the results, the results are sorted by relevance.

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

      • sortingConfigurations

        QueryRequest.Builder sortingConfigurations​(SortingConfiguration... sortingConfigurations)

        Provides configuration information to determine how the results of a query are sorted.

        You can set upto 3 fields that Amazon Kendra should sort the results on, and specify whether the results should be sorted in ascending or descending order. The sort field quota can be increased.

        If you don't provide a sorting configuration, the results are sorted by the relevance that Amazon Kendra determines for the result. In the case of ties in sorting the results, the results are sorted by relevance.

        Parameters:
        sortingConfigurations - Provides configuration information to determine how the results of a query are sorted.

        You can set upto 3 fields that Amazon Kendra should sort the results on, and specify whether the results should be sorted in ascending or descending order. The sort field quota can be increased.

        If you don't provide a sorting configuration, the results are sorted by the relevance that Amazon Kendra determines for the result. In the case of ties in sorting the results, the results are sorted by relevance.

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

      • sortingConfigurations

        QueryRequest.Builder sortingConfigurations​(Consumer<SortingConfiguration.Builder>... sortingConfigurations)

        Provides configuration information to determine how the results of a query are sorted.

        You can set upto 3 fields that Amazon Kendra should sort the results on, and specify whether the results should be sorted in ascending or descending order. The sort field quota can be increased.

        If you don't provide a sorting configuration, the results are sorted by the relevance that Amazon Kendra determines for the result. In the case of ties in sorting the results, the results are sorted by relevance.

        This is a convenience method that creates an instance of the SortingConfiguration.Builder avoiding the need to create one manually via SortingConfiguration.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #sortingConfigurations(List).

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

      • userContext

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

      • visitorId

        QueryRequest.Builder visitorId​(String visitorId)

        Provides an identifier for a specific user. The VisitorId should be a unique identifier, such as a GUID. Don't use personally identifiable information, such as the user's email address, as the VisitorId.

        Parameters:
        visitorId - Provides an identifier for a specific user. The VisitorId should be a unique identifier, such as a GUID. Don't use personally identifiable information, such as the user's email address, as the VisitorId.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • spellCorrectionConfiguration

        QueryRequest.Builder spellCorrectionConfiguration​(SpellCorrectionConfiguration spellCorrectionConfiguration)

        Enables suggested spell corrections for queries.

        Parameters:
        spellCorrectionConfiguration - Enables suggested spell corrections for queries.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • collapseConfiguration

        QueryRequest.Builder collapseConfiguration​(CollapseConfiguration collapseConfiguration)

        Provides configuration to determine how to group results by document attribute value, and how to display them (collapsed or expanded) under a designated primary document for each group.

        Parameters:
        collapseConfiguration - Provides configuration to determine how to group results by document attribute value, and how to display them (collapsed or expanded) under a designated primary document for each group.
        Returns:
        Returns a reference to this object so that method calls can be chained together.