Skip to content

Commit bf96877

Browse files
Google APIscopybara-github
Google APIs
authored and
copybara-github
committed
feat: add Similarity to explanation in aiplatform v1beta1
feat: add EncryptionSpec to featurestore in aiplatform v1beta1 feat: add PipelineTaskStatus to pipeline_job in aiplatform v1beta1 feat: add BatchReadTensorboardTimeSeriesData to tensorboard_service in aiplatform v1beta1 feat: add enable_monitoring_pipeline_logs to model_deployment_monitoring_job in aiplatform v1beta1 feat: add order_by to pipeline_service in aiplatform v1beta1 feat: add model_display_name to prediction_service in aiplatform v1beta1 feat: add specialist_worker_emails to specialist_pool in aiplatform v1beta1 Committer: @dizcology PiperOrigin-RevId: 401280513
1 parent 787f8c9 commit bf96877

16 files changed

+236
-85
lines changed

‎google/cloud/aiplatform/v1beta1/entity_type.proto‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,8 @@ message EntityType {
7676
// "overwrite" update happens.
7777
string etag = 7 [(google.api.field_behavior) = OPTIONAL];
7878

79-
// Optional. The default monitoring configuration for all Features under this
79+
// Optional. The default monitoring configuration for all Features with value type
80+
// ([Feature.ValueType][google.cloud.aiplatform.v1beta1.Feature.ValueType]) BOOL, STRING, DOUBLE or INT64 under this
8081
// EntityType.
8182
//
8283
// If this is populated with

‎google/cloud/aiplatform/v1beta1/explanation.proto‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -197,6 +197,10 @@ message ExplanationParameters {
197197
// like a lab or manufacturing line, or from diagnostic equipment, like
198198
// x-rays or quality-control cameras, use Integrated Gradients instead.
199199
XraiAttribution xrai_attribution = 3;
200+
201+
// Similarity explainability that returns the nearest neighbors from the
202+
// provided dataset.
203+
Similarity similarity = 7;
200204
}
201205

202206
// If populated, returns attributions for top K indices of outputs
@@ -337,6 +341,17 @@ message FeatureNoiseSigma {
337341
repeated NoiseSigmaForFeature noise_sigma = 1;
338342
}
339343

344+
// Similarity explainability that returns the nearest neighbors from the
345+
// provided dataset.
346+
message Similarity {
347+
// The Cloud Storage location for the input instances.
348+
GcsSource gcs_source = 1;
349+
350+
// The configuration for the generated index, the semantics are the same as
351+
// [metadata][google.cloud.aiplatform.v1beta1.Index.metadata] and should match NearestNeighborSearchConfig.
352+
google.protobuf.Value nearest_neighbor_search_config = 2;
353+
}
354+
340355
// The [ExplanationSpec][google.cloud.aiplatform.v1beta1.ExplanationSpec] entries that can be overridden at
341356
// [online explanation][google.cloud.aiplatform.v1beta1.PredictionService.Explain] time.
342357
message ExplanationSpecOverride {

‎google/cloud/aiplatform/v1beta1/feature.proto‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -117,6 +117,8 @@ message Feature {
117117

118118
// Optional. The custom monitoring configuration for this Feature, if not set, use the
119119
// monitoring_config defined for the EntityType this Feature belongs to.
120+
// Only Features with type ([Feature.ValueType][google.cloud.aiplatform.v1beta1.Feature.ValueType]) BOOL, STRING, DOUBLE or
121+
// INT64 can enable monitoring.
120122
//
121123
// If this is populated with
122124
// [FeaturestoreMonitoringConfig.disabled][] = true, snapshot analysis

‎google/cloud/aiplatform/v1beta1/featurestore.proto‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,4 +99,8 @@ message Featurestore {
9999

100100
// Output only. State of the featurestore.
101101
State state = 8 [(google.api.field_behavior) = OUTPUT_ONLY];
102+
103+
// Optional. Customer-managed encryption key spec for data storage. If set, both of the
104+
// online and offline data storage will be secured by this key.
105+
EncryptionSpec encryption_spec = 10 [(google.api.field_behavior) = OPTIONAL];
102106
}

‎google/cloud/aiplatform/v1beta1/featurestore_online_service.proto‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -63,10 +63,10 @@ service FeaturestoreOnlineServingService {
6363
// Request message for [FeaturestoreOnlineServingService.ReadFeatureValues][google.cloud.aiplatform.v1beta1.FeaturestoreOnlineServingService.ReadFeatureValues].
6464
message ReadFeatureValuesRequest {
6565
// Required. The resource name of the EntityType for the entity being read.
66-
// Value format: `projects/{project}/locations/{location}/featurestores/
67-
// {featurestore}/entityTypes/{entityType}`. For example,
68-
// for a machine learning model predicting user clicks on a website, an
69-
// EntityType ID could be "user".
66+
// Value format:
67+
// `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}`.
68+
// For example, for a machine learning model predicting user clicks on a
69+
// website, an EntityType ID could be `user`.
7070
string entity_type = 1 [
7171
(google.api.field_behavior) = REQUIRED,
7272
(google.api.resource_reference) = {
@@ -76,7 +76,7 @@ message ReadFeatureValuesRequest {
7676

7777
// Required. ID for a specific entity. For example,
7878
// for a machine learning model predicting user clicks on a website, an entity
79-
// ID could be "user_123".
79+
// ID could be `user_123`.
8080
string entity_id = 2 [(google.api.field_behavior) = REQUIRED];
8181

8282
// Required. Selector choosing Features of the target EntityType.
@@ -96,8 +96,7 @@ message ReadFeatureValuesResponse {
9696
message Header {
9797
// The resource name of the EntityType from the
9898
// [ReadFeatureValuesRequest][google.cloud.aiplatform.v1beta1.ReadFeatureValuesRequest]. Value format:
99-
// `projects/{project}/locations/{location}/featurestores/
100-
// {featurestore}/entityTypes/{entityType}`.
99+
// `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}`.
101100
string entity_type = 1 [(google.api.resource_reference) = {
102101
type: "aiplatform.googleapis.com/EntityType"
103102
}];
@@ -149,10 +148,11 @@ message ReadFeatureValuesResponse {
149148
// [FeaturestoreOnlineServingService.StreamingFeatureValuesRead][].
150149
message StreamingReadFeatureValuesRequest {
151150
// Required. The resource name of the entities' type.
152-
// Value format: `projects/{project}/locations/{location}/featurestores/
153-
// {featurestore}/entityTypes/{entityType}`. For example,
151+
// Value format:
152+
// `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}`.
153+
// For example,
154154
// for a machine learning model predicting user clicks on a website, an
155-
// EntityType ID could be "user".
155+
// EntityType ID could be `user`.
156156
string entity_type = 1 [
157157
(google.api.field_behavior) = REQUIRED,
158158
(google.api.resource_reference) = {
@@ -162,7 +162,7 @@ message StreamingReadFeatureValuesRequest {
162162

163163
// Required. IDs of entities to read Feature values of. The maximum number of IDs is
164164
// 100. For example, for a machine learning model predicting user clicks on a
165-
// website, an entity ID could be "user_123".
165+
// website, an entity ID could be `user_123`.
166166
repeated string entity_ids = 2 [(google.api.field_behavior) = REQUIRED];
167167

168168
// Required. Selector choosing Features of the target EntityType. Feature IDs will be

‎google/cloud/aiplatform/v1beta1/featurestore_service.proto‎

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,7 @@ service FeaturestoreService {
9393
delete: "/v1beta1/{name=projects/*/locations/*/featurestores/*}"
9494
};
9595
option (google.api.method_signature) = "name";
96+
option (google.api.method_signature) = "name,force";
9697
option (google.longrunning.operation_info) = {
9798
response_type: "google.protobuf.Empty"
9899
metadata_type: "DeleteOperationMetadata"
@@ -144,6 +145,7 @@ service FeaturestoreService {
144145
delete: "/v1beta1/{name=projects/*/locations/*/featurestores/*/entityTypes/*}"
145146
};
146147
option (google.api.method_signature) = "name";
148+
option (google.api.method_signature) = "name,force";
147149
option (google.longrunning.operation_info) = {
148150
response_type: "google.protobuf.Empty"
149151
metadata_type: "DeleteOperationMetadata"
@@ -282,6 +284,7 @@ service FeaturestoreService {
282284
get: "/v1beta1/{location=projects/*/locations/*}/featurestores:searchFeatures"
283285
};
284286
option (google.api.method_signature) = "location";
287+
option (google.api.method_signature) = "location,query";
285288
}
286289
}
287290

@@ -336,14 +339,14 @@ message ListFeaturestoresRequest {
336339
// Lists the featurestores that match the filter expression. The following
337340
// fields are supported:
338341
//
339-
// * `create_time`: Supports =, !=, <, >, <=, and >= comparisons. Values must
340-
// be
342+
// * `create_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons.
343+
// Values must be
341344
// in RFC 3339 format.
342-
// * `update_time`: Supports =, !=, <, >, <=, and >= comparisons. Values must
343-
// be
345+
// * `update_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons.
346+
// Values must be
344347
// in RFC 3339 format.
345-
// * `online_serving_config.fixed_node_count`: Supports =, !=, <, >, <=,
346-
// and >= comparisons.
348+
// * `online_serving_config.fixed_node_count`: Supports `=`, `!=`, `<`, `>`,
349+
// `<=`, and `>=` comparisons.
347350
// * `labels`: Supports key-value equality and key presence.
348351
//
349352
// Examples:
@@ -519,7 +522,6 @@ message ImportFeatureValuesResponse {
519522
}
520523

521524
// Request message for [FeaturestoreService.BatchReadFeatureValues][google.cloud.aiplatform.v1beta1.FeaturestoreService.BatchReadFeatureValues].
522-
// (- Next Id: 6 -)
523525
message BatchReadFeatureValuesRequest {
524526
// Describe pass-through fields in read_instance source.
525527
message PassThroughField {
@@ -739,10 +741,10 @@ message ListEntityTypesRequest {
739741
// Lists the EntityTypes that match the filter expression. The following
740742
// filters are supported:
741743
//
742-
// * `create_time`: Supports =, !=, <, >, >=, and <= comparisons. Values must
743-
// be in RFC 3339 format.
744-
// * `update_time`: Supports =, !=, <, >, >=, and <= comparisons. Values must
745-
// be in RFC 3339 format.
744+
// * `create_time`: Supports `=`, `!=`, `<`, `>`, `>=`, and `<=` comparisons.
745+
// Values must be in RFC 3339 format.
746+
// * `update_time`: Supports `=`, `!=`, `<`, `>`, `>=`, and `<=` comparisons.
747+
// Values must be in RFC 3339 format.
746748
// * `labels`: Supports key-value equality as well as key presence.
747749
//
748750
// Examples:
@@ -1003,9 +1005,9 @@ message SearchFeaturesRequest {
10031005
// comparison. This is done by:
10041006
//
10051007
// * Removing leading/trailing whitespace and tokenizing the search value.
1006-
// Characters that are not one of alphanumeric [a-zA-Z0-9], underscore [_],
1007-
// or asterisk [*] are treated as delimiters for tokens. (*) is treated as a
1008-
// wildcard that matches characters within a token.
1008+
// Characters that are not one of alphanumeric `[a-zA-Z0-9]`, underscore
1009+
// `_`, or asterisk `*` are treated as delimiters for tokens. `*` is treated
1010+
// as a wildcard that matches characters within a token.
10091011
// * Ignoring case.
10101012
// * Prepending an asterisk to the first and appending an asterisk to the
10111013
// last token in QUERY.

‎google/cloud/aiplatform/v1beta1/index_endpoint.proto‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -143,9 +143,8 @@ message DeployedIndex {
143143
// If min_replica_count is not set, the default value is 1. If
144144
// max_replica_count is not set, the default value is min_replica_count. The
145145
// max allowed replica count is 1000.
146-
//
147-
// The user is billed for the resources (at least their minimal amount) even
148-
// if the DeployedIndex receives no traffic.
146+
// The user is billed for the resources (at least their minimal amount)
147+
// even if the DeployedIndex receives no traffic.
149148
AutomaticResources automatic_resources = 7 [(google.api.field_behavior) = OPTIONAL];
150149

151150
// Optional. If true, private endpoint's access logs are sent to StackDriver Logging.

‎google/cloud/aiplatform/v1beta1/job_service.proto‎

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -923,7 +923,33 @@ message UpdateModelDeploymentMonitoringJobRequest {
923923
// server.
924924
ModelDeploymentMonitoringJob model_deployment_monitoring_job = 1 [(google.api.field_behavior) = REQUIRED];
925925

926-
// Required. The update mask applies to the resource.
926+
// Required. The update mask is used to specify the fields to be overwritten in the
927+
// ModelDeploymentMonitoringJob resource by the update.
928+
// The fields specified in the update_mask are relative to the resource, not
929+
// the full request. A field will be overwritten if it is in the mask. If the
930+
// user does not provide a mask then only the non-empty fields present in the
931+
// request will be overwritten. Set the update_mask to `*` to override all
932+
// fields.
933+
// For the objective config, the user can either provide the update mask for
934+
// model_deployment_monitoring_objective_configs or any combination of its
935+
// nested fields, such as:
936+
// model_deployment_monitoring_objective_configs.objective_config.training_dataset.
937+
//
938+
// Updatable fields:
939+
//
940+
// * `display_name`
941+
// * `model_deployment_monitoring_schedule_config`
942+
// * `model_monitoring_alert_config`
943+
// * `logging_sampling_strategy`
944+
// * `labels`
945+
// * `log_ttl`
946+
// * `enable_monitoring_pipeline_logs`
947+
// . and
948+
// * `model_deployment_monitoring_objective_configs`
949+
// . or
950+
// * `model_deployment_monitoring_objective_configs.objective_config.training_dataset`
951+
// * `model_deployment_monitoring_objective_configs.objective_config.training_prediction_skew_detection_config`
952+
// * `model_deployment_monitoring_objective_configs.objective_config.prediction_drift_detection_config`
927953
google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED];
928954
}
929955

0 commit comments

Comments
 (0)