Skip to content

get_batch_evaluation

Operation

get_batch_evaluation

get_batch_evaluation(request: GetBatchEvaluationInput | GetBatchEvaluationInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetBatchEvaluationInputDict]) -> GetBatchEvaluationOutput

Retrieves detailed information about a batch evaluation, including its status, configuration, results, and any error details.

Parameters:

Name Type Description Default
request GetBatchEvaluationInput | GetBatchEvaluationInputDict | 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[GetBatchEvaluationInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetBatchEvaluationOutput

An instance of GetBatchEvaluationOutput.

get_batch_evaluation async

get_batch_evaluation(request: GetBatchEvaluationInput | GetBatchEvaluationInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetBatchEvaluationInputDict]) -> GetBatchEvaluationOutput

Retrieves detailed information about a batch evaluation, including its status, configuration, results, and any error details.

Parameters:

Name Type Description Default
request GetBatchEvaluationInput | GetBatchEvaluationInputDict | 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[GetBatchEvaluationInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetBatchEvaluationOutput

An instance of GetBatchEvaluationOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

GetBatchEvaluationInputDict

Bases: TypedDict

Dictionary form of GetBatchEvaluationInput.

Attributes

batch_evaluation_id instance-attribute
batch_evaluation_id: Required[str]

The unique identifier of the batch evaluation to retrieve.

GetBatchEvaluationInput dataclass

Bases: _SerdeShape

Dataclass for GetBatchEvaluationInput structure.

Attributes

batch_evaluation_id class-attribute instance-attribute
batch_evaluation_id: str | None = ...

The unique identifier of the batch evaluation to retrieve.

Output

GetBatchEvaluationOutput dataclass

Bases: _SerdeShape

Dataclass for GetBatchEvaluationOutput structure.

Attributes

batch_evaluation_arn instance-attribute
batch_evaluation_arn: str

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

batch_evaluation_id instance-attribute
batch_evaluation_id: str

The unique identifier of the batch evaluation.

batch_evaluation_name instance-attribute
batch_evaluation_name: str

The name of the batch evaluation.

created_at instance-attribute
created_at: datetime

The timestamp when the batch evaluation was created.

data_source_config class-attribute instance-attribute
data_source_config: DataSourceConfig | None = ...

The data source configuration specifying where agent traces are pulled from.

description class-attribute instance-attribute
description: str | None = ...

The description of the batch evaluation.

error_details class-attribute instance-attribute
error_details: list[str] | None = ...

The error details if the batch evaluation encountered failures.

evaluation_results class-attribute instance-attribute
evaluation_results: EvaluationJobResults | None = ...

The aggregated evaluation results, including session completion counts and evaluator score summaries.

evaluators class-attribute instance-attribute
evaluators: list[Evaluator] | None = ...

The list of evaluators applied during the batch evaluation.

execution_summary_result class-attribute instance-attribute
execution_summary_result: ExecutionSummaryClusteringResultContent | None = ...

The execution summary clustering results from insights, containing grouped execution patterns across evaluated sessions.

failure_analysis_result class-attribute instance-attribute
failure_analysis_result: FailureAnalysisResultContent | None = ...

The failure analysis results from insights, containing categorized failure clusters with root causes and recommendations.

insight_results class-attribute instance-attribute
insight_results: list[InsightResult] | None = ...

The insights generated when the batch evaluation includes the Builtin.FailureAnalysis evaluator. Each insight groups related failures found across the evaluated sessions. An empty list means that no failures were found. If the analysis fails, this field is omitted and errorDetails describes the error.

insights class-attribute instance-attribute
insights: list[Insight] | None = ...

The list of insight analyses applied during the batch evaluation.

kms_key_arn class-attribute instance-attribute
kms_key_arn: str | None = ...

The ARN of the KMS key used to encrypt evaluation data.

output_config class-attribute instance-attribute
output_config: OutputConfig | None = ...

The output configuration specifying where evaluation results are written.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

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.

status instance-attribute
status: str

The current status of the batch evaluation.

updated_at class-attribute instance-attribute
updated_at: datetime | None = ...

The timestamp when the batch evaluation was last updated.

user_intent_result class-attribute instance-attribute
user_intent_result: UserIntentClusteringResultContent | None = ...

The user intent clustering results from insights, containing grouped user intents across evaluated sessions.