--- title: "GET /evaluations/batch-evaluate/{batchEvaluationId}" method: GET path: "/evaluations/batch-evaluate/{batchEvaluationId}" --- # GET /evaluations/batch-evaluate/{batchEvaluationId} `GET /evaluations/batch-evaluate/{batchEvaluationId}` Retrieves detailed information about a batch evaluation, including its status, configuration, results, and any error details. ## Path parameters - `batchEvaluationId` string, required — The unique identifier for a batch evaluation. ## Response `200` Success - GetBatchEvaluationResponse - `batchEvaluationId` string, required — The unique identifier of the batch evaluation. - `batchEvaluationArn` string, required — The Amazon Resource Name (ARN) of the batch evaluation. - `batchEvaluationName` string, required — The name of the batch evaluation. - `status` 'PENDING' | 'IN_PROGRESS' | 'COMPLETED' | 'COMPLETED_WITH_ERRORS' | 'FAILED' | 'STOPPING' | 'STOPPED' | 'DELETING', required — The current status of the batch evaluation. - `createdAt` string, date-time, required — The timestamp when the batch evaluation was created. - `evaluators` Evaluator[] — The list of evaluators applied during the batch evaluation. - `evaluatorId` string, required — The unique identifier of the evaluator. Can reference built-in evaluators (e.g., Builtin.Helpfulness) or custom evaluators. - `insights` Insight[] — The list of insight analyses applied during the batch evaluation. - `insightId` string, required — The unique identifier of the insight to run. - `dataSourceConfig` object — The data source configuration specifying where agent traces are pulled from. - `cloudWatchLogs` object — Configuration for pulling agent session traces from CloudWatch Logs. - `serviceNames` String[], required — The list of agent service names to filter traces within the specified log groups. - `logGroupNames` String[], required — The list of CloudWatch log group names to read agent traces from. Maximum of 5 log groups. - `filterConfig` object — Optional filter configuration to narrow down which sessions to evaluate. - `sessionIds` String[] — A list of specific session IDs to evaluate. If specified, only these sessions are included in the evaluation. - `timeRange` object — The time range filter for selecting sessions to evaluate. - `startTime` string, date-time — The start time of the time range. Only sessions with activity at or after this timestamp are included. - `endTime` string, date-time — The end time of the time range. Only sessions with activity before this timestamp are included. - `onlineEvaluationConfigSource` object — Reference an existing OnlineEvaluationConfig as session source - `onlineEvaluationConfigArn` string, required — The Amazon Resource Name (ARN) of the online evaluation configuration to use as the session source. - `timeRange` object — Optional session filter configuration to narrow down which sessions from the online evaluation configuration to include. - `startTime` string, date-time — The start time of the time range. Only sessions with activity at or after this timestamp are included. - `endTime` string, date-time — The end time of the time range. Only sessions with activity before this timestamp are included. - `outputConfig` object — The output configuration specifying where evaluation results are written. - `cloudWatchConfig` object — The CloudWatch Logs configuration for writing evaluation results. - `logGroupName` string, required — The name of the CloudWatch log group where evaluation results will be written. - `logStreamName` string, required — The name of the CloudWatch log stream where evaluation results will be written. - `evaluationResults` object — The aggregated evaluation results, including session completion counts and evaluator score summaries. - `numberOfSessionsCompleted` integer — The number of sessions that have been successfully evaluated. - `numberOfSessionsInProgress` integer — The number of sessions currently being evaluated. - `numberOfSessionsFailed` integer — The number of sessions that failed evaluation. - `totalNumberOfSessions` integer — The total number of sessions included in the batch evaluation. - `numberOfSessionsIgnored` integer — The number of sessions that were ignored during evaluation. - `evaluatorSummaries` EvaluatorSummary[] — A list of per-evaluator summary statistics. - `evaluatorId` string — The unique identifier of the evaluator. - `statistics` object — The aggregated statistics for this evaluator. - `averageScore` number, double — The average score across all evaluated sessions for this evaluator. - `totalEvaluated` integer — The total number of sessions evaluated by this evaluator. - `totalFailed` integer — The total number of sessions that failed evaluation by this evaluator. - `failureAnalysisResult` object — The failure analysis results from insights, containing categorized failure clusters with root causes and recommendations. - `failures` FailureCategoryCluster[], required — The list of failure category clusters identified across analyzed sessions. - `clusterId` integer, required — The unique identifier of the failure category cluster. - `name` string, required — The name of the failure category. - `description` string, required — A description of the failure category pattern. - `affectedSessionCount` integer, required — The number of sessions affected by this failure category. - `subCategories` FailureSubCategoryCluster[], required — The list of failure subcategories within this category. - `clusterId` integer, required — The unique identifier of the failure subcategory cluster. - `name` string, required — The name of the failure subcategory. - `description` string, required — A description of the failure subcategory pattern. - `affectedSessionCount` integer, required — The number of sessions affected by this failure subcategory. - `rootCauses` RootCauseCluster[], required — The list of root cause clusters identified within this subcategory. - `clusterId` integer, required — The unique identifier of the root cause cluster. - `name` string, required — The name of the root cause cluster. - `rootCause` string, required — The root cause explanation for this cluster of failures. - `recommendation` string, required — The recommended fix for this root cause. - `affectedSessionCount` integer, required — The number of sessions affected by this root cause. - `affectedSessions` AffectedSession[], required — The list of sessions affected by this root cause. - `sessionId` string, required — The unique identifier of the affected session. - `explanation` string, required — An explanation of how the failure manifested in this session. - `fixType` string, required — The type of fix recommended for this failure. - `recommendation` string, required — The specific fix recommendation for this session. - `failureSpans` FailureSpanDetail[], required — The list of spans where failures were detected in this session. - … - `userIntentResult` object — The user intent clustering results from insights, containing grouped user intents across evaluated sessions. - `userIntents` UserIntentCluster[], required — The list of user intent clusters identified across analyzed sessions. - `clusterId` integer, required — The unique identifier of the user intent cluster. - `name` string, required — The name of the user intent cluster. - `description` string, required — A description of the user intent pattern. - `affectedSessionCount` integer, required — The number of sessions with this user intent. - `affectedSessions` UserIntentAffectedSession[], required — The list of sessions with this user intent. - `sessionId` string, required — The unique identifier of the session. - `userMessages` String[], required — The user messages from this session that contributed to the intent cluster. - `executionSummaryResult` object — The execution summary clustering results from insights, containing grouped execution patterns across evaluated sessions. - `executionSummaries` ExecutionSummaryCluster[], required — The list of execution summary clusters identified across analyzed sessions. - `clusterId` integer, required — The unique identifier of the execution summary cluster. - `name` string, required — The name of the execution pattern cluster. - `description` string, required — A description of the execution pattern. - `affectedSessionCount` integer, required — The number of sessions with this execution pattern. - `affectedSessions` ExecutionSummaryAffectedSession[], required — The list of sessions with this execution pattern. - `sessionId` string, required — The unique identifier of the session. - `approachTaken` string, required — The approach taken by the agent during this session. - `finalOutcome` string, required — The final outcome of the session. - `errorDetails` ErrorDetailsListMemberString[] — The error details if the batch evaluation encountered failures. - `description` string — The description of the batch evaluation. - `updatedAt` string, date-time — The timestamp when the batch evaluation was last updated. - `kmsKeyArn` string — The ARN of the KMS key used to encrypt evaluation data. ## Other responses - `480` — UnauthorizedException - `481` — ValidationException - `482` — AccessDeniedException - `483` — ThrottlingException - `484` — ResourceNotFoundException - `485` — InternalServerException --- [API](https://skmtc.net/aws/apis/bedrock-agentcore.md) · [All operations](https://skmtc.net/aws/apis/bedrock-agentcore/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/bedrock-agentcore/versions/79623b33d495/schema)