This product is not supported for your selected Datadog site. ().

gcp_aiplatform_tuning_job

ancestors

Type: UNORDERED_LIST_STRING

base_model

Type: STRING
Provider name: baseModel
Description: The base model that is being tuned. See Supported models.

create_time

Type: TIMESTAMP
Provider name: createTime
Description: Output only. Time when the TuningJob was created.

description

Type: STRING
Provider name: description
Description: Optional. The description of the TuningJob.

encryption_spec

Type: STRUCT
Provider name: encryptionSpec
Description: 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.

  • kms_key_name
    Type: STRING
    Provider name: kmsKeyName
    Description: Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key. The key needs to be in the same region as where the compute resource is created.

end_time

Type: TIMESTAMP
Provider name: endTime
Description: Output only. Time when the TuningJob entered any of the following JobStates: JOB_STATE_SUCCEEDED, JOB_STATE_FAILED, JOB_STATE_CANCELLED, JOB_STATE_EXPIRED.

error

Type: STRUCT
Provider name: error
Description: Output only. Only populated when job’s state is JOB_STATE_FAILED or JOB_STATE_CANCELLED.

  • code
    Type: INT32
    Provider name: code
    Description: The status code, which should be an enum value of google.rpc.Code.
  • message
    Type: STRING
    Provider name: message
    Description: A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

experiment

Type: STRING
Provider name: experiment
Description: Output only. The Experiment associated with this TuningJob.

labels

Type: UNORDERED_LIST_STRING

name

Type: STRING
Provider name: name
Description: Output only. Identifier. Resource name of a TuningJob. Format: projects/{project}/locations/{location}/tuningJobs/{tuning_job}

organization_id

Type: STRING

parent

Type: STRING

project_id

Type: STRING

project_number

Type: STRING

resource_name

Type: STRING

service_account

Type: STRING
Provider name: serviceAccount
Description: The service account that the tuningJob workload runs as. If not specified, the Vertex AI 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.

start_time

Type: TIMESTAMP
Provider name: startTime
Description: Output only. Time when the TuningJob for the first time entered the JOB_STATE_RUNNING state.

state

Type: STRING
Provider name: state
Description: Output only. The detailed state of the job.
Possible values:

  • JOB_STATE_UNSPECIFIED - The job state is unspecified.
  • JOB_STATE_QUEUED - The job has been just created or resumed and processing has not yet begun.
  • JOB_STATE_PENDING - The service is preparing to run the job.
  • JOB_STATE_RUNNING - The job is in progress.
  • JOB_STATE_SUCCEEDED - The job completed successfully.
  • JOB_STATE_FAILED - The job failed.
  • JOB_STATE_CANCELLING - The job is being cancelled. From this state the job may only go to either JOB_STATE_SUCCEEDED, JOB_STATE_FAILED or JOB_STATE_CANCELLED.
  • JOB_STATE_CANCELLED - The job has been cancelled.
  • JOB_STATE_PAUSED - The job has been stopped, and can be resumed.
  • JOB_STATE_EXPIRED - The job has expired.
  • JOB_STATE_UPDATING - The job is being updated. Only jobs in the RUNNING state can be updated. After updating, the job goes back to the RUNNING state.
  • JOB_STATE_PARTIALLY_SUCCEEDED - The job is partially succeeded, some results may be missing due to errors.

supervised_tuning_spec

Type: STRUCT
Provider name: supervisedTuningSpec
Description: Tuning Spec for Supervised Fine Tuning.

  • hyper_parameters
    Type: STRUCT
    Provider name: hyperParameters
    Description: Optional. Hyperparameters for SFT.
    • adapter_size
      Type: STRING
      Provider name: adapterSize
      Description: Optional. Adapter size for tuning.
      Possible values:
      • 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.
    • epoch_count
      Type: INT64
      Provider name: epochCount
      Description: Optional. Number of complete passes the model makes over the entire training dataset during training.
    • learning_rate_multiplier
      Type: DOUBLE
      Provider name: learningRateMultiplier
      Description: Optional. Multiplier for adjusting the default learning rate.
  • training_dataset_uri
    Type: STRING
    Provider name: trainingDatasetUri
    Description: Required. Cloud Storage path to file containing training dataset for tuning. The dataset must be formatted as a JSONL file.
  • validation_dataset_uri
    Type: STRING
    Provider name: validationDatasetUri
    Description: Optional. Cloud Storage path to file containing validation dataset for tuning. The dataset must be formatted as a JSONL file.

tags

Type: UNORDERED_LIST_STRING

tuned_model

Type: STRUCT
Provider name: tunedModel
Description: Output only. The tuned model resources associated with this TuningJob.

  • endpoint
    Type: STRING
    Provider name: endpoint
    Description: Output only. A resource name of an Endpoint. Format: projects/{project}/locations/{location}/endpoints/{endpoint}.
  • model
    Type: STRING
    Provider name: model
    Description: Output only. The resource name of the TunedModel. Format: projects/{project}/locations/{location}/models/{model}.

tuned_model_display_name

Type: STRING
Provider name: tunedModelDisplayName
Description: Optional. The display name of the TunedModel. The name can be up to 128 characters long and can consist of any UTF-8 characters.

tuning_data_stats

Type: STRUCT
Provider name: tuningDataStats
Description: Output only. The tuning data statistics associated with this TuningJob.

  • supervised_tuning_data_stats
    Type: STRUCT
    Provider name: supervisedTuningDataStats
    Description: The SFT Tuning data stats.
    • dropped_example_reasons
      Type: UNORDERED_LIST_STRING
      Provider name: droppedExampleReasons
      Description: Output only. For each index in truncated_example_indices, the user-facing reason why the example was dropped. Must not include example itself.
    • total_billable_character_count
      Type: INT64
      Provider name: totalBillableCharacterCount
      Description: Output only. Number of billable characters in the tuning dataset.
    • total_billable_token_count
      Type: INT64
      Provider name: totalBillableTokenCount
      Description: Output only. Number of billable tokens in the tuning dataset.
    • total_truncated_example_count
      Type: INT64
      Provider name: totalTruncatedExampleCount
      Description: 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.
    • total_tuning_character_count
      Type: INT64
      Provider name: totalTuningCharacterCount
      Description: Output only. Number of tuning characters in the tuning dataset.
    • truncated_example_indices
      Type: UNORDERED_LIST_INT64
      Provider name: truncatedExampleIndices
      Description: Output only. A partial sample of the indices (starting from 1) of the dropped examples.
    • tuning_dataset_example_count
      Type: INT64
      Provider name: tuningDatasetExampleCount
      Description: Output only. Number of examples in the tuning dataset.
    • tuning_step_count
      Type: INT64
      Provider name: tuningStepCount
      Description: Output only. Number of tuning steps for this Tuning Job.
    • user_dataset_examples
      Type: UNORDERED_LIST_STRUCT
      Provider name: userDatasetExamples
      Description: Output only. Sample user messages in the training dataset uri.
      • parts
        Type: UNORDERED_LIST_STRUCT
        Provider name: parts
        Description: Required. Ordered Parts that constitute a single message. Parts may have different IANA MIME types.
        • code_execution_result
          Type: STRUCT
          Provider name: codeExecutionResult
          Description: Optional. Result of executing the [ExecutableCode].
          • outcome
            Type: STRING
            Provider name: outcome
            Description: Required. Outcome of the code execution.
            Possible values:
            • OUTCOME_UNSPECIFIED - Unspecified status. This value should not be used.
            • OUTCOME_OK - Code execution completed successfully.
            • OUTCOME_FAILED - Code execution finished but with a failure. stderr should contain the reason.
            • OUTCOME_DEADLINE_EXCEEDED - Code execution ran for too long, and was cancelled. There may or may not be a partial output present.
          • output
            Type: STRING
            Provider name: output
            Description: Optional. Contains stdout when code execution is successful, stderr or other description otherwise.
        • executable_code
          Type: STRUCT
          Provider name: executableCode
          Description: Optional. Code generated by the model that is meant to be executed.
          • code
            Type: STRING
            Provider name: code
            Description: Required. The code to be executed.
          • language
            Type: STRING
            Provider name: language
            Description: Required. Programming language of the code.
            Possible values:
            • LANGUAGE_UNSPECIFIED - Unspecified language. This value should not be used.
            • PYTHON - Python >= 3.10, with numpy and simpy available.
        • file_data
          Type: STRUCT
          Provider name: fileData
          Description: Optional. URI based data.
          • file_uri
            Type: STRING
            Provider name: fileUri
            Description: Required. URI.
          • gcp_display_name
            Type: STRING
            Provider name: displayName
            Description: Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is not currently used in the Gemini GenerateContent calls.
          • mime_type
            Type: STRING
            Provider name: mimeType
            Description: Required. The IANA standard MIME type of the source data.
        • function_call
          Type: STRUCT
          Provider name: functionCall
          Description: Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values.
          • name
            Type: STRING
            Provider name: name
            Description: Required. The name of the function to call. Matches [FunctionDeclaration.name].
        • function_response
          Type: STRUCT
          Provider name: functionResponse
          Description: 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.
          • name
            Type: STRING
            Provider name: name
            Description: Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].
        • inline_data
          Type: STRUCT
          Provider name: inlineData
          Description: Optional. Inlined bytes data.
          • gcp_display_name
            Type: STRING
            Provider name: displayName
            Description: Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is not currently used in the Gemini GenerateContent calls.
          • mime_type
            Type: STRING
            Provider name: mimeType
            Description: Required. The IANA standard MIME type of the source data.
        • text
          Type: STRING
          Provider name: text
          Description: Optional. Text part (can be code).
        • video_metadata
          Type: STRUCT
          Provider name: videoMetadata
          Description: Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
          • end_offset
            Type: STRING
            Provider name: endOffset
            Description: Optional. The end offset of the video.
          • start_offset
            Type: STRING
            Provider name: startOffset
            Description: Optional. The start offset of the video.
      • role
        Type: STRING
        Provider name: role
        Description: 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.
    • user_input_token_distribution
      Type: STRUCT
      Provider name: userInputTokenDistribution
      Description: Output only. Dataset distributions for the user input tokens.
      • billable_sum
        Type: INT64
        Provider name: billableSum
        Description: Output only. Sum of a given population of values that are billable.
      • buckets
        Type: UNORDERED_LIST_STRUCT
        Provider name: buckets
        Description: Output only. Defines the histogram bucket.
        • count
          Type: DOUBLE
          Provider name: count
          Description: Output only. Number of values in the bucket.
        • left
          Type: DOUBLE
          Provider name: left
          Description: Output only. Left bound of the bucket.
        • right
          Type: DOUBLE
          Provider name: right
          Description: Output only. Right bound of the bucket.
      • max
        Type: DOUBLE
        Provider name: max
        Description: Output only. The maximum of the population values.
      • mean
        Type: DOUBLE
        Provider name: mean
        Description: Output only. The arithmetic mean of the values in the population.
      • median
        Type: DOUBLE
        Provider name: median
        Description: Output only. The median of the values in the population.
      • min
        Type: DOUBLE
        Provider name: min
        Description: Output only. The minimum of the population values.
      • p5
        Type: DOUBLE
        Provider name: p5
        Description: Output only. The 5th percentile of the values in the population.
      • p95
        Type: DOUBLE
        Provider name: p95
        Description: Output only. The 95th percentile of the values in the population.
      • sum
        Type: INT64
        Provider name: sum
        Description: Output only. Sum of a given population of values.
    • user_message_per_example_distribution
      Type: STRUCT
      Provider name: userMessagePerExampleDistribution
      Description: Output only. Dataset distributions for the messages per example.
      • billable_sum
        Type: INT64
        Provider name: billableSum
        Description: Output only. Sum of a given population of values that are billable.
      • buckets
        Type: UNORDERED_LIST_STRUCT
        Provider name: buckets
        Description: Output only. Defines the histogram bucket.
        • count
          Type: DOUBLE
          Provider name: count
          Description: Output only. Number of values in the bucket.
        • left
          Type: DOUBLE
          Provider name: left
          Description: Output only. Left bound of the bucket.
        • right
          Type: DOUBLE
          Provider name: right
          Description: Output only. Right bound of the bucket.
      • max
        Type: DOUBLE
        Provider name: max
        Description: Output only. The maximum of the population values.
      • mean
        Type: DOUBLE
        Provider name: mean
        Description: Output only. The arithmetic mean of the values in the population.
      • median
        Type: DOUBLE
        Provider name: median
        Description: Output only. The median of the values in the population.
      • min
        Type: DOUBLE
        Provider name: min
        Description: Output only. The minimum of the population values.
      • p5
        Type: DOUBLE
        Provider name: p5
        Description: Output only. The 5th percentile of the values in the population.
      • p95
        Type: DOUBLE
        Provider name: p95
        Description: Output only. The 95th percentile of the values in the population.
      • sum
        Type: INT64
        Provider name: sum
        Description: Output only. Sum of a given population of values.
    • user_output_token_distribution
      Type: STRUCT
      Provider name: userOutputTokenDistribution
      Description: Output only. Dataset distributions for the user output tokens.
      • billable_sum
        Type: INT64
        Provider name: billableSum
        Description: Output only. Sum of a given population of values that are billable.
      • buckets
        Type: UNORDERED_LIST_STRUCT
        Provider name: buckets
        Description: Output only. Defines the histogram bucket.
        • count
          Type: DOUBLE
          Provider name: count
          Description: Output only. Number of values in the bucket.
        • left
          Type: DOUBLE
          Provider name: left
          Description: Output only. Left bound of the bucket.
        • right
          Type: DOUBLE
          Provider name: right
          Description: Output only. Right bound of the bucket.
      • max
        Type: DOUBLE
        Provider name: max
        Description: Output only. The maximum of the population values.
      • mean
        Type: DOUBLE
        Provider name: mean
        Description: Output only. The arithmetic mean of the values in the population.
      • median
        Type: DOUBLE
        Provider name: median
        Description: Output only. The median of the values in the population.
      • min
        Type: DOUBLE
        Provider name: min
        Description: Output only. The minimum of the population values.
      • p5
        Type: DOUBLE
        Provider name: p5
        Description: Output only. The 5th percentile of the values in the population.
      • p95
        Type: DOUBLE
        Provider name: p95
        Description: Output only. The 95th percentile of the values in the population.
      • sum
        Type: INT64
        Provider name: sum
        Description: Output only. Sum of a given population of values.

update_time

Type: TIMESTAMP
Provider name: updateTime
Description: Output only. Time when the TuningJob was most recently updated.