Class: Google::Cloud::DiscoveryEngine::V1::TrainCustomModelResponse

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/discoveryengine/v1/search_tuning_service.rb

Overview

Response of the TrainCustomModelRequest. This message is returned by the google.longrunning.Operations.response field.

Defined Under Namespace

Classes: MetricsEntry

Instance Attribute Summary collapse

Instance Attribute Details

#error_config ⇒ ::Google::Cloud::DiscoveryEngine::V1::ImportErrorConfig

Returns Echoes the destination for the complete errors in the request if set.

Returns:



142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'proto_docs/google/cloud/discoveryengine/v1/search_tuning_service.rb', line 142

class TrainCustomModelResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Float]
  class MetricsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#error_samples ⇒ ::Array<::Google::Rpc::Status>

Returns A sample of errors encountered while processing the data.

Returns:



142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'proto_docs/google/cloud/discoveryengine/v1/search_tuning_service.rb', line 142

class TrainCustomModelResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Float]
  class MetricsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#metrics ⇒ ::Google::Protobuf::Map{::String => ::Float}

Returns The metrics of the trained model.

Returns:

  • (::Google::Protobuf::Map{::String => ::Float}) —

    The metrics of the trained model.



142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'proto_docs/google/cloud/discoveryengine/v1/search_tuning_service.rb', line 142

class TrainCustomModelResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Float]
  class MetricsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#model_name ⇒ ::String

Returns Fully qualified name of the CustomTuningModel.

Returns:

  • (::String) —

    Fully qualified name of the CustomTuningModel.



142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'proto_docs/google/cloud/discoveryengine/v1/search_tuning_service.rb', line 142

class TrainCustomModelResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Float]
  class MetricsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#model_status ⇒ ::String

Returns The trained model status. Possible values are:

  • bad-data: The training data quality is bad.
  • no-improvement: Tuning didn't improve performance. Won't deploy.
  • in-progress: Model training job creation is in progress.
  • training: Model is actively training.
  • evaluating: The model is evaluating trained metrics.
  • indexing: The model trained metrics are indexing.
  • ready: The model is ready for serving.

Returns:

  • (::String) —

    The trained model status. Possible values are:

    • bad-data: The training data quality is bad.
    • no-improvement: Tuning didn't improve performance. Won't deploy.
    • in-progress: Model training job creation is in progress.
    • training: Model is actively training.
    • evaluating: The model is evaluating trained metrics.
    • indexing: The model trained metrics are indexing.
    • ready: The model is ready for serving.


142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'proto_docs/google/cloud/discoveryengine/v1/search_tuning_service.rb', line 142

class TrainCustomModelResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Float]
  class MetricsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end