Class: Google::Cloud::AIPlatform::V1::PublisherModel

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

Overview

A Model Garden Publisher Model.

Defined Under Namespace

Modules: LaunchStage, OpenSourceCategory Classes: CallToAction, Documentation, ResourceReference

Instance Attribute Summary collapse

Instance Attribute Details

#frameworks ⇒ ::Array<::String>

Returns Optional. Additional information about the model's Frameworks.

Returns:

  • (::Array<::String>) —

    Optional. Additional information about the model's Frameworks.



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'proto_docs/google/cloud/aiplatform/v1/publisher_model.rb', line 56

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

  # Reference to a resource.
  # @!attribute [rw] uri
  #   @return [::String]
  #     The URI of the resource.
  # @!attribute [rw] resource_name
  #   @return [::String]
  #     The resource name of the Google Cloud resource.
  class ResourceReference
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A named piece of documentation.
  # @!attribute [rw] title
  #   @return [::String]
  #     Required. E.g., OVERVIEW, USE CASES, DOCUMENTATION, SDK & SAMPLES, JAVA,
  #     NODE.JS, etc..
  # @!attribute [rw] content
  #   @return [::String]
  #     Required. Content of this piece of document (in Markdown format).
  class Documentation
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Actions could take on this Publisher Model.
  # @!attribute [rw] view_rest_api
  #   @return [::Google::Cloud::AIPlatform::V1::PublisherModel::CallToAction::ViewRestApi]
  #     Optional. To view Rest API docs.
  # @!attribute [rw] open_notebook
  #   @return [::Google::Cloud::AIPlatform::V1::PublisherModel::CallToAction::RegionalResourceReferences]
  #     Optional. Open notebook of the PublisherModel.
  # @!attribute [rw] create_application
  #   @return [::Google::Cloud::AIPlatform::V1::PublisherModel::CallToAction::RegionalResourceReferences]
  #     Optional. Create application using the PublisherModel.
  # @!attribute [rw] open_fine_tuning_pipeline
  #   @return [::Google::Cloud::AIPlatform::V1::PublisherModel::CallToAction::RegionalResourceReferences]
  #     Optional. Open fine-tuning pipeline of the PublisherModel.
  # @!attribute [rw] open_prompt_tuning_pipeline
  #   @return [::Google::Cloud::AIPlatform::V1::PublisherModel::CallToAction::RegionalResourceReferences]
  #     Optional. Open prompt-tuning pipeline of the PublisherModel.
  # @!attribute [rw] open_genie
  #   @return [::Google::Cloud::AIPlatform::V1::PublisherModel::CallToAction::RegionalResourceReferences]
  #     Optional. Open Genie / Playground.
  # @!attribute [rw] deploy
  #   @return [::Google::Cloud::AIPlatform::V1::PublisherModel::CallToAction::Deploy]
  #     Optional. Deploy the PublisherModel to Vertex Endpoint.
  # @!attribute [rw] open_generation_ai_studio
  #   @return [::Google::Cloud::AIPlatform::V1::PublisherModel::CallToAction::RegionalResourceReferences]
  #     Optional. Open in Generation AI Studio.
  # @!attribute [rw] request_access
  #   @return [::Google::Cloud::AIPlatform::V1::PublisherModel::CallToAction::RegionalResourceReferences]
  #     Optional. Request for access.
  class CallToAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The regional resource name or the URI. Key is region, e.g.,
    # us-central1, europe-west2, global, etc..
    # @!attribute [rw] references
    #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::AIPlatform::V1::PublisherModel::ResourceReference}]
    #     Required.
    # @!attribute [rw] title
    #   @return [::String]
    #     Required. The title of the regional resource reference.
    class RegionalResourceReferences
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # @!attribute [rw] key
      #   @return [::String]
      # @!attribute [rw] value
      #   @return [::Google::Cloud::AIPlatform::V1::PublisherModel::ResourceReference]
      class ReferencesEntry
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end

    # Rest API docs.
    # @!attribute [rw] documentations
    #   @return [::Array<::Google::Cloud::AIPlatform::V1::PublisherModel::Documentation>]
    #     Required.
    # @!attribute [rw] title
    #   @return [::String]
    #     Required. The title of the view rest API.
    class ViewRestApi
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Model metadata that is needed for UploadModel or
    # DeployModel/CreateEndpoint requests.
    # @!attribute [rw] dedicated_resources
    #   @return [::Google::Cloud::AIPlatform::V1::DedicatedResources]
    #     A description of resources that are dedicated to the DeployedModel,
    #     and that need a higher degree of manual configuration.
    # @!attribute [rw] automatic_resources
    #   @return [::Google::Cloud::AIPlatform::V1::AutomaticResources]
    #     A description of resources that to large degree are decided by Vertex
    #     AI, and require only a modest additional configuration.
    # @!attribute [rw] shared_resources
    #   @return [::String]
    #     The resource name of the shared DeploymentResourcePool to deploy on.
    #     Format:
    #     `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`
    # @!attribute [rw] model_display_name
    #   @return [::String]
    #     Optional. Default model display name.
    # @!attribute [rw] large_model_reference
    #   @return [::Google::Cloud::AIPlatform::V1::LargeModelReference]
    #     Optional. Large model reference. When this is set, model_artifact_spec
    #     is not needed.
    # @!attribute [rw] container_spec
    #   @return [::Google::Cloud::AIPlatform::V1::ModelContainerSpec]
    #     Optional. The specification of the container that is to be used when
    #     deploying this Model in Vertex AI. Not present for Large Models.
    # @!attribute [rw] artifact_uri
    #   @return [::String]
    #     Optional. The path to the directory containing the Model artifact and
    #     any of its supporting files.
    # @!attribute [rw] title
    #   @return [::String]
    #     Required. The title of the regional resource reference.
    class Deploy
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # An enum representing the open source category of a PublisherModel.
  module OpenSourceCategory
    # The open source category is unspecified, which should not be used.
    OPEN_SOURCE_CATEGORY_UNSPECIFIED = 0

    # Used to indicate the PublisherModel is not open sourced.
    PROPRIETARY = 1

    # Used to indicate the PublisherModel is a Google-owned open source model
    # w/ Google checkpoint.
    GOOGLE_OWNED_OSS_WITH_GOOGLE_CHECKPOINT = 2

    # Used to indicate the PublisherModel is a 3p-owned open source model w/
    # Google checkpoint.
    THIRD_PARTY_OWNED_OSS_WITH_GOOGLE_CHECKPOINT = 3

    # Used to indicate the PublisherModel is a Google-owned pure open source
    # model.
    GOOGLE_OWNED_OSS = 4

    # Used to indicate the PublisherModel is a 3p-owned pure open source model.
    THIRD_PARTY_OWNED_OSS = 5
  end

  # An enum representing the launch stage of a PublisherModel.
  module LaunchStage
    # The model launch stage is unspecified.
    LAUNCH_STAGE_UNSPECIFIED = 0

    # Used to indicate the PublisherModel is at Experimental launch stage.
    EXPERIMENTAL = 1

    # Used to indicate the PublisherModel is at Private Preview launch stage.
    PRIVATE_PREVIEW = 2

    # Used to indicate the PublisherModel is at Public Preview launch stage.
    PUBLIC_PREVIEW = 3

    # Used to indicate the PublisherModel is at GA launch stage.
    GA = 4
  end
end

#launch_stage ⇒ ::Google::Cloud::AIPlatform::V1::PublisherModel::LaunchStage

Returns Optional. Indicates the launch stage of the model.

Returns:



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'proto_docs/google/cloud/aiplatform/v1/publisher_model.rb', line 56

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

  # Reference to a resource.
  # @!attribute [rw] uri
  #   @return [::String]
  #     The URI of the resource.
  # @!attribute [rw] resource_name
  #   @return [::String]
  #     The resource name of the Google Cloud resource.
  class ResourceReference
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A named piece of documentation.
  # @!attribute [rw] title
  #   @return [::String]
  #     Required. E.g., OVERVIEW, USE CASES, DOCUMENTATION, SDK & SAMPLES, JAVA,
  #     NODE.JS, etc..
  # @!attribute [rw] content
  #   @return [::String]
  #     Required. Content of this piece of document (in Markdown format).
  class Documentation
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Actions could take on this Publisher Model.
  # @!attribute [rw] view_rest_api
  #   @return [::Google::Cloud::AIPlatform::V1::PublisherModel::CallToAction::ViewRestApi]
  #     Optional. To view Rest API docs.
  # @!attribute [rw] open_notebook
  #   @return [::Google::Cloud::AIPlatform::V1::PublisherModel::CallToAction::RegionalResourceReferences]
  #     Optional. Open notebook of the PublisherModel.
  # @!attribute [rw] create_application
  #   @return [::Google::Cloud::AIPlatform::V1::PublisherModel::CallToAction::RegionalResourceReferences]
  #     Optional. Create application using the PublisherModel.
  # @!attribute [rw] open_fine_tuning_pipeline
  #   @return [::Google::Cloud::AIPlatform::V1::PublisherModel::CallToAction::RegionalResourceReferences]
  #     Optional. Open fine-tuning pipeline of the PublisherModel.
  # @!attribute [rw] open_prompt_tuning_pipeline
  #   @return [::Google::Cloud::AIPlatform::V1::PublisherModel::CallToAction::RegionalResourceReferences]
  #     Optional. Open prompt-tuning pipeline of the PublisherModel.
  # @!attribute [rw] open_genie
  #   @return [::Google::Cloud::AIPlatform::V1::PublisherModel::CallToAction::RegionalResourceReferences]
  #     Optional. Open Genie / Playground.
  # @!attribute [rw] deploy
  #   @return [::Google::Cloud::AIPlatform::V1::PublisherModel::CallToAction::Deploy]
  #     Optional. Deploy the PublisherModel to Vertex Endpoint.
  # @!attribute [rw] open_generation_ai_studio
  #   @return [::Google::Cloud::AIPlatform::V1::PublisherModel::CallToAction::RegionalResourceReferences]
  #     Optional. Open in Generation AI Studio.
  # @!attribute [rw] request_access
  #   @return [::Google::Cloud::AIPlatform::V1::PublisherModel::CallToAction::RegionalResourceReferences]
  #     Optional. Request for access.
  class CallToAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The regional resource name or the URI. Key is region, e.g.,
    # us-central1, europe-west2, global, etc..
    # @!attribute [rw] references
    #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::AIPlatform::V1::PublisherModel::ResourceReference}]
    #     Required.
    # @!attribute [rw] title
    #   @return [::String]
    #     Required. The title of the regional resource reference.
    class RegionalResourceReferences
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # @!attribute [rw] key
      #   @return [::String]
      # @!attribute [rw] value
      #   @return [::Google::Cloud::AIPlatform::V1::PublisherModel::ResourceReference]
      class ReferencesEntry
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end

    # Rest API docs.
    # @!attribute [rw] documentations
    #   @return [::Array<::Google::Cloud::AIPlatform::V1::PublisherModel::Documentation>]
    #     Required.
    # @!attribute [rw] title
    #   @return [::String]
    #     Required. The title of the view rest API.
    class ViewRestApi
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Model metadata that is needed for UploadModel or
    # DeployModel/CreateEndpoint requests.
    # @!attribute [rw] dedicated_resources
    #   @return [::Google::Cloud::AIPlatform::V1::DedicatedResources]
    #     A description of resources that are dedicated to the DeployedModel,
    #     and that need a higher degree of manual configuration.
    # @!attribute [rw] automatic_resources
    #   @return [::Google::Cloud::AIPlatform::V1::AutomaticResources]
    #     A description of resources that to large degree are decided by Vertex
    #     AI, and require only a modest additional configuration.
    # @!attribute [rw] shared_resources
    #   @return [::String]
    #     The resource name of the shared DeploymentResourcePool to deploy on.
    #     Format:
    #     `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`
    # @!attribute [rw] model_display_name
    #   @return [::String]
    #     Optional. Default model display name.
    # @!attribute [rw] large_model_reference
    #   @return [::Google::Cloud::AIPlatform::V1::LargeModelReference]
    #     Optional. Large model reference. When this is set, model_artifact_spec
    #     is not needed.
    # @!attribute [rw] container_spec
    #   @return [::Google::Cloud::AIPlatform::V1::ModelContainerSpec]
    #     Optional. The specification of the container that is to be used when
    #     deploying this Model in Vertex AI. Not present for Large Models.
    # @!attribute [rw] artifact_uri
    #   @return [::String]
    #     Optional. The path to the directory containing the Model artifact and
    #     any of its supporting files.
    # @!attribute [rw] title
    #   @return [::String]
    #     Required. The title of the regional resource reference.
    class Deploy
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # An enum representing the open source category of a PublisherModel.
  module OpenSourceCategory
    # The open source category is unspecified, which should not be used.
    OPEN_SOURCE_CATEGORY_UNSPECIFIED = 0

    # Used to indicate the PublisherModel is not open sourced.
    PROPRIETARY = 1

    # Used to indicate the PublisherModel is a Google-owned open source model
    # w/ Google checkpoint.
    GOOGLE_OWNED_OSS_WITH_GOOGLE_CHECKPOINT = 2

    # Used to indicate the PublisherModel is a 3p-owned open source model w/
    # Google checkpoint.
    THIRD_PARTY_OWNED_OSS_WITH_GOOGLE_CHECKPOINT = 3

    # Used to indicate the PublisherModel is a Google-owned pure open source
    # model.
    GOOGLE_OWNED_OSS = 4

    # Used to indicate the PublisherModel is a 3p-owned pure open source model.
    THIRD_PARTY_OWNED_OSS = 5
  end

  # An enum representing the launch stage of a PublisherModel.
  module LaunchStage
    # The model launch stage is unspecified.
    LAUNCH_STAGE_UNSPECIFIED = 0

    # Used to indicate the PublisherModel is at Experimental launch stage.
    EXPERIMENTAL = 1

    # Used to indicate the PublisherModel is at Private Preview launch stage.
    PRIVATE_PREVIEW = 2

    # Used to indicate the PublisherModel is at Public Preview launch stage.
    PUBLIC_PREVIEW = 3

    # Used to indicate the PublisherModel is at GA launch stage.
    GA = 4
  end
end

#name ⇒ ::String (readonly)

Returns Output only. The resource name of the PublisherModel.

Returns:

  • (::String) —

    Output only. The resource name of the PublisherModel.



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'proto_docs/google/cloud/aiplatform/v1/publisher_model.rb', line 56

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

  # Reference to a resource.
  # @!attribute [rw] uri
  #   @return [::String]
  #     The URI of the resource.
  # @!attribute [rw] resource_name
  #   @return [::String]
  #     The resource name of the Google Cloud resource.
  class ResourceReference
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A named piece of documentation.
  # @!attribute [rw] title
  #   @return [::String]
  #     Required. E.g., OVERVIEW, USE CASES, DOCUMENTATION, SDK & SAMPLES, JAVA,
  #     NODE.JS, etc..
  # @!attribute [rw] content
  #   @return [::String]
  #     Required. Content of this piece of document (in Markdown format).
  class Documentation
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Actions could take on this Publisher Model.
  # @!attribute [rw] view_rest_api
  #   @return [::Google::Cloud::AIPlatform::V1::PublisherModel::CallToAction::ViewRestApi]
  #     Optional. To view Rest API docs.
  # @!attribute [rw] open_notebook
  #   @return [::Google::Cloud::AIPlatform::V1::PublisherModel::CallToAction::RegionalResourceReferences]
  #     Optional. Open notebook of the PublisherModel.
  # @!attribute [rw] create_application
  #   @return [::Google::Cloud::AIPlatform::V1::PublisherModel::CallToAction::RegionalResourceReferences]
  #     Optional. Create application using the PublisherModel.
  # @!attribute [rw] open_fine_tuning_pipeline
  #   @return [::Google::Cloud::AIPlatform::V1::PublisherModel::CallToAction::RegionalResourceReferences]
  #     Optional. Open fine-tuning pipeline of the PublisherModel.
  # @!attribute [rw] open_prompt_tuning_pipeline
  #   @return [::Google::Cloud::AIPlatform::V1::PublisherModel::CallToAction::RegionalResourceReferences]
  #     Optional. Open prompt-tuning pipeline of the PublisherModel.
  # @!attribute [rw] open_genie
  #   @return [::Google::Cloud::AIPlatform::V1::PublisherModel::CallToAction::RegionalResourceReferences]
  #     Optional. Open Genie / Playground.
  # @!attribute [rw] deploy
  #   @return [::Google::Cloud::AIPlatform::V1::PublisherModel::CallToAction::Deploy]
  #     Optional. Deploy the PublisherModel to Vertex Endpoint.
  # @!attribute [rw] open_generation_ai_studio
  #   @return [::Google::Cloud::AIPlatform::V1::PublisherModel::CallToAction::RegionalResourceReferences]
  #     Optional. Open in Generation AI Studio.
  # @!attribute [rw] request_access
  #   @return [::Google::Cloud::AIPlatform::V1::PublisherModel::CallToAction::RegionalResourceReferences]
  #     Optional. Request for access.
  class CallToAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The regional resource name or the URI. Key is region, e.g.,
    # us-central1, europe-west2, global, etc..
    # @!attribute [rw] references
    #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::AIPlatform::V1::PublisherModel::ResourceReference}]
    #     Required.
    # @!attribute [rw] title
    #   @return [::String]
    #     Required. The title of the regional resource reference.
    class RegionalResourceReferences
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # @!attribute [rw] key
      #   @return [::String]
      # @!attribute [rw] value
      #   @return [::Google::Cloud::AIPlatform::V1::PublisherModel::ResourceReference]
      class ReferencesEntry
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end

    # Rest API docs.
    # @!attribute [rw] documentations
    #   @return [::Array<::Google::Cloud::AIPlatform::V1::PublisherModel::Documentation>]
    #     Required.
    # @!attribute [rw] title
    #   @return [::String]
    #     Required. The title of the view rest API.
    class ViewRestApi
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Model metadata that is needed for UploadModel or
    # DeployModel/CreateEndpoint requests.
    # @!attribute [rw] dedicated_resources
    #   @return [::Google::Cloud::AIPlatform::V1::DedicatedResources]
    #     A description of resources that are dedicated to the DeployedModel,
    #     and that need a higher degree of manual configuration.
    # @!attribute [rw] automatic_resources
    #   @return [::Google::Cloud::AIPlatform::V1::AutomaticResources]
    #     A description of resources that to large degree are decided by Vertex
    #     AI, and require only a modest additional configuration.
    # @!attribute [rw] shared_resources
    #   @return [::String]
    #     The resource name of the shared DeploymentResourcePool to deploy on.
    #     Format:
    #     `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`
    # @!attribute [rw] model_display_name
    #   @return [::String]
    #     Optional. Default model display name.
    # @!attribute [rw] large_model_reference
    #   @return [::Google::Cloud::AIPlatform::V1::LargeModelReference]
    #     Optional. Large model reference. When this is set, model_artifact_spec
    #     is not needed.
    # @!attribute [rw] container_spec
    #   @return [::Google::Cloud::AIPlatform::V1::ModelContainerSpec]
    #     Optional. The specification of the container that is to be used when
    #     deploying this Model in Vertex AI. Not present for Large Models.
    # @!attribute [rw] artifact_uri
    #   @return [::String]
    #     Optional. The path to the directory containing the Model artifact and
    #     any of its supporting files.
    # @!attribute [rw] title
    #   @return [::String]
    #     Required. The title of the regional resource reference.
    class Deploy
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # An enum representing the open source category of a PublisherModel.
  module OpenSourceCategory
    # The open source category is unspecified, which should not be used.
    OPEN_SOURCE_CATEGORY_UNSPECIFIED = 0

    # Used to indicate the PublisherModel is not open sourced.
    PROPRIETARY = 1

    # Used to indicate the PublisherModel is a Google-owned open source model
    # w/ Google checkpoint.
    GOOGLE_OWNED_OSS_WITH_GOOGLE_CHECKPOINT = 2

    # Used to indicate the PublisherModel is a 3p-owned open source model w/
    # Google checkpoint.
    THIRD_PARTY_OWNED_OSS_WITH_GOOGLE_CHECKPOINT = 3

    # Used to indicate the PublisherModel is a Google-owned pure open source
    # model.
    GOOGLE_OWNED_OSS = 4

    # Used to indicate the PublisherModel is a 3p-owned pure open source model.
    THIRD_PARTY_OWNED_OSS = 5
  end

  # An enum representing the launch stage of a PublisherModel.
  module LaunchStage
    # The model launch stage is unspecified.
    LAUNCH_STAGE_UNSPECIFIED = 0

    # Used to indicate the PublisherModel is at Experimental launch stage.
    EXPERIMENTAL = 1

    # Used to indicate the PublisherModel is at Private Preview launch stage.
    PRIVATE_PREVIEW = 2

    # Used to indicate the PublisherModel is at Public Preview launch stage.
    PUBLIC_PREVIEW = 3

    # Used to indicate the PublisherModel is at GA launch stage.
    GA = 4
  end
end

#open_source_category ⇒ ::Google::Cloud::AIPlatform::V1::PublisherModel::OpenSourceCategory

Returns Required. Indicates the open source category of the publisher model.

Returns:



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'proto_docs/google/cloud/aiplatform/v1/publisher_model.rb', line 56

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

  # Reference to a resource.
  # @!attribute [rw] uri
  #   @return [::String]
  #     The URI of the resource.
  # @!attribute [rw] resource_name
  #   @return [::String]
  #     The resource name of the Google Cloud resource.
  class ResourceReference
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A named piece of documentation.
  # @!attribute [rw] title
  #   @return [::String]
  #     Required. E.g., OVERVIEW, USE CASES, DOCUMENTATION, SDK & SAMPLES, JAVA,
  #     NODE.JS, etc..
  # @!attribute [rw] content
  #   @return [::String]
  #     Required. Content of this piece of document (in Markdown format).
  class Documentation
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Actions could take on this Publisher Model.
  # @!attribute [rw] view_rest_api
  #   @return [::Google::Cloud::AIPlatform::V1::PublisherModel::CallToAction::ViewRestApi]
  #     Optional. To view Rest API docs.
  # @!attribute [rw] open_notebook
  #   @return [::Google::Cloud::AIPlatform::V1::PublisherModel::CallToAction::RegionalResourceReferences]
  #     Optional. Open notebook of the PublisherModel.
  # @!attribute [rw] create_application
  #   @return [::Google::Cloud::AIPlatform::V1::PublisherModel::CallToAction::RegionalResourceReferences]
  #     Optional. Create application using the PublisherModel.
  # @!attribute [rw] open_fine_tuning_pipeline
  #   @return [::Google::Cloud::AIPlatform::V1::PublisherModel::CallToAction::RegionalResourceReferences]
  #     Optional. Open fine-tuning pipeline of the PublisherModel.
  # @!attribute [rw] open_prompt_tuning_pipeline
  #   @return [::Google::Cloud::AIPlatform::V1::PublisherModel::CallToAction::RegionalResourceReferences]
  #     Optional. Open prompt-tuning pipeline of the PublisherModel.
  # @!attribute [rw] open_genie
  #   @return [::Google::Cloud::AIPlatform::V1::PublisherModel::CallToAction::RegionalResourceReferences]
  #     Optional. Open Genie / Playground.
  # @!attribute [rw] deploy
  #   @return [::Google::Cloud::AIPlatform::V1::PublisherModel::CallToAction::Deploy]
  #     Optional. Deploy the PublisherModel to Vertex Endpoint.
  # @!attribute [rw] open_generation_ai_studio
  #   @return [::Google::Cloud::AIPlatform::V1::PublisherModel::CallToAction::RegionalResourceReferences]
  #     Optional. Open in Generation AI Studio.
  # @!attribute [rw] request_access
  #   @return [::Google::Cloud::AIPlatform::V1::PublisherModel::CallToAction::RegionalResourceReferences]
  #     Optional. Request for access.
  class CallToAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The regional resource name or the URI. Key is region, e.g.,
    # us-central1, europe-west2, global, etc..
    # @!attribute [rw] references
    #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::AIPlatform::V1::PublisherModel::ResourceReference}]
    #     Required.
    # @!attribute [rw] title
    #   @return [::String]
    #     Required. The title of the regional resource reference.
    class RegionalResourceReferences
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # @!attribute [rw] key
      #   @return [::String]
      # @!attribute [rw] value
      #   @return [::Google::Cloud::AIPlatform::V1::PublisherModel::ResourceReference]
      class ReferencesEntry
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end

    # Rest API docs.
    # @!attribute [rw] documentations
    #   @return [::Array<::Google::Cloud::AIPlatform::V1::PublisherModel::Documentation>]
    #     Required.
    # @!attribute [rw] title
    #   @return [::String]
    #     Required. The title of the view rest API.
    class ViewRestApi
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Model metadata that is needed for UploadModel or
    # DeployModel/CreateEndpoint requests.
    # @!attribute [rw] dedicated_resources
    #   @return [::Google::Cloud::AIPlatform::V1::DedicatedResources]
    #     A description of resources that are dedicated to the DeployedModel,
    #     and that need a higher degree of manual configuration.
    # @!attribute [rw] automatic_resources
    #   @return [::Google::Cloud::AIPlatform::V1::AutomaticResources]
    #     A description of resources that to large degree are decided by Vertex
    #     AI, and require only a modest additional configuration.
    # @!attribute [rw] shared_resources
    #   @return [::String]
    #     The resource name of the shared DeploymentResourcePool to deploy on.
    #     Format:
    #     `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`
    # @!attribute [rw] model_display_name
    #   @return [::String]
    #     Optional. Default model display name.
    # @!attribute [rw] large_model_reference
    #   @return [::Google::Cloud::AIPlatform::V1::LargeModelReference]
    #     Optional. Large model reference. When this is set, model_artifact_spec
    #     is not needed.
    # @!attribute [rw] container_spec
    #   @return [::Google::Cloud::AIPlatform::V1::ModelContainerSpec]
    #     Optional. The specification of the container that is to be used when
    #     deploying this Model in Vertex AI. Not present for Large Models.
    # @!attribute [rw] artifact_uri
    #   @return [::String]
    #     Optional. The path to the directory containing the Model artifact and
    #     any of its supporting files.
    # @!attribute [rw] title
    #   @return [::String]
    #     Required. The title of the regional resource reference.
    class Deploy
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # An enum representing the open source category of a PublisherModel.
  module OpenSourceCategory
    # The open source category is unspecified, which should not be used.
    OPEN_SOURCE_CATEGORY_UNSPECIFIED = 0

    # Used to indicate the PublisherModel is not open sourced.
    PROPRIETARY = 1

    # Used to indicate the PublisherModel is a Google-owned open source model
    # w/ Google checkpoint.
    GOOGLE_OWNED_OSS_WITH_GOOGLE_CHECKPOINT = 2

    # Used to indicate the PublisherModel is a 3p-owned open source model w/
    # Google checkpoint.
    THIRD_PARTY_OWNED_OSS_WITH_GOOGLE_CHECKPOINT = 3

    # Used to indicate the PublisherModel is a Google-owned pure open source
    # model.
    GOOGLE_OWNED_OSS = 4

    # Used to indicate the PublisherModel is a 3p-owned pure open source model.
    THIRD_PARTY_OWNED_OSS = 5
  end

  # An enum representing the launch stage of a PublisherModel.
  module LaunchStage
    # The model launch stage is unspecified.
    LAUNCH_STAGE_UNSPECIFIED = 0

    # Used to indicate the PublisherModel is at Experimental launch stage.
    EXPERIMENTAL = 1

    # Used to indicate the PublisherModel is at Private Preview launch stage.
    PRIVATE_PREVIEW = 2

    # Used to indicate the PublisherModel is at Public Preview launch stage.
    PUBLIC_PREVIEW = 3

    # Used to indicate the PublisherModel is at GA launch stage.
    GA = 4
  end
end

#predict_schemata ⇒ ::Google::Cloud::AIPlatform::V1::PredictSchemata

Returns Optional. The schemata that describes formats of the PublisherModel's predictions and explanations as given and returned via PredictionService.Predict.

Returns:



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'proto_docs/google/cloud/aiplatform/v1/publisher_model.rb', line 56

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

  # Reference to a resource.
  # @!attribute [rw] uri
  #   @return [::String]
  #     The URI of the resource.
  # @!attribute [rw] resource_name
  #   @return [::String]
  #     The resource name of the Google Cloud resource.
  class ResourceReference
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A named piece of documentation.
  # @!attribute [rw] title
  #   @return [::String]
  #     Required. E.g., OVERVIEW, USE CASES, DOCUMENTATION, SDK & SAMPLES, JAVA,
  #     NODE.JS, etc..
  # @!attribute [rw] content
  #   @return [::String]
  #     Required. Content of this piece of document (in Markdown format).
  class Documentation
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Actions could take on this Publisher Model.
  # @!attribute [rw] view_rest_api
  #   @return [::Google::Cloud::AIPlatform::V1::PublisherModel::CallToAction::ViewRestApi]
  #     Optional. To view Rest API docs.
  # @!attribute [rw] open_notebook
  #   @return [::Google::Cloud::AIPlatform::V1::PublisherModel::CallToAction::RegionalResourceReferences]
  #     Optional. Open notebook of the PublisherModel.
  # @!attribute [rw] create_application
  #   @return [::Google::Cloud::AIPlatform::V1::PublisherModel::CallToAction::RegionalResourceReferences]
  #     Optional. Create application using the PublisherModel.
  # @!attribute [rw] open_fine_tuning_pipeline
  #   @return [::Google::Cloud::AIPlatform::V1::PublisherModel::CallToAction::RegionalResourceReferences]
  #     Optional. Open fine-tuning pipeline of the PublisherModel.
  # @!attribute [rw] open_prompt_tuning_pipeline
  #   @return [::Google::Cloud::AIPlatform::V1::PublisherModel::CallToAction::RegionalResourceReferences]
  #     Optional. Open prompt-tuning pipeline of the PublisherModel.
  # @!attribute [rw] open_genie
  #   @return [::Google::Cloud::AIPlatform::V1::PublisherModel::CallToAction::RegionalResourceReferences]
  #     Optional. Open Genie / Playground.
  # @!attribute [rw] deploy
  #   @return [::Google::Cloud::AIPlatform::V1::PublisherModel::CallToAction::Deploy]
  #     Optional. Deploy the PublisherModel to Vertex Endpoint.
  # @!attribute [rw] open_generation_ai_studio
  #   @return [::Google::Cloud::AIPlatform::V1::PublisherModel::CallToAction::RegionalResourceReferences]
  #     Optional. Open in Generation AI Studio.
  # @!attribute [rw] request_access
  #   @return [::Google::Cloud::AIPlatform::V1::PublisherModel::CallToAction::RegionalResourceReferences]
  #     Optional. Request for access.
  class CallToAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The regional resource name or the URI. Key is region, e.g.,
    # us-central1, europe-west2, global, etc..
    # @!attribute [rw] references
    #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::AIPlatform::V1::PublisherModel::ResourceReference}]
    #     Required.
    # @!attribute [rw] title
    #   @return [::String]
    #     Required. The title of the regional resource reference.
    class RegionalResourceReferences
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # @!attribute [rw] key
      #   @return [::String]
      # @!attribute [rw] value
      #   @return [::Google::Cloud::AIPlatform::V1::PublisherModel::ResourceReference]
      class ReferencesEntry
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end

    # Rest API docs.
    # @!attribute [rw] documentations
    #   @return [::Array<::Google::Cloud::AIPlatform::V1::PublisherModel::Documentation>]
    #     Required.
    # @!attribute [rw] title
    #   @return [::String]
    #     Required. The title of the view rest API.
    class ViewRestApi
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Model metadata that is needed for UploadModel or
    # DeployModel/CreateEndpoint requests.
    # @!attribute [rw] dedicated_resources
    #   @return [::Google::Cloud::AIPlatform::V1::DedicatedResources]
    #     A description of resources that are dedicated to the DeployedModel,
    #     and that need a higher degree of manual configuration.
    # @!attribute [rw] automatic_resources
    #   @return [::Google::Cloud::AIPlatform::V1::AutomaticResources]
    #     A description of resources that to large degree are decided by Vertex
    #     AI, and require only a modest additional configuration.
    # @!attribute [rw] shared_resources
    #   @return [::String]
    #     The resource name of the shared DeploymentResourcePool to deploy on.
    #     Format:
    #     `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`
    # @!attribute [rw] model_display_name
    #   @return [::String]
    #     Optional. Default model display name.
    # @!attribute [rw] large_model_reference
    #   @return [::Google::Cloud::AIPlatform::V1::LargeModelReference]
    #     Optional. Large model reference. When this is set, model_artifact_spec
    #     is not needed.
    # @!attribute [rw] container_spec
    #   @return [::Google::Cloud::AIPlatform::V1::ModelContainerSpec]
    #     Optional. The specification of the container that is to be used when
    #     deploying this Model in Vertex AI. Not present for Large Models.
    # @!attribute [rw] artifact_uri
    #   @return [::String]
    #     Optional. The path to the directory containing the Model artifact and
    #     any of its supporting files.
    # @!attribute [rw] title
    #   @return [::String]
    #     Required. The title of the regional resource reference.
    class Deploy
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # An enum representing the open source category of a PublisherModel.
  module OpenSourceCategory
    # The open source category is unspecified, which should not be used.
    OPEN_SOURCE_CATEGORY_UNSPECIFIED = 0

    # Used to indicate the PublisherModel is not open sourced.
    PROPRIETARY = 1

    # Used to indicate the PublisherModel is a Google-owned open source model
    # w/ Google checkpoint.
    GOOGLE_OWNED_OSS_WITH_GOOGLE_CHECKPOINT = 2

    # Used to indicate the PublisherModel is a 3p-owned open source model w/
    # Google checkpoint.
    THIRD_PARTY_OWNED_OSS_WITH_GOOGLE_CHECKPOINT = 3

    # Used to indicate the PublisherModel is a Google-owned pure open source
    # model.
    GOOGLE_OWNED_OSS = 4

    # Used to indicate the PublisherModel is a 3p-owned pure open source model.
    THIRD_PARTY_OWNED_OSS = 5
  end

  # An enum representing the launch stage of a PublisherModel.
  module LaunchStage
    # The model launch stage is unspecified.
    LAUNCH_STAGE_UNSPECIFIED = 0

    # Used to indicate the PublisherModel is at Experimental launch stage.
    EXPERIMENTAL = 1

    # Used to indicate the PublisherModel is at Private Preview launch stage.
    PRIVATE_PREVIEW = 2

    # Used to indicate the PublisherModel is at Public Preview launch stage.
    PUBLIC_PREVIEW = 3

    # Used to indicate the PublisherModel is at GA launch stage.
    GA = 4
  end
end

#publisher_model_template ⇒ ::String (readonly)

Returns Optional. Output only. Immutable. Used to indicate this model has a publisher model and provide the template of the publisher model resource name.

Returns:

  • (::String) —

    Optional. Output only. Immutable. Used to indicate this model has a publisher model and provide the template of the publisher model resource name.



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'proto_docs/google/cloud/aiplatform/v1/publisher_model.rb', line 56

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

  # Reference to a resource.
  # @!attribute [rw] uri
  #   @return [::String]
  #     The URI of the resource.
  # @!attribute [rw] resource_name
  #   @return [::String]
  #     The resource name of the Google Cloud resource.
  class ResourceReference
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A named piece of documentation.
  # @!attribute [rw] title
  #   @return [::String]
  #     Required. E.g., OVERVIEW, USE CASES, DOCUMENTATION, SDK & SAMPLES, JAVA,
  #     NODE.JS, etc..
  # @!attribute [rw] content
  #   @return [::String]
  #     Required. Content of this piece of document (in Markdown format).
  class Documentation
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Actions could take on this Publisher Model.
  # @!attribute [rw] view_rest_api
  #   @return [::Google::Cloud::AIPlatform::V1::PublisherModel::CallToAction::ViewRestApi]
  #     Optional. To view Rest API docs.
  # @!attribute [rw] open_notebook
  #   @return [::Google::Cloud::AIPlatform::V1::PublisherModel::CallToAction::RegionalResourceReferences]
  #     Optional. Open notebook of the PublisherModel.
  # @!attribute [rw] create_application
  #   @return [::Google::Cloud::AIPlatform::V1::PublisherModel::CallToAction::RegionalResourceReferences]
  #     Optional. Create application using the PublisherModel.
  # @!attribute [rw] open_fine_tuning_pipeline
  #   @return [::Google::Cloud::AIPlatform::V1::PublisherModel::CallToAction::RegionalResourceReferences]
  #     Optional. Open fine-tuning pipeline of the PublisherModel.
  # @!attribute [rw] open_prompt_tuning_pipeline
  #   @return [::Google::Cloud::AIPlatform::V1::PublisherModel::CallToAction::RegionalResourceReferences]
  #     Optional. Open prompt-tuning pipeline of the PublisherModel.
  # @!attribute [rw] open_genie
  #   @return [::Google::Cloud::AIPlatform::V1::PublisherModel::CallToAction::RegionalResourceReferences]
  #     Optional. Open Genie / Playground.
  # @!attribute [rw] deploy
  #   @return [::Google::Cloud::AIPlatform::V1::PublisherModel::CallToAction::Deploy]
  #     Optional. Deploy the PublisherModel to Vertex Endpoint.
  # @!attribute [rw] open_generation_ai_studio
  #   @return [::Google::Cloud::AIPlatform::V1::PublisherModel::CallToAction::RegionalResourceReferences]
  #     Optional. Open in Generation AI Studio.
  # @!attribute [rw] request_access
  #   @return [::Google::Cloud::AIPlatform::V1::PublisherModel::CallToAction::RegionalResourceReferences]
  #     Optional. Request for access.
  class CallToAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The regional resource name or the URI. Key is region, e.g.,
    # us-central1, europe-west2, global, etc..
    # @!attribute [rw] references
    #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::AIPlatform::V1::PublisherModel::ResourceReference}]
    #     Required.
    # @!attribute [rw] title
    #   @return [::String]
    #     Required. The title of the regional resource reference.
    class RegionalResourceReferences
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # @!attribute [rw] key
      #   @return [::String]
      # @!attribute [rw] value
      #   @return [::Google::Cloud::AIPlatform::V1::PublisherModel::ResourceReference]
      class ReferencesEntry
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end

    # Rest API docs.
    # @!attribute [rw] documentations
    #   @return [::Array<::Google::Cloud::AIPlatform::V1::PublisherModel::Documentation>]
    #     Required.
    # @!attribute [rw] title
    #   @return [::String]
    #     Required. The title of the view rest API.
    class ViewRestApi
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Model metadata that is needed for UploadModel or
    # DeployModel/CreateEndpoint requests.
    # @!attribute [rw] dedicated_resources
    #   @return [::Google::Cloud::AIPlatform::V1::DedicatedResources]
    #     A description of resources that are dedicated to the DeployedModel,
    #     and that need a higher degree of manual configuration.
    # @!attribute [rw] automatic_resources
    #   @return [::Google::Cloud::AIPlatform::V1::AutomaticResources]
    #     A description of resources that to large degree are decided by Vertex
    #     AI, and require only a modest additional configuration.
    # @!attribute [rw] shared_resources
    #   @return [::String]
    #     The resource name of the shared DeploymentResourcePool to deploy on.
    #     Format:
    #     `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`
    # @!attribute [rw] model_display_name
    #   @return [::String]
    #     Optional. Default model display name.
    # @!attribute [rw] large_model_reference
    #   @return [::Google::Cloud::AIPlatform::V1::LargeModelReference]
    #     Optional. Large model reference. When this is set, model_artifact_spec
    #     is not needed.
    # @!attribute [rw] container_spec
    #   @return [::Google::Cloud::AIPlatform::V1::ModelContainerSpec]
    #     Optional. The specification of the container that is to be used when
    #     deploying this Model in Vertex AI. Not present for Large Models.
    # @!attribute [rw] artifact_uri
    #   @return [::String]
    #     Optional. The path to the directory containing the Model artifact and
    #     any of its supporting files.
    # @!attribute [rw] title
    #   @return [::String]
    #     Required. The title of the regional resource reference.
    class Deploy
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # An enum representing the open source category of a PublisherModel.
  module OpenSourceCategory
    # The open source category is unspecified, which should not be used.
    OPEN_SOURCE_CATEGORY_UNSPECIFIED = 0

    # Used to indicate the PublisherModel is not open sourced.
    PROPRIETARY = 1

    # Used to indicate the PublisherModel is a Google-owned open source model
    # w/ Google checkpoint.
    GOOGLE_OWNED_OSS_WITH_GOOGLE_CHECKPOINT = 2

    # Used to indicate the PublisherModel is a 3p-owned open source model w/
    # Google checkpoint.
    THIRD_PARTY_OWNED_OSS_WITH_GOOGLE_CHECKPOINT = 3

    # Used to indicate the PublisherModel is a Google-owned pure open source
    # model.
    GOOGLE_OWNED_OSS = 4

    # Used to indicate the PublisherModel is a 3p-owned pure open source model.
    THIRD_PARTY_OWNED_OSS = 5
  end

  # An enum representing the launch stage of a PublisherModel.
  module LaunchStage
    # The model launch stage is unspecified.
    LAUNCH_STAGE_UNSPECIFIED = 0

    # Used to indicate the PublisherModel is at Experimental launch stage.
    EXPERIMENTAL = 1

    # Used to indicate the PublisherModel is at Private Preview launch stage.
    PRIVATE_PREVIEW = 2

    # Used to indicate the PublisherModel is at Public Preview launch stage.
    PUBLIC_PREVIEW = 3

    # Used to indicate the PublisherModel is at GA launch stage.
    GA = 4
  end
end

#supported_actions ⇒ ::Google::Cloud::AIPlatform::V1::PublisherModel::CallToAction

Returns Optional. Supported call-to-action options.

Returns:



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'proto_docs/google/cloud/aiplatform/v1/publisher_model.rb', line 56

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

  # Reference to a resource.
  # @!attribute [rw] uri
  #   @return [::String]
  #     The URI of the resource.
  # @!attribute [rw] resource_name
  #   @return [::String]
  #     The resource name of the Google Cloud resource.
  class ResourceReference
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A named piece of documentation.
  # @!attribute [rw] title
  #   @return [::String]
  #     Required. E.g., OVERVIEW, USE CASES, DOCUMENTATION, SDK & SAMPLES, JAVA,
  #     NODE.JS, etc..
  # @!attribute [rw] content
  #   @return [::String]
  #     Required. Content of this piece of document (in Markdown format).
  class Documentation
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Actions could take on this Publisher Model.
  # @!attribute [rw] view_rest_api
  #   @return [::Google::Cloud::AIPlatform::V1::PublisherModel::CallToAction::ViewRestApi]
  #     Optional. To view Rest API docs.
  # @!attribute [rw] open_notebook
  #   @return [::Google::Cloud::AIPlatform::V1::PublisherModel::CallToAction::RegionalResourceReferences]
  #     Optional. Open notebook of the PublisherModel.
  # @!attribute [rw] create_application
  #   @return [::Google::Cloud::AIPlatform::V1::PublisherModel::CallToAction::RegionalResourceReferences]
  #     Optional. Create application using the PublisherModel.
  # @!attribute [rw] open_fine_tuning_pipeline
  #   @return [::Google::Cloud::AIPlatform::V1::PublisherModel::CallToAction::RegionalResourceReferences]
  #     Optional. Open fine-tuning pipeline of the PublisherModel.
  # @!attribute [rw] open_prompt_tuning_pipeline
  #   @return [::Google::Cloud::AIPlatform::V1::PublisherModel::CallToAction::RegionalResourceReferences]
  #     Optional. Open prompt-tuning pipeline of the PublisherModel.
  # @!attribute [rw] open_genie
  #   @return [::Google::Cloud::AIPlatform::V1::PublisherModel::CallToAction::RegionalResourceReferences]
  #     Optional. Open Genie / Playground.
  # @!attribute [rw] deploy
  #   @return [::Google::Cloud::AIPlatform::V1::PublisherModel::CallToAction::Deploy]
  #     Optional. Deploy the PublisherModel to Vertex Endpoint.
  # @!attribute [rw] open_generation_ai_studio
  #   @return [::Google::Cloud::AIPlatform::V1::PublisherModel::CallToAction::RegionalResourceReferences]
  #     Optional. Open in Generation AI Studio.
  # @!attribute [rw] request_access
  #   @return [::Google::Cloud::AIPlatform::V1::PublisherModel::CallToAction::RegionalResourceReferences]
  #     Optional. Request for access.
  class CallToAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The regional resource name or the URI. Key is region, e.g.,
    # us-central1, europe-west2, global, etc..
    # @!attribute [rw] references
    #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::AIPlatform::V1::PublisherModel::ResourceReference}]
    #     Required.
    # @!attribute [rw] title
    #   @return [::String]
    #     Required. The title of the regional resource reference.
    class RegionalResourceReferences
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # @!attribute [rw] key
      #   @return [::String]
      # @!attribute [rw] value
      #   @return [::Google::Cloud::AIPlatform::V1::PublisherModel::ResourceReference]
      class ReferencesEntry
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end

    # Rest API docs.
    # @!attribute [rw] documentations
    #   @return [::Array<::Google::Cloud::AIPlatform::V1::PublisherModel::Documentation>]
    #     Required.
    # @!attribute [rw] title
    #   @return [::String]
    #     Required. The title of the view rest API.
    class ViewRestApi
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Model metadata that is needed for UploadModel or
    # DeployModel/CreateEndpoint requests.
    # @!attribute [rw] dedicated_resources
    #   @return [::Google::Cloud::AIPlatform::V1::DedicatedResources]
    #     A description of resources that are dedicated to the DeployedModel,
    #     and that need a higher degree of manual configuration.
    # @!attribute [rw] automatic_resources
    #   @return [::Google::Cloud::AIPlatform::V1::AutomaticResources]
    #     A description of resources that to large degree are decided by Vertex
    #     AI, and require only a modest additional configuration.
    # @!attribute [rw] shared_resources
    #   @return [::String]
    #     The resource name of the shared DeploymentResourcePool to deploy on.
    #     Format:
    #     `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`
    # @!attribute [rw] model_display_name
    #   @return [::String]
    #     Optional. Default model display name.
    # @!attribute [rw] large_model_reference
    #   @return [::Google::Cloud::AIPlatform::V1::LargeModelReference]
    #     Optional. Large model reference. When this is set, model_artifact_spec
    #     is not needed.
    # @!attribute [rw] container_spec
    #   @return [::Google::Cloud::AIPlatform::V1::ModelContainerSpec]
    #     Optional. The specification of the container that is to be used when
    #     deploying this Model in Vertex AI. Not present for Large Models.
    # @!attribute [rw] artifact_uri
    #   @return [::String]
    #     Optional. The path to the directory containing the Model artifact and
    #     any of its supporting files.
    # @!attribute [rw] title
    #   @return [::String]
    #     Required. The title of the regional resource reference.
    class Deploy
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # An enum representing the open source category of a PublisherModel.
  module OpenSourceCategory
    # The open source category is unspecified, which should not be used.
    OPEN_SOURCE_CATEGORY_UNSPECIFIED = 0

    # Used to indicate the PublisherModel is not open sourced.
    PROPRIETARY = 1

    # Used to indicate the PublisherModel is a Google-owned open source model
    # w/ Google checkpoint.
    GOOGLE_OWNED_OSS_WITH_GOOGLE_CHECKPOINT = 2

    # Used to indicate the PublisherModel is a 3p-owned open source model w/
    # Google checkpoint.
    THIRD_PARTY_OWNED_OSS_WITH_GOOGLE_CHECKPOINT = 3

    # Used to indicate the PublisherModel is a Google-owned pure open source
    # model.
    GOOGLE_OWNED_OSS = 4

    # Used to indicate the PublisherModel is a 3p-owned pure open source model.
    THIRD_PARTY_OWNED_OSS = 5
  end

  # An enum representing the launch stage of a PublisherModel.
  module LaunchStage
    # The model launch stage is unspecified.
    LAUNCH_STAGE_UNSPECIFIED = 0

    # Used to indicate the PublisherModel is at Experimental launch stage.
    EXPERIMENTAL = 1

    # Used to indicate the PublisherModel is at Private Preview launch stage.
    PRIVATE_PREVIEW = 2

    # Used to indicate the PublisherModel is at Public Preview launch stage.
    PUBLIC_PREVIEW = 3

    # Used to indicate the PublisherModel is at GA launch stage.
    GA = 4
  end
end

#version_id ⇒ ::String (readonly)

Returns Output only. Immutable. The version ID of the PublisherModel. A new version is committed when a new model version is uploaded under an existing model id. It is an auto-incrementing decimal number in string representation.

Returns:

  • (::String) —

    Output only. Immutable. The version ID of the PublisherModel. A new version is committed when a new model version is uploaded under an existing model id. It is an auto-incrementing decimal number in string representation.



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'proto_docs/google/cloud/aiplatform/v1/publisher_model.rb', line 56

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

  # Reference to a resource.
  # @!attribute [rw] uri
  #   @return [::String]
  #     The URI of the resource.
  # @!attribute [rw] resource_name
  #   @return [::String]
  #     The resource name of the Google Cloud resource.
  class ResourceReference
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A named piece of documentation.
  # @!attribute [rw] title
  #   @return [::String]
  #     Required. E.g., OVERVIEW, USE CASES, DOCUMENTATION, SDK & SAMPLES, JAVA,
  #     NODE.JS, etc..
  # @!attribute [rw] content
  #   @return [::String]
  #     Required. Content of this piece of document (in Markdown format).
  class Documentation
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Actions could take on this Publisher Model.
  # @!attribute [rw] view_rest_api
  #   @return [::Google::Cloud::AIPlatform::V1::PublisherModel::CallToAction::ViewRestApi]
  #     Optional. To view Rest API docs.
  # @!attribute [rw] open_notebook
  #   @return [::Google::Cloud::AIPlatform::V1::PublisherModel::CallToAction::RegionalResourceReferences]
  #     Optional. Open notebook of the PublisherModel.
  # @!attribute [rw] create_application
  #   @return [::Google::Cloud::AIPlatform::V1::PublisherModel::CallToAction::RegionalResourceReferences]
  #     Optional. Create application using the PublisherModel.
  # @!attribute [rw] open_fine_tuning_pipeline
  #   @return [::Google::Cloud::AIPlatform::V1::PublisherModel::CallToAction::RegionalResourceReferences]
  #     Optional. Open fine-tuning pipeline of the PublisherModel.
  # @!attribute [rw] open_prompt_tuning_pipeline
  #   @return [::Google::Cloud::AIPlatform::V1::PublisherModel::CallToAction::RegionalResourceReferences]
  #     Optional. Open prompt-tuning pipeline of the PublisherModel.
  # @!attribute [rw] open_genie
  #   @return [::Google::Cloud::AIPlatform::V1::PublisherModel::CallToAction::RegionalResourceReferences]
  #     Optional. Open Genie / Playground.
  # @!attribute [rw] deploy
  #   @return [::Google::Cloud::AIPlatform::V1::PublisherModel::CallToAction::Deploy]
  #     Optional. Deploy the PublisherModel to Vertex Endpoint.
  # @!attribute [rw] open_generation_ai_studio
  #   @return [::Google::Cloud::AIPlatform::V1::PublisherModel::CallToAction::RegionalResourceReferences]
  #     Optional. Open in Generation AI Studio.
  # @!attribute [rw] request_access
  #   @return [::Google::Cloud::AIPlatform::V1::PublisherModel::CallToAction::RegionalResourceReferences]
  #     Optional. Request for access.
  class CallToAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The regional resource name or the URI. Key is region, e.g.,
    # us-central1, europe-west2, global, etc..
    # @!attribute [rw] references
    #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::AIPlatform::V1::PublisherModel::ResourceReference}]
    #     Required.
    # @!attribute [rw] title
    #   @return [::String]
    #     Required. The title of the regional resource reference.
    class RegionalResourceReferences
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # @!attribute [rw] key
      #   @return [::String]
      # @!attribute [rw] value
      #   @return [::Google::Cloud::AIPlatform::V1::PublisherModel::ResourceReference]
      class ReferencesEntry
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end

    # Rest API docs.
    # @!attribute [rw] documentations
    #   @return [::Array<::Google::Cloud::AIPlatform::V1::PublisherModel::Documentation>]
    #     Required.
    # @!attribute [rw] title
    #   @return [::String]
    #     Required. The title of the view rest API.
    class ViewRestApi
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Model metadata that is needed for UploadModel or
    # DeployModel/CreateEndpoint requests.
    # @!attribute [rw] dedicated_resources
    #   @return [::Google::Cloud::AIPlatform::V1::DedicatedResources]
    #     A description of resources that are dedicated to the DeployedModel,
    #     and that need a higher degree of manual configuration.
    # @!attribute [rw] automatic_resources
    #   @return [::Google::Cloud::AIPlatform::V1::AutomaticResources]
    #     A description of resources that to large degree are decided by Vertex
    #     AI, and require only a modest additional configuration.
    # @!attribute [rw] shared_resources
    #   @return [::String]
    #     The resource name of the shared DeploymentResourcePool to deploy on.
    #     Format:
    #     `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`
    # @!attribute [rw] model_display_name
    #   @return [::String]
    #     Optional. Default model display name.
    # @!attribute [rw] large_model_reference
    #   @return [::Google::Cloud::AIPlatform::V1::LargeModelReference]
    #     Optional. Large model reference. When this is set, model_artifact_spec
    #     is not needed.
    # @!attribute [rw] container_spec
    #   @return [::Google::Cloud::AIPlatform::V1::ModelContainerSpec]
    #     Optional. The specification of the container that is to be used when
    #     deploying this Model in Vertex AI. Not present for Large Models.
    # @!attribute [rw] artifact_uri
    #   @return [::String]
    #     Optional. The path to the directory containing the Model artifact and
    #     any of its supporting files.
    # @!attribute [rw] title
    #   @return [::String]
    #     Required. The title of the regional resource reference.
    class Deploy
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # An enum representing the open source category of a PublisherModel.
  module OpenSourceCategory
    # The open source category is unspecified, which should not be used.
    OPEN_SOURCE_CATEGORY_UNSPECIFIED = 0

    # Used to indicate the PublisherModel is not open sourced.
    PROPRIETARY = 1

    # Used to indicate the PublisherModel is a Google-owned open source model
    # w/ Google checkpoint.
    GOOGLE_OWNED_OSS_WITH_GOOGLE_CHECKPOINT = 2

    # Used to indicate the PublisherModel is a 3p-owned open source model w/
    # Google checkpoint.
    THIRD_PARTY_OWNED_OSS_WITH_GOOGLE_CHECKPOINT = 3

    # Used to indicate the PublisherModel is a Google-owned pure open source
    # model.
    GOOGLE_OWNED_OSS = 4

    # Used to indicate the PublisherModel is a 3p-owned pure open source model.
    THIRD_PARTY_OWNED_OSS = 5
  end

  # An enum representing the launch stage of a PublisherModel.
  module LaunchStage
    # The model launch stage is unspecified.
    LAUNCH_STAGE_UNSPECIFIED = 0

    # Used to indicate the PublisherModel is at Experimental launch stage.
    EXPERIMENTAL = 1

    # Used to indicate the PublisherModel is at Private Preview launch stage.
    PRIVATE_PREVIEW = 2

    # Used to indicate the PublisherModel is at Public Preview launch stage.
    PUBLIC_PREVIEW = 3

    # Used to indicate the PublisherModel is at GA launch stage.
    GA = 4
  end
end