Class EvaluationMetadata

java.lang.Object
software.amazon.awssdk.services.bedrockagentcore.model.EvaluationMetadata
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<EvaluationMetadata.Builder,EvaluationMetadata>

@Generated("software.amazon.awssdk:codegen") public final class EvaluationMetadata extends Object implements SdkPojo, Serializable, ToCopyableBuilder<EvaluationMetadata.Builder,EvaluationMetadata>

Metadata for the evaluation, including session-specific ground truth data.

See Also:
  • Method Details

    • hasSessionMetadata

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

      public final List<SessionMetadataShape> sessionMetadata()

      A list of session metadata entries containing ground truth data and test scenario identifiers for specific sessions.

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

      Returns:
      A list of session metadata entries containing ground truth data and test scenario identifiers for specific sessions.
    • toBuilder

      public EvaluationMetadata.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<EvaluationMetadata.Builder,EvaluationMetadata>
    • builder

      public static EvaluationMetadata.Builder builder()
    • serializableBuilderClass

      public static Class<? extends EvaluationMetadata.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)
    • fromSessionMetadata

      public static EvaluationMetadata fromSessionMetadata(List<SessionMetadataShape> sessionMetadata)
      Create an instance of this class with sessionMetadata() initialized to the given value.

      A list of session metadata entries containing ground truth data and test scenario identifiers for specific sessions.

      Parameters:
      sessionMetadata - A list of session metadata entries containing ground truth data and test scenario identifiers for specific sessions.
    • type

      public EvaluationMetadata.Type type()
      Retrieve an enum value representing which member of this object is populated. When this class is returned in a service response, this will be EvaluationMetadata.Type.UNKNOWN_TO_SDK_VERSION if the service returned a member that is only known to a newer SDK version. When this class is created directly in your code, this will be EvaluationMetadata.Type.UNKNOWN_TO_SDK_VERSION if zero members are set, and null if more than one member is set.
    • 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