Discovery Engine V1 API - Class Google::Cloud::DiscoveryEngine::V1::CustomTuningModel (v1.2.0)

Reference documentation and code samples for the Discovery Engine V1 API class Google::Cloud::DiscoveryEngine::V1::CustomTuningModel.

Metadata that describes a custom tuned model.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#create_time

def create_time() -> ::Google::Protobuf::Timestamp
Returns

#create_time=

def create_time=(value) -> ::Google::Protobuf::Timestamp
Parameter
Returns

#display_name

def display_name() -> ::String
Returns
  • (::String) — The display name of the model.

#display_name=

def display_name=(value) -> ::String
Parameter
  • value (::String) — The display name of the model.
Returns
  • (::String) — The display name of the model.

#error_message

def error_message() -> ::String
Returns
  • (::String) — Currently this is only populated if the model state is INPUT_VALIDATION_FAILED.

#error_message=

def error_message=(value) -> ::String
Parameter
  • value (::String) — Currently this is only populated if the model state is INPUT_VALIDATION_FAILED.
Returns
  • (::String) — Currently this is only populated if the model state is INPUT_VALIDATION_FAILED.

#metrics

def metrics() -> ::Google::Protobuf::Map{::String => ::Float}
Returns
  • (::Google::Protobuf::Map{::String => ::Float}) — The metrics of the trained model.

#metrics=

def metrics=(value) -> ::Google::Protobuf::Map{::String => ::Float}
Parameter
  • value (::Google::Protobuf::Map{::String => ::Float}) — The metrics of the trained model.
Returns
  • (::Google::Protobuf::Map{::String => ::Float}) — The metrics of the trained model.

#model_state

def model_state() -> ::Google::Cloud::DiscoveryEngine::V1::CustomTuningModel::ModelState
Returns

#model_state=

def model_state=(value) -> ::Google::Cloud::DiscoveryEngine::V1::CustomTuningModel::ModelState
Parameter
Returns

#model_version

def model_version() -> ::Integer
Returns
  • (::Integer) — The version of the model.

#model_version=

def model_version=(value) -> ::Integer
Parameter
  • value (::Integer) — The version of the model.
Returns
  • (::Integer) — The version of the model.

#name

def name() -> ::String
Returns
  • (::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.

#name=

def name=(value) -> ::String
Parameter
  • value (::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.

Returns
  • (::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.

#training_start_time

def training_start_time() -> ::Google::Protobuf::Timestamp
Returns

#training_start_time=

def training_start_time=(value) -> ::Google::Protobuf::Timestamp
Parameter
Returns