Skip to content

Commit 321abab

Browse files
Google APIscopybara-github
authored andcommitted
feat: add prediction service RPC RawPredict to aiplatform_v1beta1
feat: add tensorboard service RPCs to aiplatform_v1beta1: BatchCreateTensorboardRuns, BatchCreateTensorboardTimeSeries, WriteTensorboardExperimentData feat: add model_deployment_monitoring_job to Endpoint in aiplatform_v1beta1 feat: add deployment_group to DeployedIndex in aiplatform_v1beta1 feat: add ModelEvaluationExplanationSpec in aiplatform_v1beta1 Committer: @dizcology PiperOrigin-RevId: 393890669
1 parent 298a980 commit 321abab

30 files changed

Lines changed: 355 additions & 109 deletions

google/cloud/aiplatform/v1beta1/BUILD.bazel

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -164,7 +164,7 @@ java_gapic_library(
164164
":aiplatform_java_grpc",
165165
] + _JAVA_GRPC_SUBPACKAGE_DEPS,
166166
deps = [
167-
":aiplatform_java_proto",
167+
":aiplatform_java_proto","//google/api:api_java_proto",
168168
] + _JAVA_PROTO_SUBPACKAGE_DEPS,
169169
)
170170

google/cloud/aiplatform/v1beta1/aiplatform_v1beta1.yaml

Lines changed: 19 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,12 @@ types:
5555
- name: google.cloud.aiplatform.v1beta1.ImportDataResponse
5656
- name: google.cloud.aiplatform.v1beta1.ImportFeatureValuesOperationMetadata
5757
- name: google.cloud.aiplatform.v1beta1.ImportFeatureValuesResponse
58+
- name: google.cloud.aiplatform.v1beta1.PurgeArtifactsMetadata
59+
- name: google.cloud.aiplatform.v1beta1.PurgeArtifactsResponse
60+
- name: google.cloud.aiplatform.v1beta1.PurgeContextsMetadata
61+
- name: google.cloud.aiplatform.v1beta1.PurgeContextsResponse
62+
- name: google.cloud.aiplatform.v1beta1.PurgeExecutionsMetadata
63+
- name: google.cloud.aiplatform.v1beta1.PurgeExecutionsResponse
5864
- name: google.cloud.aiplatform.v1beta1.SpecialistPool
5965
- name: google.cloud.aiplatform.v1beta1.SuggestTrialsMetadata
6066
- name: google.cloud.aiplatform.v1beta1.SuggestTrialsResponse
@@ -117,9 +123,7 @@ backend:
117123
deadline: 60.0
118124
- selector: 'google.cloud.aiplatform.v1beta1.PipelineService.*'
119125
deadline: 60.0
120-
- selector: google.cloud.aiplatform.v1beta1.PredictionService.Explain
121-
deadline: 600.0
122-
- selector: google.cloud.aiplatform.v1beta1.PredictionService.Predict
126+
- selector: 'google.cloud.aiplatform.v1beta1.PredictionService.*'
123127
deadline: 600.0
124128
- selector: 'google.cloud.aiplatform.v1beta1.SpecialistPoolService.*'
125129
deadline: 60.0
@@ -152,6 +156,7 @@ http:
152156
- post: '/ui/{name=projects/*/locations/*/datasets/*/savedQueries/*/operations/*}:cancel'
153157
- post: '/ui/{name=projects/*/locations/*/datasets/*/annotationSpecs/*/operations/*}:cancel'
154158
- post: '/ui/{name=projects/*/locations/*/datasets/*/dataItems/*/annotations/*/operations/*}:cancel'
159+
- post: '/ui/{name=projects/*/locations/*/edgeDevices/*/operations/*}:cancel'
155160
- post: '/ui/{name=projects/*/locations/*/endpoints/*/operations/*}:cancel'
156161
- post: '/ui/{name=projects/*/locations/*/featurestores/*/operations/*}:cancel'
157162
- post: '/ui/{name=projects/*/locations/*/featurestores/*/entityTypes/*/operations/*}:cancel'
@@ -180,6 +185,7 @@ http:
180185
- post: '/v1beta1/{name=projects/*/locations/*/datasets/*/savedQueries/*/operations/*}:cancel'
181186
- post: '/v1beta1/{name=projects/*/locations/*/datasets/*/annotationSpecs/*/operations/*}:cancel'
182187
- post: '/v1beta1/{name=projects/*/locations/*/datasets/*/dataItems/*/annotations/*/operations/*}:cancel'
188+
- post: '/v1beta1/{name=projects/*/locations/*/edgeDevices/*/operations/*}:cancel'
183189
- post: '/v1beta1/{name=projects/*/locations/*/endpoints/*/operations/*}:cancel'
184190
- post: '/v1beta1/{name=projects/*/locations/*/featurestores/*/operations/*}:cancel'
185191
- post: '/v1beta1/{name=projects/*/locations/*/featurestores/*/entityTypes/*/operations/*}:cancel'
@@ -210,6 +216,7 @@ http:
210216
- delete: '/ui/{name=projects/*/locations/*/datasets/*/savedQueries/*/operations/*}'
211217
- delete: '/ui/{name=projects/*/locations/*/datasets/*/annotationSpecs/*/operations/*}'
212218
- delete: '/ui/{name=projects/*/locations/*/datasets/*/dataItems/*/annotations/*/operations/*}'
219+
- delete: '/ui/{name=projects/*/locations/*/edgeDevices/*/operations/*}'
213220
- delete: '/ui/{name=projects/*/locations/*/endpoints/*/operations/*}'
214221
- delete: '/ui/{name=projects/*/locations/*/featurestores/*/operations/*}'
215222
- delete: '/ui/{name=projects/*/locations/*/featurestores/*/entityTypes/*/operations/*}'
@@ -238,6 +245,7 @@ http:
238245
- delete: '/v1beta1/{name=projects/*/locations/*/datasets/*/savedQueries/*/operations/*}'
239246
- delete: '/v1beta1/{name=projects/*/locations/*/datasets/*/annotationSpecs/*/operations/*}'
240247
- delete: '/v1beta1/{name=projects/*/locations/*/datasets/*/dataItems/*/annotations/*/operations/*}'
248+
- delete: '/v1beta1/{name=projects/*/locations/*/edgeDevices/*/operations/*}'
241249
- delete: '/v1beta1/{name=projects/*/locations/*/endpoints/*/operations/*}'
242250
- delete: '/v1beta1/{name=projects/*/locations/*/featurestores/*/operations/*}'
243251
- delete: '/v1beta1/{name=projects/*/locations/*/featurestores/*/entityTypes/*/operations/*}'
@@ -268,6 +276,8 @@ http:
268276
- get: '/ui/{name=projects/*/locations/*/datasets/*/savedQueries/*/operations/*}'
269277
- get: '/ui/{name=projects/*/locations/*/datasets/*/annotationSpecs/*/operations/*}'
270278
- get: '/ui/{name=projects/*/locations/*/datasets/*/dataItems/*/annotations/*/operations/*}'
279+
- get: '/ui/{name=projects/*/locations/*/edgeDeploymentJobs/*/operations/*}'
280+
- get: '/ui/{name=projects/*/locations/*/edgeDevices/*/operations/*}'
271281
- get: '/ui/{name=projects/*/locations/*/endpoints/*/operations/*}'
272282
- get: '/ui/{name=projects/*/locations/*/featurestores/*/operations/*}'
273283
- get: '/ui/{name=projects/*/locations/*/featurestores/*/entityTypes/*/operations/*}'
@@ -296,6 +306,7 @@ http:
296306
- get: '/v1beta1/{name=projects/*/locations/*/datasets/*/savedQueries/*/operations/*}'
297307
- get: '/v1beta1/{name=projects/*/locations/*/datasets/*/annotationSpecs/*/operations/*}'
298308
- get: '/v1beta1/{name=projects/*/locations/*/datasets/*/dataItems/*/annotations/*/operations/*}'
309+
- get: '/v1beta1/{name=projects/*/locations/*/edgeDevices/*/operations/*}'
299310
- get: '/v1beta1/{name=projects/*/locations/*/endpoints/*/operations/*}'
300311
- get: '/v1beta1/{name=projects/*/locations/*/featurestores/*/operations/*}'
301312
- get: '/v1beta1/{name=projects/*/locations/*/featurestores/*/entityTypes/*/operations/*}'
@@ -326,6 +337,7 @@ http:
326337
- get: '/ui/{name=projects/*/locations/*/datasets/*/savedQueries/*}/operations'
327338
- get: '/ui/{name=projects/*/locations/*/datasets/*/annotationSpecs/*}/operations'
328339
- get: '/ui/{name=projects/*/locations/*/datasets/*/dataItems/*/annotations/*}/operations'
340+
- get: '/ui/{name=projects/*/locations/*/edgeDevices/*}/operations'
329341
- get: '/ui/{name=projects/*/locations/*/endpoints/*}/operations'
330342
- get: '/ui/{name=projects/*/locations/*/featurestores/*}/operations'
331343
- get: '/ui/{name=projects/*/locations/*/featurestores/*/entityTypes/*}/operations'
@@ -354,6 +366,7 @@ http:
354366
- get: '/v1beta1/{name=projects/*/locations/*/datasets/*/savedQueries/*}/operations'
355367
- get: '/v1beta1/{name=projects/*/locations/*/datasets/*/annotationSpecs/*}/operations'
356368
- get: '/v1beta1/{name=projects/*/locations/*/datasets/*/dataItems/*/annotations/*}/operations'
369+
- get: '/v1beta1/{name=projects/*/locations/*/edgeDevices/*}/operations'
357370
- get: '/v1beta1/{name=projects/*/locations/*/endpoints/*}/operations'
358371
- get: '/v1beta1/{name=projects/*/locations/*/featurestores/*}/operations'
359372
- get: '/v1beta1/{name=projects/*/locations/*/featurestores/*/entityTypes/*}/operations'
@@ -384,6 +397,7 @@ http:
384397
- post: '/ui/{name=projects/*/locations/*/datasets/*/savedQueries/*/operations/*}:wait'
385398
- post: '/ui/{name=projects/*/locations/*/datasets/*/annotationSpecs/*/operations/*}:wait'
386399
- post: '/ui/{name=projects/*/locations/*/datasets/*/dataItems/*/annotations/*/operations/*}:wait'
400+
- post: '/ui/{name=projects/*/locations/*/edgeDevices/*/operations/*}:wait'
387401
- post: '/ui/{name=projects/*/locations/*/endpoints/*/operations/*}:wait'
388402
- post: '/ui/{name=projects/*/locations/*/featurestores/*/operations/*}:wait'
389403
- post: '/ui/{name=projects/*/locations/*/featurestores/*/entityTypes/*/operations/*}:wait'
@@ -412,6 +426,7 @@ http:
412426
- post: '/v1beta1/{name=projects/*/locations/*/datasets/*/savedQueries/*/operations/*}:wait'
413427
- post: '/v1beta1/{name=projects/*/locations/*/datasets/*/annotationSpecs/*/operations/*}:wait'
414428
- post: '/v1beta1/{name=projects/*/locations/*/datasets/*/dataItems/*/annotations/*/operations/*}:wait'
429+
- post: '/v1beta1/{name=projects/*/locations/*/edgeDevices/*/operations/*}:wait'
415430
- post: '/v1beta1/{name=projects/*/locations/*/endpoints/*/operations/*}:wait'
416431
- post: '/v1beta1/{name=projects/*/locations/*/featurestores/*/operations/*}:wait'
417432
- post: '/v1beta1/{name=projects/*/locations/*/featurestores/*/entityTypes/*/operations/*}:wait'
@@ -489,11 +504,7 @@ authentication:
489504
oauth:
490505
canonical_scopes: |-
491506
https://www.googleapis.com/auth/cloud-platform
492-
- selector: google.cloud.aiplatform.v1beta1.PredictionService.Explain
493-
oauth:
494-
canonical_scopes: |-
495-
https://www.googleapis.com/auth/cloud-platform
496-
- selector: google.cloud.aiplatform.v1beta1.PredictionService.Predict
507+
- selector: 'google.cloud.aiplatform.v1beta1.PredictionService.*'
497508
oauth:
498509
canonical_scopes: |-
499510
https://www.googleapis.com/auth/cloud-platform

google/cloud/aiplatform/v1beta1/annotation.proto

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ package google.cloud.aiplatform.v1beta1;
1818

1919
import "google/api/field_behavior.proto";
2020
import "google/api/resource.proto";
21+
2122
import "google/cloud/aiplatform/v1beta1/user_action_reference.proto";
2223
import "google/protobuf/struct.proto";
2324
import "google/protobuf/timestamp.proto";

google/cloud/aiplatform/v1beta1/artifact.proto

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,7 @@ message Artifact {
103103
string schema_version = 15;
104104

105105
// Properties of the Artifact.
106+
// The size of this field should not exceed 200KB.
106107
google.protobuf.Struct metadata = 16;
107108

108109
// Description of the Artifact

google/cloud/aiplatform/v1beta1/context.proto

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,7 @@ message Context {
8888
string schema_version = 14;
8989

9090
// Properties of the Context.
91+
// The size of this field should not exceed 200KB.
9192
google.protobuf.Struct metadata = 15;
9293

9394
// Description of the Context

google/cloud/aiplatform/v1beta1/custom_job.proto

Lines changed: 19 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -92,9 +92,17 @@ message CustomJob {
9292
// provided encryption key.
9393
EncryptionSpec encryption_spec = 12;
9494

95-
// Output only. The web access URIs for the training job.
96-
// The keys are the node names in the training jobs, e.g. workerpool0-0.
97-
// The values are the URIs for each node's web portal in the job.
95+
// Output only. URIs for accessing [interactive
96+
// shells](https://cloud.google.com/vertex-ai/docs/training/monitor-debug-interactive-shell)
97+
// (one URI for each training node). Only available if
98+
// [job_spec.enable_web_access][google.cloud.aiplatform.v1beta1.CustomJobSpec.enable_web_access] is `true`.
99+
//
100+
// The keys are names of each node in the training job; for example,
101+
// `workerpool0-0` for the primary node, `workerpool1-0` for the first node in
102+
// the second worker pool, and `workerpool1-1` for the second node in the
103+
// second worker pool.
104+
//
105+
// The values are the URIs for each node's interactive shell.
98106
map<string, string> web_access_uris = 16 [(google.api.field_behavior) = OUTPUT_ONLY];
99107
}
100108

@@ -110,7 +118,7 @@ message CustomJobSpec {
110118

111119
// Specifies the service account for workload run-as account.
112120
// Users submitting jobs must have act-as permission on this run-as account.
113-
// If unspecified, the [AI Platform Custom Code Service
121+
// If unspecified, the [Vertex AI Custom Code Service
114122
// Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents)
115123
// for the CustomJob's project is used.
116124
string service_account = 4;
@@ -163,8 +171,13 @@ message CustomJobSpec {
163171
}
164172
];
165173

166-
// Optional. Vertex AI will enable web portal access to the containers. The portals
167-
// can be accessed on web via the URLs given by [web_access_uris][].
174+
// Optional. Whether you want Vertex AI to enable [interactive shell
175+
// access](https://cloud.google.com/vertex-ai/docs/training/monitor-debug-interactive-shell)
176+
// to training containers.
177+
//
178+
// If set to `true`, you can access interactive shells at the URIs given
179+
// by [CustomJob.web_access_uris][google.cloud.aiplatform.v1beta1.CustomJob.web_access_uris] or [Trial.web_access_uris][google.cloud.aiplatform.v1beta1.Trial.web_access_uris] (within
180+
// [HyperparameterTuningJob.trials][google.cloud.aiplatform.v1beta1.HyperparameterTuningJob.trials]).
168181
bool enable_web_access = 10 [(google.api.field_behavior) = OPTIONAL];
169182
}
170183

google/cloud/aiplatform/v1beta1/data_item.proto

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ package google.cloud.aiplatform.v1beta1;
1818

1919
import "google/api/field_behavior.proto";
2020
import "google/api/resource.proto";
21+
2122
import "google/protobuf/struct.proto";
2223
import "google/protobuf/timestamp.proto";
2324
import "google/api/annotations.proto";

google/cloud/aiplatform/v1beta1/dataset.proto

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,9 @@ message Dataset {
4747
// characters.
4848
string display_name = 2 [(google.api.field_behavior) = REQUIRED];
4949

50+
// Optional. The description of the Dataset.
51+
string description = 16 [(google.api.field_behavior) = OPTIONAL];
52+
5053
// Required. Points to a YAML file stored on Google Cloud Storage describing additional
5154
// information about the Dataset.
5255
// The schema is defined as an OpenAPI 3.0.2 Schema Object.

google/cloud/aiplatform/v1beta1/dataset_service.proto

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,8 @@ option java_package = "com.google.cloud.aiplatform.v1beta1";
3737
option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1";
3838
option ruby_package = "Google::Cloud::AIPlatform::V1beta1";
3939

40+
// The service that handles the CRUD of Vertex AI Dataset and its child
41+
// resources.
4042
service DatasetService {
4143
option (google.api.default_host) = "aiplatform.googleapis.com";
4244
option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform";

google/cloud/aiplatform/v1beta1/endpoint.proto

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ import "google/cloud/aiplatform/v1beta1/encryption_spec.proto";
2222
import "google/cloud/aiplatform/v1beta1/explanation.proto";
2323
import "google/cloud/aiplatform/v1beta1/machine_resources.proto";
2424
import "google/cloud/aiplatform/v1beta1/model_deployment_monitoring_job.proto";
25+
import "google/cloud/aiplatform/v1beta1/model_monitoring.proto";
2526
import "google/protobuf/timestamp.proto";
2627
import "google/api/annotations.proto";
2728

@@ -105,6 +106,17 @@ message Endpoint {
105106
string network = 13 [(google.api.resource_reference) = {
106107
type: "compute.googleapis.com/Network"
107108
}];
109+
110+
// Output only. Resource name of the Model Monitoring job associated with this Endpoint
111+
// if monitoring is enabled by [CreateModelDeploymentMonitoringJob][].
112+
// Format:
113+
// `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}`
114+
string model_deployment_monitoring_job = 14 [
115+
(google.api.field_behavior) = OUTPUT_ONLY,
116+
(google.api.resource_reference) = {
117+
type: "aiplatform.googleapis.com/ModelDeploymentMonitoringJob"
118+
}
119+
];
108120
}
109121

110122
// A deployment of a Model. Endpoints contain one or more DeployedModels.
@@ -119,8 +131,8 @@ message DeployedModel {
119131
// that need a higher degree of manual configuration.
120132
DedicatedResources dedicated_resources = 7;
121133

122-
// A description of resources that to large degree are decided by AI
123-
// Platform, and require only a modest additional configuration.
134+
// A description of resources that to large degree are decided by Vertex
135+
// AI, and require only a modest additional configuration.
124136
AutomaticResources automatic_resources = 8;
125137
}
126138

0 commit comments

Comments
 (0)