Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-141531,219979.8 KB

Retrieves detailed information about an evaluator, including its configuration, status, and metadata. Works with both built-in and custom evaluators.

get/evaluators/{evaluatorId}

Path parameters

evaluatorIdstring required

The unique identifier of the evaluator to retrieve. Can be a built-in evaluator ID (e.g., Builtin.Helpfulness) or a custom evaluator ID.

Query parameters

includedData'ALL_DATA' | 'METADATA_ONLY'

Controls which data is returned in the response. <code>ALL_DATA</code> (default) returns the full evaluator including decrypted instructions and rating scale. For evaluators encrypted with a customer managed KMS key, this requires <code>kms:Decrypt</code> permission on the key. <code>METADATA_ONLY</code> returns evaluator metadata and model configuration without instructions or rating scale, and does not require any KMS permissions.

Response

Success

evaluatorArnstring required

The Amazon Resource Name (ARN) of the evaluator.

evaluatorIdstring required

The unique identifier of the evaluator.

evaluatorNamestring required

The name of the evaluator.

descriptionstring password

The description of the evaluator.

level'TOOL_CALL' | 'TRACE' | 'SESSION' required

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

status'ACTIVE' | 'CREATING' | 'CREATE_FAILED' | 'UPDATING' | 'UPDATE_FAILED' | 'DELETING' required

The current status of the evaluator.

createdAtstring date-time required

The timestamp when the evaluator was created.

updatedAtstring date-time required

The timestamp when the evaluator was last updated.

lockedForModificationboolean

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

kmsKeyArnstring

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