feat: Adds BigQuery output table field to batch prediction job output config

feat: Adds Feature Store features
feat: Adds CustomJob.web_access_uris, CustomJob.enable_web_access fields
feat: Adds Endpoint.network, Endpoint.private_endpoints fields and PrivateEndpoints message
feat: Adds Execution.State constants: CACHED and CANCELLED
feat: Adds IndexEndpoint.private_ip_ranges field
feat: Adds IndexEndpointService.deployed_index_id field
feat: Adds MetadataService.DeleteArtifact and DeleteExecution methods
feat: Adds ModelMonitoringObjectConfig.explanation_config field and ModelMonitoringObjectConfig.ExplanationConfig message
feat: Adds ModelMonitoringObjectiveConfig.TrainingPredictionSkewDetectionConfig.attribution_score_skew_thresholds and ModelMonitoringObjectiveConfig.PredictionDriftDetectionConfig.attribution_score_drift_threshold fields
feat: Adds fields to Study message

PiperOrigin-RevId: 385903722
pull/670/head^2
Google APIs 4 years ago committed by Copybara-Service
parent 9a0b354fef
commit 4e836c7c25
  1. 5
      google/cloud/aiplatform/v1beta1/BUILD.bazel
  2. 3
      google/cloud/aiplatform/v1beta1/accelerator_type.proto
  3. 4
      google/cloud/aiplatform/v1beta1/annotation.proto
  4. 3
      google/cloud/aiplatform/v1beta1/annotation_spec.proto
  5. 3
      google/cloud/aiplatform/v1beta1/artifact.proto
  6. 14
      google/cloud/aiplatform/v1beta1/batch_prediction_job.proto
  7. 3
      google/cloud/aiplatform/v1beta1/completion_stats.proto
  8. 3
      google/cloud/aiplatform/v1beta1/context.proto
  9. 12
      google/cloud/aiplatform/v1beta1/custom_job.proto
  10. 4
      google/cloud/aiplatform/v1beta1/data_item.proto
  11. 3
      google/cloud/aiplatform/v1beta1/data_labeling_job.proto
  12. 3
      google/cloud/aiplatform/v1beta1/dataset.proto
  13. 3
      google/cloud/aiplatform/v1beta1/dataset_service.proto
  14. 3
      google/cloud/aiplatform/v1beta1/deployed_index_ref.proto
  15. 3
      google/cloud/aiplatform/v1beta1/deployed_model_ref.proto
  16. 3
      google/cloud/aiplatform/v1beta1/encryption_spec.proto
  17. 36
      google/cloud/aiplatform/v1beta1/endpoint.proto
  18. 3
      google/cloud/aiplatform/v1beta1/endpoint_service.proto
  19. 3
      google/cloud/aiplatform/v1beta1/entity_type.proto
  20. 3
      google/cloud/aiplatform/v1beta1/env_var.proto
  21. 3
      google/cloud/aiplatform/v1beta1/event.proto
  22. 9
      google/cloud/aiplatform/v1beta1/execution.proto
  23. 3
      google/cloud/aiplatform/v1beta1/explanation.proto
  24. 3
      google/cloud/aiplatform/v1beta1/explanation_metadata.proto
  25. 3
      google/cloud/aiplatform/v1beta1/feature.proto
  26. 3
      google/cloud/aiplatform/v1beta1/feature_monitoring_stats.proto
  27. 3
      google/cloud/aiplatform/v1beta1/feature_selector.proto
  28. 4
      google/cloud/aiplatform/v1beta1/featurestore.proto
  29. 13
      google/cloud/aiplatform/v1beta1/featurestore_monitoring.proto
  30. 16
      google/cloud/aiplatform/v1beta1/featurestore_online_service.proto
  31. 22
      google/cloud/aiplatform/v1beta1/featurestore_service.proto
  32. 3
      google/cloud/aiplatform/v1beta1/hyperparameter_tuning_job.proto
  33. 3
      google/cloud/aiplatform/v1beta1/index.proto
  34. 15
      google/cloud/aiplatform/v1beta1/index_endpoint.proto
  35. 6
      google/cloud/aiplatform/v1beta1/index_endpoint_service.proto
  36. 3
      google/cloud/aiplatform/v1beta1/index_service.proto
  37. 6
      google/cloud/aiplatform/v1beta1/io.proto
  38. 3
      google/cloud/aiplatform/v1beta1/job_service.proto
  39. 3
      google/cloud/aiplatform/v1beta1/job_state.proto
  40. 3
      google/cloud/aiplatform/v1beta1/lineage_subgraph.proto
  41. 10
      google/cloud/aiplatform/v1beta1/machine_resources.proto
  42. 3
      google/cloud/aiplatform/v1beta1/manual_batch_tuning_parameters.proto
  43. 3
      google/cloud/aiplatform/v1beta1/metadata_schema.proto
  44. 242
      google/cloud/aiplatform/v1beta1/metadata_service.proto
  45. 3
      google/cloud/aiplatform/v1beta1/metadata_store.proto
  46. 3
      google/cloud/aiplatform/v1beta1/migratable_resource.proto
  47. 3
      google/cloud/aiplatform/v1beta1/migration_service.proto
  48. 3
      google/cloud/aiplatform/v1beta1/model.proto
  49. 4
      google/cloud/aiplatform/v1beta1/model_deployment_monitoring_job.proto
  50. 3
      google/cloud/aiplatform/v1beta1/model_evaluation.proto
  51. 3
      google/cloud/aiplatform/v1beta1/model_evaluation_slice.proto
  52. 57
      google/cloud/aiplatform/v1beta1/model_monitoring.proto
  53. 3
      google/cloud/aiplatform/v1beta1/model_service.proto
  54. 3
      google/cloud/aiplatform/v1beta1/operation.proto
  55. 3
      google/cloud/aiplatform/v1beta1/pipeline_job.proto
  56. 35
      google/cloud/aiplatform/v1beta1/pipeline_service.proto
  57. 3
      google/cloud/aiplatform/v1beta1/pipeline_state.proto
  58. 4
      google/cloud/aiplatform/v1beta1/prediction_service.proto
  59. 3
      google/cloud/aiplatform/v1beta1/specialist_pool.proto
  60. 3
      google/cloud/aiplatform/v1beta1/specialist_pool_service.proto
  61. 42
      google/cloud/aiplatform/v1beta1/study.proto
  62. 3
      google/cloud/aiplatform/v1beta1/tensorboard.proto
  63. 3
      google/cloud/aiplatform/v1beta1/tensorboard_data.proto
  64. 3
      google/cloud/aiplatform/v1beta1/tensorboard_experiment.proto
  65. 3
      google/cloud/aiplatform/v1beta1/tensorboard_run.proto
  66. 3
      google/cloud/aiplatform/v1beta1/tensorboard_service.proto
  67. 3
      google/cloud/aiplatform/v1beta1/tensorboard_time_series.proto
  68. 3
      google/cloud/aiplatform/v1beta1/training_pipeline.proto
  69. 3
      google/cloud/aiplatform/v1beta1/types.proto
  70. 3
      google/cloud/aiplatform/v1beta1/user_action_reference.proto
  71. 3
      google/cloud/aiplatform/v1beta1/value.proto
  72. 3
      google/cloud/aiplatform/v1beta1/vizier_service.proto

@ -97,6 +97,7 @@ proto_library(
"//google/api:annotations_proto",
"//google/api:client_proto",
"//google/api:field_behavior_proto",
"//google/api:httpbody_proto",
"//google/api:resource_proto",
"//google/longrunning:operations_proto",
"//google/rpc:status_proto",
@ -212,6 +213,7 @@ go_proto_library(
protos = [":aiplatform_proto"],
deps = [
"//google/api:annotations_go_proto",
"//google/api:httpbody_go_proto",
"//google/longrunning:longrunning_go_proto",
"//google/rpc:status_go_proto",
"//google/type:money_go_proto",
@ -223,9 +225,11 @@ go_gapic_library(
srcs = [":aiplatform_proto_with_info"],
grpc_service_config = "aiplatform_grpc_service_config.json",
importpath = "cloud.google.com/go/aiplatform/apiv1beta1;aiplatform",
metadata = True,
service_yaml = "aiplatform_v1beta1.yaml",
deps = [
":aiplatform_go_proto",
"//google/api:httpbody_go_proto",
"//google/longrunning:longrunning_go_proto",
"@com_google_cloud_go//longrunning:go_default_library",
"@com_google_cloud_go//longrunning/autogen:go_default_library",
@ -246,6 +250,7 @@ go_gapic_assembly_pkg(
name = "gapi-cloud-aiplatform-v1beta1-go",
deps = [
":aiplatform_go_gapic",
":aiplatform_go_gapic_srcjar-metadata.srcjar",
":aiplatform_go_gapic_srcjar-test.srcjar",
":aiplatform_go_proto",
],

@ -18,10 +18,13 @@ package google.cloud.aiplatform.v1beta1;
import "google/api/annotations.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
option java_multiple_files = true;
option java_outer_classname = "AcceleratorTypeProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1";
option ruby_package = "Google::Cloud::AIPlatform::V1beta1";
// Represents a hardware accelerator type.
enum AcceleratorType {

@ -18,16 +18,18 @@ package google.cloud.aiplatform.v1beta1;
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
import "google/cloud/aiplatform/v1beta1/user_action_reference.proto";
import "google/protobuf/struct.proto";
import "google/protobuf/timestamp.proto";
import "google/api/annotations.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
option java_multiple_files = true;
option java_outer_classname = "AnnotationProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1";
option ruby_package = "Google::Cloud::AIPlatform::V1beta1";
// Used to assign specific AnnotationSpec to a particular area of a DataItem or
// the whole part of the DataItem.

@ -21,10 +21,13 @@ import "google/api/resource.proto";
import "google/protobuf/timestamp.proto";
import "google/api/annotations.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
option java_multiple_files = true;
option java_outer_classname = "AnnotationSpecProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1";
option ruby_package = "Google::Cloud::AIPlatform::V1beta1";
// Identifies a concept with which DataItems may be annotated with.
message AnnotationSpec {

@ -23,10 +23,13 @@ import "google/protobuf/struct.proto";
import "google/protobuf/timestamp.proto";
import "google/api/annotations.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
option java_multiple_files = true;
option java_outer_classname = "ArtifactProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1";
option ruby_package = "Google::Cloud::AIPlatform::V1beta1";
// Instance of a general artifact.
message Artifact {

@ -31,10 +31,13 @@ import "google/protobuf/timestamp.proto";
import "google/rpc/status.proto";
import "google/api/annotations.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
option java_multiple_files = true;
option java_outer_classname = "BatchPredictionJobProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1";
option ruby_package = "Google::Cloud::AIPlatform::V1beta1";
// A job that uses a [Model][google.cloud.aiplatform.v1beta1.BatchPredictionJob.model] to produce predictions
// on multiple [input instances][google.cloud.aiplatform.v1beta1.BatchPredictionJob.input_config]. If
@ -93,8 +96,7 @@ message BatchPredictionJob {
// `errors_N.<extension>` files are created (N depends on total number
// of failed predictions). These files contain the failed instances,
// as per their schema, followed by an additional `error` field which as
// value has
// [`google.rpc.Status`](Status)
// value has [google.rpc.Status][google.rpc.Status]
// containing only `code` and `message` fields.
GcsDestination gcs_destination = 2;
@ -114,7 +116,7 @@ message BatchPredictionJob {
// prediction schemata. The `errors` table contains rows for which the
// prediction has failed, it has instance columns, as per the
// instance schema, followed by a single "errors" column, which as values
// has [`google.rpc.Status`](Status)
// has [google.rpc.Status][google.rpc.Status]
// represented as a STRUCT, and containing only `code` and `message`.
BigQueryDestination bigquery_destination = 3;
}
@ -139,6 +141,12 @@ message BatchPredictionJob {
// format, into which the prediction output is written.
string bigquery_output_dataset = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
}
// Output only. The name of the BigQuery table created, in
// `predictions_<timestamp>`
// format, into which the prediction output is written.
// Can be used by UI to generate the BigQuery output path, for example.
string bigquery_output_table = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
}
// Output only. Resource name of the BatchPredictionJob.

@ -20,10 +20,13 @@ import "google/api/field_behavior.proto";
import "google/rpc/status.proto";
import "google/api/annotations.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
option java_multiple_files = true;
option java_outer_classname = "CompletionStatsProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1";
option ruby_package = "Google::Cloud::AIPlatform::V1beta1";
// Success and error statistics of processing multiple entities
// (for example, DataItems or structured data rows) in batch.

@ -23,10 +23,13 @@ import "google/protobuf/struct.proto";
import "google/protobuf/timestamp.proto";
import "google/api/annotations.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
option java_multiple_files = true;
option java_outer_classname = "ContextProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1";
option ruby_package = "Google::Cloud::AIPlatform::V1beta1";
// Instance of a general context.
message Context {

@ -28,10 +28,13 @@ import "google/protobuf/timestamp.proto";
import "google/rpc/status.proto";
import "google/api/annotations.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
option java_multiple_files = true;
option java_outer_classname = "CustomJobProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1";
option ruby_package = "Google::Cloud::AIPlatform::V1beta1";
// Represents a job that runs custom workloads such as a Docker container or a
// Python package. A CustomJob can have multiple worker pools and each worker
@ -88,6 +91,11 @@ message CustomJob {
// then all resources created by the CustomJob will be encrypted with the
// provided encryption key.
EncryptionSpec encryption_spec = 12;
// Output only. The web access URIs for the training job.
// The keys are the node names in the training jobs, e.g. workerpool0-0.
// The values are the URIs for each node's web portal in the job.
map<string, string> web_access_uris = 16 [(google.api.field_behavior) = OUTPUT_ONLY];
}
// Represents the spec of a CustomJob.
@ -154,6 +162,10 @@ message CustomJobSpec {
type: "aiplatform.googleapis.com/Tensorboard"
}
];
// Optional. Vertex AI will enable web portal access to the containers. The portals
// can be accessed on web via the URLs given by [web_access_uris][].
bool enable_web_access = 10 [(google.api.field_behavior) = OPTIONAL];
}
// Represents the spec of a worker pool in a job.

@ -18,15 +18,17 @@ package google.cloud.aiplatform.v1beta1;
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
import "google/protobuf/struct.proto";
import "google/protobuf/timestamp.proto";
import "google/api/annotations.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
option java_multiple_files = true;
option java_outer_classname = "DataItemProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1";
option ruby_package = "Google::Cloud::AIPlatform::V1beta1";
// A piece of data in a Dataset. Could be an image, a video, a document or plain
// text.

@ -28,10 +28,13 @@ import "google/rpc/status.proto";
import "google/type/money.proto";
import "google/api/annotations.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
option java_multiple_files = true;
option java_outer_classname = "DataLabelingJobProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1";
option ruby_package = "Google::Cloud::AIPlatform::V1beta1";
// DataLabelingJob is used to trigger a human labeling job on unlabeled data
// from the following Dataset:

@ -24,10 +24,13 @@ import "google/protobuf/struct.proto";
import "google/protobuf/timestamp.proto";
import "google/api/annotations.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
option java_multiple_files = true;
option java_outer_classname = "DatasetProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1";
option ruby_package = "Google::Cloud::AIPlatform::V1beta1";
// A collection of DataItems and Annotations on them.
message Dataset {

@ -29,10 +29,13 @@ import "google/cloud/aiplatform/v1beta1/training_pipeline.proto";
import "google/longrunning/operations.proto";
import "google/protobuf/field_mask.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
option java_multiple_files = true;
option java_outer_classname = "DatasetServiceProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1";
option ruby_package = "Google::Cloud::AIPlatform::V1beta1";
service DatasetService {
option (google.api.default_host) = "aiplatform.googleapis.com";

@ -20,10 +20,13 @@ import "google/api/field_behavior.proto";
import "google/api/resource.proto";
import "google/api/annotations.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
option java_multiple_files = true;
option java_outer_classname = "DeployedIndexRefProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1";
option ruby_package = "Google::Cloud::AIPlatform::V1beta1";
// Points to a DeployedIndex.
message DeployedIndexRef {

@ -20,10 +20,13 @@ import "google/api/field_behavior.proto";
import "google/api/resource.proto";
import "google/api/annotations.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
option java_multiple_files = true;
option java_outer_classname = "DeployedModelNameProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1";
option ruby_package = "Google::Cloud::AIPlatform::V1beta1";
// Points to a DeployedModel.
message DeployedModelRef {

@ -19,10 +19,13 @@ package google.cloud.aiplatform.v1beta1;
import "google/api/field_behavior.proto";
import "google/api/annotations.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
option java_multiple_files = true;
option java_outer_classname = "EncryptionSpecProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1";
option ruby_package = "Google::Cloud::AIPlatform::V1beta1";
// Represents a customer-managed encryption key spec that can be applied to
// a top-level resource.

@ -25,10 +25,13 @@ import "google/cloud/aiplatform/v1beta1/model_deployment_monitoring_job.proto";
import "google/protobuf/timestamp.proto";
import "google/api/annotations.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
option java_multiple_files = true;
option java_outer_classname = "EndpointProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1";
option ruby_package = "Google::Cloud::AIPlatform::V1beta1";
// Models are deployed into it, and afterwards Endpoint is called to obtain
// predictions and explanations.
@ -87,6 +90,21 @@ message Endpoint {
// Endpoint and all sub-resources of this Endpoint will be secured by
// this key.
EncryptionSpec encryption_spec = 10;
// The full name of the Google Compute Engine
// [network](/compute/docs/networks-and-firewalls#networks) to which the
// Endpoint should be peered.
//
// Private services access must already be configured for the network. If left
// unspecified, the Endpoint is not peered with any network.
//
// [Format](https://cloud.google.com/compute/docs/reference/rest/v1/networks/insert):
// projects/{project}/global/networks/{network}.
// Where {project} is a project number, as in '12345', and {network} is
// network name.
string network = 13 [(google.api.resource_reference) = {
type: "compute.googleapis.com/Network"
}];
}
// A deployment of a Model. Endpoints contain one or more DeployedModels.
@ -158,4 +176,22 @@ message DeployedModel {
// receives prediction requests at a high queries per second rate (QPS).
// Estimate your costs before enabling this option.
bool enable_access_logging = 13;
// Output only. Provide paths for users to send predict/explain/health requests directly to
// the deployed model services running on Cloud via private services access.
// This field is populated if [network][google.cloud.aiplatform.v1beta1.Endpoint.network] is configured.
PrivateEndpoints private_endpoints = 14 [(google.api.field_behavior) = OUTPUT_ONLY];
}
// PrivateEndpoints is used to provide paths for users to send
// requests via private services access.
message PrivateEndpoints {
// Output only. Http(s) path to send prediction requests.
string predict_http_uri = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Http(s) path to send explain requests.
string explain_http_uri = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Http(s) path to send health check requests.
string health_http_uri = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
}

@ -25,10 +25,13 @@ import "google/cloud/aiplatform/v1beta1/operation.proto";
import "google/longrunning/operations.proto";
import "google/protobuf/field_mask.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
option java_multiple_files = true;
option java_outer_classname = "EndpointServiceProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1";
option ruby_package = "Google::Cloud::AIPlatform::V1beta1";
service EndpointService {
option (google.api.default_host) = "aiplatform.googleapis.com";

@ -23,10 +23,13 @@ import "google/cloud/aiplatform/v1beta1/featurestore_monitoring.proto";
import "google/protobuf/timestamp.proto";
import "google/api/annotations.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
option java_multiple_files = true;
option java_outer_classname = "EntityTypeProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1";
option ruby_package = "Google::Cloud::AIPlatform::V1beta1";
// An entity type is a type of object in a system that needs to be modeled and
// have stored information about. For example, driver is an entity type, and

@ -19,10 +19,13 @@ package google.cloud.aiplatform.v1beta1;
import "google/api/field_behavior.proto";
import "google/api/annotations.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
option java_multiple_files = true;
option java_outer_classname = "EnvVarProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1";
option ruby_package = "Google::Cloud::AIPlatform::V1beta1";
// Represents an environment variable present in a Container or Python Module.
message EnvVar {

@ -21,10 +21,13 @@ import "google/api/resource.proto";
import "google/protobuf/timestamp.proto";
import "google/api/annotations.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
option java_multiple_files = true;
option java_outer_classname = "EventProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1";
option ruby_package = "Google::Cloud::AIPlatform::V1beta1";
// An edge describing the relationship between an Artifact and an Execution in
// a lineage graph.

@ -23,10 +23,13 @@ import "google/protobuf/struct.proto";
import "google/protobuf/timestamp.proto";
import "google/api/annotations.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
option java_multiple_files = true;
option java_outer_classname = "ExecutionProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1";
option ruby_package = "Google::Cloud::AIPlatform::V1beta1";
// Instance of a general execution.
message Execution {
@ -51,6 +54,12 @@ message Execution {
// The Execution has failed
FAILED = 4;
// The Execution completed through Cache hit.
CACHED = 5;
// The Execution was cancelled.
CANCELLED = 6;
}
// Output only. The resource name of the Execution.

@ -22,10 +22,13 @@ import "google/cloud/aiplatform/v1beta1/io.proto";
import "google/protobuf/struct.proto";
import "google/api/annotations.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
option java_multiple_files = true;
option java_outer_classname = "ExplanationProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1";
option ruby_package = "Google::Cloud::AIPlatform::V1beta1";
// Explanation of a prediction (provided in [PredictResponse.predictions][google.cloud.aiplatform.v1beta1.PredictResponse.predictions])
// produced by the Model on a given [instance][google.cloud.aiplatform.v1beta1.ExplainRequest.instances].

@ -20,10 +20,13 @@ import "google/api/field_behavior.proto";
import "google/protobuf/struct.proto";
import "google/api/annotations.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
option java_multiple_files = true;
option java_outer_classname = "ExplanationMetadataProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1";
option ruby_package = "Google::Cloud::AIPlatform::V1beta1";
// Metadata describing the Model's input and output for explanation.
message ExplanationMetadata {

@ -23,10 +23,13 @@ import "google/cloud/aiplatform/v1beta1/featurestore_monitoring.proto";
import "google/protobuf/timestamp.proto";
import "google/api/annotations.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
option java_multiple_files = true;
option java_outer_classname = "FeatureProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1";
option ruby_package = "Google::Cloud::AIPlatform::V1beta1";
// Feature Metadata information that describes an attribute of an entity type.
// For example, apple is an entity type, and color is a feature that describes

@ -19,10 +19,13 @@ package google.cloud.aiplatform.v1beta1;
import "google/protobuf/timestamp.proto";
import "google/api/annotations.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
option java_multiple_files = true;
option java_outer_classname = "FeatureMonitoringStatsProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1";
option ruby_package = "Google::Cloud::AIPlatform::V1beta1";
// Stats and Anomaly generated at specific timestamp for specific Feature.
// The start_time and end_time are used to define the time range of the dataset

@ -19,10 +19,13 @@ package google.cloud.aiplatform.v1beta1;
import "google/api/field_behavior.proto";
import "google/api/annotations.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
option java_multiple_files = true;
option java_outer_classname = "FeatureSelectorProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1";
option ruby_package = "Google::Cloud::AIPlatform::V1beta1";
// Matcher for Features of an EntityType by Feature ID.
message IdMatcher {

@ -18,13 +18,17 @@ package google.cloud.aiplatform.v1beta1;
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
import "google/cloud/aiplatform/v1beta1/encryption_spec.proto";
import "google/protobuf/timestamp.proto";
import "google/api/annotations.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
option java_multiple_files = true;
option java_outer_classname = "FeaturestoreProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1";
option ruby_package = "Google::Cloud::AIPlatform::V1beta1";
// Featurestore configuration information on how the Featurestore is configured.
message Featurestore {

@ -19,10 +19,13 @@ package google.cloud.aiplatform.v1beta1;
import "google/protobuf/duration.proto";
import "google/api/annotations.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
option java_multiple_files = true;
option java_outer_classname = "FeaturestoreMonitoringProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1";
option ruby_package = "Google::Cloud::AIPlatform::V1beta1";
// Configuration of how features in Featurestore are monitored.
message FeaturestoreMonitoringConfig {
@ -47,6 +50,16 @@ message FeaturestoreMonitoringConfig {
// Configuration of the snapshot analysis based monitoring pipeline
// running interval. The value is rolled up to full day.
google.protobuf.Duration monitoring_interval = 2;
// Configuration of the snapshot analysis based monitoring pipeline
// running interval. The value indicates number of days.
// If both
// [FeaturestoreMonitoringConfig.SnapshotAnalysis.monitoring_interval_days][google.cloud.aiplatform.v1beta1.FeaturestoreMonitoringConfig.SnapshotAnalysis.monitoring_interval_days]
// and [FeaturestoreMonitoringConfig.SnapshotAnalysis.monitoring_interval][google.cloud.aiplatform.v1beta1.FeaturestoreMonitoringConfig.SnapshotAnalysis.monitoring_interval]
// are set when creating/updating EntityTypes/Features,
// [FeaturestoreMonitoringConfig.SnapshotAnalysis.monitoring_interval_days][google.cloud.aiplatform.v1beta1.FeaturestoreMonitoringConfig.SnapshotAnalysis.monitoring_interval_days]
// will be used.
int32 monitoring_interval_days = 3;
}
// The config for Snapshot Analysis Based Feature Monitoring.

@ -24,10 +24,13 @@ import "google/cloud/aiplatform/v1beta1/feature_selector.proto";
import "google/cloud/aiplatform/v1beta1/types.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
option java_multiple_files = true;
option java_outer_classname = "FeaturestoreOnlineServiceProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1";
option ruby_package = "Google::Cloud::AIPlatform::V1beta1";
// A service for serving online feature values.
service FeaturestoreOnlineServingService {
@ -157,12 +160,13 @@ message StreamingReadFeatureValuesRequest {
}
];
// Required. IDs of entities to read Feature values of. For example,
// for a machine learning model predicting user clicks on a website, an
// entity ID could be "user_123".
// Required. IDs of entities to read Feature values of. The maximum number of IDs is
// 100. For example, for a machine learning model predicting user clicks on a
// website, an entity ID could be "user_123".
repeated string entity_ids = 2 [(google.api.field_behavior) = REQUIRED];
// Required. Selector choosing Features of the target EntityType.
// Required. Selector choosing Features of the target EntityType. Feature IDs will be
// deduplicated.
FeatureSelector feature_selector = 3 [(google.api.field_behavior) = REQUIRED];
}
@ -208,8 +212,8 @@ message FeatureValue {
bytes bytes_value = 13;
}
// Output only. Metadata of feature value.
Metadata metadata = 14 [(google.api.field_behavior) = OUTPUT_ONLY];
// Metadata of feature value.
Metadata metadata = 14;
}
// Container for list of values.

@ -31,10 +31,13 @@ import "google/longrunning/operations.proto";
import "google/protobuf/field_mask.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
option java_multiple_files = true;
option java_outer_classname = "FeaturestoreServiceProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1";
option ruby_package = "Google::Cloud::AIPlatform::V1beta1";
// The service that handles CRUD and List for resources for Featurestore.
service FeaturestoreService {
@ -518,6 +521,13 @@ message ImportFeatureValuesResponse {
// Request message for [FeaturestoreService.BatchReadFeatureValues][google.cloud.aiplatform.v1beta1.FeaturestoreService.BatchReadFeatureValues].
// (- Next Id: 6 -)
message BatchReadFeatureValuesRequest {
// Describe pass-through fields in read_instance source.
message PassThroughField {
// Required. The name of the field in the CSV header or the name of the column in
// BigQuery table. The naming restriction is the same as [Feature.name][google.cloud.aiplatform.v1beta1.Feature.name].
string field_name = 1 [(google.api.field_behavior) = REQUIRED];
}
// Selects Features of an EntityType to read values of and specifies read
// settings.
message EntityTypeSpec {
@ -559,6 +569,9 @@ message BatchReadFeatureValuesRequest {
// Values in the timestamp column must use the RFC 3339 format, e.g.
// `2012-07-30T10:43:17.123Z`.
CsvSource csv_read_instances = 3;
// Similar to csv_read_instances, but from BigQuery source.
BigQuerySource bigquery_read_instances = 5;
}
// Required. The resource name of the Featurestore from which to query Feature values.
@ -574,6 +587,15 @@ message BatchReadFeatureValuesRequest {
// Required. Specifies output location and format.
FeatureValueDestination destination = 4 [(google.api.field_behavior) = REQUIRED];
// When not empty, the specified fields in the *_read_instances source will be
// joined as-is in the output, in addition to those fields from the
// Featurestore Entity.
//
// For BigQuery source, the type of the pass-through values will be
// automatically inferred. For CSV source, the pass-through values will be
// passed as opaque bytes.
repeated PassThroughField pass_through_fields = 8;
// Required. Specifies EntityType grouping Features to read values of and settings.
// Each EntityType referenced in
// [BatchReadFeatureValuesRequest.entity_type_specs] must have a column

@ -26,10 +26,13 @@ import "google/protobuf/timestamp.proto";
import "google/rpc/status.proto";
import "google/api/annotations.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
option java_multiple_files = true;
option java_outer_classname = "HyperparameterTuningJobProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1";
option ruby_package = "Google::Cloud::AIPlatform::V1beta1";
// Represents a HyperparameterTuningJob. A HyperparameterTuningJob
// has a Study specification and multiple CustomJobs with identical

@ -23,10 +23,13 @@ import "google/protobuf/struct.proto";
import "google/protobuf/timestamp.proto";
import "google/api/annotations.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
option java_multiple_files = true;
option java_outer_classname = "IndexProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1";
option ruby_package = "Google::Cloud::AIPlatform::V1beta1";
// A representation of a collection of database items organized in a way that
// allows for approximate nearest neighbor (a.k.a ANN) algorithms search.

@ -23,10 +23,13 @@ import "google/cloud/aiplatform/v1beta1/machine_resources.proto";
import "google/protobuf/timestamp.proto";
import "google/api/annotations.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
option java_multiple_files = true;
option java_outer_classname = "IndexEndpointProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1";
option ruby_package = "Google::Cloud::AIPlatform::V1beta1";
// Indexes are deployed into it. An IndexEndpoint can have multiple
// DeployedIndexes.
@ -157,6 +160,18 @@ message DeployedIndex {
// Optional. If set, the authentication is enabled for the private endpoint.
DeployedIndexAuthConfig deployed_index_auth_config = 9 [(google.api.field_behavior) = OPTIONAL];
// Optional. A list of reserved ip ranges under the VPC network that can be
// used for this DeployedIndex.
//
// If set, we will deploy the index within the provided ip ranges. Otherwise,
// the index might be deployed to any ip ranges under the provided VPC
// network.
//
// The value sohuld be the name of the address
// (https://cloud.google.com/compute/docs/reference/rest/v1/addresses)
// Example: 'vertex-ai-ip-range'.
repeated string reserved_ip_ranges = 10 [(google.api.field_behavior) = OPTIONAL];
}
// Used to set up the auth on the DeployedIndex's private endpoint.

@ -25,10 +25,13 @@ import "google/cloud/aiplatform/v1beta1/operation.proto";
import "google/longrunning/operations.proto";
import "google/protobuf/field_mask.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
option java_multiple_files = true;
option java_outer_classname = "IndexEndpointServiceProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1";
option ruby_package = "Google::Cloud::AIPlatform::V1beta1";
// A service for managing Vertex AI's IndexEndpoints.
service IndexEndpointService {
@ -252,6 +255,9 @@ message DeployIndexResponse {
message DeployIndexOperationMetadata {
// The operation generic information.
GenericOperationMetadata generic_metadata = 1;
// The unique index id specified by user
string deployed_index_id = 2;
}
// Request message for [IndexEndpointService.UndeployIndex][google.cloud.aiplatform.v1beta1.IndexEndpointService.UndeployIndex].

@ -25,10 +25,13 @@ import "google/cloud/aiplatform/v1beta1/operation.proto";
import "google/longrunning/operations.proto";
import "google/protobuf/field_mask.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
option java_multiple_files = true;
option java_outer_classname = "IndexServiceProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1";
option ruby_package = "Google::Cloud::AIPlatform::V1beta1";
// A service for creating and managing Vertex AI's Index resources.
service IndexService {

@ -19,10 +19,13 @@ package google.cloud.aiplatform.v1beta1;
import "google/api/field_behavior.proto";
import "google/api/annotations.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
option java_multiple_files = true;
option java_outer_classname = "IoProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1";
option ruby_package = "Google::Cloud::AIPlatform::V1beta1";
// The storage details for Avro input content.
message AvroSource {
@ -72,7 +75,8 @@ message BigQueryDestination {
// Accepted forms:
//
// * BigQuery path. For example:
// `bq://projectId` or `bq://projectId.bqDatasetId.bqTableId`.
// `bq://projectId` or `bq://projectId.bqDatasetId` or
// `bq://projectId.bqDatasetId.bqTableId`.
string output_uri = 1 [(google.api.field_behavior) = REQUIRED];
}

@ -31,10 +31,13 @@ import "google/protobuf/empty.proto";
import "google/protobuf/field_mask.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
option java_multiple_files = true;
option java_outer_classname = "JobServiceProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1";
option ruby_package = "Google::Cloud::AIPlatform::V1beta1";
// A service for creating and managing Vertex AI's jobs.
service JobService {

@ -18,10 +18,13 @@ package google.cloud.aiplatform.v1beta1;
import "google/api/annotations.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
option java_multiple_files = true;
option java_outer_classname = "JobStateProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1";
option ruby_package = "Google::Cloud::AIPlatform::V1beta1";
// Describes the state of a job.
enum JobState {

@ -22,10 +22,13 @@ import "google/cloud/aiplatform/v1beta1/event.proto";
import "google/cloud/aiplatform/v1beta1/execution.proto";
import "google/api/annotations.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
option java_multiple_files = true;
option java_outer_classname = "LineageSubgraphProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1";
option ruby_package = "Google::Cloud::AIPlatform::V1beta1";
// A subgraph of the overall lineage graph. Event edges connect Artifact and
// Execution nodes.

@ -20,10 +20,13 @@ import "google/api/field_behavior.proto";
import "google/cloud/aiplatform/v1beta1/accelerator_type.proto";
import "google/api/annotations.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
option java_multiple_files = true;
option java_outer_classname = "MachineResourcesProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1";
option ruby_package = "Google::Cloud::AIPlatform::V1beta1";
// Specification of a single machine.
message MachineSpec {
@ -58,12 +61,11 @@ message DedicatedResources {
];
// Required. Immutable. The minimum number of machine replicas this DeployedModel will be always
// deployed on. If traffic against it increases, it may dynamically be
// deployed on. This value must be greater than or equal to 1.
//
// If traffic against the DeployedModel increases, it may dynamically be
// deployed onto more replicas, and as traffic decreases, some of these extra
// replicas may be freed.
// Note: if [machine_spec.accelerator_count][google.cloud.aiplatform.v1beta1.MachineSpec.accelerator_count] is
// above 0, currently the model will be always deployed precisely on
// [min_replica_count][google.cloud.aiplatform.v1beta1.DedicatedResources.min_replica_count].
int32 min_replica_count = 2 [
(google.api.field_behavior) = REQUIRED,
(google.api.field_behavior) = IMMUTABLE

@ -19,10 +19,13 @@ package google.cloud.aiplatform.v1beta1;
import "google/api/field_behavior.proto";
import "google/api/annotations.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
option java_multiple_files = true;
option java_outer_classname = "ManualBatchTuningParametersProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1";
option ruby_package = "Google::Cloud::AIPlatform::V1beta1";
// Manual batch tuning parameters.
message ManualBatchTuningParameters {

@ -21,10 +21,13 @@ import "google/api/resource.proto";
import "google/protobuf/timestamp.proto";
import "google/api/annotations.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
option java_multiple_files = true;
option java_outer_classname = "MetadataSchemaProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1";
option ruby_package = "Google::Cloud::AIPlatform::V1beta1";
// Instance of a general MetadataSchema.
message MetadataSchema {

@ -31,10 +31,13 @@ import "google/cloud/aiplatform/v1beta1/operation.proto";
import "google/longrunning/operations.proto";
import "google/protobuf/field_mask.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
option java_multiple_files = true;
option java_outer_classname = "MetadataServiceProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1";
option ruby_package = "Google::Cloud::AIPlatform::V1beta1";
// Service for reading and writing metadata entries.
service MetadataService {
@ -116,6 +119,31 @@ service MetadataService {
option (google.api.method_signature) = "artifact,update_mask";
}
// Deletes an Artifact.
rpc DeleteArtifact(DeleteArtifactRequest) returns (google.longrunning.Operation) {
option (google.api.http) = {
delete: "/v1beta1/{name=projects/*/locations/*/metadataStores/*/artifacts/*}"
};
option (google.api.method_signature) = "name";
option (google.longrunning.operation_info) = {
response_type: "google.protobuf.Empty"
metadata_type: "DeleteOperationMetadata"
};
}
// Purges Artifacts.
rpc PurgeArtifacts(PurgeArtifactsRequest) returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1beta1/{parent=projects/*/locations/*/metadataStores/*}/artifacts:purge"
body: "*"
};
option (google.api.method_signature) = "parent";
option (google.longrunning.operation_info) = {
response_type: "PurgeArtifactsResponse"
metadata_type: "PurgeArtifactsMetadata"
};
}
// Creates a Context associated with a MetadataStore.
rpc CreateContext(CreateContextRequest) returns (Context) {
option (google.api.http) = {
@ -162,6 +190,19 @@ service MetadataService {
};
}
// Purges Contexts.
rpc PurgeContexts(PurgeContextsRequest) returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1beta1/{parent=projects/*/locations/*/metadataStores/*}/contexts:purge"
body: "*"
};
option (google.api.method_signature) = "parent";
option (google.longrunning.operation_info) = {
response_type: "PurgeContextsResponse"
metadata_type: "PurgeContextsMetadata"
};
}
// Adds a set of Artifacts and Executions to a Context. If any of the
// Artifacts or Executions have already been added to a Context, they are
// simply skipped.
@ -229,6 +270,31 @@ service MetadataService {
option (google.api.method_signature) = "execution,update_mask";
}
// Deletes an Execution.
rpc DeleteExecution(DeleteExecutionRequest) returns (google.longrunning.Operation) {
option (google.api.http) = {
delete: "/v1beta1/{name=projects/*/locations/*/metadataStores/*/executions/*}"
};
option (google.api.method_signature) = "name";
option (google.longrunning.operation_info) = {
response_type: "google.protobuf.Empty"
metadata_type: "DeleteOperationMetadata"
};
}
// Purges Executions.
rpc PurgeExecutions(PurgeExecutionsRequest) returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1beta1/{parent=projects/*/locations/*/metadataStores/*}/executions:purge"
body: "*"
};
option (google.api.method_signature) = "parent";
option (google.longrunning.operation_info) = {
response_type: "PurgeExecutionsResponse"
metadata_type: "PurgeExecutionsMetadata"
};
}
// Adds Events to the specified Execution. An Event indicates whether an
// Artifact was used as an input or output for an Execution. If an Event
// already exists between the Execution and the Artifact, the Event is
@ -514,6 +580,66 @@ message UpdateArtifactRequest {
bool allow_missing = 3;
}
// Request message for [MetadataService.DeleteArtifact][google.cloud.aiplatform.v1beta1.MetadataService.DeleteArtifact].
message DeleteArtifactRequest {
// Required. The resource name of the Artifact to delete.
// Format:
// projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "aiplatform.googleapis.com/Artifact"
}
];
// Optional. The etag of the Artifact to delete.
// If this is provided, it must match the server's etag. Otherwise, the
// request will fail with a FAILED_PRECONDITION.
string etag = 2 [(google.api.field_behavior) = OPTIONAL];
}
// Request message for [MetadataService.PurgeArtifacts][google.cloud.aiplatform.v1beta1.MetadataService.PurgeArtifacts].
message PurgeArtifactsRequest {
// Required. The metadata store to purge Artifacts from.
// Format:
// projects/{project}/locations/{location}/metadataStores/{metadatastore}
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
child_type: "aiplatform.googleapis.com/Artifact"
}
];
// Required. A required filter matching the Artifacts to be purged.
// E.g., update_time <= 2020-11-19T11:30:00-04:00.
string filter = 2 [(google.api.field_behavior) = REQUIRED];
// Optional. Flag to indicate to actually perform the purge.
// If `force` is set to false, the method will return a sample of
// Artifact names that would be deleted.
bool force = 3 [(google.api.field_behavior) = OPTIONAL];
}
// Response message for [MetadataService.PurgeArtifacts][google.cloud.aiplatform.v1beta1.MetadataService.PurgeArtifacts].
message PurgeArtifactsResponse {
// The number of Artifacts that this request deleted (or, if `force` is false,
// the number of Artifacts that will be deleted). This can be an estimate.
int64 purge_count = 1;
// A sample of the Artifact names that will be deleted.
// Only populated if `force` is set to false. The maximum number of samples is
// 100 (it is possible to return fewer).
repeated string purge_sample = 2 [(google.api.resource_reference) = {
type: "aiplatform.googleapis.com/Artifact"
}];
}
// Details of operations that perform [MetadataService.PurgeArtifacts][google.cloud.aiplatform.v1beta1.MetadataService.PurgeArtifacts].
message PurgeArtifactsMetadata {
// Operation metadata for purging Artifacts.
GenericOperationMetadata generic_metadata = 1;
}
// Request message for [MetadataService.CreateContext][google.cloud.aiplatform.v1beta1.MetadataService.CreateContext].
message CreateContextRequest {
// Required. The resource name of the MetadataStore where the Context should be
@ -641,7 +767,7 @@ message UpdateContextRequest {
// Request message for [MetadataService.DeleteContext][google.cloud.aiplatform.v1beta1.MetadataService.DeleteContext].
message DeleteContextRequest {
// Required. The resource name of the Context to retrieve.
// Required. The resource name of the Context to delete.
// Format:
// projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}
string name = 1 [
@ -651,11 +777,56 @@ message DeleteContextRequest {
}
];
// If set to true, any child resources of this Context will be deleted.
// (Otherwise, the request will fail with a FAILED_PRECONDITION error if the
// Context has any child resources, such as another Context, Artifact, or
// Execution).
// The force deletion semantics is still undefined.
// Users should not use this field.
bool force = 2;
// Optional. The etag of the Context to delete.
// If this is provided, it must match the server's etag. Otherwise, the
// request will fail with a FAILED_PRECONDITION.
string etag = 3 [(google.api.field_behavior) = OPTIONAL];
}
// Request message for [MetadataService.PurgeContexts][google.cloud.aiplatform.v1beta1.MetadataService.PurgeContexts].
message PurgeContextsRequest {
// Required. The metadata store to purge Contexts from.
// Format:
// projects/{project}/locations/{location}/metadataStores/{metadatastore}
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
child_type: "aiplatform.googleapis.com/Context"
}
];
// Required. A required filter matching the Contexts to be purged.
// E.g., update_time <= 2020-11-19T11:30:00-04:00.
string filter = 2 [(google.api.field_behavior) = REQUIRED];
// Optional. Flag to indicate to actually perform the purge.
// If `force` is set to false, the method will return a sample of
// Context names that would be deleted.
bool force = 3 [(google.api.field_behavior) = OPTIONAL];
}
// Response message for [MetadataService.PurgeContexts][google.cloud.aiplatform.v1beta1.MetadataService.PurgeContexts].
message PurgeContextsResponse {
// The number of Contexts that this request deleted (or, if `force` is false,
// the number of Contexts that will be deleted). This can be an estimate.
int64 purge_count = 1;
// A sample of the Context names that will be deleted.
// Only populated if `force` is set to false. The maximum number of samples is
// 100 (it is possible to return fewer).
repeated string purge_sample = 2 [(google.api.resource_reference) = {
type: "aiplatform.googleapis.com/Context"
}];
}
// Details of operations that perform [MetadataService.PurgeContexts][google.cloud.aiplatform.v1beta1.MetadataService.PurgeContexts].
message PurgeContextsMetadata {
// Operation metadata for purging Contexts.
GenericOperationMetadata generic_metadata = 1;
}
// Request message for [MetadataService.AddContextArtifactsAndExecutions][google.cloud.aiplatform.v1beta1.MetadataService.AddContextArtifactsAndExecutions].
@ -857,6 +1028,67 @@ message UpdateExecutionRequest {
bool allow_missing = 3;
}
// Request message for [MetadataService.DeleteExecution][google.cloud.aiplatform.v1beta1.MetadataService.DeleteExecution].
message DeleteExecutionRequest {
// Required. The resource name of the Execution to delete.
// Format:
// projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "aiplatform.googleapis.com/Execution"
}
];
// Optional. The etag of the Execution to delete.
// If this is provided, it must match the server's etag. Otherwise, the
// request will fail with a FAILED_PRECONDITION.
string etag = 2 [(google.api.field_behavior) = OPTIONAL];
}
// Request message for [MetadataService.PurgeExecutions][google.cloud.aiplatform.v1beta1.MetadataService.PurgeExecutions].
message PurgeExecutionsRequest {
// Required. The metadata store to purge Executions from.
// Format:
// projects/{project}/locations/{location}/metadataStores/{metadatastore}
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
child_type: "aiplatform.googleapis.com/Execution"
}
];
// Required. A required filter matching the Executions to be purged.
// E.g., update_time <= 2020-11-19T11:30:00-04:00.
string filter = 2 [(google.api.field_behavior) = REQUIRED];
// Optional. Flag to indicate to actually perform the purge.
// If `force` is set to false, the method will return a sample of
// Execution names that would be deleted.
bool force = 3 [(google.api.field_behavior) = OPTIONAL];
}
// Response message for [MetadataService.PurgeExecutions][google.cloud.aiplatform.v1beta1.MetadataService.PurgeExecutions].
message PurgeExecutionsResponse {
// The number of Executions that this request deleted (or, if `force` is
// false, the number of Executions that will be deleted). This can be an
// estimate.
int64 purge_count = 1;
// A sample of the Execution names that will be deleted.
// Only populated if `force` is set to false. The maximum number of samples is
// 100 (it is possible to return fewer).
repeated string purge_sample = 2 [(google.api.resource_reference) = {
type: "aiplatform.googleapis.com/Execution"
}];
}
// Details of operations that perform [MetadataService.PurgeExecutions][google.cloud.aiplatform.v1beta1.MetadataService.PurgeExecutions].
message PurgeExecutionsMetadata {
// Operation metadata for purging Executions.
GenericOperationMetadata generic_metadata = 1;
}
// Request message for [MetadataService.AddExecutionEvents][google.cloud.aiplatform.v1beta1.MetadataService.AddExecutionEvents].
message AddExecutionEventsRequest {
// Required. The resource name of the Execution that the Events connect

@ -22,10 +22,13 @@ import "google/cloud/aiplatform/v1beta1/encryption_spec.proto";
import "google/protobuf/timestamp.proto";
import "google/api/annotations.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
option java_multiple_files = true;
option java_outer_classname = "MetadataProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1";
option ruby_package = "Google::Cloud::AIPlatform::V1beta1";
// Instance of a metadata store. Contains a set of metadata that can be
// queried.

@ -21,10 +21,13 @@ import "google/api/resource.proto";
import "google/protobuf/timestamp.proto";
import "google/api/annotations.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
option java_multiple_files = true;
option java_outer_classname = "MigratableResourceProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1";
option ruby_package = "Google::Cloud::AIPlatform::V1beta1";
option (google.api.resource_definition) = {
type: "ml.googleapis.com/Version"
pattern: "projects/{project}/models/{model}/versions/{version}"

@ -27,10 +27,13 @@ import "google/cloud/aiplatform/v1beta1/operation.proto";
import "google/longrunning/operations.proto";
import "google/rpc/status.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
option java_multiple_files = true;
option java_outer_classname = "MigrationServiceProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1";
option ruby_package = "Google::Cloud::AIPlatform::V1beta1";
// A service that migrates resources from automl.googleapis.com,
// datalabeling.googleapis.com and ml.googleapis.com to Vertex AI.

@ -27,10 +27,13 @@ import "google/protobuf/struct.proto";
import "google/protobuf/timestamp.proto";
import "google/api/annotations.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
option java_multiple_files = true;
option java_outer_classname = "ModelProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1";
option ruby_package = "Google::Cloud::AIPlatform::V1beta1";
// A trained machine learning Model.
message Model {

@ -18,6 +18,7 @@ package google.cloud.aiplatform.v1beta1;
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
import "google/cloud/aiplatform/v1beta1/encryption_spec.proto";
import "google/cloud/aiplatform/v1beta1/feature_monitoring_stats.proto";
import "google/cloud/aiplatform/v1beta1/io.proto";
import "google/cloud/aiplatform/v1beta1/job_state.proto";
@ -27,10 +28,13 @@ import "google/protobuf/struct.proto";
import "google/protobuf/timestamp.proto";
import "google/api/annotations.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
option java_multiple_files = true;
option java_outer_classname = "ModelDeploymentMonitoringJobProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1";
option ruby_package = "Google::Cloud::AIPlatform::V1beta1";
// The Model Monitoring Objective types.
enum ModelDeploymentMonitoringObjectiveType {

@ -23,10 +23,13 @@ import "google/protobuf/struct.proto";
import "google/protobuf/timestamp.proto";
import "google/api/annotations.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
option java_multiple_files = true;
option java_outer_classname = "ModelEvaluationProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1";
option ruby_package = "Google::Cloud::AIPlatform::V1beta1";
// A collection of metrics calculated by comparing Model's predictions on all of
// the test data against annotations from the test data.

@ -22,10 +22,13 @@ import "google/protobuf/struct.proto";
import "google/protobuf/timestamp.proto";
import "google/api/annotations.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
option java_multiple_files = true;
option java_outer_classname = "ModelEvaluationSliceProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1";
option ruby_package = "Google::Cloud::AIPlatform::V1beta1";
// A collection of metrics calculated by comparing Model's predictions on a
// slice of the test data against ground truth annotations.

@ -20,10 +20,13 @@ import "google/api/resource.proto";
import "google/cloud/aiplatform/v1beta1/io.proto";
import "google/api/annotations.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
option java_multiple_files = true;
option java_outer_classname = "ModelMonitoringProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1";
option ruby_package = "Google::Cloud::AIPlatform::V1beta1";
// Next ID: 6
message ModelMonitoringObjectiveConfig {
@ -73,6 +76,11 @@ message ModelMonitoringObjectiveConfig {
// feature. The threshold here is against feature distribution distance
// between the training and prediction feature.
map<string, ThresholdConfig> skew_thresholds = 1;
// Key is the feature name and value is the threshold. The threshold here is
// against attribution score distance between the training and prediction
// feature.
map<string, ThresholdConfig> attribution_score_skew_thresholds = 2;
}
// The config for Prediction data drift detection.
@ -82,6 +90,52 @@ message ModelMonitoringObjectiveConfig {
// feature. The threshold here is against feature distribution distance
// between different time windws.
map<string, ThresholdConfig> drift_thresholds = 1;
// Key is the feature name and value is the threshold. The threshold here is
// against attribution score distance between different time windows.
map<string, ThresholdConfig> attribution_score_drift_thresholds = 2;
}
// The config for integrated with Explainable AI. Only applicable if the Model
// has explanation_spec populated.
message ExplanationConfig {
// Output from [BatchPredictionJob][google.cloud.aiplatform.v1beta1.BatchPredictionJob] for Model Monitoring baseline dataset,
// which can be used to generate baseline attribution scores.
message ExplanationBaseline {
// The storage format of the predictions generated BatchPrediction job.
enum PredictionFormat {
// Should not be set.
PREDICTION_FORMAT_UNSPECIFIED = 0;
// Predictions are in JSONL files, consistent from the definition here
// (http://shortn/_4bS0hL7ofb).
JSONL = 2;
// Predictions are in BigQuery.
BIGQUERY = 3;
}
// The configuration specifying of BatchExplain job output. This can be
// used to generate the baseline of feature attribution scores.
oneof destination {
// Cloud Storage location for BatchExplain output.
GcsDestination gcs = 2;
// BigQuery location for BatchExplain output.
BigQueryDestination bigquery = 3;
}
// The storage format of the predictions generated BatchPrediction job.
PredictionFormat prediction_format = 1;
}
// If want to analyze the Explainable AI feature attribute scores or not.
// If set to true, Vertex AI will log the feature attributions from
// explain response and do the skew/drift detection for them.
bool enable_feature_attributes = 1;
// Predictions generated by the BatchPredictionJob using baseline dataset.
ExplanationBaseline explanation_baseline = 2;
}
// Training dataset for models. This field has to be set only if
@ -93,6 +147,9 @@ message ModelMonitoringObjectiveConfig {
// The config for drift of prediction data.
PredictionDriftDetectionConfig prediction_drift_detection_config = 3;
// The config for integrated with Explainable AI.
ExplanationConfig explanation_config = 5;
}
// Next ID: 2

@ -28,10 +28,13 @@ import "google/cloud/aiplatform/v1beta1/operation.proto";
import "google/longrunning/operations.proto";
import "google/protobuf/field_mask.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
option java_multiple_files = true;
option java_outer_classname = "ModelServiceProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1";
option ruby_package = "Google::Cloud::AIPlatform::V1beta1";
// A service for managing Vertex AI's machine learning Models.
service ModelService {

@ -21,10 +21,13 @@ import "google/protobuf/timestamp.proto";
import "google/rpc/status.proto";
import "google/api/annotations.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
option java_multiple_files = true;
option java_outer_classname = "OperationProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1";
option ruby_package = "Google::Cloud::AIPlatform::V1beta1";
// Generic Metadata shared by all operations.
message GenericOperationMetadata {

@ -29,10 +29,13 @@ import "google/protobuf/timestamp.proto";
import "google/rpc/status.proto";
import "google/api/annotations.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
option java_multiple_files = true;
option java_outer_classname = "Pipeline";
option java_package = "com.google.cloud.aiplatform.v1beta1";
option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1";
option ruby_package = "Google::Cloud::AIPlatform::V1beta1";
option (google.api.resource_definition) = {
type: "compute.googleapis.com/Network"
pattern: "projects/{project}/global/networks/{network}"

@ -26,10 +26,13 @@ import "google/longrunning/operations.proto";
import "google/protobuf/empty.proto";
import "google/protobuf/field_mask.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
option java_multiple_files = true;
option java_outer_classname = "PipelineServiceProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1";
option ruby_package = "Google::Cloud::AIPlatform::V1beta1";
// A service for creating and managing Vertex AI's pipelines. This includes both
// `TrainingPipeline` resources (used for AutoML and custom training) and
@ -189,22 +192,32 @@ message ListTrainingPipelinesRequest {
}
];
// The standard list filter.
// Supported fields:
//
// * `display_name` supports = and !=.
//
// * `state` supports = and !=.
// Lists the PipelineJobs that match the filter expression. The following
// fields are supported:
//
// Some examples of using the filter are:
// * `pipeline_name`: Supports `=` and `!=` comparisons.
// * `create_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons.
// Values must be in RFC 3339 format.
// * `update_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons.
// Values must be in RFC 3339 format.
// * `end_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons.
// Values must be in RFC 3339 format.
// * `labels`: Supports key-value equality and key presence.
//
// * `state="PIPELINE_STATE_SUCCEEDED" AND display_name="my_pipeline"`
// Filter expressions can be combined together using logical operators
// (`AND` & `OR`).
// For example: `pipeline_name="test" AND create_time>"2020-05-18T13:30:00Z"`.
//
// * `state="PIPELINE_STATE_RUNNING" OR display_name="my_pipeline"`
// The syntax to define filter expression is based on
// https://google.aip.dev/160.
//
// * `NOT display_name="my_pipeline"`
// Examples:
//
// * `state="PIPELINE_STATE_FAILED"`
// * `create_time>"2021-05-18T00:00:00Z" OR
// update_time>"2020-05-18T00:00:00Z"` PipelineJobs created or updated
// after 2020-05-18 00:00:00 UTC.
// * `labels.env = "prod"`
// PipelineJobs with label "env" set to "prod".
string filter = 2;
// The standard list page size.

@ -18,10 +18,13 @@ package google.cloud.aiplatform.v1beta1;
import "google/api/annotations.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
option java_multiple_files = true;
option java_outer_classname = "PipelineStateProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1";
option ruby_package = "Google::Cloud::AIPlatform::V1beta1";
// Describes the state of a pipeline.
enum PipelineState {

@ -19,14 +19,18 @@ package google.cloud.aiplatform.v1beta1;
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
import "google/api/httpbody.proto";
import "google/api/resource.proto";
import "google/cloud/aiplatform/v1beta1/explanation.proto";
import "google/protobuf/struct.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
option java_multiple_files = true;
option java_outer_classname = "PredictionServiceProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1";
option ruby_package = "Google::Cloud::AIPlatform::V1beta1";
// A service for online predictions and explanations.
service PredictionService {

@ -20,10 +20,13 @@ import "google/api/field_behavior.proto";
import "google/api/resource.proto";
import "google/api/annotations.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
option java_multiple_files = true;
option java_outer_classname = "SpecialistPoolProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1";
option ruby_package = "Google::Cloud::AIPlatform::V1beta1";
// SpecialistPool represents customers' own workforce to work on their data
// labeling jobs. It includes a group of specialist managers who are responsible

@ -25,10 +25,13 @@ import "google/cloud/aiplatform/v1beta1/specialist_pool.proto";
import "google/longrunning/operations.proto";
import "google/protobuf/field_mask.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
option java_multiple_files = true;
option java_outer_classname = "SpecialistPoolServiceProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1";
option ruby_package = "Google::Cloud::AIPlatform::V1beta1";
// A service for creating and managing Customer SpecialistPools.
// When customers start Data Labeling jobs, they can reuse/create Specialist

@ -21,13 +21,15 @@ import "google/api/resource.proto";
import "google/protobuf/duration.proto";
import "google/protobuf/struct.proto";
import "google/protobuf/timestamp.proto";
import "google/protobuf/wrappers.proto";
import "google/api/annotations.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
option java_multiple_files = true;
option java_outer_classname = "StudyProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1";
option ruby_package = "Google::Cloud::AIPlatform::V1beta1";
// A message representing a Study.
message Study {
@ -168,6 +170,11 @@ message Trial {
type: "aiplatform.googleapis.com/CustomJob"
}
];
// Output only. The web access URIs for the training job.
// The keys are the node names in the training jobs, e.g. workerpool0-0.
// The values are the URIs for each node's web portal in the job.
map<string, string> web_access_uris = 12 [(google.api.field_behavior) = OUTPUT_ONLY];
}
// Represents specification of a Study.
@ -203,6 +210,14 @@ message StudySpec {
// Required. Inclusive maximum value of the parameter.
double max_value = 2 [(google.api.field_behavior) = REQUIRED];
// A default value for a `DOUBLE` parameter that is assumed to be a
// relatively good starting point. Unset value signals that there is no
// offered starting point.
//
// Currently only supported by the Vizier service. Not supported by
// HyperparamterTuningJob or TrainingPipeline.
optional double default_value = 4;
}
// Value specification for a parameter in `INTEGER` type.
@ -212,12 +227,28 @@ message StudySpec {
// Required. Inclusive maximum value of the parameter.
int64 max_value = 2 [(google.api.field_behavior) = REQUIRED];
// A default value for an `INTEGER` parameter that is assumed to be a
// relatively good starting point. Unset value signals that there is no
// offered starting point.
//
// Currently only supported by the Vizier service. Not supported by
// HyperparamterTuningJob or TrainingPipeline.
optional int64 default_value = 4;
}
// Value specification for a parameter in `CATEGORICAL` type.
message CategoricalValueSpec {
// Required. The list of possible categories.
repeated string values = 1 [(google.api.field_behavior) = REQUIRED];
// A default value for a `CATEGORICAL` parameter that is assumed to be a
// relatively good starting point. Unset value signals that there is no
// offered starting point.
//
// Currently only supported by the Vizier service. Not supported by
// HyperparamterTuningJob or TrainingPipeline.
optional string default_value = 3;
}
// Value specification for a parameter in `DISCRETE` type.
@ -227,6 +258,15 @@ message StudySpec {
// For instance, this parameter might have possible settings of 1.5, 2.5,
// and 4.0. This list should not contain more than 1,000 values.
repeated double values = 1 [(google.api.field_behavior) = REQUIRED];
// A default value for a `DISCRETE` parameter that is assumed to be a
// relatively good starting point. Unset value signals that there is no
// offered starting point. It automatically rounds to the
// nearest feasible discrete point.
//
// Currently only supported by the Vizier service. Not supported by
// HyperparamterTuningJob or TrainingPipeline.
optional double default_value = 3;
}
// Represents a parameter spec with condition from its parent parameter.

@ -22,10 +22,13 @@ import "google/cloud/aiplatform/v1beta1/encryption_spec.proto";
import "google/protobuf/timestamp.proto";
import "google/api/annotations.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
option java_multiple_files = true;
option java_outer_classname = "TensorboardProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1";
option ruby_package = "Google::Cloud::AIPlatform::V1beta1";
// Tensorboard is a physical database that stores users' training metrics.
// A default Tensorboard is provided in each region of a GCP project.

@ -21,10 +21,13 @@ import "google/cloud/aiplatform/v1beta1/tensorboard_time_series.proto";
import "google/protobuf/timestamp.proto";
import "google/api/annotations.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
option java_multiple_files = true;
option java_outer_classname = "TensorboardDataProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1";
option ruby_package = "Google::Cloud::AIPlatform::V1beta1";
// All the data stored in a TensorboardTimeSeries.
message TimeSeriesData {

@ -21,10 +21,13 @@ import "google/api/resource.proto";
import "google/protobuf/timestamp.proto";
import "google/api/annotations.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
option java_multiple_files = true;
option java_outer_classname = "TensorboardExperimentProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1";
option ruby_package = "Google::Cloud::AIPlatform::V1beta1";
// A TensorboardExperiment is a group of TensorboardRuns, that are typically the
// results of a training job run, in a Tensorboard.

@ -21,10 +21,13 @@ import "google/api/resource.proto";
import "google/protobuf/timestamp.proto";
import "google/api/annotations.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
option java_multiple_files = true;
option java_outer_classname = "TensorboardRunProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1";
option ruby_package = "Google::Cloud::AIPlatform::V1beta1";
// TensorboardRun maps to a specific execution of a training job with a given
// set of hyperparameter values, model definition, dataset, etc

@ -29,10 +29,13 @@ import "google/cloud/aiplatform/v1beta1/tensorboard_time_series.proto";
import "google/longrunning/operations.proto";
import "google/protobuf/field_mask.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
option java_multiple_files = true;
option java_outer_classname = "TensorboardServiceProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1";
option ruby_package = "Google::Cloud::AIPlatform::V1beta1";
// TensorboardService
service TensorboardService {

@ -21,10 +21,13 @@ import "google/api/resource.proto";
import "google/protobuf/timestamp.proto";
import "google/api/annotations.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
option java_multiple_files = true;
option java_outer_classname = "TensorboardTimeSeriesProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1";
option ruby_package = "Google::Cloud::AIPlatform::V1beta1";
// TensorboardTimeSeries maps to times series produced in training runs
message TensorboardTimeSeries {

@ -29,10 +29,13 @@ import "google/protobuf/timestamp.proto";
import "google/rpc/status.proto";
import "google/api/annotations.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
option java_multiple_files = true;
option java_outer_classname = "TrainingPipelineProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1";
option ruby_package = "Google::Cloud::AIPlatform::V1beta1";
// The TrainingPipeline orchestrates tasks associated with training a Model. It
// always executes the training task, and optionally may also

@ -18,10 +18,13 @@ package google.cloud.aiplatform.v1beta1;
import "google/api/annotations.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
option java_multiple_files = true;
option java_outer_classname = "TypesProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1";
option ruby_package = "Google::Cloud::AIPlatform::V1beta1";
// A list of boolean values.
message BoolArray {

@ -18,10 +18,13 @@ package google.cloud.aiplatform.v1beta1;
import "google/api/annotations.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
option java_multiple_files = true;
option java_outer_classname = "UserActionReferenceProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1";
option ruby_package = "Google::Cloud::AIPlatform::V1beta1";
// References an API call. It contains more information about long running
// operation and Jobs that are triggered by the API call.

@ -18,10 +18,13 @@ package google.cloud.aiplatform.v1beta1;
import "google/api/annotations.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
option java_multiple_files = true;
option java_outer_classname = "ValueProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1";
option ruby_package = "Google::Cloud::AIPlatform::V1beta1";
// Value is the value of the field.
message Value {

@ -26,10 +26,13 @@ import "google/longrunning/operations.proto";
import "google/protobuf/empty.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
option java_multiple_files = true;
option java_outer_classname = "VizierServiceProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1";
option ruby_package = "Google::Cloud::AIPlatform::V1beta1";
// Vertex Vizier API.
//

Loading…
Cancel
Save