Class: Google::Cloud::AutoML::V1::Model

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

Overview

API proto representing a trained machine learning model.

Defined Under Namespace

Modules: DeploymentState Classes: LabelsEntry

Instance Attribute Summary collapse

Instance Attribute Details

#create_time ⇒ ::Google::Protobuf::Timestamp

Returns Output only. Timestamp when the model training finished and can be used for prediction.

Returns:



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'proto_docs/google/cloud/automl/v1/model.rb', line 81

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

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

  # Deployment state of the model.
  module DeploymentState
    # Should not be used, an un-set enum has this value by default.
    DEPLOYMENT_STATE_UNSPECIFIED = 0

    # Model is deployed.
    DEPLOYED = 1

    # Model is not deployed.
    UNDEPLOYED = 2
  end
end

#dataset_id ⇒ ::String

Returns Required. The resource ID of the dataset used to create the model. The dataset must come from the same ancestor project and location.

Returns:

  • (::String) —

    Required. The resource ID of the dataset used to create the model. The dataset must come from the same ancestor project and location.



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'proto_docs/google/cloud/automl/v1/model.rb', line 81

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

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

  # Deployment state of the model.
  module DeploymentState
    # Should not be used, an un-set enum has this value by default.
    DEPLOYMENT_STATE_UNSPECIFIED = 0

    # Model is deployed.
    DEPLOYED = 1

    # Model is not deployed.
    UNDEPLOYED = 2
  end
end

#deployment_state ⇒ ::Google::Cloud::AutoML::V1::Model::DeploymentState

Returns Output only. Deployment state of the model. A model can only serve prediction requests after it gets deployed.

Returns:



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'proto_docs/google/cloud/automl/v1/model.rb', line 81

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

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

  # Deployment state of the model.
  module DeploymentState
    # Should not be used, an un-set enum has this value by default.
    DEPLOYMENT_STATE_UNSPECIFIED = 0

    # Model is deployed.
    DEPLOYED = 1

    # Model is not deployed.
    UNDEPLOYED = 2
  end
end

#display_name ⇒ ::String

Returns Required. The name of the model to show in the interface. The name can be up to 32 characters long and can consist only of ASCII Latin letters A-Z and a-z, underscores (_), and ASCII digits 0-9. It must start with a letter.

Returns:

  • (::String) —

    Required. The name of the model to show in the interface. The name can be up to 32 characters long and can consist only of ASCII Latin letters A-Z and a-z, underscores (_), and ASCII digits 0-9. It must start with a letter.



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'proto_docs/google/cloud/automl/v1/model.rb', line 81

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

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

  # Deployment state of the model.
  module DeploymentState
    # Should not be used, an un-set enum has this value by default.
    DEPLOYMENT_STATE_UNSPECIFIED = 0

    # Model is deployed.
    DEPLOYED = 1

    # Model is not deployed.
    UNDEPLOYED = 2
  end
end

#etag ⇒ ::String

Returns Used to perform a consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

Returns:

  • (::String) —

    Used to perform a consistent read-modify-write updates. If not set, a blind "overwrite" update happens.



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'proto_docs/google/cloud/automl/v1/model.rb', line 81

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

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

  # Deployment state of the model.
  module DeploymentState
    # Should not be used, an un-set enum has this value by default.
    DEPLOYMENT_STATE_UNSPECIFIED = 0

    # Model is deployed.
    DEPLOYED = 1

    # Model is not deployed.
    UNDEPLOYED = 2
  end
end

#image_classification_model_metadata ⇒ ::Google::Cloud::AutoML::V1::ImageClassificationModelMetadata

Returns Metadata for image classification models.

Returns:



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'proto_docs/google/cloud/automl/v1/model.rb', line 81

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

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

  # Deployment state of the model.
  module DeploymentState
    # Should not be used, an un-set enum has this value by default.
    DEPLOYMENT_STATE_UNSPECIFIED = 0

    # Model is deployed.
    DEPLOYED = 1

    # Model is not deployed.
    UNDEPLOYED = 2
  end
end

#image_object_detection_model_metadata ⇒ ::Google::Cloud::AutoML::V1::ImageObjectDetectionModelMetadata

Returns Metadata for image object detection models.

Returns:



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'proto_docs/google/cloud/automl/v1/model.rb', line 81

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

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

  # Deployment state of the model.
  module DeploymentState
    # Should not be used, an un-set enum has this value by default.
    DEPLOYMENT_STATE_UNSPECIFIED = 0

    # Model is deployed.
    DEPLOYED = 1

    # Model is not deployed.
    UNDEPLOYED = 2
  end
end

#labels ⇒ ::Google::Protobuf::Map{::String => ::String}

Returns Optional. The labels with user-defined metadata to organize your model.

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. Label values are optional. Label keys must start with a letter.

See https://goo.gl/xmQnxf for more information on and examples of labels.

Returns:

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

    Optional. The labels with user-defined metadata to organize your model.

    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. Label values are optional. Label keys must start with a letter.

    See https://goo.gl/xmQnxf for more information on and examples of labels.



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'proto_docs/google/cloud/automl/v1/model.rb', line 81

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

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

  # Deployment state of the model.
  module DeploymentState
    # Should not be used, an un-set enum has this value by default.
    DEPLOYMENT_STATE_UNSPECIFIED = 0

    # Model is deployed.
    DEPLOYED = 1

    # Model is not deployed.
    UNDEPLOYED = 2
  end
end

#name ⇒ ::String

Returns Output only. Resource name of the model. Format: projects/{project_id}/locations/{location_id}/models/{model_id}.

Returns:

  • (::String) —

    Output only. Resource name of the model. Format: projects/{project_id}/locations/{location_id}/models/{model_id}



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'proto_docs/google/cloud/automl/v1/model.rb', line 81

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

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

  # Deployment state of the model.
  module DeploymentState
    # Should not be used, an un-set enum has this value by default.
    DEPLOYMENT_STATE_UNSPECIFIED = 0

    # Model is deployed.
    DEPLOYED = 1

    # Model is not deployed.
    UNDEPLOYED = 2
  end
end

#text_classification_model_metadata ⇒ ::Google::Cloud::AutoML::V1::TextClassificationModelMetadata

Returns Metadata for text classification models.

Returns:



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'proto_docs/google/cloud/automl/v1/model.rb', line 81

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

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

  # Deployment state of the model.
  module DeploymentState
    # Should not be used, an un-set enum has this value by default.
    DEPLOYMENT_STATE_UNSPECIFIED = 0

    # Model is deployed.
    DEPLOYED = 1

    # Model is not deployed.
    UNDEPLOYED = 2
  end
end

#text_extraction_model_metadata ⇒ ::Google::Cloud::AutoML::V1::TextExtractionModelMetadata

Returns Metadata for text extraction models.

Returns:



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'proto_docs/google/cloud/automl/v1/model.rb', line 81

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

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

  # Deployment state of the model.
  module DeploymentState
    # Should not be used, an un-set enum has this value by default.
    DEPLOYMENT_STATE_UNSPECIFIED = 0

    # Model is deployed.
    DEPLOYED = 1

    # Model is not deployed.
    UNDEPLOYED = 2
  end
end

#text_sentiment_model_metadata ⇒ ::Google::Cloud::AutoML::V1::TextSentimentModelMetadata

Returns Metadata for text sentiment models.

Returns:



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'proto_docs/google/cloud/automl/v1/model.rb', line 81

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

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

  # Deployment state of the model.
  module DeploymentState
    # Should not be used, an un-set enum has this value by default.
    DEPLOYMENT_STATE_UNSPECIFIED = 0

    # Model is deployed.
    DEPLOYED = 1

    # Model is not deployed.
    UNDEPLOYED = 2
  end
end

#translation_model_metadata ⇒ ::Google::Cloud::AutoML::V1::TranslationModelMetadata

Returns Metadata for translation models.

Returns:



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'proto_docs/google/cloud/automl/v1/model.rb', line 81

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

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

  # Deployment state of the model.
  module DeploymentState
    # Should not be used, an un-set enum has this value by default.
    DEPLOYMENT_STATE_UNSPECIFIED = 0

    # Model is deployed.
    DEPLOYED = 1

    # Model is not deployed.
    UNDEPLOYED = 2
  end
end

#update_time ⇒ ::Google::Protobuf::Timestamp

Returns Output only. Timestamp when this model was last updated.

Returns:



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'proto_docs/google/cloud/automl/v1/model.rb', line 81

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

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

  # Deployment state of the model.
  module DeploymentState
    # Should not be used, an un-set enum has this value by default.
    DEPLOYMENT_STATE_UNSPECIFIED = 0

    # Model is deployed.
    DEPLOYED = 1

    # Model is not deployed.
    UNDEPLOYED = 2
  end
end