BedrockAgentCore / Client / list_batch_evaluations

list_batch_evaluations

BedrockAgentCore.Client.list_batch_evaluations(**kwargs)

Lists all batch evaluations in the account, providing summary information about each evaluation’s status and configuration.

See also: AWS API Documentation

Request Syntax

response = client.list_batch_evaluations(
    maxResults=123,
    nextToken='string'
)

Parameters:

• maxResults (integer) – The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.

• nextToken (string) – If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

Return type:

dict

Returns:

Response Syntax

{
    'batchEvaluations': [
        {
            'batchEvaluationId': 'string',
            'batchEvaluationArn': 'string',
            'batchEvaluationName': 'string',
            'status': 'PENDING'|'IN_PROGRESS'|'COMPLETED'|'COMPLETED_WITH_ERRORS'|'FAILED'|'STOPPING'|'STOPPED'|'DELETING',
            'createdAt': datetime(2015, 1, 1),
            'description': 'string',
            'evaluators': [
                {
                    'evaluatorId': 'string'
                },
            ],
            'evaluationResults': {
                'numberOfSessionsCompleted': 123,
                'numberOfSessionsInProgress': 123,
                'numberOfSessionsFailed': 123,
                'totalNumberOfSessions': 123,
                'numberOfSessionsIgnored': 123,
                'evaluatorSummaries': [
                    {
                        'evaluatorId': 'string',
                        'statistics': {
                            'averageScore': 123.0
                        },
                        'totalEvaluated': 123,
                        'totalFailed': 123
                    },
                ]
            },
            'errorDetails': [
                'string',
            ],
            'updatedAt': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

• (dict) –

  • batchEvaluations (list) –

    The list of batch evaluation summaries.

    • (dict) –

      Summary representation for list responses

      • batchEvaluationId (string) –

        The unique identifier of the batch evaluation.

      • batchEvaluationArn (string) –

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

      • batchEvaluationName (string) –

        The name of the batch evaluation.

      • status (string) –

        The current status of the batch evaluation.

      • createdAt (datetime) –

        The timestamp when the batch evaluation was created.

      • description (string) –

        The description of the batch evaluation.

      • evaluators (list) –

        The list of evaluators applied during the batch evaluation.

        • (dict) –

          An evaluator to run against sessions

          • evaluatorId (string) –

            The unique identifier of the evaluator. Can reference built-in evaluators (e.g., Builtin.Helpfulness) or custom evaluators.

      • evaluationResults (dict) –

        The aggregated evaluation results.

        • 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 (list) –

          A list of per-evaluator summary statistics.

          • (dict) –

            Summary statistics for a single evaluator within a batch evaluation.

            • evaluatorId (string) –

              The unique identifier of the evaluator.

            • statistics (dict) –

              The aggregated statistics for this evaluator.

              • averageScore (float) –

                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.

      • errorDetails (list) –

        The error details if the batch evaluation encountered failures.

        • (string) –

      • updatedAt (datetime) –

        The timestamp when the batch evaluation was last updated.

  • nextToken (string) –

    If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.

Exceptions

• BedrockAgentCore.Client.exceptions.UnauthorizedException

• BedrockAgentCore.Client.exceptions.ValidationException

• BedrockAgentCore.Client.exceptions.AccessDeniedException

• BedrockAgentCore.Client.exceptions.ThrottlingException

• BedrockAgentCore.Client.exceptions.InternalServerException