Class TextSegment

java.lang.Object
software.amazon.awssdk.services.qbusiness.model.TextSegment
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<TextSegment.Builder,TextSegment>
@Generated("software.amazon.awssdk:codegen") public final class TextSegment extends Object implements SdkPojo, Serializable, ToCopyableBuilder<TextSegment.Builder,TextSegment>

Provides information about a text extract in a chat response that can be attributed to a source document.

See Also:

  • Method Details

    • beginOffset

      public final Integer beginOffset()

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

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

    • endOffset

      public final Integer endOffset()

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

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

    • snippetExcerpt

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

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

    • mediaId

      @Deprecated public final 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.

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

    • mediaMimeType

      @Deprecated public final 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.

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

    • sourceDetails

      public final SourceDetails sourceDetails()

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

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

    • toBuilder

      public TextSegment.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<TextSegment.Builder,TextSegment>
      Returns:
      a builder for type T

    • builder

      public static TextSegment.Builder builder()

    • serializableBuilderClass

      public static Class<? extends TextSegment.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.