Skip to content

EvaluationSummary

Source code in docs_src/capo_bedrock/types/evaluation_summary.py
class EvaluationSummary(TypedDict, closed=True):
    job_arn: "capo_bedrock.types.evaluation_job_arn.EvaluationJobArn"
    """<p>The Amazon Resource Name (ARN) of the evaluation job.</p>"""
    job_name: "capo_bedrock.types.evaluation_job_name.EvaluationJobName"
    """<p>The name for the evaluation job.</p>"""
    status: "capo_bedrock.types.evaluation_job_status.EvaluationJobStatus"
    """<p>The current status of the evaluation job.</p>"""
    creation_time: "capo_bedrock.types.timestamp.Timestamp"
    """<p>The time the evaluation job was created.</p>"""
    job_type: "capo_bedrock.types.evaluation_job_type.EvaluationJobType"
    """<p>Specifies whether the evaluation job is automated or human-based.</p>"""
    evaluation_task_types: (
        "capo_bedrock.types.evaluation_task_types.EvaluationTaskTypes"
    )
    """<p>The type of task for model evaluation.</p>"""
    model_identifiers: "capo_bedrock.types.evaluation_bedrock_model_identifiers.EvaluationBedrockModelIdentifiers"
    """<p>The Amazon Resource Names (ARNs) of the model(s) used for the evaluation job.</p>"""
    rag_identifiers: NotRequired[
        "capo_bedrock.types.evaluation_bedrock_knowledge_base_identifiers.EvaluationBedrockKnowledgeBaseIdentifiers"
    ]
    """<p>The Amazon Resource Names (ARNs) of the knowledge base resources used for a knowledge base evaluation job.</p>"""
    evaluator_model_identifiers: NotRequired[
        "capo_bedrock.types.evaluator_model_identifiers.EvaluatorModelIdentifiers"
    ]
    """<p>The Amazon Resource Names (ARNs) of the models used to compute the metrics for a knowledge base evaluation job.</p>"""
    custom_metrics_evaluator_model_identifiers: NotRequired[
        "capo_bedrock.types.evaluator_model_identifiers.EvaluatorModelIdentifiers"
    ]
    """<p>The Amazon Resource Names (ARNs) of the models used to compute custom metrics in an Amazon Bedrock evaluation job.</p>"""
    inference_config_summary: NotRequired[
        "capo_bedrock.types.evaluation_inference_config_summary.EvaluationInferenceConfigSummary"
    ]
    """<p>Identifies the models, Knowledge Bases, or other RAG sources evaluated in a model or Knowledge Base evaluation job.</p>"""
    application_type: NotRequired["capo_bedrock.types.application_type.ApplicationType"]
    """<p>Specifies whether the evaluation job is for evaluating a model or evaluating a knowledge base (retrieval and response generation).</p>"""

application_type instance-attribute

application_type: NotRequired[ApplicationType]

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

creation_time instance-attribute

creation_time: Timestamp

The time the evaluation job was created.

custom_metrics_evaluator_model_identifiers instance-attribute

custom_metrics_evaluator_model_identifiers: NotRequired[EvaluatorModelIdentifiers]

The Amazon Resource Names (ARNs) of the models used to compute custom metrics in an Amazon Bedrock evaluation job.

evaluation_task_types instance-attribute

evaluation_task_types: EvaluationTaskTypes

The type of task for model evaluation.

evaluator_model_identifiers instance-attribute

evaluator_model_identifiers: NotRequired[EvaluatorModelIdentifiers]

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

inference_config_summary instance-attribute

inference_config_summary: NotRequired[EvaluationInferenceConfigSummary]

Identifies the models, Knowledge Bases, or other RAG sources evaluated in a model or Knowledge Base evaluation job.

job_arn instance-attribute

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

job_name instance-attribute

The name for the evaluation job.

job_type instance-attribute

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

model_identifiers instance-attribute

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

rag_identifiers instance-attribute

rag_identifiers: NotRequired[EvaluationBedrockKnowledgeBaseIdentifiers]

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

status instance-attribute

The current status of the evaluation job.