interface CfnEvaluatorProps

Language	Type name
.NET	Amazon.CDK.AWS.BedrockAgentCore.CfnEvaluatorProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsbedrockagentcore#CfnEvaluatorProps
Java	software.amazon.awscdk.services.bedrockagentcore.CfnEvaluatorProps
Python	aws_cdk.aws_bedrockagentcore.CfnEvaluatorProps
TypeScript	aws-cdk-lib » aws_bedrockagentcore » CfnEvaluatorProps

Properties for defining a CfnEvaluator.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-evaluator.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_bedrockagentcore as bedrockagentcore } from 'aws-cdk-lib';

declare const additionalModelRequestFields: any;
const cfnEvaluatorProps: bedrockagentcore.CfnEvaluatorProps = {
  evaluatorConfig: {
    llmAsAJudge: {
      instructions: 'instructions',
      modelConfig: {
        bedrockEvaluatorModelConfig: {
          modelId: 'modelId',

          // the properties below are optional
          additionalModelRequestFields: additionalModelRequestFields,
          inferenceConfig: {
            maxTokens: 123,
            temperature: 123,
            topP: 123,
          },
        },
      },
      ratingScale: {
        categorical: [{
          definition: 'definition',
          label: 'label',
        }],
        numerical: [{
          definition: 'definition',
          label: 'label',
          value: 123,
        }],
      },
    },
  },
  evaluatorName: 'evaluatorName',
  level: 'level',

  // the properties below are optional
  description: 'description',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

Name	Type	Description
evaluatorConfig	IResolvable | EvaluatorConfigProperty	The configuration that defines how an evaluator assesses agent performance.
evaluatorName	string	The name of the evaluator.
level	string
description?	string	The description of the evaluator.
tags?	CfnTag[]	A list of tags to assign to the evaluator.

---

evaluatorConfig

Type: IResolvable | EvaluatorConfigProperty

The configuration that defines how an evaluator assesses agent performance.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-evaluator.html#cfn-bedrockagentcore-evaluator-evaluatorconfig

---

evaluatorName

Type: string

The name of the evaluator.

Must be unique within your account.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-evaluator.html#cfn-bedrockagentcore-evaluator-evaluatorname

---

level

Type: string

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-evaluator.html#cfn-bedrockagentcore-evaluator-level

---

description?

Type: string (optional)

The description of the evaluator.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-evaluator.html#cfn-bedrockagentcore-evaluator-description

---

tags?

Type: CfnTag[] (optional)

A list of tags to assign to the evaluator.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-evaluator.html#cfn-bedrockagentcore-evaluator-tags