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

Class CreateEvaluationJobRequest

    • Method Detail

      • jobName

        public final String jobName()

        The name of the model evaluation job. Model evaluation job names must unique with your AWS account, and your account's AWS region.

        Returns:
        The name of the model evaluation job. Model evaluation job names must unique with your AWS account, and your account's AWS region.

      • jobDescription

        public final String jobDescription()

        A description of the model evaluation job.

        Returns:
        A description of the model evaluation job.

      • clientRequestToken

        public final String clientRequestToken()

        A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

        Returns:
        A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

      • roleArn

        public final String roleArn()

        The Amazon Resource Name (ARN) of an IAM service role that Amazon Bedrock can assume to perform tasks on your behalf. The service role must have Amazon Bedrock as the service principal, and provide access to any Amazon S3 buckets specified in the EvaluationConfig object. To pass this role to Amazon Bedrock, the caller of this API must have the iam:PassRole permission. To learn more about the required permissions, see Required permissions.

        Returns:
        The Amazon Resource Name (ARN) of an IAM service role that Amazon Bedrock can assume to perform tasks on your behalf. The service role must have Amazon Bedrock as the service principal, and provide access to any Amazon S3 buckets specified in the EvaluationConfig object. To pass this role to Amazon Bedrock, the caller of this API must have the iam:PassRole permission. To learn more about the required permissions, see Required permissions.

      • customerEncryptionKeyId

        public final String customerEncryptionKeyId()

        Specify your customer managed key ARN that will be used to encrypt your model evaluation job.

        Returns:
        Specify your customer managed key ARN that will be used to encrypt your model evaluation job.

      • hasJobTags

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

      • jobTags

        public final List<Tag> jobTags()

        Tags to attach to the model 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 hasJobTags() method.

        Returns:
        Tags to attach to the model evaluation job.

      • evaluationConfig

        public final EvaluationConfig evaluationConfig()

        Specifies whether the model evaluation job is automatic or uses human worker.

        Returns:
        Specifies whether the model evaluation job is automatic or uses human worker.

      • inferenceConfig

        public final EvaluationInferenceConfig inferenceConfig()

        Specify the models you want to use in your model evaluation job. Automatic model evaluation jobs support a single model, and model evaluation job that use human workers support two models.

        Returns:
        Specify the models you want to use in your model evaluation job. Automatic model evaluation jobs support a single model, and model evaluation job that use human workers support two models.

      • outputDataConfig

        public final EvaluationOutputDataConfig outputDataConfig()

        An object that defines where the results of model evaluation job will be saved in Amazon S3.

        Returns:
        An object that defines where the results of model evaluation job will be saved in Amazon S3.

      • 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