Grader Models

class EvalContentItem:

A single content item: input text, output text, input image, or input audio.

String

class ResponseInputText:

A text input to the model.

String text

The text input to the model.

JsonValue; type

The type of the input item. Always input_text.

Optional<PromptCacheBreakpoint> promptCacheBreakpoint

Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request’s prompt_cache_options.ttl; the boundary is not rounded to a token block.

JsonValue; mode

The breakpoint mode. Always explicit.

OutputText

String text

The text output from the model.

JsonValue; type

The type of the output text. Always output_text.

InputImage

String imageUrl

The URL of the image input.

formaturi

JsonValue; type

The type of the image input. Always input_image.

Optional<String> detail

The detail level of the image to be sent to the model. One of high, low, or auto. Defaults to auto.

class ResponseInputAudio:

An audio input to the model.

InputAudio inputAudio

String data

Base64-encoded audio data.

Format format

The format of the audio data. Currently supported formats are mp3 and wav.

One of the following:

MP3("mp3")

WAV("wav")

JsonValue; type

The type of the input item. Always input_audio.

class LabelModelGrader:

A LabelModelGrader object which uses a model to assign labels to each item in the evaluation.

List<Input> input

Content content

Inputs to the model - can contain template strings. Supports text, output text, input images, and input audio, either as a single item or an array of items.

One of the following:

String

class ResponseInputText:

A text input to the model.

String text

The text input to the model.

JsonValue; type

The type of the input item. Always input_text.

Optional<PromptCacheBreakpoint> promptCacheBreakpoint

Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request’s prompt_cache_options.ttl; the boundary is not rounded to a token block.

JsonValue; mode

The breakpoint mode. Always explicit.

class OutputText:

A text output from the model.

String text

The text output from the model.

JsonValue; type

The type of the output text. Always output_text.

class InputImage:

An image input block used within EvalItem content arrays.

String imageUrl

The URL of the image input.

formaturi

JsonValue; type

The type of the image input. Always input_image.

Optional<String> detail

The detail level of the image to be sent to the model. One of high, low, or auto. Defaults to auto.

class ResponseInputAudio:

An audio input to the model.

InputAudio inputAudio

String data

Base64-encoded audio data.

Format format

The format of the audio data. Currently supported formats are mp3 and wav.

One of the following:

MP3("mp3")

WAV("wav")

JsonValue; type

The type of the input item. Always input_audio.

List<EvalContentItem>

One of the following:

String

class ResponseInputText:

A text input to the model.

String text

The text input to the model.

JsonValue; type

The type of the input item. Always input_text.

Optional<PromptCacheBreakpoint> promptCacheBreakpoint

Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request’s prompt_cache_options.ttl; the boundary is not rounded to a token block.

JsonValue; mode

The breakpoint mode. Always explicit.

OutputText

String text

The text output from the model.

JsonValue; type

The type of the output text. Always output_text.

InputImage

String imageUrl

The URL of the image input.

formaturi

JsonValue; type

The type of the image input. Always input_image.

Optional<String> detail

The detail level of the image to be sent to the model. One of high, low, or auto. Defaults to auto.

class ResponseInputAudio:

An audio input to the model.

InputAudio inputAudio

String data

Base64-encoded audio data.

Format format

The format of the audio data. Currently supported formats are mp3 and wav.

One of the following:

MP3("mp3")

WAV("wav")

JsonValue; type

The type of the input item. Always input_audio.

Role role

The role of the message input. One of user, assistant, system, or developer.

One of the following:

USER("user")

ASSISTANT("assistant")

SYSTEM("system")

DEVELOPER("developer")

Optional<Type> type

The type of the message input. Always message.

List<String> labels

The labels to assign to each item in the evaluation.

String model

The model to use for the evaluation. Must support structured outputs.

String name

The name of the grader.

List<String> passingLabels

The labels that indicate a passing result. Must be a subset of labels.

JsonValue; type

The object type, which is always label_model.

class MultiGrader:

A MultiGrader object combines the output of multiple graders to produce a single score.

String calculateOutput

A formula to calculate the output based on grader results.

Graders graders

A StringCheckGrader object that performs a string comparison between input and reference using a specified operation.

One of the following:

class StringCheckGrader:

A StringCheckGrader object that performs a string comparison between input and reference using a specified operation.

String input

The input text. This may include template strings.

String name

The name of the grader.

Operation operation

The string check operation to perform. One of eq, ne, like, or ilike.

One of the following:

EQ("eq")

NE("ne")

LIKE("like")

ILIKE("ilike")

String reference

The reference text. This may include template strings.

JsonValue; type

The object type, which is always string_check.

class TextSimilarityGrader:

A TextSimilarityGrader object which grades text based on similarity metrics.

EvaluationMetric evaluationMetric

The evaluation metric to use. One of cosine, fuzzy_match, bleu, gleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, rouge_5, or rouge_l.

One of the following:

COSINE("cosine")

FUZZY_MATCH("fuzzy_match")

BLEU("bleu")

GLEU("gleu")

METEOR("meteor")

ROUGE_1("rouge_1")

ROUGE_2("rouge_2")

ROUGE_3("rouge_3")

ROUGE_4("rouge_4")

ROUGE_5("rouge_5")

ROUGE_L("rouge_l")

String input

The text being graded.

String name

The name of the grader.

String reference

The text being graded against.

JsonValue; type

The type of grader.

class PythonGrader:

A PythonGrader object that runs a python script on the input.

String name

The name of the grader.

String source

The source code of the python script.

JsonValue; type

The object type, which is always python.

Optional<String> imageTag

The image tag to use for the python script.

class ScoreModelGrader:

A ScoreModelGrader object that uses a model to assign a score to the input.

List<Input> input

The input messages evaluated by the grader. Supports text, output text, input image, and input audio content blocks, and may include template strings.

Content content

Inputs to the model - can contain template strings. Supports text, output text, input images, and input audio, either as a single item or an array of items.

One of the following:

String

class ResponseInputText:

A text input to the model.

String text

The text input to the model.

JsonValue; type

The type of the input item. Always input_text.

Optional<PromptCacheBreakpoint> promptCacheBreakpoint

Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request’s prompt_cache_options.ttl; the boundary is not rounded to a token block.

JsonValue; mode

The breakpoint mode. Always explicit.

class OutputText:

A text output from the model.

String text

The text output from the model.

JsonValue; type

The type of the output text. Always output_text.

class InputImage:

An image input block used within EvalItem content arrays.

String imageUrl

The URL of the image input.

formaturi

JsonValue; type

The type of the image input. Always input_image.

Optional<String> detail

The detail level of the image to be sent to the model. One of high, low, or auto. Defaults to auto.

class ResponseInputAudio:

An audio input to the model.

InputAudio inputAudio

String data

Base64-encoded audio data.

Format format

The format of the audio data. Currently supported formats are mp3 and wav.

One of the following:

MP3("mp3")

WAV("wav")

JsonValue; type

The type of the input item. Always input_audio.

List<EvalContentItem>

One of the following:

String

class ResponseInputText:

A text input to the model.

String text

The text input to the model.

JsonValue; type

The type of the input item. Always input_text.

Optional<PromptCacheBreakpoint> promptCacheBreakpoint

Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request’s prompt_cache_options.ttl; the boundary is not rounded to a token block.

JsonValue; mode

The breakpoint mode. Always explicit.

OutputText

String text

The text output from the model.

JsonValue; type

The type of the output text. Always output_text.

InputImage

String imageUrl

The URL of the image input.

formaturi

JsonValue; type

The type of the image input. Always input_image.

Optional<String> detail

The detail level of the image to be sent to the model. One of high, low, or auto. Defaults to auto.

class ResponseInputAudio:

An audio input to the model.

InputAudio inputAudio

String data

Base64-encoded audio data.

Format format

The format of the audio data. Currently supported formats are mp3 and wav.

One of the following:

MP3("mp3")

WAV("wav")

JsonValue; type

The type of the input item. Always input_audio.

Role role

The role of the message input. One of user, assistant, system, or developer.

One of the following:

USER("user")

ASSISTANT("assistant")

SYSTEM("system")

DEVELOPER("developer")

Optional<Type> type

The type of the message input. Always message.

String model

The model to use for the evaluation.

String name

The name of the grader.

JsonValue; type

The object type, which is always score_model.

Optional<List<Double>> range

The range of the score. Defaults to [0, 1].

Optional<SamplingParams> samplingParams

The sampling parameters for the model.

Optional<Long> maxCompletionsTokens

The maximum number of tokens the grader model may generate in its response.

minimum1

Optional<ReasoningEffort> reasoningEffort

Constrains effort on reasoning for reasoning models. Currently supported values are none, minimal, low, medium, high, xhigh, and max. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response. Not all reasoning models support every value. See the reasoning guide for model-specific support.

Optional<Long> seed

A seed value to initialize the randomness, during sampling.

Optional<Double> temperature

A higher temperature increases randomness in the outputs.

Optional<Double> topP

An alternative to temperature for nucleus sampling; 1.0 includes all tokens.

class LabelModelGrader:

A LabelModelGrader object which uses a model to assign labels to each item in the evaluation.

List<Input> input

Content content

Inputs to the model - can contain template strings. Supports text, output text, input images, and input audio, either as a single item or an array of items.

One of the following:

String

class ResponseInputText:

A text input to the model.

String text

The text input to the model.

JsonValue; type

The type of the input item. Always input_text.

Optional<PromptCacheBreakpoint> promptCacheBreakpoint

Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request’s prompt_cache_options.ttl; the boundary is not rounded to a token block.

JsonValue; mode

The breakpoint mode. Always explicit.

class OutputText:

A text output from the model.

String text

The text output from the model.

JsonValue; type

The type of the output text. Always output_text.

class InputImage:

An image input block used within EvalItem content arrays.

String imageUrl

The URL of the image input.

formaturi

JsonValue; type

The type of the image input. Always input_image.

Optional<String> detail

The detail level of the image to be sent to the model. One of high, low, or auto. Defaults to auto.

class ResponseInputAudio:

An audio input to the model.

InputAudio inputAudio

String data

Base64-encoded audio data.

Format format

The format of the audio data. Currently supported formats are mp3 and wav.

One of the following:

MP3("mp3")

WAV("wav")

JsonValue; type

The type of the input item. Always input_audio.

List<EvalContentItem>

One of the following:

String

class ResponseInputText:

A text input to the model.

String text

The text input to the model.

JsonValue; type

The type of the input item. Always input_text.

Optional<PromptCacheBreakpoint> promptCacheBreakpoint

Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request’s prompt_cache_options.ttl; the boundary is not rounded to a token block.

JsonValue; mode

The breakpoint mode. Always explicit.

OutputText

String text

The text output from the model.

JsonValue; type

The type of the output text. Always output_text.

InputImage

String imageUrl

The URL of the image input.

formaturi

JsonValue; type

The type of the image input. Always input_image.

Optional<String> detail

The detail level of the image to be sent to the model. One of high, low, or auto. Defaults to auto.

class ResponseInputAudio:

An audio input to the model.

InputAudio inputAudio

String data

Base64-encoded audio data.

Format format

The format of the audio data. Currently supported formats are mp3 and wav.

One of the following:

MP3("mp3")

WAV("wav")

JsonValue; type

The type of the input item. Always input_audio.

Role role

The role of the message input. One of user, assistant, system, or developer.

One of the following:

USER("user")

ASSISTANT("assistant")

SYSTEM("system")

DEVELOPER("developer")

Optional<Type> type

The type of the message input. Always message.

List<String> labels

The labels to assign to each item in the evaluation.

String model

The model to use for the evaluation. Must support structured outputs.

String name

The name of the grader.

List<String> passingLabels

The labels that indicate a passing result. Must be a subset of labels.

JsonValue; type

The object type, which is always label_model.

String name

The name of the grader.

JsonValue; type

The object type, which is always multi.

class PythonGrader:

A PythonGrader object that runs a python script on the input.

String name

The name of the grader.

String source

The source code of the python script.

JsonValue; type

The object type, which is always python.

Optional<String> imageTag

The image tag to use for the python script.

class ScoreModelGrader:

A ScoreModelGrader object that uses a model to assign a score to the input.

List<Input> input

The input messages evaluated by the grader. Supports text, output text, input image, and input audio content blocks, and may include template strings.

Content content

Inputs to the model - can contain template strings. Supports text, output text, input images, and input audio, either as a single item or an array of items.

One of the following:

String

class ResponseInputText:

A text input to the model.

String text

The text input to the model.

JsonValue; type

The type of the input item. Always input_text.

Optional<PromptCacheBreakpoint> promptCacheBreakpoint

Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request’s prompt_cache_options.ttl; the boundary is not rounded to a token block.

JsonValue; mode

The breakpoint mode. Always explicit.

class OutputText:

A text output from the model.

String text

The text output from the model.

JsonValue; type

The type of the output text. Always output_text.

class InputImage:

An image input block used within EvalItem content arrays.

String imageUrl

The URL of the image input.

formaturi

JsonValue; type

The type of the image input. Always input_image.

Optional<String> detail

The detail level of the image to be sent to the model. One of high, low, or auto. Defaults to auto.

class ResponseInputAudio:

An audio input to the model.

InputAudio inputAudio

String data

Base64-encoded audio data.

Format format

The format of the audio data. Currently supported formats are mp3 and wav.

One of the following:

MP3("mp3")

WAV("wav")

JsonValue; type

The type of the input item. Always input_audio.

List<EvalContentItem>

One of the following:

String

class ResponseInputText:

A text input to the model.

String text

The text input to the model.

JsonValue; type

The type of the input item. Always input_text.

Optional<PromptCacheBreakpoint> promptCacheBreakpoint

Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request’s prompt_cache_options.ttl; the boundary is not rounded to a token block.

JsonValue; mode

The breakpoint mode. Always explicit.

OutputText

String text

The text output from the model.

JsonValue; type

The type of the output text. Always output_text.

InputImage

String imageUrl

The URL of the image input.

formaturi

JsonValue; type

The type of the image input. Always input_image.

Optional<String> detail

The detail level of the image to be sent to the model. One of high, low, or auto. Defaults to auto.

class ResponseInputAudio:

An audio input to the model.

InputAudio inputAudio

String data

Base64-encoded audio data.

Format format

The format of the audio data. Currently supported formats are mp3 and wav.

One of the following:

MP3("mp3")

WAV("wav")

JsonValue; type

The type of the input item. Always input_audio.

Role role

The role of the message input. One of user, assistant, system, or developer.

One of the following:

USER("user")

ASSISTANT("assistant")

SYSTEM("system")

DEVELOPER("developer")

Optional<Type> type

The type of the message input. Always message.

String model

The model to use for the evaluation.

String name

The name of the grader.

JsonValue; type

The object type, which is always score_model.

Optional<List<Double>> range

The range of the score. Defaults to [0, 1].

Optional<SamplingParams> samplingParams

The sampling parameters for the model.

Optional<Long> maxCompletionsTokens

The maximum number of tokens the grader model may generate in its response.

minimum1

Optional<ReasoningEffort> reasoningEffort

Constrains effort on reasoning for reasoning models. Currently supported values are none, minimal, low, medium, high, xhigh, and max. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response. Not all reasoning models support every value. See the reasoning guide for model-specific support.

Optional<Long> seed

A seed value to initialize the randomness, during sampling.

Optional<Double> temperature

A higher temperature increases randomness in the outputs.

Optional<Double> topP

An alternative to temperature for nucleus sampling; 1.0 includes all tokens.

class StringCheckGrader:

A StringCheckGrader object that performs a string comparison between input and reference using a specified operation.

String input

The input text. This may include template strings.

String name

The name of the grader.

Operation operation

The string check operation to perform. One of eq, ne, like, or ilike.

One of the following:

EQ("eq")

NE("ne")

LIKE("like")

ILIKE("ilike")

String reference

The reference text. This may include template strings.

JsonValue; type

The object type, which is always string_check.

class TextSimilarityGrader:

A TextSimilarityGrader object which grades text based on similarity metrics.

EvaluationMetric evaluationMetric

The evaluation metric to use. One of cosine, fuzzy_match, bleu, gleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, rouge_5, or rouge_l.

One of the following:

COSINE("cosine")

FUZZY_MATCH("fuzzy_match")

BLEU("bleu")

GLEU("gleu")

METEOR("meteor")

ROUGE_1("rouge_1")

ROUGE_2("rouge_2")

ROUGE_3("rouge_3")

ROUGE_4("rouge_4")

ROUGE_5("rouge_5")

ROUGE_L("rouge_l")

String input

The text being graded.

String name

The name of the grader.

String reference

The text being graded against.

JsonValue; type

The type of grader.

Suggested

Suggested

Grader Models

ModelsExpand Collapse