Class AgenticRetrieveCitation

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

A citation mapping a span of the generated answer to supporting results.

See Also:

  • Method Details

    • endIndex

      public final Integer endIndex()

      Character offset end (exclusive) in the answer text.

      Returns:
      Character offset end (exclusive) in the answer text.

    • hasReferences

      public final boolean hasReferences()
      For responses, this returns true if the service returned a value for the References property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • references

      public final List<AgenticRetrieveCitationReference> references()

      References to results that support this span.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasReferences() method.

      Returns:
      References to results that support this span.

    • startIndex

      public final Integer startIndex()

      Character offset start in the answer text.

      Returns:
      Character offset start in the answer text.

    • toBuilder

      public AgenticRetrieveCitation.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<AgenticRetrieveCitation.Builder,AgenticRetrieveCitation>
      Returns:
      a builder for type T

    • builder

      public static AgenticRetrieveCitation.Builder builder()

    • serializableBuilderClass

      public static Class<? extends AgenticRetrieveCitation.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.