Methods
ModelsExpand Collapse
type DpoHyperparametersResp struct{…}The hyperparameters used for the DPO fine-tuning job.
The hyperparameters used for the DPO fine-tuning job.
BatchSize DpoHyperparametersBatchSizeUnionRespoptionalNumber of examples in each batch. A larger batch size means that model parameters are updated less frequently, but with lower variance.
Number of examples in each batch. A larger batch size means that model parameters are updated less frequently, but with lower variance.
Beta DpoHyperparametersBetaUnionRespoptionalThe beta value for the DPO method. A higher beta value will increase the weight of the penalty between the policy and reference model.
The beta value for the DPO method. A higher beta value will increase the weight of the penalty between the policy and reference model.
LearningRateMultiplier DpoHyperparametersLearningRateMultiplierUnionRespoptionalScaling factor for the learning rate. A smaller learning rate may be useful to avoid overfitting.
Scaling factor for the learning rate. A smaller learning rate may be useful to avoid overfitting.
NEpochs DpoHyperparametersNEpochsUnionRespoptionalThe number of epochs to train the model for. An epoch refers to one full cycle through the training dataset.
The number of epochs to train the model for. An epoch refers to one full cycle through the training dataset.
type DpoMethod struct{…}Configuration for the DPO fine-tuning method.
Configuration for the DPO fine-tuning method.
The hyperparameters used for the DPO fine-tuning job.
type ReinforcementHyperparametersResp struct{…}The hyperparameters used for the reinforcement fine-tuning job.
The hyperparameters used for the reinforcement fine-tuning job.
BatchSize ReinforcementHyperparametersBatchSizeUnionRespoptionalNumber of examples in each batch. A larger batch size means that model parameters are updated less frequently, but with lower variance.
Number of examples in each batch. A larger batch size means that model parameters are updated less frequently, but with lower variance.
ComputeMultiplier ReinforcementHyperparametersComputeMultiplierUnionRespoptionalMultiplier on amount of compute used for exploring search space during training.
Multiplier on amount of compute used for exploring search space during training.
EvalInterval ReinforcementHyperparametersEvalIntervalUnionRespoptionalThe number of training steps between evaluation runs.
The number of training steps between evaluation runs.
EvalSamples ReinforcementHyperparametersEvalSamplesUnionRespoptionalNumber of evaluation samples to generate per training step.
Number of evaluation samples to generate per training step.
LearningRateMultiplier ReinforcementHyperparametersLearningRateMultiplierUnionRespoptionalScaling factor for the learning rate. A smaller learning rate may be useful to avoid overfitting.
Scaling factor for the learning rate. A smaller learning rate may be useful to avoid overfitting.
NEpochs ReinforcementHyperparametersNEpochsUnionRespoptionalThe number of epochs to train the model for. An epoch refers to one full cycle through the training dataset.
The number of epochs to train the model for. An epoch refers to one full cycle through the training dataset.
ReasoningEffort ReinforcementHyperparametersReasoningEffortoptionalLevel of reasoning effort.
Level of reasoning effort.
type ReinforcementMethod struct{…}Configuration for the reinforcement fine-tuning method.
Configuration for the reinforcement fine-tuning method.
Grader ReinforcementMethodGraderUnionThe grader used for the fine-tuning job.
The grader used for the fine-tuning job.
type StringCheckGrader struct{…}A StringCheckGrader object that performs a string comparison between input and reference using a specified operation.
A StringCheckGrader object that performs a string comparison between input and reference using a specified operation.
The input text. This may include template strings.
The name of the grader.
Operation StringCheckGraderOperationThe string check operation to perform. One of eq, ne, like, or ilike.
The string check operation to perform. One of eq, ne, like, or ilike.
The reference text. This may include template strings.
The object type, which is always string_check.
type TextSimilarityGrader struct{…}A TextSimilarityGrader object which grades text based on similarity metrics.
A TextSimilarityGrader object which grades text based on similarity metrics.
EvaluationMetric TextSimilarityGraderEvaluationMetricThe 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.
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.
The text being graded.
The name of the grader.
The text being graded against.
The type of grader.
type PythonGrader struct{…}A PythonGrader object that runs a python script on the input.
A PythonGrader object that runs a python script on the input.
The name of the grader.
The source code of the python script.
The object type, which is always python.
The image tag to use for the python script.
type ScoreModelGrader struct{…}A ScoreModelGrader object that uses a model to assign a score to the input.
A ScoreModelGrader object that uses a model to assign a score to the input.
Input []ScoreModelGraderInputThe input messages evaluated by the grader. Supports text, output text, input image, and input audio content blocks, and may include template strings.
The input messages evaluated by the grader. Supports text, output text, input image, and input audio content blocks, and may include template strings.
Content ScoreModelGraderInputContentUnionInputs 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.
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.
type ResponseInputText struct{…}A text input to the model.
A text input to the model.
The text input to the model.
The type of the input item. Always input_text.
type ScoreModelGraderInputContentOutputText struct{…}A text output from the model.
A text output from the model.
The text output from the model.
The type of the output text. Always output_text.
type ScoreModelGraderInputContentInputImage struct{…}An image input block used within EvalItem content arrays.
An image input block used within EvalItem content arrays.
The URL of the image input.
The type of the image input. Always input_image.
The detail level of the image to be sent to the model. One of high, low, or auto. Defaults to auto.
type ResponseInputAudio struct{…}An audio input to the model.
An audio input to the model.
InputAudio ResponseInputAudioInputAudio
Base64-encoded audio data.
Format stringThe format of the audio data. Currently supported formats are mp3 and
wav.
The format of the audio data. Currently supported formats are mp3 and
wav.
The type of the input item. Always input_audio.
type GraderInputs []GraderInputUnionA list of inputs, each of which may be either an input text, output text, input
image, or input audio object.
A list of inputs, each of which may be either an input text, output text, input image, or input audio object.
type ResponseInputText struct{…}A text input to the model.
A text input to the model.
The text input to the model.
The type of the input item. Always input_text.
type GraderInputOutputText struct{…}A text output from the model.
A text output from the model.
The text output from the model.
The type of the output text. Always output_text.
type GraderInputInputImage struct{…}An image input block used within EvalItem content arrays.
An image input block used within EvalItem content arrays.
The URL of the image input.
The type of the image input. Always input_image.
The detail level of the image to be sent to the model. One of high, low, or auto. Defaults to auto.
type ResponseInputAudio struct{…}An audio input to the model.
An audio input to the model.
InputAudio ResponseInputAudioInputAudio
Base64-encoded audio data.
Format stringThe format of the audio data. Currently supported formats are mp3 and
wav.
The format of the audio data. Currently supported formats are mp3 and
wav.
The type of the input item. Always input_audio.
Role stringThe role of the message input. One of user, assistant, system, or
developer.
The role of the message input. One of user, assistant, system, or
developer.
The type of the message input. Always message.
The model to use for the evaluation.
The name of the grader.
The object type, which is always score_model.
The range of the score. Defaults to [0, 1].
SamplingParams ScoreModelGraderSamplingParamsoptionalThe sampling parameters for the model.
The sampling parameters for the model.
The maximum number of tokens the grader model may generate in its response.
Constrains effort on reasoning for
reasoning models.
Currently supported values are none, minimal, low, medium, high, and xhigh. Reducing
reasoning effort can result in faster responses and fewer tokens used
on reasoning in a response.
gpt-5.1defaults tonone, which does not perform reasoning. The supported reasoning values forgpt-5.1arenone,low,medium, andhigh. Tool calls are supported for all reasoning values in gpt-5.1.- All models before
gpt-5.1default tomediumreasoning effort, and do not supportnone. - The
gpt-5-promodel defaults to (and only supports)highreasoning effort. xhighis supported for all models aftergpt-5.1-codex-max.
A seed value to initialize the randomness, during sampling.
A higher temperature increases randomness in the outputs.
An alternative to temperature for nucleus sampling; 1.0 includes all tokens.
type MultiGrader struct{…}A MultiGrader object combines the output of multiple graders to produce a single score.
A MultiGrader object combines the output of multiple graders to produce a single score.
A formula to calculate the output based on grader results.
Graders MultiGraderGradersUnionA StringCheckGrader object that performs a string comparison between input and reference using a specified operation.
A StringCheckGrader object that performs a string comparison between input and reference using a specified operation.
type StringCheckGrader struct{…}A StringCheckGrader object that performs a string comparison between input and reference using a specified operation.
A StringCheckGrader object that performs a string comparison between input and reference using a specified operation.
The input text. This may include template strings.
The name of the grader.
Operation StringCheckGraderOperationThe string check operation to perform. One of eq, ne, like, or ilike.
The string check operation to perform. One of eq, ne, like, or ilike.
The reference text. This may include template strings.
The object type, which is always string_check.
type TextSimilarityGrader struct{…}A TextSimilarityGrader object which grades text based on similarity metrics.
A TextSimilarityGrader object which grades text based on similarity metrics.
EvaluationMetric TextSimilarityGraderEvaluationMetricThe 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.
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.
The text being graded.
The name of the grader.
The text being graded against.
The type of grader.
type PythonGrader struct{…}A PythonGrader object that runs a python script on the input.
A PythonGrader object that runs a python script on the input.
The name of the grader.
The source code of the python script.
The object type, which is always python.
The image tag to use for the python script.
type ScoreModelGrader struct{…}A ScoreModelGrader object that uses a model to assign a score to the input.
A ScoreModelGrader object that uses a model to assign a score to the input.
Input []ScoreModelGraderInputThe input messages evaluated by the grader. Supports text, output text, input image, and input audio content blocks, and may include template strings.
The input messages evaluated by the grader. Supports text, output text, input image, and input audio content blocks, and may include template strings.
Content ScoreModelGraderInputContentUnionInputs 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.
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.
type ResponseInputText struct{…}A text input to the model.
A text input to the model.
The text input to the model.
The type of the input item. Always input_text.
type ScoreModelGraderInputContentOutputText struct{…}A text output from the model.
A text output from the model.
The text output from the model.
The type of the output text. Always output_text.
type ScoreModelGraderInputContentInputImage struct{…}An image input block used within EvalItem content arrays.
An image input block used within EvalItem content arrays.
The URL of the image input.
The type of the image input. Always input_image.
The detail level of the image to be sent to the model. One of high, low, or auto. Defaults to auto.
type ResponseInputAudio struct{…}An audio input to the model.
An audio input to the model.
InputAudio ResponseInputAudioInputAudio
Base64-encoded audio data.
Format stringThe format of the audio data. Currently supported formats are mp3 and
wav.
The format of the audio data. Currently supported formats are mp3 and
wav.
The type of the input item. Always input_audio.
type GraderInputs []GraderInputUnionA list of inputs, each of which may be either an input text, output text, input
image, or input audio object.
A list of inputs, each of which may be either an input text, output text, input image, or input audio object.
type ResponseInputText struct{…}A text input to the model.
A text input to the model.
The text input to the model.
The type of the input item. Always input_text.
type GraderInputOutputText struct{…}A text output from the model.
A text output from the model.
The text output from the model.
The type of the output text. Always output_text.
type GraderInputInputImage struct{…}An image input block used within EvalItem content arrays.
An image input block used within EvalItem content arrays.
The URL of the image input.
The type of the image input. Always input_image.
The detail level of the image to be sent to the model. One of high, low, or auto. Defaults to auto.
type ResponseInputAudio struct{…}An audio input to the model.
An audio input to the model.
InputAudio ResponseInputAudioInputAudio
Base64-encoded audio data.
Format stringThe format of the audio data. Currently supported formats are mp3 and
wav.
The format of the audio data. Currently supported formats are mp3 and
wav.
The type of the input item. Always input_audio.
Role stringThe role of the message input. One of user, assistant, system, or
developer.
The role of the message input. One of user, assistant, system, or
developer.
The type of the message input. Always message.
The model to use for the evaluation.
The name of the grader.
The object type, which is always score_model.
The range of the score. Defaults to [0, 1].
SamplingParams ScoreModelGraderSamplingParamsoptionalThe sampling parameters for the model.
The sampling parameters for the model.
The maximum number of tokens the grader model may generate in its response.
Constrains effort on reasoning for
reasoning models.
Currently supported values are none, minimal, low, medium, high, and xhigh. Reducing
reasoning effort can result in faster responses and fewer tokens used
on reasoning in a response.
gpt-5.1defaults tonone, which does not perform reasoning. The supported reasoning values forgpt-5.1arenone,low,medium, andhigh. Tool calls are supported for all reasoning values in gpt-5.1.- All models before
gpt-5.1default tomediumreasoning effort, and do not supportnone. - The
gpt-5-promodel defaults to (and only supports)highreasoning effort. xhighis supported for all models aftergpt-5.1-codex-max.
A seed value to initialize the randomness, during sampling.
A higher temperature increases randomness in the outputs.
An alternative to temperature for nucleus sampling; 1.0 includes all tokens.
type LabelModelGrader struct{…}A LabelModelGrader object which uses a model to assign labels to each item
in the evaluation.
A LabelModelGrader object which uses a model to assign labels to each item in the evaluation.
Input []LabelModelGraderInput
Content LabelModelGraderInputContentUnionInputs 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.
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.
type ResponseInputText struct{…}A text input to the model.
A text input to the model.
The text input to the model.
The type of the input item. Always input_text.
type LabelModelGraderInputContentOutputText struct{…}A text output from the model.
A text output from the model.
The text output from the model.
The type of the output text. Always output_text.
type LabelModelGraderInputContentInputImage struct{…}An image input block used within EvalItem content arrays.
An image input block used within EvalItem content arrays.
The URL of the image input.
The type of the image input. Always input_image.
The detail level of the image to be sent to the model. One of high, low, or auto. Defaults to auto.
type ResponseInputAudio struct{…}An audio input to the model.
An audio input to the model.
InputAudio ResponseInputAudioInputAudio
Base64-encoded audio data.
Format stringThe format of the audio data. Currently supported formats are mp3 and
wav.
The format of the audio data. Currently supported formats are mp3 and
wav.
The type of the input item. Always input_audio.
type GraderInputs []GraderInputUnionA list of inputs, each of which may be either an input text, output text, input
image, or input audio object.
A list of inputs, each of which may be either an input text, output text, input image, or input audio object.
type ResponseInputText struct{…}A text input to the model.
A text input to the model.
The text input to the model.
The type of the input item. Always input_text.
type GraderInputOutputText struct{…}A text output from the model.
A text output from the model.
The text output from the model.
The type of the output text. Always output_text.
type GraderInputInputImage struct{…}An image input block used within EvalItem content arrays.
An image input block used within EvalItem content arrays.
The URL of the image input.
The type of the image input. Always input_image.
The detail level of the image to be sent to the model. One of high, low, or auto. Defaults to auto.
type ResponseInputAudio struct{…}An audio input to the model.
An audio input to the model.
InputAudio ResponseInputAudioInputAudio
Base64-encoded audio data.
Format stringThe format of the audio data. Currently supported formats are mp3 and
wav.
The format of the audio data. Currently supported formats are mp3 and
wav.
The type of the input item. Always input_audio.
Role stringThe role of the message input. One of user, assistant, system, or
developer.
The role of the message input. One of user, assistant, system, or
developer.
The type of the message input. Always message.
The labels to assign to each item in the evaluation.
The model to use for the evaluation. Must support structured outputs.
The name of the grader.
The labels that indicate a passing result. Must be a subset of labels.
The object type, which is always label_model.
The name of the grader.
The object type, which is always multi.
The hyperparameters used for the reinforcement fine-tuning job.
type SupervisedHyperparametersResp struct{…}The hyperparameters used for the fine-tuning job.
The hyperparameters used for the fine-tuning job.
BatchSize SupervisedHyperparametersBatchSizeUnionRespoptionalNumber of examples in each batch. A larger batch size means that model parameters are updated less frequently, but with lower variance.
Number of examples in each batch. A larger batch size means that model parameters are updated less frequently, but with lower variance.
LearningRateMultiplier SupervisedHyperparametersLearningRateMultiplierUnionRespoptionalScaling factor for the learning rate. A smaller learning rate may be useful to avoid overfitting.
Scaling factor for the learning rate. A smaller learning rate may be useful to avoid overfitting.
NEpochs SupervisedHyperparametersNEpochsUnionRespoptionalThe number of epochs to train the model for. An epoch refers to one full cycle through the training dataset.
The number of epochs to train the model for. An epoch refers to one full cycle through the training dataset.
type SupervisedMethod struct{…}Configuration for the supervised fine-tuning method.
Configuration for the supervised fine-tuning method.
The hyperparameters used for the fine-tuning job.