Skip to content
v2.274.0

NumericalRatingOption Struct ​

A numerical rating scale option for custom evaluators.

Numerical scales define labeled numeric values for scoring agent performance.

Example ​

ts
// 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';
const numericalRatingOption: bedrockagentcore.NumericalRatingOption = {
  definition: 'definition',
  label: 'label',
  value: 123,
};

Properties ​

definitionstringdefinitionstrdefinitionStringDefinitionstringDefinition*stringrequired#
The description that explains what this numerical rating represents.
example
ts
'The response is comprehensive, accurate, and well-structured.'
labelstringlabelstrlabelStringLabelstringLabel*stringrequired#
The label for this rating option.
example
ts
'Excellent'
valuenumbervalueint | floatvalueNumberValuedoubleValue*float64required#
The numerical value for this rating scale option.
example
ts
5