get_batch_evaluation¶
Operation¶
async
¶
get_batch_evaluation(input: GetBatchEvaluationInput, plugins: list[Plugin] | None = None) -> GetBatchEvaluationOutput
Retrieves detailed information about a batch evaluation, including its status, configuration, results, and any error details.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
GetBatchEvaluationInput
|
An instance of |
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 |
|---|---|
GetBatchEvaluationOutput
|
An instance of |
Input¶
dataclass
¶
Output¶
dataclass
¶
Dataclass for GetBatchEvaluationOutput structure.
Attributes¶
instance-attribute
¶
batch_evaluation_arn: str
The Amazon Resource Name (ARN) of the batch evaluation.
instance-attribute
¶
batch_evaluation_id: str
The unique identifier of the batch evaluation.
instance-attribute
¶
batch_evaluation_name: str
The name of the batch evaluation.
instance-attribute
¶
created_at: datetime
The timestamp when the batch evaluation was created.
class-attribute
instance-attribute
¶
data_source_config: DataSourceConfig | None = None
The data source configuration specifying where agent traces are pulled from.
class-attribute
instance-attribute
¶
description: str | None = None
The description of the batch evaluation.
class-attribute
instance-attribute
¶
error_details: list[str] | None = None
The error details if the batch evaluation encountered failures.
class-attribute
instance-attribute
¶
evaluation_results: EvaluationJobResults | None = None
The aggregated evaluation results, including session completion counts and evaluator score summaries.
class-attribute
instance-attribute
¶
evaluators: list[Evaluator] | None = None
The list of evaluators applied during the batch evaluation.
class-attribute
instance-attribute
¶
execution_summary_result: ExecutionSummaryClusteringResultContent | None = None
The execution summary clustering results from insights, containing grouped execution patterns across evaluated sessions.
class-attribute
instance-attribute
¶
failure_analysis_result: FailureAnalysisResultContent | None = None
The failure analysis results from insights, containing categorized failure clusters with root causes and recommendations.
class-attribute
instance-attribute
¶
insights: list[Insight] | None = None
The list of insight analyses applied during the batch evaluation.
class-attribute
instance-attribute
¶
kms_key_arn: str | None = None
The ARN of the KMS key used to encrypt evaluation data.
class-attribute
instance-attribute
¶
output_config: OutputConfig | None = None
The output configuration specifying where evaluation results are written.
instance-attribute
¶
status: BatchEvaluationStatus
The current status of the batch evaluation.
class-attribute
instance-attribute
¶
updated_at: datetime | None = None
The timestamp when the batch evaluation was last updated.
class-attribute
instance-attribute
¶
user_intent_result: UserIntentClusteringResultContent | None = None
The user intent clustering results from insights, containing grouped user intents across evaluated sessions.