BedrockAgentCore / Paginator / ListBatchEvaluations

ListBatchEvaluations¶

class BedrockAgentCore.Paginator.ListBatchEvaluations¶

paginator = client.get_paginator('list_batch_evaluations')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from BedrockAgentCore.Client.list_batch_evaluations().

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

PaginationConfig (dict) –

A dictionary that provides parameters to control pagination.

MaxItems (integer) –

The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
PageSize (integer) –

The size of each page.
StartingToken (string) –

A token to specify where to start paginating. This is the NextToken from a previous response.

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'
                },
            ],
            'insights': [
                {
                    'insightId': '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',
            ],
            'kmsKeyArn': '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 during batch evaluation.
        
        evaluatorId (string) –
        
        The unique identifier of the evaluator. Can reference built-in evaluators (e.g., Builtin.Helpfulness) or custom evaluators.
    - insights (list) –
      
      The list of insight analyses applied during the batch evaluation.
      - (dict) –
        
        A reference to an insight analysis to run against sessions during batch evaluation. Insights provide deeper analysis beyond individual evaluator scores, including failure detection, user intent clustering, and execution summarization.
        
        insightId (string) –
        
        The unique identifier of the insight to run.
    - 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) –
    - kmsKeyArn (string) –
      
      The ARN of the KMS key used to encrypt evaluation data.
    - updatedAt (datetime) –
      
      The timestamp when the batch evaluation was last updated.
- NextToken (string) –
  
  A token to resume pagination.