Bedrock  >  Operations  >  get_evaluation_job

get_evaluation_job

Operation

get_evaluation_job async

get_evaluation_job(input: GetEvaluationJobInput, plugins: list[Plugin] | None = None) -> GetEvaluationJobOutput

Gets information about an evaluation job, such as the status of the job.

Parameters:

Name	Type	Description	Default
input	GetEvaluationJobInput	An instance of GetEvaluationJobInput.	required
plugins	list[Plugin] | None	A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.	None

Returns:

Type	Description
GetEvaluationJobOutput	An instance of GetEvaluationJobOutput.

Input

GetEvaluationJobInput dataclass

Dataclass for GetEvaluationJobInput structure.

Attributes

job_identifier class-attribute instance-attribute

job_identifier: str | None = field(repr=False, default=None)

The Amazon Resource Name (ARN) of the evaluation job you want get information on.

Output

GetEvaluationJobOutput dataclass

Dataclass for GetEvaluationJobOutput structure.

Attributes

application_type class-attribute instance-attribute

application_type: ApplicationType | None = None

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

creation_time instance-attribute

creation_time: datetime

The time the evaluation job was created.

customer_encryption_key_id class-attribute instance-attribute

customer_encryption_key_id: str | None = None

The Amazon Resource Name (ARN) of the customer managed encryption key specified when the evaluation job was created.

evaluation_config instance-attribute

evaluation_config: EvaluationConfig

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

failure_messages class-attribute instance-attribute

failure_messages: list[str] | None = None

A list of strings that specify why the evaluation job failed to create.

inference_config instance-attribute

inference_config: EvaluationInferenceConfig

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

job_arn instance-attribute

job_arn: str

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

job_description class-attribute instance-attribute

job_description: str | None = field(repr=False, default=None)

The description of the evaluation job.

job_name instance-attribute

job_name: str

The name for the evaluation job.

job_type instance-attribute

job_type: EvaluationJobType

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

last_modified_time class-attribute instance-attribute

last_modified_time: datetime | None = None

The time the evaluation job was last modified.

output_data_config instance-attribute

output_data_config: EvaluationOutputDataConfig

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

role_arn instance-attribute

role_arn: str

The Amazon Resource Name (ARN) of the IAM service role used in the evaluation job.

status instance-attribute

status: EvaluationJobStatus

The current status of the evaluation job.