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

Interface FeaturedResultsItem.Builder

    • Method Detail

      • id

        FeaturedResultsItem.Builder id​(String id)

        The identifier of the featured result.

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

      • type

        FeaturedResultsItem.Builder type​(String type)

        The type of document within the featured result response. For example, a response could include a question-answer type that's relevant to the query.

        Parameters:
        type - The type of document within the featured result response. For example, a response could include a question-answer type that's relevant to the query.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        QueryResultType, QueryResultType

      • type

        FeaturedResultsItem.Builder type​(QueryResultType type)

        The type of document within the featured result response. For example, a response could include a question-answer type that's relevant to the query.

        Parameters:
        type - The type of document within the featured result response. For example, a response could include a question-answer type that's relevant to the query.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        QueryResultType, QueryResultType

      • additionalAttributes

        FeaturedResultsItem.Builder additionalAttributes​(Collection<AdditionalResultAttribute> additionalAttributes)

        One or more additional attributes associated with the featured result.

        Parameters:
        additionalAttributes - One or more additional attributes associated with the featured result.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • additionalAttributes

        FeaturedResultsItem.Builder additionalAttributes​(AdditionalResultAttribute... additionalAttributes)

        One or more additional attributes associated with the featured result.

        Parameters:
        additionalAttributes - One or more additional attributes associated with the featured result.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • documentId

        FeaturedResultsItem.Builder documentId​(String documentId)

        The identifier of the featured document.

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

      • documentTitle

        FeaturedResultsItem.Builder documentTitle​(TextWithHighlights documentTitle)
        Sets the value of the DocumentTitle property for this object.
        Parameters:
        documentTitle - The new value for the DocumentTitle property for this object.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • documentExcerpt

        FeaturedResultsItem.Builder documentExcerpt​(TextWithHighlights documentExcerpt)
        Sets the value of the DocumentExcerpt property for this object.
        Parameters:
        documentExcerpt - The new value for the DocumentExcerpt property for this object.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • documentURI

        FeaturedResultsItem.Builder documentURI​(String documentURI)

        The source URI location of the featured document.

        Parameters:
        documentURI - The source URI location of the featured document.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • documentAttributes

        FeaturedResultsItem.Builder documentAttributes​(Collection<DocumentAttribute> documentAttributes)

        An array of document attributes assigned to a featured document in the search results. For example, the document author (_author) or the source URI (_source_uri) of the document.

        Parameters:
        documentAttributes - An array of document attributes assigned to a featured document in the search results. For example, the document author (_author) or the source URI (_source_uri) of the document.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • documentAttributes

        FeaturedResultsItem.Builder documentAttributes​(DocumentAttribute... documentAttributes)

        An array of document attributes assigned to a featured document in the search results. For example, the document author (_author) or the source URI (_source_uri) of the document.

        Parameters:
        documentAttributes - An array of document attributes assigned to a featured document in the search results. For example, the document author (_author) or the source URI (_source_uri) of the document.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • documentAttributes

        FeaturedResultsItem.Builder documentAttributes​(Consumer<DocumentAttribute.Builder>... documentAttributes)

        An array of document attributes assigned to a featured document in the search results. For example, the document author (_author) or the source URI (_source_uri) of the document.

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

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

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

      • feedbackToken

        FeaturedResultsItem.Builder feedbackToken​(String feedbackToken)

        A token that identifies a particular featured result from a particular query. Use this token to provide click-through feedback for the result. For more information, see Submitting feedback.

        Parameters:
        feedbackToken - A token that identifies a particular featured result from a particular query. Use this token to provide click-through feedback for the result. For more information, see Submitting feedback.
        Returns:
        Returns a reference to this object so that method calls can be chained together.