REST Resource: projects.locations.tuningJobs

Resource: TuningJob

Represents a TuningJob that runs with Google owned models.

JSON representation 
{
  "name": string,
  "tunedModelDisplayName": string,
  "description": string,
  "state": enum (JobState),
  "createTime": string,
  "startTime": string,
  "endTime": string,
  "updateTime": string,
  "error": {
    object (Status)
  },
  "labels": {
    string: string,
    ...
  },
  "experiment": string,
  "tunedModel": {
    object (TunedModel)
  },
  "tuningDataStats": {
    object (TuningDataStats)
  },

  // Union field source_model can be only one of the following:
  "baseModel": string
  // End of list of possible types for union field source_model.

  // Union field tuning_spec can be only one of the following:
  "supervisedTuningSpec": {
    object (SupervisedTuningSpec)
  }
  // End of list of possible types for union field tuning_spec.
}
Fields
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.
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.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
startTime

string (Timestamp format)

Output only. time when the TuningJob for the first time entered the JOB_STATE_RUNNING state.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
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.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

Output only. time when the TuningJob was most recently updated.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
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 assiociated with this TuningJob.
tuningDataStats

object (TuningDataStats)

Output only. The tuning data statistics associated with this TuningJob.

Union field source_model.

source_model can be only one of the following:
baseModel

string

The base model that is being tuned, e.g., "gemini-1.0-pro-002".

Union field tuning_spec.

tuning_spec can be only one of the following:
supervisedTuningSpec

object (SupervisedTuningSpec)

Tuning Spec for Supervised Fine Tuning.

SupervisedTuningSpec

Tuning Spec for Supervised Tuning.

JSON representation 
{
  "trainingDatasetUri": string,
  "validationDatasetUri": string,
  "hyperParameters": {
    object (SupervisedHyperParameters)
  }
}
Fields
trainingDatasetUri

string

Required. Cloud Storage path to file containing training dataset for tuning. The dataset must be formatted as a JSONL file.
validationDatasetUri

string

Optional. Cloud Storage path to file containing validation dataset for tuning. The dataset must be formatted as a JSONL file.
hyperParameters

object (SupervisedHyperParameters)

Optional. Hyperparameters for SFT.

SupervisedHyperParameters

Hyperparameters for SFT.

JSON representation 
{
  "epochCount": string,
  "learningRateMultiplier": number,
  "adapterSize": enum (AdapterSize)
}
Fields
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.
adapterSize

enum (AdapterSize)

Optional. Adapter size for tuning.

AdapterSize

Supported adapter sizes for tuning.

Enums
ADAPTER_SIZE_UNSPECIFIED Adapter size is unspecified.
ADAPTER_SIZE_ONE Adapter size 1.
ADAPTER_SIZE_FOUR Adapter size 4.
ADAPTER_SIZE_EIGHT Adapter size 8.
ADAPTER_SIZE_SIXTEEN Adapter size 16.

TunedModel

The Model Registry Model and Online Prediction Endpoint assiociated with this TuningJob.

JSON representation 
{
  "model": string,
  "endpoint": string
}
Fields
model

string

Output only. The resource name of the TunedModel. Format: projects/{project}/locations/{location}/models/{model}.
endpoint

string

Output only. A resource name of an Endpoint. Format: projects/{project}/locations/{location}/endpoints/{endpoint}.

TuningDataStats

The tuning data statistic values for TuningJob.

JSON representation 
{

  // Union field tuning_data_stats can be only one of the following:
  "supervisedTuningDataStats": {
    object (SupervisedTuningDataStats)
  }
  // End of list of possible types for union field tuning_data_stats.
}
Fields

Union field tuning_data_stats.

tuning_data_stats can be only one of the following:
supervisedTuningDataStats

object (SupervisedTuningDataStats)

The SFT Tuning data stats.

SupervisedTuningDataStats

Tuning data statistics for Supervised Tuning.

JSON representation 
{
  "tuningDatasetExampleCount": string,
  "totalTuningCharacterCount": string,
  "totalBillableCharacterCount": string,
  "tuningStepCount": string,
  "userInputTokenDistribution": {
    object (SupervisedTuningDatasetDistribution)
  },
  "userOutputTokenDistribution": {
    object (SupervisedTuningDatasetDistribution)
  },
  "userMessagePerExampleDistribution": {
    object (SupervisedTuningDatasetDistribution)
  },
  "userDatasetExamples": [
    {
      object (Content)
    }
  ]
}
Fields
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

string (int64 format)

Output only. Number of billable characters 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.
userMessagePerExampleDistribution

object (SupervisedTuningDatasetDistribution)

Output only. Dataset distributions for the messages per example.
userDatasetExamples[]

object (Content)

Output only. Sample user messages in the training dataset uri.

SupervisedTuningDatasetDistribution

Dataset distribution for Supervised Tuning.

JSON representation 
{
  "sum": string,
  "min": number,
  "max": number,
  "mean": number,
  "median": number,
  "p5": number,
  "p95": number,
  "buckets": [
    {
      object (DatasetBucket)
    }
  ]
}
Fields
sum

string (int64 format)

Output only. Sum of a given population of values.
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.

DatasetBucket

Dataset bucket used to create a histogram for the distribution given a population of values.

JSON representation 
{
  "count": number,
  "left": number,
  "right": number
}
Fields
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.

Content

The base structured datatype containing multi-part content of a message.

A Content includes a role field designating the producer of the Content and a parts field containing multi-part data that contains the content of the message turn.

JSON representation 
{
  "role": string,
  "parts": [
    {
      object (Part)
    }
  ]
}
Fields
role

string

Optional. The producer of the content. Must be either 'user' or 'model'.

Useful to set for multi-turn conversations, otherwise can be left blank or unset.
parts[]

object (Part)

Required. Ordered Parts that constitute a single message. Parts may have different IANA MIME types.

Part

A datatype containing media that is part of a multi-part Content message.

A Part consists of data which has an associated datatype. A Part can only contain one of the accepted types in Part.data.

A Part must have a fixed IANA MIME type identifying the type and subtype of the media if inlineData or fileData field is filled with raw bytes.

JSON representation 
{

  // Union field data can be only one of the following:
  "text": string,
  "inlineData": {
    object (Blob)
  },
  "fileData": {
    object (FileData)
  },
  "functionCall": {
    object (FunctionCall)
  },
  "functionResponse": {
    object (FunctionResponse)
  }
  // End of list of possible types for union field data.

  // Union field metadata can be only one of the following:
  "videoMetadata": {
    object (VideoMetadata)
  }
  // End of list of possible types for union field metadata.
}
Fields

Union field data.

data can be only one of the following:
text

string

Optional. Text part (can be code).
inlineData

object (Blob)

Optional. Inlined bytes data.
fileData

object (FileData)

Optional. URI based data.
functionCall

object (FunctionCall)

Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values.
functionResponse

object (FunctionResponse)

Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model.

Union field metadata.

metadata can be only one of the following:
videoMetadata

object (VideoMetadata)

Optional. Video metadata. The metadata should only be specified while the video data is presented in inlineData or fileData.

Blob

Content blob.

It's preferred to send as text directly rather than raw bytes.

JSON representation 
{
  "mimeType": string,
  "data": string
}
Fields
mimeType

string

Required. The IANA standard MIME type of the source data.
data

string (bytes format)

Required. Raw bytes.

A base64-encoded string.

FileData

URI based data.

JSON representation 
{
  "mimeType": string,
  "fileUri": string
}
Fields
mimeType

string

Required. The IANA standard MIME type of the source data.
fileUri

string

Required. URI.

FunctionCall

A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values.

JSON representation 
{
  "name": string,
  "args": {
    object
  }
}
Fields
name

string

Required. The name of the function to call. Matches [FunctionDeclaration.name].
args

object (Struct format)

Optional. Required. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.

FunctionResponse

The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction.

JSON representation 
{
  "name": string,
  "response": {
    object
  }
}
Fields
name

string

Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].
response

object (Struct format)

Required. The function response in JSON object format.

VideoMetadata

metadata describes the input video content.

JSON representation 
{
  "startOffset": string,
  "endOffset": string
}
Fields
startOffset

string (Duration format)

Optional. The start offset of the video.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
endOffset

string (Duration format)

Optional. The end offset of the video.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".

Methods

cancel

 Cancels a TuningJob.

create

 Creates a TuningJob.

get

 Gets a TuningJob.

list

 Lists TuningJobs in a Location.