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

Class CreateEvaluationJobRequest

    • Method Detail

      • jobName

        public final String jobName()

        A name for the evaluation job. Names must unique with your Amazon Web Services account, and your account's Amazon Web Services region.

        Returns:
        A name for the evaluation job. Names must unique with your Amazon Web Services account, and your account's Amazon Web Services region.

      • jobDescription

        public final String jobDescription()

        A description of the evaluation job.

        Returns:
        A description of the 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. To learn more about the required permissions, see Required permissions for model evaluations.

        Returns:
        The Amazon Resource Name (ARN) of an IAM service role that Amazon Bedrock can assume to perform tasks on your behalf. To learn more about the required permissions, see Required permissions for model evaluations.

      • customerEncryptionKeyId

        public final String customerEncryptionKeyId()

        Specify your customer managed encryption key Amazon Resource Name (ARN) that will be used to encrypt your evaluation job.

        Returns:
        Specify your customer managed encryption key Amazon Resource Name (ARN) that will be used to encrypt your 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.

      • 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

      • evaluationConfig

        public final EvaluationConfig evaluationConfig()

        Contains the configuration details of either an automated or human-based evaluation job.

        Returns:
        Contains the configuration details of either an automated or human-based evaluation job.

      • inferenceConfig

        public final EvaluationInferenceConfig inferenceConfig()

        Contains the configuration details of the inference model for the evaluation job.

        For model evaluation jobs, automated jobs support a single model or inference profile, and jobs that use human workers support two models or inference profiles.

        Returns:
        Contains the configuration details of the inference model for the evaluation job.

        For model evaluation jobs, automated jobs support a single model or inference profile, and jobs that use human workers support two models or inference profiles.

      • outputDataConfig

        public final EvaluationOutputDataConfig outputDataConfig()

        Contains the configuration details of the Amazon S3 bucket for storing the results of the evaluation job.

        Returns:
        Contains the configuration details of the Amazon S3 bucket for storing the results of the evaluation job.

      • 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