Package software.amazon.awssdk.services.bedrock.model

Class EvaluationSummary

    • Method Detail

      • 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.

      • creationTime

        public final Instant creationTime()

        The time the evaluation job was created.

        Returns:
        The time the evaluation job was created.

      • 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:
        EvaluationJobType

      • 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:
        ApplicationType

      • 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:
        ApplicationType

      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object

      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object

      • 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)