get_evaluation_job¶
Operation¶
get_evaluation_job
¶
get_evaluation_job(request: GetEvaluationJobInput | GetEvaluationJobInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetEvaluationJobInputDict]) -> GetEvaluationJobOutput
Gets information about an evaluation job, such as the status of the job.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
GetEvaluationJobInput | GetEvaluationJobInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[GetEvaluationJobInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
GetEvaluationJobOutput
|
An instance of |
get_evaluation_job
async
¶
get_evaluation_job(request: GetEvaluationJobInput | GetEvaluationJobInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetEvaluationJobInputDict]) -> GetEvaluationJobOutput
Gets information about an evaluation job, such as the status of the job.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
GetEvaluationJobInput | GetEvaluationJobInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[GetEvaluationJobInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
GetEvaluationJobOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
Output¶
GetEvaluationJobOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for GetEvaluationJobOutput structure.
Attributes¶
application_type
class-attribute
instance-attribute
¶
application_type: str | None = ...
Specifies whether the evaluation job is for evaluating a model or evaluating a knowledge base (retrieval and response generation).
customer_encryption_key_id
class-attribute
instance-attribute
¶
customer_encryption_key_id: str | 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
¶
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_description
class-attribute
instance-attribute
¶
job_description: str | None = ...
The description of the evaluation job.
job_type
instance-attribute
¶
job_type: str
Specifies whether the evaluation job is automated or human-based.
last_modified_time
class-attribute
instance-attribute
¶
last_modified_time: datetime | 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.
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.