Class EvaluationSummary

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

Summary information of an evaluation job.

See Also:

  • Method Details

    • jobArn

      public final String jobArn()

      The Amazon Resource Name (ARN) of the evaluation job.

      Returns:
      The Amazon Resource Name (ARN) of the evaluation job.

    • jobName

      public final String jobName()

      The name for the evaluation job.

      Returns:
      The name for the evaluation job.

    • status

      public final EvaluationJobStatus status()

      The current status of the evaluation job.

      If the service returns an enum value that is not available in the current SDK version, status will return EvaluationJobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The current status of the evaluation job.
      See Also:

    • statusAsString

      public final String statusAsString()

      The current status of the evaluation job.

      If the service returns an enum value that is not available in the current SDK version, status will return EvaluationJobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The current status of the evaluation job.
      See Also:

    • creationTime

      public final Instant creationTime()

      The time the evaluation job was created.

      Returns:
      The time the evaluation job was created.

    • jobType

      public final EvaluationJobType jobType()

      Specifies whether the evaluation job is automated or human-based.

      If the service returns an enum value that is not available in the current SDK version, jobType will return EvaluationJobType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from jobTypeAsString().

      Returns:
      Specifies whether the evaluation job is automated or human-based.
      See Also:

    • jobTypeAsString

      public final String jobTypeAsString()

      Specifies whether the evaluation job is automated or human-based.

      If the service returns an enum value that is not available in the current SDK version, jobType will return EvaluationJobType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from jobTypeAsString().

      Returns:
      Specifies whether the evaluation job is automated or human-based.
      See Also:

    • evaluationTaskTypes

      public final List<EvaluationTaskType> evaluationTaskTypes()

      The type of task for model evaluation.

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

      Returns:
      The type of task for model evaluation.

    • hasEvaluationTaskTypes

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

    • evaluationTaskTypesAsStrings

      public final List<String> evaluationTaskTypesAsStrings()

      The type of task for model evaluation.

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

      Returns:
      The type of task for model evaluation.

    • hasModelIdentifiers

      @Deprecated public final boolean hasModelIdentifiers()
      Deprecated.
      Inference identifiers should be retrieved from the inferenceConfigSummary
      For responses, this returns true if the service returned a value for the ModelIdentifiers 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.

    • modelIdentifiers

      @Deprecated public final List<String> modelIdentifiers()
      Deprecated.
      Inference identifiers should be retrieved from the inferenceConfigSummary

      The Amazon Resource Names (ARNs) of the model(s) used for the evaluation job.

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

      Returns:
      The Amazon Resource Names (ARNs) of the model(s) used for the evaluation job.

    • hasRagIdentifiers

      @Deprecated public final boolean hasRagIdentifiers()
      Deprecated.
      Inference identifiers should be retrieved from the inferenceConfigSummary
      For responses, this returns true if the service returned a value for the RagIdentifiers 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.

    • ragIdentifiers

      @Deprecated public final List<String> ragIdentifiers()
      Deprecated.
      Inference identifiers should be retrieved from the inferenceConfigSummary

      The Amazon Resource Names (ARNs) of the knowledge base resources used for a knowledge base evaluation job.

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

      Returns:
      The Amazon Resource Names (ARNs) of the knowledge base resources used for a knowledge base evaluation job.

    • hasEvaluatorModelIdentifiers

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

    • evaluatorModelIdentifiers

      public final List<String> evaluatorModelIdentifiers()

      The Amazon Resource Names (ARNs) of the models used to compute the metrics for a knowledge base evaluation job.

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

      Returns:
      The Amazon Resource Names (ARNs) of the models used to compute the metrics for a knowledge base evaluation job.

    • hasCustomMetricsEvaluatorModelIdentifiers

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

    • customMetricsEvaluatorModelIdentifiers

      public final List<String> customMetricsEvaluatorModelIdentifiers()

      The Amazon Resource Names (ARNs) of the models used to compute custom metrics in an Amazon Bedrock evaluation job.

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

      Returns:
      The Amazon Resource Names (ARNs) of the models used to compute custom metrics in an Amazon Bedrock evaluation job.

    • inferenceConfigSummary

      public final EvaluationInferenceConfigSummary inferenceConfigSummary()

      Identifies the models, Knowledge Bases, or other RAG sources evaluated in a model or Knowledge Base evaluation job.

      Returns:
      Identifies the models, Knowledge Bases, or other RAG sources evaluated in a model or Knowledge Base evaluation job.

    • applicationType

      public final ApplicationType applicationType()

      Specifies whether the evaluation job is for evaluating a model or evaluating a knowledge base (retrieval and response generation).

      If the service returns an enum value that is not available in the current SDK version, applicationType will return ApplicationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from applicationTypeAsString().

      Returns:
      Specifies whether the evaluation job is for evaluating a model or evaluating a knowledge base (retrieval and response generation).
      See Also:

    • applicationTypeAsString

      public final String applicationTypeAsString()

      Specifies whether the evaluation job is for evaluating a model or evaluating a knowledge base (retrieval and response generation).

      If the service returns an enum value that is not available in the current SDK version, applicationType will return ApplicationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from applicationTypeAsString().

      Returns:
      Specifies whether the evaluation job is for evaluating a model or evaluating a knowledge base (retrieval and response generation).
      See Also:

    • toBuilder

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

    • builder

      public static EvaluationSummary.Builder builder()

    • serializableBuilderClass

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