Package software.amazon.awssdk.services.bedrockruntime.model

Class Citation

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

Contains information about a citation that references a specific source document. Citations provide traceability between the model's generated response and the source documents that informed that response.

See Also:

  • Method Details

    • title

      public final String title()

      The title or identifier of the source document being cited.

      Returns:
      The title or identifier of the source document being cited.

    • source

      public final String source()

      The source from the original search result that provided the cited content.

      Returns:
      The source from the original search result that provided the cited content.

    • hasSourceContent

      public final boolean hasSourceContent()
      For responses, this returns true if the service returned a value for the SourceContent 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.

    • sourceContent

      public final List<CitationSourceContent> sourceContent()

      The specific content from the source document that was referenced or cited in the generated response.

      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 hasSourceContent() method.

      Returns:
      The specific content from the source document that was referenced or cited in the generated response.

    • location

      public final CitationLocation location()

      The precise location within the source document where the cited content can be found, including character positions, page numbers, or chunk identifiers.

      Returns:
      The precise location within the source document where the cited content can be found, including character positions, page numbers, or chunk identifiers.

    • toBuilder

      public Citation.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<Citation.Builder,Citation>

    • builder

      public static Citation.Builder builder()

    • serializableBuilderClass

      public static Class<? extends Citation.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)
      Specified by:
      equalsBySdkFields in interface SdkPojo

    • 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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo