Skip to content

CustomMetricDefinitionDict

Dictionary Type

CustomMetricDefinitionDict

Bases: TypedDict

Dictionary form of CustomMetricDefinition.

Attributes

instructions instance-attribute
instructions: Required[str]

The prompt for a custom metric that instructs the evaluator model how to rate the model or RAG source under evaluation.

name instance-attribute
name: Required[str]

The name for a custom metric. Names must be unique in your Amazon Web Services region.

rating_scale instance-attribute

Defines the rating scale to be used for a custom metric. We recommend that you always define a ratings scale when creating a custom metric. If you don't define a scale, Amazon Bedrock won't be able to visually display the results of the evaluation in the console or calculate average values of numerical scores. For more information on specifying a rating scale, see Specifying an output schema (rating scale).