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
pull/675/head
Google APIs 4 years ago committed by Copybara-Service
parent 787f8c9a73
commit bf96877434
  1. 3
      google/cloud/aiplatform/v1beta1/entity_type.proto
  2. 15
      google/cloud/aiplatform/v1beta1/explanation.proto
  3. 2
      google/cloud/aiplatform/v1beta1/feature.proto
  4. 4
      google/cloud/aiplatform/v1beta1/featurestore.proto
  5. 22
      google/cloud/aiplatform/v1beta1/featurestore_online_service.proto
  6. 30
      google/cloud/aiplatform/v1beta1/featurestore_service.proto
  7. 5
      google/cloud/aiplatform/v1beta1/index_endpoint.proto
  8. 28
      google/cloud/aiplatform/v1beta1/job_service.proto
  9. 92
      google/cloud/aiplatform/v1beta1/metadata_service.proto
  10. 5
      google/cloud/aiplatform/v1beta1/model_deployment_monitoring_job.proto
  11. 4
      google/cloud/aiplatform/v1beta1/model_service.proto
  12. 21
      google/cloud/aiplatform/v1beta1/pipeline_job.proto
  13. 17
      google/cloud/aiplatform/v1beta1/pipeline_service.proto
  14. 13
      google/cloud/aiplatform/v1beta1/prediction_service.proto
  15. 3
      google/cloud/aiplatform/v1beta1/specialist_pool.proto
  16. 57
      google/cloud/aiplatform/v1beta1/tensorboard_service.proto

@ -76,7 +76,8 @@ message EntityType {
// "overwrite" update happens.
string etag = 7 [(google.api.field_behavior) = OPTIONAL];
// Optional. The default monitoring configuration for all Features under this
// Optional. The default monitoring configuration for all Features with value type
// ([Feature.ValueType][google.cloud.aiplatform.v1beta1.Feature.ValueType]) BOOL, STRING, DOUBLE or INT64 under this
// EntityType.
//
// If this is populated with

@ -197,6 +197,10 @@ message ExplanationParameters {
// like a lab or manufacturing line, or from diagnostic equipment, like
// x-rays or quality-control cameras, use Integrated Gradients instead.
XraiAttribution xrai_attribution = 3;
// Similarity explainability that returns the nearest neighbors from the
// provided dataset.
Similarity similarity = 7;
}
// If populated, returns attributions for top K indices of outputs
@ -337,6 +341,17 @@ message FeatureNoiseSigma {
repeated NoiseSigmaForFeature noise_sigma = 1;
}
// Similarity explainability that returns the nearest neighbors from the
// provided dataset.
message Similarity {
// The Cloud Storage location for the input instances.
GcsSource gcs_source = 1;
// The configuration for the generated index, the semantics are the same as
// [metadata][google.cloud.aiplatform.v1beta1.Index.metadata] and should match NearestNeighborSearchConfig.
google.protobuf.Value nearest_neighbor_search_config = 2;
}
// The [ExplanationSpec][google.cloud.aiplatform.v1beta1.ExplanationSpec] entries that can be overridden at
// [online explanation][google.cloud.aiplatform.v1beta1.PredictionService.Explain] time.
message ExplanationSpecOverride {

@ -117,6 +117,8 @@ message Feature {
// Optional. The custom monitoring configuration for this Feature, if not set, use the
// monitoring_config defined for the EntityType this Feature belongs to.
// Only Features with type ([Feature.ValueType][google.cloud.aiplatform.v1beta1.Feature.ValueType]) BOOL, STRING, DOUBLE or
// INT64 can enable monitoring.
//
// If this is populated with
// [FeaturestoreMonitoringConfig.disabled][] = true, snapshot analysis

@ -99,4 +99,8 @@ message Featurestore {
// Output only. State of the featurestore.
State state = 8 [(google.api.field_behavior) = OUTPUT_ONLY];
// Optional. Customer-managed encryption key spec for data storage. If set, both of the
// online and offline data storage will be secured by this key.
EncryptionSpec encryption_spec = 10 [(google.api.field_behavior) = OPTIONAL];
}

@ -63,10 +63,10 @@ service FeaturestoreOnlineServingService {
// Request message for [FeaturestoreOnlineServingService.ReadFeatureValues][google.cloud.aiplatform.v1beta1.FeaturestoreOnlineServingService.ReadFeatureValues].
message ReadFeatureValuesRequest {
// Required. The resource name of the EntityType for the entity being read.
// Value format: `projects/{project}/locations/{location}/featurestores/
// {featurestore}/entityTypes/{entityType}`. For example,
// for a machine learning model predicting user clicks on a website, an
// EntityType ID could be "user".
// Value format:
// `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}`.
// For example, for a machine learning model predicting user clicks on a
// website, an EntityType ID could be `user`.
string entity_type = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
@ -76,7 +76,7 @@ message ReadFeatureValuesRequest {
// Required. ID for a specific entity. For example,
// for a machine learning model predicting user clicks on a website, an entity
// ID could be "user_123".
// ID could be `user_123`.
string entity_id = 2 [(google.api.field_behavior) = REQUIRED];
// Required. Selector choosing Features of the target EntityType.
@ -96,8 +96,7 @@ message ReadFeatureValuesResponse {
message Header {
// The resource name of the EntityType from the
// [ReadFeatureValuesRequest][google.cloud.aiplatform.v1beta1.ReadFeatureValuesRequest]. Value format:
// `projects/{project}/locations/{location}/featurestores/
// {featurestore}/entityTypes/{entityType}`.
// `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}`.
string entity_type = 1 [(google.api.resource_reference) = {
type: "aiplatform.googleapis.com/EntityType"
}];
@ -149,10 +148,11 @@ message ReadFeatureValuesResponse {
// [FeaturestoreOnlineServingService.StreamingFeatureValuesRead][].
message StreamingReadFeatureValuesRequest {
// Required. The resource name of the entities' type.
// Value format: `projects/{project}/locations/{location}/featurestores/
// {featurestore}/entityTypes/{entityType}`. For example,
// Value format:
// `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}`.
// For example,
// for a machine learning model predicting user clicks on a website, an
// EntityType ID could be "user".
// EntityType ID could be `user`.
string entity_type = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
@ -162,7 +162,7 @@ message StreamingReadFeatureValuesRequest {
// 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".
// 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. Feature IDs will be

@ -93,6 +93,7 @@ service FeaturestoreService {
delete: "/v1beta1/{name=projects/*/locations/*/featurestores/*}"
};
option (google.api.method_signature) = "name";
option (google.api.method_signature) = "name,force";
option (google.longrunning.operation_info) = {
response_type: "google.protobuf.Empty"
metadata_type: "DeleteOperationMetadata"
@ -144,6 +145,7 @@ service FeaturestoreService {
delete: "/v1beta1/{name=projects/*/locations/*/featurestores/*/entityTypes/*}"
};
option (google.api.method_signature) = "name";
option (google.api.method_signature) = "name,force";
option (google.longrunning.operation_info) = {
response_type: "google.protobuf.Empty"
metadata_type: "DeleteOperationMetadata"
@ -282,6 +284,7 @@ service FeaturestoreService {
get: "/v1beta1/{location=projects/*/locations/*}/featurestores:searchFeatures"
};
option (google.api.method_signature) = "location";
option (google.api.method_signature) = "location,query";
}
}
@ -336,14 +339,14 @@ message ListFeaturestoresRequest {
// Lists the featurestores that match the filter expression. The following
// fields are supported:
//
// * `create_time`: Supports =, !=, <, >, <=, and >= comparisons. Values must
// be
// * `create_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons.
// Values must be
// in RFC 3339 format.
// * `update_time`: Supports =, !=, <, >, <=, and >= comparisons. Values must
// be
// * `update_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons.
// Values must be
// in RFC 3339 format.
// * `online_serving_config.fixed_node_count`: Supports =, !=, <, >, <=,
// and >= comparisons.
// * `online_serving_config.fixed_node_count`: Supports `=`, `!=`, `<`, `>`,
// `<=`, and `>=` comparisons.
// * `labels`: Supports key-value equality and key presence.
//
// Examples:
@ -519,7 +522,6 @@ 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 {
@ -739,10 +741,10 @@ message ListEntityTypesRequest {
// Lists the EntityTypes that match the filter expression. The following
// filters are supported:
//
// * `create_time`: Supports =, !=, <, >, >=, and <= comparisons. Values must
// be in RFC 3339 format.
// * `update_time`: Supports =, !=, <, >, >=, and <= comparisons. Values must
// be in RFC 3339 format.
// * `create_time`: Supports `=`, `!=`, `<`, `>`, `>=`, and `<=` comparisons.
// Values must be in RFC 3339 format.
// * `update_time`: Supports `=`, `!=`, `<`, `>`, `>=`, and `<=` comparisons.
// Values must be in RFC 3339 format.
// * `labels`: Supports key-value equality as well as key presence.
//
// Examples:
@ -1003,9 +1005,9 @@ message SearchFeaturesRequest {
// comparison. This is done by:
//
// * Removing leading/trailing whitespace and tokenizing the search value.
// Characters that are not one of alphanumeric [a-zA-Z0-9], underscore [_],
// or asterisk [*] are treated as delimiters for tokens. (*) is treated as a
// wildcard that matches characters within a token.
// Characters that are not one of alphanumeric `[a-zA-Z0-9]`, underscore
// `_`, or asterisk `*` are treated as delimiters for tokens. `*` is treated
// as a wildcard that matches characters within a token.
// * Ignoring case.
// * Prepending an asterisk to the first and appending an asterisk to the
// last token in QUERY.

@ -143,9 +143,8 @@ message DeployedIndex {
// If min_replica_count is not set, the default value is 1. If
// max_replica_count is not set, the default value is min_replica_count. The
// max allowed replica count is 1000.
//
// The user is billed for the resources (at least their minimal amount) even
// if the DeployedIndex receives no traffic.
// The user is billed for the resources (at least their minimal amount)
// even if the DeployedIndex receives no traffic.
AutomaticResources automatic_resources = 7 [(google.api.field_behavior) = OPTIONAL];
// Optional. If true, private endpoint's access logs are sent to StackDriver Logging.

@ -923,7 +923,33 @@ message UpdateModelDeploymentMonitoringJobRequest {
// server.
ModelDeploymentMonitoringJob model_deployment_monitoring_job = 1 [(google.api.field_behavior) = REQUIRED];
// Required. The update mask applies to the resource.
// Required. The update mask is used to specify the fields to be overwritten in the
// ModelDeploymentMonitoringJob resource by the update.
// The fields specified in the update_mask are relative to the resource, not
// the full request. A field will be overwritten if it is in the mask. If the
// user does not provide a mask then only the non-empty fields present in the
// request will be overwritten. Set the update_mask to `*` to override all
// fields.
// For the objective config, the user can either provide the update mask for
// model_deployment_monitoring_objective_configs or any combination of its
// nested fields, such as:
// model_deployment_monitoring_objective_configs.objective_config.training_dataset.
//
// Updatable fields:
//
// * `display_name`
// * `model_deployment_monitoring_schedule_config`
// * `model_monitoring_alert_config`
// * `logging_sampling_strategy`
// * `labels`
// * `log_ttl`
// * `enable_monitoring_pipeline_logs`
// . and
// * `model_deployment_monitoring_objective_configs`
// . or
// * `model_deployment_monitoring_objective_configs.objective_config.training_dataset`
// * `model_deployment_monitoring_objective_configs.objective_config.training_prediction_skew_detection_config`
// * `model_deployment_monitoring_objective_configs.objective_config.prediction_drift_detection_config`
google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED];
}

@ -357,7 +357,7 @@ service MetadataService {
message CreateMetadataStoreRequest {
// Required. The resource name of the Location where the MetadataStore should
// be created.
// Format: projects/{project}/locations/{location}/
// Format: `projects/{project}/locations/{location}/`
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
@ -369,10 +369,10 @@ message CreateMetadataStoreRequest {
MetadataStore metadata_store = 2 [(google.api.field_behavior) = REQUIRED];
// The {metadatastore} portion of the resource name with the format:
// projects/{project}/locations/{location}/metadataStores/{metadatastore}
// `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
// If not provided, the MetadataStore's ID will be a UUID generated by the
// service.
// Must be 4-128 characters in length. Valid characters are /[a-z][0-9]-/.
// Must be 4-128 characters in length. Valid characters are `/[a-z][0-9]-/`.
// Must be unique across all MetadataStores in the parent Location.
// (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED
// if the caller can't view the preexisting MetadataStore.)
@ -389,7 +389,7 @@ message CreateMetadataStoreOperationMetadata {
message GetMetadataStoreRequest {
// Required. The resource name of the MetadataStore to retrieve.
// Format:
// projects/{project}/locations/{location}/metadataStores/{metadatastore}
// `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
@ -402,7 +402,7 @@ message GetMetadataStoreRequest {
message ListMetadataStoresRequest {
// Required. The Location whose MetadataStores should be listed.
// Format:
// projects/{project}/locations/{location}
// `projects/{project}/locations/{location}`
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
@ -440,7 +440,7 @@ message ListMetadataStoresResponse {
message DeleteMetadataStoreRequest {
// Required. The resource name of the MetadataStore to delete.
// Format:
// projects/{project}/locations/{location}/metadataStores/{metadatastore}
// `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
@ -463,7 +463,7 @@ message CreateArtifactRequest {
// Required. The resource name of the MetadataStore where the Artifact should
// be created.
// Format:
// projects/{project}/locations/{location}/metadataStores/{metadatastore}
// `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
@ -475,9 +475,9 @@ message CreateArtifactRequest {
Artifact artifact = 2 [(google.api.field_behavior) = REQUIRED];
// The {artifact} portion of the resource name with the format:
// projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}
// `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}`
// If not provided, the Artifact's ID will be a UUID generated by the service.
// Must be 4-128 characters in length. Valid characters are /[a-z][0-9]-/.
// Must be 4-128 characters in length. Valid characters are `/[a-z][0-9]-/`.
// Must be unique across all Artifacts in the parent MetadataStore. (Otherwise
// the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the
// caller can't view the preexisting Artifact.)
@ -488,7 +488,7 @@ message CreateArtifactRequest {
message GetArtifactRequest {
// Required. The resource name of the Artifact to retrieve.
// Format:
// projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}
// `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}`
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
@ -501,7 +501,7 @@ message GetArtifactRequest {
message ListArtifactsRequest {
// Required. The MetadataStore whose Artifacts should be listed.
// Format:
// projects/{project}/locations/{location}/metadataStores/{metadatastore}
// `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
@ -568,7 +568,7 @@ message UpdateArtifactRequest {
// The Artifact's [Artifact.name][google.cloud.aiplatform.v1beta1.Artifact.name] field is used to identify the Artifact to
// be updated.
// Format:
// projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}
// `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}`
Artifact artifact = 1 [(google.api.field_behavior) = REQUIRED];
// Required. A FieldMask indicating which fields should be updated.
@ -584,7 +584,7 @@ message UpdateArtifactRequest {
message DeleteArtifactRequest {
// Required. The resource name of the Artifact to delete.
// Format:
// projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}
// `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}`
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
@ -602,7 +602,7 @@ message DeleteArtifactRequest {
message PurgeArtifactsRequest {
// Required. The metadata store to purge Artifacts from.
// Format:
// projects/{project}/locations/{location}/metadataStores/{metadatastore}
// `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
@ -611,7 +611,7 @@ message PurgeArtifactsRequest {
];
// Required. A required filter matching the Artifacts to be purged.
// E.g., update_time <= 2020-11-19T11:30:00-04:00.
// 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.
@ -645,7 +645,7 @@ message CreateContextRequest {
// Required. The resource name of the MetadataStore where the Context should be
// created.
// Format:
// projects/{project}/locations/{location}/metadataStores/{metadatastore}
// `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
@ -657,9 +657,9 @@ message CreateContextRequest {
Context context = 2 [(google.api.field_behavior) = REQUIRED];
// The {context} portion of the resource name with the format:
// projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}.
// `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`.
// If not provided, the Context's ID will be a UUID generated by the service.
// Must be 4-128 characters in length. Valid characters are /[a-z][0-9]-/.
// Must be 4-128 characters in length. Valid characters are `/[a-z][0-9]-/`.
// Must be unique across all Contexts in the parent MetadataStore. (Otherwise
// the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the
// caller can't view the preexisting Context.)
@ -670,7 +670,7 @@ message CreateContextRequest {
message GetContextRequest {
// Required. The resource name of the Context to retrieve.
// Format:
// projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}
// `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
@ -683,7 +683,7 @@ message GetContextRequest {
message ListContextsRequest {
// Required. The MetadataStore whose Contexts should be listed.
// Format:
// projects/{project}/locations/{location}/metadataStores/{metadatastore}
// `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
@ -754,7 +754,7 @@ message UpdateContextRequest {
// The Context's [Context.name][google.cloud.aiplatform.v1beta1.Context.name] field is used to identify the Context to be
// updated.
// Format:
// projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}
// `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`
Context context = 1 [(google.api.field_behavior) = REQUIRED];
// Required. A FieldMask indicating which fields should be updated.
@ -770,7 +770,7 @@ message UpdateContextRequest {
message DeleteContextRequest {
// Required. The resource name of the Context to delete.
// Format:
// projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}
// `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
@ -792,7 +792,7 @@ message DeleteContextRequest {
message PurgeContextsRequest {
// Required. The metadata store to purge Contexts from.
// Format:
// projects/{project}/locations/{location}/metadataStores/{metadatastore}
// `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
@ -801,7 +801,7 @@ message PurgeContextsRequest {
];
// Required. A required filter matching the Contexts to be purged.
// E.g., update_time <= 2020-11-19T11:30:00-04:00.
// 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.
@ -835,7 +835,7 @@ message AddContextArtifactsAndExecutionsRequest {
// Required. The resource name of the Context that the Artifacts and Executions
// belong to.
// Format:
// projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}
// `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`
string context = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
@ -846,7 +846,7 @@ message AddContextArtifactsAndExecutionsRequest {
// The resource names of the Artifacts to attribute to the Context.
//
// Format:
// projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}
// `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}`
repeated string artifacts = 2 [(google.api.resource_reference) = {
type: "aiplatform.googleapis.com/Artifact"
}];
@ -855,7 +855,7 @@ message AddContextArtifactsAndExecutionsRequest {
// Context.
//
// Format:
// projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}
// `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}`
repeated string executions = 3 [(google.api.resource_reference) = {
type: "aiplatform.googleapis.com/Execution"
}];
@ -871,7 +871,7 @@ message AddContextChildrenRequest {
// Required. The resource name of the parent Context.
//
// Format:
// projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}
// `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`
string context = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
@ -895,7 +895,7 @@ message QueryContextLineageSubgraphRequest {
// Required. The resource name of the Context whose Artifacts and Executions
// should be retrieved as a LineageSubgraph.
// Format:
// projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}
// `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`
//
// The request may error with FAILED_PRECONDITION if the number of Artifacts,
// the number of Executions, or the number of Events that would be returned
@ -913,7 +913,7 @@ message CreateExecutionRequest {
// Required. The resource name of the MetadataStore where the Execution should
// be created.
// Format:
// projects/{project}/locations/{location}/metadataStores/{metadatastore}
// `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
@ -925,10 +925,10 @@ message CreateExecutionRequest {
Execution execution = 2 [(google.api.field_behavior) = REQUIRED];
// The {execution} portion of the resource name with the format:
// projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}
// `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}`
// If not provided, the Execution's ID will be a UUID generated by the
// service.
// Must be 4-128 characters in length. Valid characters are /[a-z][0-9]-/.
// Must be 4-128 characters in length. Valid characters are `/[a-z][0-9]-/`.
// Must be unique across all Executions in the parent MetadataStore.
// (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED
// if the caller can't view the preexisting Execution.)
@ -939,7 +939,7 @@ message CreateExecutionRequest {
message GetExecutionRequest {
// Required. The resource name of the Execution to retrieve.
// Format:
// projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}
// `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}`
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
@ -952,7 +952,7 @@ message GetExecutionRequest {
message ListExecutionsRequest {
// Required. The MetadataStore whose Executions should be listed.
// Format:
// projects/{project}/locations/{location}/metadataStores/{metadatastore}
// `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
@ -1018,7 +1018,7 @@ message UpdateExecutionRequest {
// The Execution's [Execution.name][google.cloud.aiplatform.v1beta1.Execution.name] field is used to identify the Execution
// to be updated.
// Format:
// projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}
// `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}`
Execution execution = 1 [(google.api.field_behavior) = REQUIRED];
// Required. A FieldMask indicating which fields should be updated.
@ -1034,7 +1034,7 @@ message UpdateExecutionRequest {
message DeleteExecutionRequest {
// Required. The resource name of the Execution to delete.
// Format:
// projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}
// `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}`
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
@ -1052,7 +1052,7 @@ message DeleteExecutionRequest {
message PurgeExecutionsRequest {
// Required. The metadata store to purge Executions from.
// Format:
// projects/{project}/locations/{location}/metadataStores/{metadatastore}
// `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
@ -1061,7 +1061,7 @@ message PurgeExecutionsRequest {
];
// Required. A required filter matching the Executions to be purged.
// E.g., update_time <= 2020-11-19T11:30:00-04:00.
// 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.
@ -1096,7 +1096,7 @@ message AddExecutionEventsRequest {
// Required. The resource name of the Execution that the Events connect
// Artifacts with.
// Format:
// projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}
// `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}`
string execution = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
@ -1118,7 +1118,7 @@ message QueryExecutionInputsAndOutputsRequest {
// Required. The resource name of the Execution whose input and output Artifacts should
// be retrieved as a LineageSubgraph.
// Format:
// projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}
// `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}`
string execution = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
@ -1132,7 +1132,7 @@ message CreateMetadataSchemaRequest {
// Required. The resource name of the MetadataStore where the MetadataSchema should
// be created.
// Format:
// projects/{project}/locations/{location}/metadataStores/{metadatastore}
// `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
@ -1144,10 +1144,10 @@ message CreateMetadataSchemaRequest {
MetadataSchema metadata_schema = 2 [(google.api.field_behavior) = REQUIRED];
// The {metadata_schema} portion of the resource name with the format:
// projects/{project}/locations/{location}/metadataStores/{metadatastore}/metadataSchemas/{metadataschema}
// `projects/{project}/locations/{location}/metadataStores/{metadatastore}/metadataSchemas/{metadataschema}`
// If not provided, the MetadataStore's ID will be a UUID generated by the
// service.
// Must be 4-128 characters in length. Valid characters are /[a-z][0-9]-/.
// Must be 4-128 characters in length. Valid characters are `/[a-z][0-9]-/`.
// Must be unique across all MetadataSchemas in the parent Location.
// (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED
// if the caller can't view the preexisting MetadataSchema.)
@ -1158,7 +1158,7 @@ message CreateMetadataSchemaRequest {
message GetMetadataSchemaRequest {
// Required. The resource name of the MetadataSchema to retrieve.
// Format:
// projects/{project}/locations/{location}/metadataStores/{metadatastore}/metadataSchemas/{metadataschema}
// `projects/{project}/locations/{location}/metadataStores/{metadatastore}/metadataSchemas/{metadataschema}`
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
@ -1171,7 +1171,7 @@ message GetMetadataSchemaRequest {
message ListMetadataSchemasRequest {
// Required. The MetadataStore whose MetadataSchemas should be listed.
// Format:
// projects/{project}/locations/{location}/metadataStores/{metadatastore}
// `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
@ -1213,7 +1213,7 @@ message QueryArtifactLineageSubgraphRequest {
// Required. The resource name of the Artifact whose Lineage needs to be retrieved as a
// LineageSubgraph.
// Format:
// projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}
// `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}`
//
// The request may error with FAILED_PRECONDITION if the number of Artifacts,
// the number of Executions, or the number of Events that would be returned

@ -190,6 +190,11 @@ message ModelDeploymentMonitoringJob {
// ModelDeploymentMonitoringJob will be secured by this key.
EncryptionSpec encryption_spec = 21;
// If true, the scheduled monitoring pipeline status logs are sent to
// Google Cloud Logging. Please note the logs incur cost, which are subject to
// [Cloud Logging pricing](https://cloud.google.com/logging#pricing).
bool enable_monitoring_pipeline_logs = 22;
// Output only. Only populated when the job's state is `JOB_STATE_FAILED` or
// `JOB_STATE_CANCELLED`.
google.rpc.Status error = 23 [(google.api.field_behavior) = OUTPUT_ONLY];

@ -80,7 +80,8 @@ service ModelService {
}
// Deletes a Model.
// Note: Model can only be deleted if there are no DeployedModels created
//
// Model can only be deleted if there are no [DeployedModels][] created
// from it.
rpc DeleteModel(DeleteModelRequest) returns (google.longrunning.Operation) {
option (google.api.http) = {
@ -284,7 +285,6 @@ message ExportModelRequest {
}
// Required. The resource name of the Model to export.
// Format: `projects/{project}/locations/{location}/models/{model}`
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {

@ -157,6 +157,23 @@ message PipelineJobDetail {
// The runtime detail of a task execution.
message PipelineTaskDetail {
// A single record of the task status.
message PipelineTaskStatus {
// Output only. Update time of this status.
google.protobuf.Timestamp update_time = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The state of the task.
State state = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The error that occurred during the state. May be set when the state is
// any of the non-final state (PENDING/RUNNING/CANCELLING) or FAILED state.
// If the state is FAILED, the error here is final and not going to be
// retried.
// If the state is a non-final state, the error indicates a system-error
// being retried.
google.rpc.Status error = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
}
// A list of artifact metadata.
message ArtifactList {
// Output only. A list of artifact metadata.
@ -231,6 +248,10 @@ message PipelineTaskDetail {
// Only populated when the task's state is FAILED or CANCELLED.
google.rpc.Status error = 9 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. A list of task status. This field keeps a record of task status evolving
// over time.
repeated PipelineTaskStatus pipeline_task_status = 13 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The runtime input artifacts of the task.
map<string, ArtifactList> inputs = 10 [(google.api.field_behavior) = OUTPUT_ONLY];

@ -310,6 +310,10 @@ message ListPipelineJobsRequest {
// fields are supported:
//
// * `pipeline_name`: Supports `=` and `!=` comparisons.
// * `display_name`: Supports `=`, `!=` comparisons, and `:` wildcard.
// * `pipeline_job_user_id`: Supports `=`, `!=` comparisons, and `:` wildcard.
// for example, can check if pipeline's display_name contains *step* by doing
// display_name:\"*step*\"
// * `create_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons.
// Values must be in RFC 3339 format.
// * `update_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons.
@ -342,6 +346,19 @@ message ListPipelineJobsRequest {
// [ListPipelineJobsResponse.next_page_token][google.cloud.aiplatform.v1beta1.ListPipelineJobsResponse.next_page_token] of the previous
// [PipelineService.ListPipelineJobs][google.cloud.aiplatform.v1beta1.PipelineService.ListPipelineJobs] call.
string page_token = 4;
// A comma-separated list of fields to order by. The default sort order is in
// ascending order. Use "desc" after a field name for descending. You can have
// multiple order_by fields provided e.g. "create_time desc, end_time",
// "end_time, start_time, update_time" For example, using "create_time desc,
// end_time" will order results by create time in descending order, and if
// there are multiple jobs having the same create time, order them by the end
// time in ascending order. if order_by is not specified, it will order by
// default order is create time in descending order. Supported fields:
// * `create_time`
// * `update_time`
// * `end_time`
string order_by = 6;
}
// Response message for [PipelineService.ListPipelineJobs][google.cloud.aiplatform.v1beta1.PipelineService.ListPipelineJobs]

@ -115,6 +115,19 @@ message PredictResponse {
// ID of the Endpoint's DeployedModel that served this prediction.
string deployed_model_id = 2;
// Output only. The name of the Model this DeployedModel, that served this prediction, was
// created from.
string model = 3 [
(google.api.field_behavior) = OUTPUT_ONLY,
(google.api.resource_reference) = {
type: "aiplatform.googleapis.com/Model"
}
];
// Output only. The [display name][google.cloud.aiplatform.v1beta1.Model.display_name] of the Model this DeployedModel,
// that served this prediction, was created from.
string model_display_name = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
}
// Request message for [PredictionService.RawPredict][google.cloud.aiplatform.v1beta1.PredictionService.RawPredict].

@ -57,4 +57,7 @@ message SpecialistPool {
// Output only. The resource name of the pending data labeling jobs.
repeated string pending_data_labeling_jobs = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
// The email addresses of workers in the SpecialistPool.
repeated string specialist_worker_emails = 7;
}

@ -252,11 +252,23 @@ service TensorboardService {
};
}
// Reads a TensorboardTimeSeries' data. Data is returned in paginated
// responses. By default, if the number of data points stored is less than
// 1000, all data will be returned. Otherwise, 1000 data points will be
// randomly selected from this time series and returned. This value can be
// changed by changing max_data_points.
// Reads multiple TensorboardTimeSeries' data. The data point number limit is
// 1000 for scalars, 100 for tensors and blob references. If the number of
// data points stored is less than the limit, all data will be returned.
// Otherwise, that limit number of data points will be randomly selected from
// this time series and returned.
rpc BatchReadTensorboardTimeSeriesData(BatchReadTensorboardTimeSeriesDataRequest) returns (BatchReadTensorboardTimeSeriesDataResponse) {
option (google.api.http) = {
get: "/v1beta1/{tensorboard=projects/*/locations/*/tensorboards/*}/experiments/*/runs/*/timeSeries:batchRead"
};
option (google.api.method_signature) = "tensorboard";
}
// Reads a TensorboardTimeSeries' data. By default, if the number of data
// points stored is less than 1000, all data will be returned. Otherwise, 1000
// data points will be randomly selected from this time series and returned.
// This value can be changed by changing max_data_points, which can't be
// greater than 10k.
rpc ReadTensorboardTimeSeriesData(ReadTensorboardTimeSeriesDataRequest) returns (ReadTensorboardTimeSeriesDataResponse) {
option (google.api.http) = {
get: "/v1beta1/{tensorboard_time_series=projects/*/locations/*/tensorboards/*/experiments/*/runs/*/timeSeries/*}:read"
@ -728,8 +740,7 @@ message CreateTensorboardTimeSeriesRequest {
// Optional. The user specified unique ID to use for the TensorboardTimeSeries, which
// will become the final component of the TensorboardTimeSeries's resource
// name. Ref: go/ucaip-user-specified-id
//
// name.
// This value should match "[a-z0-9][a-z0-9-]{0, 127}"
string tensorboard_time_series_id = 3 [(google.api.field_behavior) = OPTIONAL];
@ -828,6 +839,38 @@ message DeleteTensorboardTimeSeriesRequest {
];
}
// Request message for
// [TensorboardService.BatchReadTensorboardTimeSeriesData][google.cloud.aiplatform.v1beta1.TensorboardService.BatchReadTensorboardTimeSeriesData].
message BatchReadTensorboardTimeSeriesDataRequest {
// Required. The resource name of the Tensorboard containing TensorboardTimeSeries to
// read data from. Format:
// `projects/{project}/locations/{location}/tensorboards/{tensorboard}`.
// The TensorboardTimeSeries referenced by [time_series][google.cloud.aiplatform.v1beta1.BatchReadTensorboardTimeSeriesDataRequest.time_series] must be sub
// resources of this Tensorboard.
string tensorboard = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "aiplatform.googleapis.com/Tensorboard"
}
];
// Required. The resource names of the TensorboardTimeSeries to read data from. Format:
// `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`
repeated string time_series = 2 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "aiplatform.googleapis.com/TensorboardTimeSeries"
}
];
}
// Response message for
// [TensorboardService.BatchReadTensorboardTimeSeriesData][google.cloud.aiplatform.v1beta1.TensorboardService.BatchReadTensorboardTimeSeriesData].
message BatchReadTensorboardTimeSeriesDataResponse {
// The returned time series data.
repeated TimeSeriesData time_series_data = 1;
}
// Request message for [TensorboardService.ReadTensorboardTimeSeriesData][google.cloud.aiplatform.v1beta1.TensorboardService.ReadTensorboardTimeSeriesData].
message ReadTensorboardTimeSeriesDataRequest {
// Required. The resource name of the TensorboardTimeSeries to read data from.

Loading…
Cancel
Save