Resource: TuningJob
Represents a TuningJob that runs with Google owned models.
name
string
Output only. Identifier. Resource name of a TuningJob. Format: projects/{project}/locations/{location}/tuningJobs/{tuningJob}
tunedModelDisplayName
string
Optional. The display name of the TunedModel
. The name can be up to 128 characters long and can consist of any UTF-8 characters. For continuous tuning, tunedModelDisplayName will by default use the same display name as the pre-tuned model. If a new display name is provided, the tuning job will create a new model instead of a new version.
description
string
Optional. The description of the TuningJob
.
state
enum ( JobState
)
Output only. The detailed state of the job.
createTime
string ( Timestamp
format)
Output only. time when the TuningJob
was created.
Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z"
, "2014-10-02T15:01:23.045123456Z"
or "2014-10-02T15:01:23+05:30"
.
startTime
string ( Timestamp
format)
Output only. time when the TuningJob
for the first time entered the JOB_STATE_RUNNING
state.
Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z"
, "2014-10-02T15:01:23.045123456Z"
or "2014-10-02T15:01:23+05:30"
.
endTime
string ( Timestamp
format)
Output only. time when the TuningJob entered any of the following JobStates
: JOB_STATE_SUCCEEDED
, JOB_STATE_FAILED
, JOB_STATE_CANCELLED
, JOB_STATE_EXPIRED
.
Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z"
, "2014-10-02T15:01:23.045123456Z"
or "2014-10-02T15:01:23+05:30"
.
updateTime
string ( Timestamp
format)
Output only. time when the TuningJob
was most recently updated.
Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z"
, "2014-10-02T15:01:23.045123456Z"
or "2014-10-02T15:01:23+05:30"
.
error
object ( Status
)
Output only. Only populated when job's state is JOB_STATE_FAILED
or JOB_STATE_CANCELLED
.
labels
map (key: string, value: string)
Optional. The labels with user-defined metadata to organize TuningJob
and generated resources such as Model
and Endpoint
.
label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed.
See https://goo.gl/xmQnxf for more information and examples of labels.
experiment
string
Output only. The Experiment associated with this TuningJob
.
tunedModel
object ( TunedModel
)
Output only. The tuned model resources associated with this TuningJob
.
tuningDataStats
object ( TuningDataStats
)
Output only. The tuning data statistics associated with this TuningJob
.
encryptionSpec
object ( EncryptionSpec
)
Customer-managed encryption key options for a TuningJob. If this is set, then all resources created by the TuningJob will be encrypted with the provided encryption key.
serviceAccount
string
The service account that the tuningJob workload runs as. If not specified, the Agent Platform Secure Fine-Tuned service Agent in the project will be used. See https://cloud.google.com/iam/docs/service-agents#vertex-ai-secure-fine-tuning-service-agent
Users starting the pipeline must have the iam.serviceAccounts.actAs
permission on this service account.
evaluateDatasetRuns[]
object ( EvaluateDatasetRun
)
Output only. Evaluation runs for the Tuning Job.
source_model
Union type
source_model
can be only one of the following:baseModel
string
The base model that is being tuned. See Supported models .
preTunedModel
object ( PreTunedModel
)
The pre-tuned model for continuous tuning.
tuning_spec
Union type
tuning_spec
can be only one of the following:supervisedTuningSpec
object ( SupervisedTuningSpec
)
Tuning Spec for Supervised Fine Tuning.
| JSON representation |
|---|
{ "name" : string , "tunedModelDisplayName" : string , "description" : string , "state" : enum ( |
PreTunedModel
A pre-tuned model for continuous tuning.
tunedModelName
string
The resource name of the Model. E.g., a model resource name with a specified version id or alias:
projects/{project}/locations/{location}/models/{model}@{versionId}
projects/{project}/locations/{location}/models/{model}@{alias}
Or, omit the version id to use the default version:
projects/{project}/locations/{location}/models/{model}
checkpointId
string
Optional. The source checkpoint id. If not specified, the default checkpoint will be used.
baseModel
string
Output only. The name of the base model this PreTunedModel
was tuned from.
| JSON representation |
|---|
{ "tunedModelName" : string , "checkpointId" : string , "baseModel" : string } |
SupervisedTuningSpec
Tuning Spec for Supervised Tuning for first party models.
trainingDatasetUri
string
Required. Training dataset used for tuning. The dataset can be specified as either a Cloud Storage path to a JSONL file or as the resource name of a Vertex Multimodal Dataset.
validationDatasetUri
string
Optional. Validation dataset used for tuning. The dataset can be specified as either a Cloud Storage path to a JSONL file or as the resource name of a Vertex Multimodal Dataset.
hyperParameters
object ( SupervisedHyperParameters
)
Optional. Hyperparameters for SFT.
exportLastCheckpointOnly
boolean
Optional. If set to true, disable intermediate checkpoints for SFT and only the last checkpoint will be exported. Otherwise, enable intermediate checkpoints for SFT. Default is false.
evaluationConfig
object ( EvaluationConfig
)
Optional. Evaluation Config for Tuning Job.
| JSON representation |
|---|
{ "trainingDatasetUri" : string , "validationDatasetUri" : string , "hyperParameters" : { object ( |
SupervisedHyperParameters
Hyperparameters for SFT.
epochCount
string ( int64
format)
Optional. Number of complete passes the model makes over the entire training dataset during training.
learningRateMultiplier
number
Optional. Multiplier for adjusting the default learning rate. Mutually exclusive with learningRate
. This feature is only available for 1P models.
adapterSize
enum ( AdapterSize
)
Optional. Adapter size for tuning.
| JSON representation |
|---|
{
"epochCount"
:
string
,
"learningRateMultiplier"
:
number
,
"adapterSize"
:
enum (
|
AdapterSize
Supported adapter sizes for tuning.
| Enums | |
|---|---|
ADAPTER_SIZE_UNSPECIFIED
|
Adapter size is unspecified. |
ADAPTER_SIZE_ONE
|
Adapter size 1. |
ADAPTER_SIZE_TWO
|
Adapter size 2. |
ADAPTER_SIZE_FOUR
|
Adapter size 4. |
ADAPTER_SIZE_EIGHT
|
Adapter size 8. |
ADAPTER_SIZE_SIXTEEN
|
Adapter size 16. |
ADAPTER_SIZE_THIRTY_TWO
|
Adapter size 32. |
EvaluationConfig
Evaluation Config for Tuning Job.
metrics[]
object ( Metric
)
Required. The metrics used for evaluation.
outputConfig
object ( OutputConfig
)
Required. Config for evaluation output.
autoraterConfig
object ( AutoraterConfig
)
Optional. Autorater config for evaluation.
inferenceGenerationConfig
object ( GenerationConfig
)
Optional. Configuration options for inference generation and outputs. If not set, default generation parameters are used.
| JSON representation |
|---|
{ "metrics" : [ { object ( |
Metric
The metric used for running evaluations.
aggregationMetrics[]
enum ( AggregationMetric
)
Optional. The aggregation metrics to use.
metric_spec
Union type
metric_spec
can be only one of the following:predefinedMetricSpec
object ( PredefinedMetricSpec
)
The spec for a pre-defined metric.
computationBasedMetricSpec
object ( ComputationBasedMetricSpec
)
Spec for a computation based metric.
llmBasedMetricSpec
object ( LLMBasedMetricSpec
)
Spec for an LLM based metric.
pointwiseMetricSpec
object ( PointwiseMetricSpec
)
Spec for pointwise metric.
pairwiseMetricSpec
object ( PairwiseMetricSpec
)
Spec for pairwise metric.
exactMatchSpec
object ( ExactMatchSpec
)
Spec for exact match metric.
bleuSpec
object ( BleuSpec
)
Spec for bleu metric.
rougeSpec
object ( RougeSpec
)
Spec for rouge metric.
| JSON representation |
|---|
{ "aggregationMetrics" : [ enum ( |
PredefinedMetricSpec
The spec for a pre-defined metric.
metricSpecName
string
Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1".
metricSpecParameters
object ( Struct
format)
Optional. The parameters needed to run the pre-defined metric.
| JSON representation |
|---|
{ "metricSpecName" : string , "metricSpecParameters" : { object } } |
ComputationBasedMetricSpec
Specification for a computation based metric.
type
enum ( ComputationBasedMetricType
)
Required. The type of the computation based metric.
parameters
object ( Struct
format)
Optional. A map of parameters for the metric, e.g. {"rougeType": "rougeL"}.
| JSON representation |
|---|
{
"type"
:
enum (
|
ComputationBasedMetricType
Types of computation based metrics.
| Enums | |
|---|---|
COMPUTATION_BASED_METRIC_TYPE_UNSPECIFIED
|
Unspecified computation based metric type. |
EXACT_MATCH
|
Exact match metric. |
BLEU
|
BLEU metric. |
ROUGE
|
ROUGE metric. |
LLMBasedMetricSpec
Specification for an LLM based metric.
resultParserConfig
object ( EvaluationParserConfig
)
Optional. The parser config for the metric result.
rubrics_source
Union type
rubrics_source
can be only one of the following:rubricGroupKey
string
Use a pre-defined group of rubrics associated with the input. Refers to a key in the rubricGroups map of EvaluationInstance.
predefinedRubricGenerationSpec
object ( PredefinedMetricSpec
)
Dynamically generate rubrics using a predefined spec.
metricPromptTemplate
string
Required. Template for the prompt sent to the judge model.
systemInstruction
string
Optional. System instructions for the judge model.
judgeAutoraterConfig
object ( AutoraterConfig
)
Optional. Optional configuration for the judge LLM (Autorater).
additionalConfig
object ( Struct
format)
Optional. Optional additional configuration for the metric.
| JSON representation |
|---|
{ "resultParserConfig" : { object ( |
AutoraterConfig
The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset.
autoraterModel
string
Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use.
Publisher model format: projects/{project}/locations/{location}/publishers/*/models/*
Tuned model endpoint format: projects/{project}/locations/{location}/endpoints/{endpoint}
generationConfig
object ( GenerationConfig
)
Optional. Configuration options for model generation and outputs.
samplingCount
integer
Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32.
flipEnabled
boolean
Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias.
| JSON representation |
|---|
{
"autoraterModel"
:
string
,
"generationConfig"
:
{
object (
|
GenerationConfig
Configuration for content generation.
This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output.
stopSequences[]
string
Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker.
responseMimeType
string
Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined.
responseModalities[]
enum ( Modality
)
Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to [TEXT, IMAGE]
, the response will include both text and an image.
thinkingConfig
object ( ThinkingConfig
)
Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking.
temperature
number
Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0].
topP
number
Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least topP
. This helps generate more diverse and less repetitive responses. For example, a topP
of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or topP
, but not both.
topK
number
Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a topK
of 40 means the model will choose the next word from the 40 most likely words.
candidateCount
integer
Optional. The number of candidate responses to generate.
A higher candidateCount
can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one.
maxOutputTokens
integer
Optional. The maximum number of tokens to generate in the response.
A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses.
responseLogprobs
boolean
Optional. If set to true, the log probabilities of the output tokens are returned.
log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging.
logprobs
integer
Optional. The number of top log probabilities to return for each token.
This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response.
presencePenalty
number
Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0].
frequencyPenalty
number
Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0].
seed
integer
Optional. A seed for the random number generator.
By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, topP, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like temperature
, which control the level
of randomness. seed
ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results.
responseSchema
object ( Schema
)
Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the OpenAPI 3.0 schema object object.
When this field is set, you must also set the responseMimeType
to application/json
.
responseJsonSchema
value ( Value
format)
Optional. When this field is set, responseSchema
must be omitted and responseMimeType
must be set to application/json
.
routingConfig
object ( RoutingConfig
)
Optional. Routing configuration.
mediaResolution
enum ( MediaResolution
)
Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model.
speechConfig
object ( SpeechConfig
)
Optional. The speech generation config.
enableAffectiveDialog
boolean
Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response.
imageConfig
object ( ImageConfig
)
Optional. Config for image generation features.
| JSON representation |
|---|
{ "stopSequences" : [ string ] , "responseMimeType" : string , "responseModalities" : [ enum ( |
RoutingConfig
The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name.
routing_config
Union type
routing_config
can be only one of the following:autoMode
object ( AutoRoutingMode
)
In this mode, the model is selected automatically based on the content of the request.
manualMode
object ( ManualRoutingMode
)
In this mode, the model is specified manually.
| JSON representation |
|---|
{ // routing_config "autoMode" : { object ( |
AutoRoutingMode
The configuration for automated routing.
When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference.
modelRoutingPreference
enum ( ModelRoutingPreference
)
The model routing preference.
| JSON representation |
|---|
{
"modelRoutingPreference"
:
enum (
|
ModelRoutingPreference
The model routing preference.
| Enums | |
|---|---|
UNKNOWN
|
Unspecified model routing preference. |
PRIORITIZE_QUALITY
|
The model will be selected to prioritize the quality of the response. |
BALANCED
|
The model will be selected to balance quality and cost. |
PRIORITIZE_COST
|
The model will be selected to prioritize the cost of the request. |
ManualRoutingMode
The configuration for manual routing.
When manual routing is specified, the model will be selected based on the model name provided.
modelName
string
The name of the model to use. Only public LLM models are accepted.
| JSON representation |
|---|
{ "modelName" : string } |
Modality
The modalities of the response.
| Enums | |
|---|---|
MODALITY_UNSPECIFIED
|
Unspecified modality. Will be processed as text. |
TEXT
|
Text modality. |
IMAGE
|
Image modality. |
AUDIO
|
Audio modality. |
VIDEO
|
Video modality. |
MediaResolution
Media resolution for the input media.
| Enums | |
|---|---|
MEDIA_RESOLUTION_UNSPECIFIED
|
Media resolution has not been set. |
MEDIA_RESOLUTION_LOW
|
Media resolution set to low (64 tokens). |
MEDIA_RESOLUTION_MEDIUM
|
Media resolution set to medium (256 tokens). |
MEDIA_RESOLUTION_HIGH
|
Media resolution set to high (zoomed reframing with 256 tokens). |
SpeechConfig
Configuration for speech generation.
voiceConfig
object ( VoiceConfig
)
The configuration for the voice to use.
languageCode
string
Optional. The language code (ISO 639-1) for the speech synthesis.
multiSpeakerVoiceConfig
object ( MultiSpeakerVoiceConfig
)
The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with voiceConfig
.
| JSON representation |
|---|
{ "voiceConfig" : { object ( |
VoiceConfig
Configuration for a voice.
voice_config
Union type
voice_config
can be only one of the following:prebuiltVoiceConfig
object ( PrebuiltVoiceConfig
)
The configuration for a prebuilt voice.
replicatedVoiceConfig
object ( ReplicatedVoiceConfig
)
Optional. The configuration for a replicated voice. This enables users to replicate a voice from an audio sample.
| JSON representation |
|---|
{ // voice_config "prebuiltVoiceConfig" : { object ( |
PrebuiltVoiceConfig
Configuration for a prebuilt voice.
voiceName
string
The name of the prebuilt voice to use.
| JSON representation |
|---|
{ "voiceName" : string } |
ReplicatedVoiceConfig
The configuration for the replicated voice to use.
mimeType
string
Optional. The mimetype of the voice sample. The only currently supported value is audio/wav
. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. mimeType
will default to audio/wav
if not set.
voiceSampleAudio
string ( bytes
format)
Optional. The sample of the custom voice.
A base64-encoded string.
| JSON representation |
|---|
{ "mimeType" : string , "voiceSampleAudio" : string } |
MultiSpeakerVoiceConfig
Configuration for a multi-speaker text-to-speech request.
speakerVoiceConfigs[]
object ( SpeakerVoiceConfig
)
Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
| JSON representation |
|---|
{
"speakerVoiceConfigs"
:
[
{
object (
|
SpeakerVoiceConfig
Configuration for a single speaker in a multi-speaker setup.
speaker
string
Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
voiceConfig
object ( VoiceConfig
)
Required. The configuration for the voice of this speaker.
| JSON representation |
|---|
{
"speaker"
:
string
,
"voiceConfig"
:
{
object (
|
ThinkingConfig
Configuration for the model's thinking features.
"Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response.
includeThoughts
boolean
Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available.
thinkingBudget
integer
Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency.
thinkingLevel
enum ( ThinkingLevel
)
Optional. The number of thoughts tokens that the model should generate.
| JSON representation |
|---|
{
"includeThoughts"
:
boolean
,
"thinkingBudget"
:
integer
,
"thinkingLevel"
:
enum (
|
ThinkingLevel
The thinking level for the model.
| Enums | |
|---|---|
THINKING_LEVEL_UNSPECIFIED
|
Unspecified thinking level. |
LOW
|
Low thinking level. |
MEDIUM
|
Medium thinking level. |
HIGH
|
High thinking level. |
MINIMAL
|
MINIMAL thinking level. |
ImageConfig
Configuration for image generation.
This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people.
aspectRatio
string
Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported:
"1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
personGeneration
enum ( PersonGeneration
)
Optional. Controls whether the model can generate people.
imageSize
string
Optional. Specifies the size of generated images. Supported values are 1K
, 2K
, 4K
. If not specified, the model will use default value 1K
.
| JSON representation |
|---|
{ "imageOutputOptions" : { object ( |
ImageOutputOptions
The image output format for generated images.
mimeType
string
Optional. The image format that the output should be saved as.
compressionQuality
integer
Optional. The compression quality of the output image.
| JSON representation |
|---|
{ "mimeType" : string , "compressionQuality" : integer } |
PersonGeneration
Enum for controlling the generation of people in images.
| Enums | |
|---|---|
PERSON_GENERATION_UNSPECIFIED
|
The default behavior is unspecified. The model will decide whether to generate images of people. |
ALLOW_ALL
|
Allows the model to generate images of people, including adults and children. |
ALLOW_ADULT
|
Allows the model to generate images of adults, but not children. |
ALLOW_NONE
|
Prevents the model from generating images of people. |
EvaluationParserConfig
Config for parsing LLM responses. It can be used to parse the LLM response to be evaluated, or the LLM response from LLM-based metrics/Autoraters.
parser
Union type
parser
can be only one of the following:customCodeParserConfig
object ( CustomCodeParserConfig
)
Optional. Use custom code to parse the LLM response.
| JSON representation |
|---|
{
// parser
"customCodeParserConfig"
:
{
object (
|
CustomCodeParserConfig
Configuration for parsing the LLM response using custom code.
parsingFunction
string
Required. Python function for parsing results. The function should be defined within this string.
The function takes a list of strings (LLM responses) and should return either a list of dictionaries (for rubrics) or a single dictionary (for a metric result).
Example function signature: def parse(responses: list[str]) -> list[dict[str, Any]] | dict[str, Any]:
When parsing rubrics, return a list of dictionaries, where each dictionary represents a Rubric. Example for rubrics: [ { "content": {"property": {"description": "The response is factual."}}, "type": "FACTUALITY", "importance": "HIGH" }, { "content": {"property": {"description": "The response is fluent."}}, "type": "FLUENCY", "importance": "MEDIUM" } ]
When parsing critique results, return a dictionary representing a MetricResult. Example for a metric result: { "score": 0.8, "explanation": "The model followed most instructions.", "rubricVerdicts": [...] }
... code for result extraction and aggregation
| JSON representation |
|---|
{ "parsingFunction" : string } |
PointwiseMetricSpec
Spec for pointwise metric.
customOutputFormatConfig
object ( CustomOutputFormatConfig
)
Optional. CustomOutputFormatConfig allows customization of metric output. By default, metrics return a score and explanation. When this config is set, the default output is replaced with either: - The raw output string. - A parsed output based on a user-defined schema. If a custom format is chosen, the score
and explanation
fields in the corresponding metric result will be empty.
metricPromptTemplate
string
Required. Metric prompt template for pointwise metric.
systemInstruction
string
Optional. System instructions for pointwise metric.
| JSON representation |
|---|
{
"customOutputFormatConfig"
:
{
object (
|
CustomOutputFormatConfig
Spec for custom output format configuration.
custom_output_format_config
Union type
custom_output_format_config
can be only one of the following:returnRawOutput
boolean
Optional. Whether to return raw output.
| JSON representation |
|---|
{ // custom_output_format_config "returnRawOutput" : boolean // Union type } |
PairwiseMetricSpec
Spec for pairwise metric.
candidateResponseFieldName
string
Optional. The field name of the candidate response.
baselineResponseFieldName
string
Optional. The field name of the baseline response.
customOutputFormatConfig
object ( CustomOutputFormatConfig
)
Optional. CustomOutputFormatConfig allows customization of metric output. When this config is set, the default output is replaced with the raw output string. If a custom format is chosen, the pairwiseChoice
and explanation
fields in the corresponding metric result will be empty.
metricPromptTemplate
string
Required. Metric prompt template for pairwise metric.
systemInstruction
string
Optional. System instructions for pairwise metric.
| JSON representation |
|---|
{
"candidateResponseFieldName"
:
string
,
"baselineResponseFieldName"
:
string
,
"customOutputFormatConfig"
:
{
object (
|
ExactMatchSpec
This type has no fields.
Spec for exact match metric - returns 1 if prediction and reference exactly matches, otherwise 0.
BleuSpec
Spec for bleu score metric - calculates the precision of n-grams in the prediction as compared to reference - returns a score ranging between 0 to 1.
useEffectiveOrder
boolean
Optional. Whether to useEffectiveOrder to compute bleu score.
| JSON representation |
|---|
{ "useEffectiveOrder" : boolean } |
RougeSpec
Spec for rouge score metric - calculates the recall of n-grams in prediction as compared to reference - returns a score ranging between 0 and 1.
rougeType
string
Optional. Supported rouge types are rougen[1-9], rougeL, and rougeLsum.
useStemmer
boolean
Optional. Whether to use stemmer to compute rouge score.
splitSummaries
boolean
Optional. Whether to split summaries while using rougeLsum.
| JSON representation |
|---|
{ "rougeType" : string , "useStemmer" : boolean , "splitSummaries" : boolean } |
AggregationMetric
The per-metric statistics on evaluation results supported by EvaluationService.EvaluateDataset
.
| Enums | |
|---|---|
AGGREGATION_METRIC_UNSPECIFIED
|
Unspecified aggregation metric. |
AVERAGE
|
Average aggregation metric. Not supported for Pairwise metric. |
MODE
|
Mode aggregation metric. |
STANDARD_DEVIATION
|
Standard deviation aggregation metric. Not supported for pairwise metric. |
VARIANCE
|
Variance aggregation metric. Not supported for pairwise metric. |
MINIMUM
|
Minimum aggregation metric. Not supported for pairwise metric. |
MAXIMUM
|
Maximum aggregation metric. Not supported for pairwise metric. |
MEDIAN
|
Median aggregation metric. Not supported for pairwise metric. |
PERCENTILE_P90
|
90th percentile aggregation metric. Not supported for pairwise metric. |
PERCENTILE_P95
|
95th percentile aggregation metric. Not supported for pairwise metric. |
PERCENTILE_P99
|
99th percentile aggregation metric. Not supported for pairwise metric. |
OutputConfig
Config for evaluation output.
destination
Union type
destination
can be only one of the following:gcsDestination
object ( GcsDestination
)
Cloud storage destination for evaluation output.
| JSON representation |
|---|
{
// destination
"gcsDestination"
:
{
object (
|
TunedModel
The Model Registry Model and Online Prediction Endpoint associated with this TuningJob
.
model
string
Output only. The resource name of the TunedModel. Format:
projects/{project}/locations/{location}/models/{model}@{versionId}
When tuning from a base model, the version id will be 1.
For continuous tuning, if the provided tunedModelDisplayName is set and different from parent model's display name, the tuned model will have a new parent model with version 1. Otherwise the version id will be incremented by 1 from the last version id in the parent model. E.g.,
projects/{project}/locations/{location}/models/{model}@{last_version_id +
1}
endpoint
string
Output only. A resource name of an Endpoint. Format: projects/{project}/locations/{location}/endpoints/{endpoint}
.
checkpoints[]
object ( TunedModelCheckpoint
)
Output only. The checkpoints associated with this TunedModel. This field is only populated for tuning jobs that enable intermediate checkpoints.
| JSON representation |
|---|
{
"model"
:
string
,
"endpoint"
:
string
,
"checkpoints"
:
[
{
object (
|
TunedModelCheckpoint
TunedModelCheckpoint for the Tuned Model of a Tuning Job.
checkpointId
string
The id of the checkpoint.
epoch
string ( int64
format)
The epoch of the checkpoint.
step
string ( int64
format)
The step of the checkpoint.
endpoint
string
The Endpoint resource name that the checkpoint is deployed to. Format: projects/{project}/locations/{location}/endpoints/{endpoint}
.
| JSON representation |
|---|
{ "checkpointId" : string , "epoch" : string , "step" : string , "endpoint" : string } |
TuningDataStats
The tuning data statistic values for TuningJob
.
tuning_data_stats
Union type
tuning_data_stats
can be only one of the following:supervisedTuningDataStats
object ( SupervisedTuningDataStats
)
The SFT Tuning data stats.
| JSON representation |
|---|
{
// tuning_data_stats
"supervisedTuningDataStats"
:
{
object (
|
SupervisedTuningDataStats
Tuning data statistics for Supervised Tuning.
tuningDatasetExampleCount
string ( int64
format)
Output only. Number of examples in the tuning dataset.
totalTuningCharacterCount
string ( int64
format)
Output only. Number of tuning characters in the tuning dataset.
totalBillableCharacterCount
(deprecated)
string ( int64
format)
Output only. Number of billable characters in the tuning dataset.
totalBillableTokenCount
string ( int64
format)
Output only. Number of billable tokens in the tuning dataset.
tuningStepCount
string ( int64
format)
Output only. Number of tuning steps for this Tuning Job.
userInputTokenDistribution
object ( SupervisedTuningDatasetDistribution
)
Output only. Dataset distributions for the user input tokens.
userOutputTokenDistribution
object ( SupervisedTuningDatasetDistribution
)
Output only. Dataset distributions for the user output tokens.
userDatasetExamples[]
object ( Content
)
Output only. Sample user messages in the training dataset uri.
totalTruncatedExampleCount
string ( int64
format)
Output only. The number of examples in the dataset that have been dropped. An example can be dropped for reasons including: too many tokens, contains an invalid image, contains too many images, etc.
truncatedExampleIndices[]
string ( int64
format)
Output only. A partial sample of the indices (starting from 1) of the dropped examples.
droppedExampleReasons[]
string
Output only. For each index in truncatedExampleIndices
, the user-facing reason why the example was dropped.
| JSON representation |
|---|
{ "tuningDatasetExampleCount" : string , "totalTuningCharacterCount" : string , "totalBillableCharacterCount" : string , "totalBillableTokenCount" : string , "tuningStepCount" : string , "userInputTokenDistribution" : { object ( |
SupervisedTuningDatasetDistribution
Dataset distribution for Supervised Tuning.
sum
string ( int64
format)
Output only. Sum of a given population of values.
billableSum
string ( int64
format)
Output only. Sum of a given population of values that are billable.
min
number
Output only. The minimum of the population values.
max
number
Output only. The maximum of the population values.
mean
number
Output only. The arithmetic mean of the values in the population.
median
number
Output only. The median of the values in the population.
p5
number
Output only. The 5th percentile of the values in the population.
p95
number
Output only. The 95th percentile of the values in the population.
buckets[]
object ( DatasetBucket
)
Output only. Defines the histogram bucket.
| JSON representation |
|---|
{
"sum"
:
string
,
"billableSum"
:
string
,
"min"
:
number
,
"max"
:
number
,
"mean"
:
number
,
"median"
:
number
,
"p5"
:
number
,
"p95"
:
number
,
"buckets"
:
[
{
object (
|
DatasetBucket
Dataset bucket used to create a histogram for the distribution given a population of values.
count
number
Output only. Number of values in the bucket.
left
number
Output only. left bound of the bucket.
right
number
Output only. Right bound of the bucket.
| JSON representation |
|---|
{ "count" : number , "left" : number , "right" : number } |
EvaluateDatasetRun
Evaluate Dataset Run result for Tuning Job.
operationName
(deprecated)
string
Output only. Deprecated: The updated architecture uses evaluationRun instead.
evaluationRun
string
Output only. The resource name of the evaluation run. Format: projects/{project}/locations/{location}/evaluationRuns/{evaluation_run_id}
.
checkpointId
string
Output only. The checkpoint id used in the evaluation run. Only populated when evaluating checkpoints.
evaluateDatasetResponse
object ( EvaluateDatasetResponse
)
Output only. Results for EvaluationService.
error
object ( Status
)
Output only. The error of the evaluation run if any.
| JSON representation |
|---|
{ "operationName" : string , "evaluationRun" : string , "checkpointId" : string , "evaluateDatasetResponse" : { object ( |
EvaluateDatasetResponse
The results from an evaluation run performed by the EvaluationService.
aggregationOutput
object ( AggregationOutput
)
Output only. Aggregation statistics derived from results of EvaluationService.
outputInfo
object ( OutputInfo
)
Output only. Output info for EvaluationService.
| JSON representation |
|---|
{ "aggregationOutput" : { object ( |
AggregationOutput
The aggregation result for the entire dataset and all metrics.
dataset
object ( EvaluationDataset
)
The dataset used for evaluation & aggregation.
aggregationResults[]
object ( AggregationResult
)
One AggregationResult per metric.
| JSON representation |
|---|
{ "dataset" : { object ( |
EvaluationDataset
The dataset used for evaluation.
source
Union type
source
can be only one of the following:gcsSource
object ( GcsSource
)
Cloud storage source holds the dataset. Currently only one Cloud Storage file path is supported.
bigquerySource
object ( BigQuerySource
)
BigQuery source holds the dataset.
| JSON representation |
|---|
{ // source "gcsSource" : { object ( |
AggregationResult
The aggregation result for a single metric.
aggregation_result
Union type
aggregation_result
can be only one of the following:pointwiseMetricResult
object ( PointwiseMetricResult
)
result for pointwise metric.
pairwiseMetricResult
object ( PairwiseMetricResult
)
result for pairwise metric.
exactMatchMetricValue
object ( ExactMatchMetricValue
)
Results for exact match metric.
bleuMetricValue
object ( BleuMetricValue
)
Results for bleu metric.
rougeMetricValue
object ( RougeMetricValue
)
Results for rouge metric.
| JSON representation |
|---|
{ // aggregation_result "pointwiseMetricResult" : { object ( |
PointwiseMetricResult
Spec for pointwise metric result.
explanation
string
Output only. Explanation for pointwise metric score.
customOutput
object ( CustomOutput
)
Output only. Spec for custom output.
score
number
Output only. Pointwise metric score.
| JSON representation |
|---|
{
"explanation"
:
string
,
"customOutput"
:
{
object (
|
CustomOutput
RawOutput
Raw output.
rawOutput[]
string
Output only. Raw output string.
| JSON representation |
|---|
{ "rawOutput" : [ string ] } |
PairwiseMetricResult
Spec for pairwise metric result.
pairwiseChoice
enum ( PairwiseChoice
)
Output only. Pairwise metric choice.
explanation
string
Output only. Explanation for pairwise metric score.
customOutput
object ( CustomOutput
)
Output only. Spec for custom output.
| JSON representation |
|---|
{ "pairwiseChoice" : enum ( |
PairwiseChoice
Pairwise prediction autorater preference.
| Enums | |
|---|---|
PAIRWISE_CHOICE_UNSPECIFIED
|
Unspecified prediction choice. |
BASELINE
|
baseline prediction wins |
CANDIDATE
|
Candidate prediction wins |
TIE
|
Winner cannot be determined |
ExactMatchMetricValue
Exact match metric value for an instance.
score
number
Output only. Exact match score.
| JSON representation |
|---|
{ "score" : number } |
BleuMetricValue
Bleu metric value for an instance.
score
number
Output only. Bleu score.
| JSON representation |
|---|
{ "score" : number } |
RougeMetricValue
Rouge metric value for an instance.
score
number
Output only. Rouge score.
| JSON representation |
|---|
{ "score" : number } |
OutputInfo
Describes the info for output of EvaluationService.
output_location
Union type
output_location
can be only one of the following:gcsOutputDirectory
string
Output only. The full path of the Cloud Storage directory created, into which the evaluation results and aggregation results are written.
| JSON representation |
|---|
{ // output_location "gcsOutputDirectory" : string // Union type } |
Methods |
|
|---|---|
|
Cancels a tuning job. |
|
Creates a tuning job. |
|
Gets a tuning job. |
|
Lists tuning jobs in a location. |
|
Rebase a tuned model. |

