Class RetrievedReference

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

Contains metadata about a source cited for the generated response.

This data type is used in the following API operations:

See Also:

  • Method Details

    • content

      public final RetrievalResultContent content()

      Contains the cited text from the data source.

      Returns:
      Contains the cited text from the data source.

    • location

      public final RetrievalResultLocation location()

      Contains information about the location of the data source.

      Returns:
      Contains information about the location of the data source.

    • hasMetadata

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

    • metadata

      public final Map<String,Document> metadata()

      Contains metadata attributes and their values for the file in the data source. For more information, see Metadata and filtering.

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

      Returns:
      Contains metadata attributes and their values for the file in the data source. For more information, see Metadata and filtering.

    • toBuilder

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

    • builder

      public static RetrievedReference.Builder builder()

    • serializableBuilderClass

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