Bedrock / Paginator / ListEvaluationJobs

ListEvaluationJobs

class Bedrock.Paginator.ListEvaluationJobs

paginator = client.get_paginator('list_evaluation_jobs')

paginate(**kwargs)

Creates an iterator that will paginate through responses from Bedrock.Client.list_evaluation_jobs().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    creationTimeAfter=datetime(2015, 1, 1),
    creationTimeBefore=datetime(2015, 1, 1),
    statusEquals='InProgress'|'Completed'|'Failed'|'Stopping'|'Stopped'|'Deleting',
    applicationTypeEquals='ModelEvaluation'|'RagEvaluation',
    nameContains='string',
    sortBy='CreationTime',
    sortOrder='Ascending'|'Descending',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• creationTimeAfter (datetime) – A filter to only list evaluation jobs created after a specified time.

• creationTimeBefore (datetime) – A filter to only list evaluation jobs created before a specified time.

• statusEquals (string) – A filter to only list evaluation jobs that are of a certain status.

• applicationTypeEquals (string) – A filter to only list evaluation jobs that are either model evaluations or knowledge base evaluations.

• nameContains (string) – A filter to only list evaluation jobs that contain a specified string in the job name.

• sortBy (string) – Specifies a creation time to sort the list of evaluation jobs by when they were created.

• sortOrder (string) – Specifies whether to sort the list of evaluation jobs by either ascending or descending order.

• 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

{
    'jobSummaries': [
        {
            'jobArn': 'string',
            'jobName': 'string',
            'status': 'InProgress'|'Completed'|'Failed'|'Stopping'|'Stopped'|'Deleting',
            'creationTime': datetime(2015, 1, 1),
            'jobType': 'Human'|'Automated',
            'evaluationTaskTypes': [
                'Summarization'|'Classification'|'QuestionAndAnswer'|'Generation'|'Custom',
            ],
            'modelIdentifiers': [
                'string',
            ],
            'ragIdentifiers': [
                'string',
            ],
            'evaluatorModelIdentifiers': [
                'string',
            ],
            'applicationType': 'ModelEvaluation'|'RagEvaluation'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • jobSummaries (list) –

    A list of summaries of the evaluation jobs.

    • (dict) –

      Summary information of an evaluation job.

      • jobArn (string) –

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

      • jobName (string) –

        The name for the evaluation job.

      • status (string) –

        The current status of the evaluation job.

      • creationTime (datetime) –

        The time the evaluation job was created.

      • jobType (string) –

        Specifies whether the evaluation job is automated or human-based.

      • evaluationTaskTypes (list) –

        The type of task for model evaluation.

        • (string) –

      • modelIdentifiers (list) –

        The Amazon Resource Names (ARNs) of the model(s) used for the evaluation job.

        • (string) –

      • ragIdentifiers (list) –

        The Amazon Resource Names (ARNs) of the knowledge base resources used for a knowledge base evaluation job.

        • (string) –

      • evaluatorModelIdentifiers (list) –

        The Amazon Resource Names (ARNs) of the models used to compute the metrics for a knowledge base evaluation job.

        • (string) –

      • applicationType (string) –

        Specifies whether the evaluation job is for evaluating a model or evaluating a knowledge base (retrieval and response generation).

  • NextToken (string) –

    A token to resume pagination.