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

Interface FeaturedResultsSet.Builder

    • Method Detail

      • featuredResultsSetId

        FeaturedResultsSet.Builder featuredResultsSetId​(String featuredResultsSetId)

        The identifier of the set of featured results.

        Parameters:
        featuredResultsSetId - The identifier of the set of featured results.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • featuredResultsSetName

        FeaturedResultsSet.Builder featuredResultsSetName​(String featuredResultsSetName)

        The name for the set of featured results.

        Parameters:
        featuredResultsSetName - The name for the set of featured results.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • description

        FeaturedResultsSet.Builder description​(String description)

        The description for the set of featured results.

        Parameters:
        description - The description for the set of featured results.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • status

        FeaturedResultsSet.Builder status​(String status)

        The current status of the set of featured results. When the value is ACTIVE, featured results are ready for use. You can still configure your settings before setting the status to ACTIVE. You can set the status to ACTIVE or INACTIVE using the UpdateFeaturedResultsSet API. The queries you specify for featured results must be unique per featured results set for each index, whether the status is ACTIVE or INACTIVE.

        Parameters:
        status - The current status of the set of featured results. When the value is ACTIVE, featured results are ready for use. You can still configure your settings before setting the status to ACTIVE. You can set the status to ACTIVE or INACTIVE using the UpdateFeaturedResultsSet API. The queries you specify for featured results must be unique per featured results set for each index, whether the status is ACTIVE or INACTIVE.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        FeaturedResultsSetStatus, FeaturedResultsSetStatus

      • status

        FeaturedResultsSet.Builder status​(FeaturedResultsSetStatus status)

        The current status of the set of featured results. When the value is ACTIVE, featured results are ready for use. You can still configure your settings before setting the status to ACTIVE. You can set the status to ACTIVE or INACTIVE using the UpdateFeaturedResultsSet API. The queries you specify for featured results must be unique per featured results set for each index, whether the status is ACTIVE or INACTIVE.

        Parameters:
        status - The current status of the set of featured results. When the value is ACTIVE, featured results are ready for use. You can still configure your settings before setting the status to ACTIVE. You can set the status to ACTIVE or INACTIVE using the UpdateFeaturedResultsSet API. The queries you specify for featured results must be unique per featured results set for each index, whether the status is ACTIVE or INACTIVE.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        FeaturedResultsSetStatus, FeaturedResultsSetStatus

      • queryTexts

        FeaturedResultsSet.Builder queryTexts​(Collection<String> queryTexts)

        The list of queries for featuring results.

        Specific queries are mapped to specific documents for featuring in the results. If a query contains an exact match, then one or more specific documents are featured in the results. The exact match applies to the full query. For example, if you only specify 'Kendra', queries such as 'How does kendra semantically rank results?' will not render the featured results. Featured results are designed for specific queries, rather than queries that are too broad in scope.

        Parameters:
        queryTexts - The list of queries for featuring results.

        Specific queries are mapped to specific documents for featuring in the results. If a query contains an exact match, then one or more specific documents are featured in the results. The exact match applies to the full query. For example, if you only specify 'Kendra', queries such as 'How does kendra semantically rank results?' will not render the featured results. Featured results are designed for specific queries, rather than queries that are too broad in scope.

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

      • queryTexts

        FeaturedResultsSet.Builder queryTexts​(String... queryTexts)

        The list of queries for featuring results.

        Specific queries are mapped to specific documents for featuring in the results. If a query contains an exact match, then one or more specific documents are featured in the results. The exact match applies to the full query. For example, if you only specify 'Kendra', queries such as 'How does kendra semantically rank results?' will not render the featured results. Featured results are designed for specific queries, rather than queries that are too broad in scope.

        Parameters:
        queryTexts - The list of queries for featuring results.

        Specific queries are mapped to specific documents for featuring in the results. If a query contains an exact match, then one or more specific documents are featured in the results. The exact match applies to the full query. For example, if you only specify 'Kendra', queries such as 'How does kendra semantically rank results?' will not render the featured results. Featured results are designed for specific queries, rather than queries that are too broad in scope.

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

      • featuredDocuments

        FeaturedResultsSet.Builder featuredDocuments​(Collection<FeaturedDocument> featuredDocuments)

        The list of document IDs for the documents you want to feature at the top of the search results page. You can use the Query API to search for specific documents with their document IDs included in the result items, or you can use the console.

        You can add up to four featured documents. You can request to increase this limit by contacting Support.

        Specific queries are mapped to specific documents for featuring in the results. If a query contains an exact match, then one or more specific documents are featured in the results. The exact match applies to the full query. For example, if you only specify 'Kendra', queries such as 'How does kendra semantically rank results?' will not render the featured results. Featured results are designed for specific queries, rather than queries that are too broad in scope.

        Parameters:
        featuredDocuments - The list of document IDs for the documents you want to feature at the top of the search results page. You can use the Query API to search for specific documents with their document IDs included in the result items, or you can use the console.

        You can add up to four featured documents. You can request to increase this limit by contacting Support.

        Specific queries are mapped to specific documents for featuring in the results. If a query contains an exact match, then one or more specific documents are featured in the results. The exact match applies to the full query. For example, if you only specify 'Kendra', queries such as 'How does kendra semantically rank results?' will not render the featured results. Featured results are designed for specific queries, rather than queries that are too broad in scope.

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

      • featuredDocuments

        FeaturedResultsSet.Builder featuredDocuments​(FeaturedDocument... featuredDocuments)

        The list of document IDs for the documents you want to feature at the top of the search results page. You can use the Query API to search for specific documents with their document IDs included in the result items, or you can use the console.

        You can add up to four featured documents. You can request to increase this limit by contacting Support.

        Specific queries are mapped to specific documents for featuring in the results. If a query contains an exact match, then one or more specific documents are featured in the results. The exact match applies to the full query. For example, if you only specify 'Kendra', queries such as 'How does kendra semantically rank results?' will not render the featured results. Featured results are designed for specific queries, rather than queries that are too broad in scope.

        Parameters:
        featuredDocuments - The list of document IDs for the documents you want to feature at the top of the search results page. You can use the Query API to search for specific documents with their document IDs included in the result items, or you can use the console.

        You can add up to four featured documents. You can request to increase this limit by contacting Support.

        Specific queries are mapped to specific documents for featuring in the results. If a query contains an exact match, then one or more specific documents are featured in the results. The exact match applies to the full query. For example, if you only specify 'Kendra', queries such as 'How does kendra semantically rank results?' will not render the featured results. Featured results are designed for specific queries, rather than queries that are too broad in scope.

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

      • featuredDocuments

        FeaturedResultsSet.Builder featuredDocuments​(Consumer<FeaturedDocument.Builder>... featuredDocuments)

        The list of document IDs for the documents you want to feature at the top of the search results page. You can use the Query API to search for specific documents with their document IDs included in the result items, or you can use the console.

        You can add up to four featured documents. You can request to increase this limit by contacting Support.

        Specific queries are mapped to specific documents for featuring in the results. If a query contains an exact match, then one or more specific documents are featured in the results. The exact match applies to the full query. For example, if you only specify 'Kendra', queries such as 'How does kendra semantically rank results?' will not render the featured results. Featured results are designed for specific queries, rather than queries that are too broad in scope.

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

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

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

      • lastUpdatedTimestamp

        FeaturedResultsSet.Builder lastUpdatedTimestamp​(Long lastUpdatedTimestamp)

        The Unix timestamp when the set of featured results was last updated.

        Parameters:
        lastUpdatedTimestamp - The Unix timestamp when the set of featured results was last updated.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • creationTimestamp

        FeaturedResultsSet.Builder creationTimestamp​(Long creationTimestamp)

        The Unix timestamp when the set of featured results was created.

        Parameters:
        creationTimestamp - The Unix timestamp when the set of featured results was created.
        Returns:
        Returns a reference to this object so that method calls can be chained together.