Class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCustomTuningModel

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/discoveryengine_v1alpha/classes.rb,
lib/google/apis/discoveryengine_v1alpha/representations.rb,
lib/google/apis/discoveryengine_v1alpha/representations.rb

Overview

Metadata that describes a custom tuned model.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1alphaCustomTuningModel

Returns a new instance of GoogleCloudDiscoveryengineV1alphaCustomTuningModel.



7870
7871
7872
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 7870

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#create_time ⇒ String

Deprecated: Timestamp the Model was created at. Corresponds to the JSON property createTime

Returns:

  • (String) 


7829
7830
7831
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 7829

def create_time
  @create_time
end

#display_name ⇒ String

The display name of the model. Corresponds to the JSON property displayName

Returns:

  • (String) 


7834
7835
7836
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 7834

def display_name
  @display_name
end

#error_message ⇒ String

Currently this is only populated if the model state is INPUT_VALIDATION_FAILED. Corresponds to the JSON property errorMessage

Returns:

  • (String) 


7840
7841
7842
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 7840

def error_message
  @error_message
end

#metrics ⇒ Hash<String,Float>

The metrics of the trained model. Corresponds to the JSON property metrics

Returns:

  • (Hash<String,Float>) 


7845
7846
7847
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 7845

def metrics
  @metrics
end

#model_state ⇒ String

The state that the model is in (e.g.TRAINING or TRAINING_FAILED). Corresponds to the JSON property modelState

Returns:

  • (String) 


7850
7851
7852
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 7850

def model_state
  @model_state
end

#model_version ⇒ Fixnum

The version of the model. Corresponds to the JSON property modelVersion

Returns:

  • (Fixnum) 


7855
7856
7857
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 7855

def model_version
  @model_version
end

#name ⇒ String

Required. The fully qualified resource name of the model. Format: projects/ project/locations/location/collections/collection/dataStores/data_store/ customTuningModels/custom_tuning_model`. Model must be an alpha-numerical string with limit of 40 characters. Corresponds to the JSON propertyname`

Returns:

  • (String) 


7863
7864
7865
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 7863

def name
  @name
end

#training_start_time ⇒ String

Timestamp the model training was initiated. Corresponds to the JSON property trainingStartTime

Returns:

  • (String) 


7868
7869
7870
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 7868

def training_start_time
  @training_start_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



7875
7876
7877
7878
7879
7880
7881
7882
7883
7884
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 7875

def update!(**args)
  @create_time = args[:create_time] if args.key?(:create_time)
  @display_name = args[:display_name] if args.key?(:display_name)
  @error_message = args[:error_message] if args.key?(:error_message)
  @metrics = args[:metrics] if args.key?(:metrics)
  @model_state = args[:model_state] if args.key?(:model_state)
  @model_version = args[:model_version] if args.key?(:model_version)
  @name = args[:name] if args.key?(:name)
  @training_start_time = args[:training_start_time] if args.key?(:training_start_time)
end