Interface TextSegment.Builder

All Superinterfaces:
Buildable, CopyableBuilder<TextSegment.Builder,TextSegment>, SdkBuilder<TextSegment.Builder,TextSegment>, SdkPojo
Enclosing class:
TextSegment
@Mutable @NotThreadSafe public static interface TextSegment.Builder extends SdkPojo, CopyableBuilder<TextSegment.Builder,TextSegment>

  • Method Details

    • beginOffset

      TextSegment.Builder beginOffset(Integer beginOffset)

      The zero-based location in the response string where the source attribution starts.

      Parameters:
      beginOffset - The zero-based location in the response string where the source attribution starts.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • endOffset

      TextSegment.Builder endOffset(Integer endOffset)

      The zero-based location in the response string where the source attribution ends.

      Parameters:
      endOffset - The zero-based location in the response string where the source attribution ends.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • snippetExcerpt

      TextSegment.Builder snippetExcerpt(SnippetExcerpt snippetExcerpt)

      The relevant text excerpt from a source that was used to generate a citation text segment in an Amazon Q Business chat response.

      Parameters:
      snippetExcerpt - The relevant text excerpt from a source that was used to generate a citation text segment in an Amazon Q Business chat response.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • snippetExcerpt

      default TextSegment.Builder snippetExcerpt(Consumer<SnippetExcerpt.Builder> snippetExcerpt)

      The relevant text excerpt from a source that was used to generate a citation text segment in an Amazon Q Business chat response.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to snippetExcerpt(SnippetExcerpt).

      Parameters:
      snippetExcerpt - a consumer that will call methods on SnippetExcerpt.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • mediaId

      @Deprecated TextSegment.Builder mediaId(String mediaId)
      Deprecated.
      Deprecated in favor of using mediaId within the respective sourceDetails field.

      The identifier of the media object associated with the text segment in the source attribution.

      Parameters:
      mediaId - The identifier of the media object associated with the text segment in the source attribution.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • mediaMimeType

      @Deprecated TextSegment.Builder mediaMimeType(String mediaMimeType)
      Deprecated.
      Deprecated in favor of using mediaMimeType within the respective sourceDetails field.

      The MIME type (image/png) of the media object associated with the text segment in the source attribution.

      Parameters:
      mediaMimeType - The MIME type (image/png) of the media object associated with the text segment in the source attribution.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sourceDetails

      TextSegment.Builder sourceDetails(SourceDetails sourceDetails)

      Source information for a segment of extracted text, including its media type.

      Parameters:
      sourceDetails - Source information for a segment of extracted text, including its media type.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sourceDetails

      default TextSegment.Builder sourceDetails(Consumer<SourceDetails.Builder> sourceDetails)

      Source information for a segment of extracted text, including its media type.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to sourceDetails(SourceDetails).

      Parameters:
      sourceDetails - a consumer that will call methods on SourceDetails.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: