View a markdown version of this page

EvaluatorSummary - Amazon Bedrock AgentCore Control Plane
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

EvaluatorSummary

The summary information about an evaluator, including basic metadata and status information.

Contents

createdAt

The timestamp when the evaluator was created.

Type: Timestamp

Required: Yes

evaluatorArn

The Amazon Resource Name (ARN) of the evaluator.

Type: String

Pattern: arn:aws[a-zA-Z-]*:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:evaluator\/[a-zA-Z][a-zA-Z0-9-_]{0,99}-[a-zA-Z0-9]{10}$|^arn:aws[a-zA-Z-]*:bedrock-agentcore:::evaluator/(Builtin|ThirdParty)\.[a-zA-Z0-9._-]+

Required: Yes

evaluatorId

The unique identifier of the evaluator.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 111.

Pattern: (Builtin\.[a-zA-Z0-9._-]+|ThirdParty\.[a-zA-Z0-9_-]+\.[a-zA-Z0-9_-]+|[a-zA-Z][a-zA-Z0-9-_]{0,99}-[a-zA-Z0-9]{10})

Required: Yes

evaluatorName

The name of the evaluator.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 48.

Pattern: (Builtin\.[a-zA-Z0-9._-]+|ThirdParty\.[a-zA-Z0-9_-]+\.[a-zA-Z0-9_-]+|[a-zA-Z][a-zA-Z0-9_]{0,47})

Required: Yes

evaluatorType

The type of evaluator, indicating whether it is a built-in evaluator provided by the service or a custom evaluator created by the user.

Type: String

Valid Values: Builtin | ThirdParty | Custom | CustomCode | CustomDerived

Required: Yes

status

The current status of the evaluator.

Type: String

Valid Values: ACTIVE | CREATING | CREATE_FAILED | UPDATING | UPDATE_FAILED | DELETING

Required: Yes

updatedAt

The timestamp when the evaluator was last updated.

Type: Timestamp

Required: Yes

description

The description of the evaluator.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 200.

Required: No

kmsKeyArn

The Amazon Resource Name (ARN) of the customer managed Amazon KMS key used to encrypt the evaluator's sensitive data. This field is only present for evaluators encrypted with a customer managed key.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}

Required: No

level

The evaluation level (TOOL_CALL, TRACE, or SESSION) that determines the scope of evaluation.

Type: String

Valid Values: TOOL_CALL | TRACE | SESSION

Required: No

lockedForModification

Whether the evaluator is locked for modification due to being referenced by active online evaluation configurations.

Type: Boolean

Required: No

provider

The source of the evaluator's logic: Amazon, a third-party library, or you.

Type: String

Valid Values: AWS | DeepEval | AutoEval | Custom

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: