Class EvaluationSummary
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<EvaluationSummary.Builder,
EvaluationSummary>
Summary information of an evaluation job.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionfinal ApplicationType
Specifies whether the evaluation job is for evaluating a model or evaluating a knowledge base (retrieval and response generation).final String
Specifies whether the evaluation job is for evaluating a model or evaluating a knowledge base (retrieval and response generation).static EvaluationSummary.Builder
builder()
final Instant
The time the evaluation job was created.The Amazon Resource Names (ARNs) of the models used to compute custom metrics in an Amazon Bedrock evaluation job.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final List
<EvaluationTaskType> The type of task for model evaluation.The type of task for model evaluation.The Amazon Resource Names (ARNs) of the models used to compute the metrics for a knowledge base evaluation job.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the CustomMetricsEvaluatorModelIdentifiers property.final boolean
For responses, this returns true if the service returned a value for the EvaluationTaskTypes property.final boolean
For responses, this returns true if the service returned a value for the EvaluatorModelIdentifiers property.final int
hashCode()
final boolean
Deprecated.Inference identifiers should be retrieved from the inferenceConfigSummaryfinal boolean
Deprecated.Inference identifiers should be retrieved from the inferenceConfigSummaryIdentifies the models, Knowledge Bases, or other RAG sources evaluated in a model or Knowledge Base evaluation job.final String
jobArn()
The Amazon Resource Name (ARN) of the evaluation job.final String
jobName()
The name for the evaluation job.final EvaluationJobType
jobType()
Specifies whether the evaluation job is automated or human-based.final String
Specifies whether the evaluation job is automated or human-based.Deprecated.Inference identifiers should be retrieved from the inferenceConfigSummaryDeprecated.Inference identifiers should be retrieved from the inferenceConfigSummarystatic Class
<? extends EvaluationSummary.Builder> final EvaluationJobStatus
status()
The current status of the evaluation job.final String
The current status of the evaluation job.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
jobArn
The Amazon Resource Name (ARN) of the evaluation job.
- Returns:
- The Amazon Resource Name (ARN) of the evaluation job.
-
jobName
The name for the evaluation job.
- Returns:
- The name for the evaluation job.
-
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 returnEvaluationJobStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The current status of the evaluation job.
- See Also:
-
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 returnEvaluationJobStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The current status of the evaluation job.
- See Also:
-
creationTime
The time the evaluation job was created.
- Returns:
- The time the evaluation job was created.
-
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 returnEvaluationJobType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromjobTypeAsString()
.- Returns:
- Specifies whether the evaluation job is automated or human-based.
- See Also:
-
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 returnEvaluationJobType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromjobTypeAsString()
.- Returns:
- Specifies whether the evaluation job is automated or human-based.
- See Also:
-
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 theisEmpty()
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
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.Inference identifiers should be retrieved from the inferenceConfigSummaryFor 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 theisEmpty()
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.Inference identifiers should be retrieved from the inferenceConfigSummaryThe 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.Inference identifiers should be retrieved from the inferenceConfigSummaryFor 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 theisEmpty()
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.Inference identifiers should be retrieved from the inferenceConfigSummaryThe 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 theisEmpty()
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
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 theisEmpty()
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
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
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
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 returnApplicationType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromapplicationTypeAsString()
.- Returns:
- Specifies whether the evaluation job is for evaluating a model or evaluating a knowledge base (retrieval and response generation).
- See Also:
-
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 returnApplicationType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromapplicationTypeAsString()
.- Returns:
- Specifies whether the evaluation job is for evaluating a model or evaluating a knowledge base (retrieval and response generation).
- See Also:
-
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 interfaceToCopyableBuilder<EvaluationSummary.Builder,
EvaluationSummary> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
-
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
- Returns:
- The mapping between the field name and its corresponding field.
-