close()

Close httplib2 connections.

create(parent, body=None, x__xgafv=None)

Creates a Schedule.

Args:
parent: string, Required. The resource name of the Location to create the Schedule in. Format: `projects/{project}/locations/{location}` (required)
body: object, The request body.
The object takes the form of:

{ # An instance of a Schedule periodically schedules runs to make API calls based on user specified time specification and API request type.
"allowQueueing": True or False, # Optional. Whether new scheduled runs can be queued when max_concurrent_runs limit is reached. If set to true, new runs will be queued instead of skipped. Default to false.
"catchUp": True or False, # Output only. Whether to backfill missed runs when the schedule is resumed from PAUSED state. If set to true, all missed runs will be scheduled. New runs will be scheduled after the backfill is complete. Default to false.
"createModelMonitoringJobRequest": { # Request message for ModelMonitoringService.CreateModelMonitoringJob. # Request for ModelMonitoringService.CreateModelMonitoringJob.
"modelMonitoringJob": { # Represents a model monitoring job that analyze dataset using different monitoring algorithm. # Required. The ModelMonitoringJob to create
"createTime": "A String", # Output only. Timestamp when this ModelMonitoringJob was created.
"displayName": "A String", # The display name of the ModelMonitoringJob. The name can be up to 128 characters long and can consist of any UTF-8.
"jobExecutionDetail": { # Represent the execution details of the job. # Output only. Execution results for all the monitoring objectives.
"baselineDatasets": [ # Processed baseline datasets.
{ # Processed dataset information.
"location": "A String", # Actual data location of the processed dataset.
"timeRange": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Dataset time range information if any.
"endTime": "A String", # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
"startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
},
},
],
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Additional job error status.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"objectiveStatus": { # Status of data processing for each monitoring objective. Key is the objective.
"a_key": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
},
"targetDatasets": [ # Processed target datasets.
{ # Processed dataset information.
"location": "A String", # Actual data location of the processed dataset.
"timeRange": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Dataset time range information if any.
"endTime": "A String", # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
"startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
},
},
],
},
"modelMonitoringSpec": { # Monitoring monitoring job spec. It outlines the specifications for monitoring objectives, notifications, and result exports. # Monitoring monitoring job spec. It outlines the specifications for monitoring objectives, notifications, and result exports. If left blank, the default monitoring specifications from the top-level resource 'ModelMonitor' will be applied. If provided, we will use the specification defined here rather than the default one.
"notificationSpec": { # Notification spec(email, notification channel) for model monitoring statistics/alerts. # The model monitoring notification spec.
"emailConfig": { # The config for email alerts. # Email alert config.
"userEmails": [ # The email addresses to send the alerts.
"A String",
],
},
"enableCloudLogging": True or False, # Dump the anomalies to Cloud Logging. The anomalies will be put to json payload encoded from proto google.cloud.aiplatform.logging.ModelMonitoringAnomaliesLogEntry. This can be further sinked to Pub/Sub or any other services supported by Cloud Logging.
"notificationChannelConfigs": [ # Notification channel config.
{ # Google Cloud Notification Channel config.
"notificationChannel": "A String", # Resource names of the NotificationChannels. Must be of the format `projects//notificationChannels/`
},
],
},
"objectiveSpec": { # Monitoring objectives spec. # The monitoring objective spec.
"baselineDataset": { # Model monitoring data input spec. # Baseline dataset. It could be the training dataset or production serving dataset from a previous period.
"batchPredictionOutput": { # Data from Vertex AI Batch prediction job output. # Vertex AI Batch prediction Job.
"batchPredictionJob": "A String", # Vertex AI Batch prediction job resource name. The job must match the model version specified in [ModelMonitor].[model_monitoring_target].
},
"columnizedDataset": { # Input dataset spec. # Columnized dataset.
"bigquerySource": { # Dataset spec for data sotred in BigQuery. # BigQuery data source.
"query": "A String", # Standard SQL to be used instead of the `table_uri`.
"tableUri": "A String", # BigQuery URI to a table, up to 2000 characters long. All the columns in the table will be selected. Accepted forms: * BigQuery path. For example: `bq://projectId.bqDatasetId.bqTableId`.
},
"gcsSource": { # Dataset spec for data stored in Google Cloud Storage. # Google Cloud Storage data source.
"format": "A String", # Data format of the dataset.
"gcsUri": "A String", # Google Cloud Storage URI to the input file(s). May contain wildcards. For more information on wildcards, see https://cloud.google.com/storage/docs/gsutil/addlhelp/WildcardNames.
},
"timestampField": "A String", # The timestamp field. Usually for serving data.
"vertexDataset": "A String", # Resource name of the Vertex AI managed dataset.
},
"timeInterval": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # The time interval (pair of start_time and end_time) for which results should be returned.
"endTime": "A String", # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
"startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
},
"timeOffset": { # Time offset setting. # The time offset setting for which results should be returned.
"offset": "A String", # [offset] is the time difference from the cut-off time. For scheduled jobs, the cut-off time is the scheduled time. For non-scheduled jobs, it's the time when the job was created. Currently we support the following format: 'w|W': Week, 'd|D': Day, 'h|H': Hour E.g. '1h' stands for 1 hour, '2d' stands for 2 days.
"window": "A String", # [window] refers to the scope of data selected for analysis. It allows you to specify the quantity of data you wish to examine. Currently we support the following format: 'w|W': Week, 'd|D': Day, 'h|H': Hour E.g. '1h' stands for 1 hour, '2d' stands for 2 days.
},
"vertexEndpointLogs": { # Data from Vertex AI Endpoint request response logging. # Vertex AI Endpoint request & response logging.
"endpoints": [ # List of endpoint resource names. The endpoints must enable the logging with the [Endpoint].[request_response_logging_config], and must contain the deployed model corresponding to the model version specified in [ModelMonitor].[model_monitoring_target].
"A String",
],
},
},
"explanationSpec": { # Specification of Model explanation. # The explanation spec. This spec is required when the objectives spec includes feature attribution objectives.
"metadata": { # Metadata describing the Model's input and output for explanation. # Optional. Metadata describing the Model's input and output for explanation.
"featureAttributionsSchemaUri": "A String", # Points to a YAML file stored on Google Cloud Storage describing the format of the feature attributions. The schema is defined as an OpenAPI 3.0.2 [Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). AutoML tabular Models always have this field populated by Vertex AI. Note: The URI given on output may be different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.
"inputs": { # Required. Map from feature names to feature input metadata. Keys are the name of the features. Values are the specification of the feature. An empty InputMetadata is valid. It describes a text feature which has the name specified as the key in ExplanationMetadata.inputs. The baseline of the empty feature is chosen by Vertex AI. For Vertex AI-provided Tensorflow images, the key can be any friendly name of the feature. Once specified, featureAttributions are keyed by this key (if not grouped with another feature). For custom images, the key must match with the key in instance.
"a_key": { # Metadata of the input of a feature. Fields other than InputMetadata.input_baselines are applicable only for Models that are using Vertex AI-provided images for Tensorflow.
"denseShapeTensorName": "A String", # Specifies the shape of the values of the input if the input is a sparse representation. Refer to Tensorflow documentation for more details: https://www.tensorflow.org/api_docs/python/tf/sparse/SparseTensor.
"encodedBaselines": [ # A list of baselines for the encoded tensor. The shape of each baseline should match the shape of the encoded tensor. If a scalar is provided, Vertex AI broadcasts to the same shape as the encoded tensor.
"",
],
"encodedTensorName": "A String", # Encoded tensor is a transformation of the input tensor. Must be provided if choosing Integrated Gradients attribution or XRAI attribution and the input tensor is not differentiable. An encoded tensor is generated if the input tensor is encoded by a lookup table.
"encoding": "A String", # Defines how the feature is encoded into the input tensor. Defaults to IDENTITY.
"featureValueDomain": { # Domain details of the input feature value. Provides numeric information about the feature, such as its range (min, max). If the feature has been pre-processed, for example with z-scoring, then it provides information about how to recover the original feature. For example, if the input feature is an image and it has been pre-processed to obtain 0-mean and stddev = 1 values, then original_mean, and original_stddev refer to the mean and stddev of the original feature (e.g. image tensor) from which input feature (with mean = 0 and stddev = 1) was obtained. # The domain details of the input feature value. Like min/max, original mean or standard deviation if normalized.
"maxValue": 3.14, # The maximum permissible value for this feature.
"minValue": 3.14, # The minimum permissible value for this feature.
"originalMean": 3.14, # If this input feature has been normalized to a mean value of 0, the original_mean specifies the mean value of the domain prior to normalization.
"originalStddev": 3.14, # If this input feature has been normalized to a standard deviation of 1.0, the original_stddev specifies the standard deviation of the domain prior to normalization.
},
"groupName": "A String", # Name of the group that the input belongs to. Features with the same group name will be treated as one feature when computing attributions. Features grouped together can have different shapes in value. If provided, there will be one single attribution generated in Attribution.feature_attributions, keyed by the group name.
"indexFeatureMapping": [ # A list of feature names for each index in the input tensor. Required when the input InputMetadata.encoding is BAG_OF_FEATURES, BAG_OF_FEATURES_SPARSE, INDICATOR.
"A String",
],
"indicesTensorName": "A String", # Specifies the index of the values of the input tensor. Required when the input tensor is a sparse representation. Refer to Tensorflow documentation for more details: https://www.tensorflow.org/api_docs/python/tf/sparse/SparseTensor.
"inputBaselines": [ # Baseline inputs for this feature. If no baseline is specified, Vertex AI chooses the baseline for this feature. If multiple baselines are specified, Vertex AI returns the average attributions across them in Attribution.feature_attributions. For Vertex AI-provided Tensorflow images (both 1.x and 2.x), the shape of each baseline must match the shape of the input tensor. If a scalar is provided, we broadcast to the same shape as the input tensor. For custom images, the element of the baselines must be in the same format as the feature's input in the instance[]. The schema of any single instance may be specified via Endpoint's DeployedModels' Model's PredictSchemata's instance_schema_uri.
"",
],
"inputTensorName": "A String", # Name of the input tensor for this feature. Required and is only applicable to Vertex AI-provided images for Tensorflow.
"modality": "A String", # Modality of the feature. Valid values are: numeric, image. Defaults to numeric.
"visualization": { # Visualization configurations for image explanation. # Visualization configurations for image explanation.
"clipPercentLowerbound": 3.14, # Excludes attributions below the specified percentile, from the highlighted areas. Defaults to 62.
"clipPercentUpperbound": 3.14, # Excludes attributions above the specified percentile from the highlighted areas. Using the clip_percent_upperbound and clip_percent_lowerbound together can be useful for filtering out noise and making it easier to see areas of strong attribution. Defaults to 99.9.
"colorMap": "A String", # The color scheme used for the highlighted areas. Defaults to PINK_GREEN for Integrated Gradients attribution, which shows positive attributions in green and negative in pink. Defaults to VIRIDIS for XRAI attribution, which highlights the most influential regions in yellow and the least influential in blue.
"overlayType": "A String", # How the original image is displayed in the visualization. Adjusting the overlay can help increase visual clarity if the original image makes it difficult to view the visualization. Defaults to NONE.
"polarity": "A String", # Whether to only highlight pixels with positive contributions, negative or both. Defaults to POSITIVE.
"type": "A String", # Type of the image visualization. Only applicable to Integrated Gradients attribution. OUTLINES shows regions of attribution, while PIXELS shows per-pixel attribution. Defaults to OUTLINES.
},
},
},
"latentSpaceSource": "A String", # Name of the source to generate embeddings for example based explanations.
"outputs": { # Required. Map from output names to output metadata. For Vertex AI-provided Tensorflow images, keys can be any user defined string that consists of any UTF-8 characters. For custom images, keys are the name of the output field in the prediction to be explained. Currently only one key is allowed.
"a_key": { # Metadata of the prediction output to be explained.
"displayNameMappingKey": "A String", # Specify a field name in the prediction to look for the display name. Use this if the prediction contains the display names for the outputs. The display names in the prediction must have the same shape of the outputs, so that it can be located by Attribution.output_index for a specific output.
"indexDisplayNameMapping": "", # Static mapping between the index and display name. Use this if the outputs are a deterministic n-dimensional array, e.g. a list of scores of all the classes in a pre-defined order for a multi-classification Model. It's not feasible if the outputs are non-deterministic, e.g. the Model produces top-k classes or sort the outputs by their values. The shape of the value must be an n-dimensional array of strings. The number of dimensions must match that of the outputs to be explained. The Attribution.output_display_name is populated by locating in the mapping with Attribution.output_index.
"outputTensorName": "A String", # Name of the output tensor. Required and is only applicable to Vertex AI provided images for Tensorflow.
},
},
},
"parameters": { # Parameters to configure explaining for Model's predictions. # Required. Parameters that configure explaining of the Model's predictions.
"examples": { # Example-based explainability that returns the nearest neighbors from the provided dataset. # Example-based explanations that returns the nearest neighbors from the provided dataset.
"exampleGcsSource": { # The Cloud Storage input instances. # The Cloud Storage input instances.
"dataFormat": "A String", # The format in which instances are given, if not specified, assume it's JSONL format. Currently only JSONL format is supported.
"gcsSource": { # The Google Cloud Storage location for the input content. # The Cloud Storage location for the input instances.
"uris": [ # Required. Google Cloud Storage URI(-s) to the input file(s). May contain wildcards. For more information on wildcards, see https://cloud.google.com/storage/docs/gsutil/addlhelp/WildcardNames.
"A String",
],
},
},
"gcsSource": { # The Google Cloud Storage location for the input content. # The Cloud Storage locations that contain the instances to be indexed for approximate nearest neighbor search.
"uris": [ # Required. Google Cloud Storage URI(-s) to the input file(s). May contain wildcards. For more information on wildcards, see https://cloud.google.com/storage/docs/gsutil/addlhelp/WildcardNames.
"A String",
],
},
"nearestNeighborSearchConfig": "", # The full configuration for the generated index, the semantics are the same as metadata and should match [NearestNeighborSearchConfig](https://cloud.google.com/vertex-ai/docs/explainable-ai/configuring-explanations-example-based#nearest-neighbor-search-config).
"neighborCount": 42, # The number of neighbors to return when querying for examples.
"presets": { # Preset configuration for example-based explanations # Simplified preset configuration, which automatically sets configuration values based on the desired query speed-precision trade-off and modality.
"modality": "A String", # The modality of the uploaded model, which automatically configures the distance measurement and feature normalization for the underlying example index and queries. If your model does not precisely fit one of these types, it is okay to choose the closest type.
"query": "A String", # Preset option controlling parameters for speed-precision trade-off when querying for examples. If omitted, defaults to `PRECISE`.
},
},
"integratedGradientsAttribution": { # An attribution method that computes the Aumann-Shapley value taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1703.01365 # An attribution method that computes Aumann-Shapley values taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1703.01365
"blurBaselineConfig": { # Config for blur baseline. When enabled, a linear path from the maximally blurred image to the input image is created. Using a blurred baseline instead of zero (black image) is motivated by the BlurIG approach explained here: https://arxiv.org/abs/2004.03383 # Config for IG with blur baseline. When enabled, a linear path from the maximally blurred image to the input image is created. Using a blurred baseline instead of zero (black image) is motivated by the BlurIG approach explained here: https://arxiv.org/abs/2004.03383
"maxBlurSigma": 3.14, # The standard deviation of the blur kernel for the blurred baseline. The same blurring parameter is used for both the height and the width dimension. If not set, the method defaults to the zero (i.e. black for images) baseline.
},
"smoothGradConfig": { # Config for SmoothGrad approximation of gradients. When enabled, the gradients are approximated by averaging the gradients from noisy samples in the vicinity of the inputs. Adding noise can help improve the computed gradients. Refer to this paper for more details: https://arxiv.org/pdf/1706.03825.pdf # Config for SmoothGrad approximation of gradients. When enabled, the gradients are approximated by averaging the gradients from noisy samples in the vicinity of the inputs. Adding noise can help improve the computed gradients. Refer to this paper for more details: https://arxiv.org/pdf/1706.03825.pdf
"featureNoiseSigma": { # Noise sigma by features. Noise sigma represents the standard deviation of the gaussian kernel that will be used to add noise to interpolated inputs prior to computing gradients. # This is similar to noise_sigma, but provides additional flexibility. A separate noise sigma can be provided for each feature, which is useful if their distributions are different. No noise is added to features that are not set. If this field is unset, noise_sigma will be used for all features.
"noiseSigma": [ # Noise sigma per feature. No noise is added to features that are not set.
{ # Noise sigma for a single feature.
"name": "A String", # The name of the input feature for which noise sigma is provided. The features are defined in explanation metadata inputs.
"sigma": 3.14, # This represents the standard deviation of the Gaussian kernel that will be used to add noise to the feature prior to computing gradients. Similar to noise_sigma but represents the noise added to the current feature. Defaults to 0.1.
},
],
},
"noiseSigma": 3.14, # This is a single float value and will be used to add noise to all the features. Use this field when all features are normalized to have the same distribution: scale to range [0, 1], [-1, 1] or z-scoring, where features are normalized to have 0-mean and 1-variance. Learn more about [normalization](https://developers.google.com/machine-learning/data-prep/transform/normalization). For best results the recommended value is about 10% - 20% of the standard deviation of the input feature. Refer to section 3.2 of the SmoothGrad paper: https://arxiv.org/pdf/1706.03825.pdf. Defaults to 0.1. If the distribution is different per feature, set feature_noise_sigma instead for each feature.
"noisySampleCount": 42, # The number of gradient samples to use for approximation. The higher this number, the more accurate the gradient is, but the runtime complexity increases by this factor as well. Valid range of its value is [1, 50]. Defaults to 3.
},
"stepCount": 42, # Required. The number of steps for approximating the path integral. A good value to start is 50 and gradually increase until the sum to diff property is within the desired error range. Valid range of its value is [1, 100], inclusively.
},
"outputIndices": [ # If populated, only returns attributions that have output_index contained in output_indices. It must be an ndarray of integers, with the same shape of the output it's explaining. If not populated, returns attributions for top_k indices of outputs. If neither top_k nor output_indices is populated, returns the argmax index of the outputs. Only applicable to Models that predict multiple outputs (e,g, multi-class Models that predict multiple classes).
"",
],
"sampledShapleyAttribution": { # An attribution method that approximates Shapley values for features that contribute to the label being predicted. A sampling strategy is used to approximate the value rather than considering all subsets of features. # An attribution method that approximates Shapley values for features that contribute to the label being predicted. A sampling strategy is used to approximate the value rather than considering all subsets of features. Refer to this paper for model details: https://arxiv.org/abs/1306.4265.
"pathCount": 42, # Required. The number of feature permutations to consider when approximating the Shapley values. Valid range of its value is [1, 50], inclusively.
},
"topK": 42, # If populated, returns attributions for top K indices of outputs (defaults to 1). Only applies to Models that predicts more than one outputs (e,g, multi-class Models). When set to -1, returns explanations for all outputs.
"xraiAttribution": { # An explanation method that redistributes Integrated Gradients attributions to segmented regions, taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1906.02825 Supported only by image Models. # An attribution method that redistributes Integrated Gradients attribution to segmented regions, taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1906.02825 XRAI currently performs better on natural images, like a picture of a house or an animal. If the images are taken in artificial environments, like a lab or manufacturing line, or from diagnostic equipment, like x-rays or quality-control cameras, use Integrated Gradients instead.
"blurBaselineConfig": { # Config for blur baseline. When enabled, a linear path from the maximally blurred image to the input image is created. Using a blurred baseline instead of zero (black image) is motivated by the BlurIG approach explained here: https://arxiv.org/abs/2004.03383 # Config for XRAI with blur baseline. When enabled, a linear path from the maximally blurred image to the input image is created. Using a blurred baseline instead of zero (black image) is motivated by the BlurIG approach explained here: https://arxiv.org/abs/2004.03383
"maxBlurSigma": 3.14, # The standard deviation of the blur kernel for the blurred baseline. The same blurring parameter is used for both the height and the width dimension. If not set, the method defaults to the zero (i.e. black for images) baseline.
},
"smoothGradConfig": { # Config for SmoothGrad approximation of gradients. When enabled, the gradients are approximated by averaging the gradients from noisy samples in the vicinity of the inputs. Adding noise can help improve the computed gradients. Refer to this paper for more details: https://arxiv.org/pdf/1706.03825.pdf # Config for SmoothGrad approximation of gradients. When enabled, the gradients are approximated by averaging the gradients from noisy samples in the vicinity of the inputs. Adding noise can help improve the computed gradients. Refer to this paper for more details: https://arxiv.org/pdf/1706.03825.pdf
"featureNoiseSigma": { # Noise sigma by features. Noise sigma represents the standard deviation of the gaussian kernel that will be used to add noise to interpolated inputs prior to computing gradients. # This is similar to noise_sigma, but provides additional flexibility. A separate noise sigma can be provided for each feature, which is useful if their distributions are different. No noise is added to features that are not set. If this field is unset, noise_sigma will be used for all features.
"noiseSigma": [ # Noise sigma per feature. No noise is added to features that are not set.
{ # Noise sigma for a single feature.
"name": "A String", # The name of the input feature for which noise sigma is provided. The features are defined in explanation metadata inputs.
"sigma": 3.14, # This represents the standard deviation of the Gaussian kernel that will be used to add noise to the feature prior to computing gradients. Similar to noise_sigma but represents the noise added to the current feature. Defaults to 0.1.
},
],
},
"noiseSigma": 3.14, # This is a single float value and will be used to add noise to all the features. Use this field when all features are normalized to have the same distribution: scale to range [0, 1], [-1, 1] or z-scoring, where features are normalized to have 0-mean and 1-variance. Learn more about [normalization](https://developers.google.com/machine-learning/data-prep/transform/normalization). For best results the recommended value is about 10% - 20% of the standard deviation of the input feature. Refer to section 3.2 of the SmoothGrad paper: https://arxiv.org/pdf/1706.03825.pdf. Defaults to 0.1. If the distribution is different per feature, set feature_noise_sigma instead for each feature.
"noisySampleCount": 42, # The number of gradient samples to use for approximation. The higher this number, the more accurate the gradient is, but the runtime complexity increases by this factor as well. Valid range of its value is [1, 50]. Defaults to 3.
},
"stepCount": 42, # Required. The number of steps for approximating the path integral. A good value to start is 50 and gradually increase until the sum to diff property is met within the desired error range. Valid range of its value is [1, 100], inclusively.
},
},
},
"tabularObjective": { # Tabular monitoring objective. # Tabular monitoring objective.
"featureAttributionSpec": { # Feature attribution monitoring spec. # Feature attribution monitoring spec.
"batchExplanationDedicatedResources": { # A description of resources that are used for performing batch operations, are dedicated to a Model, and need manual configuration. # The config of resources used by the Model Monitoring during the batch explanation for non-AutoML models. If not set, `n1-standard-2` machine type will be used by default.
"machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine.
"acceleratorCount": 42, # The number of accelerators to attach to the machine.
"acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count.
"machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required.
"reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation.
"key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value.
"reservationAffinityType": "A String", # Required. Specifies the reservation affinity type.
"values": [ # Optional. Corresponds to the label values of a reservation resource. This must be the full resource name of the reservation.
"A String",
],
},
"tpuTopology": "A String", # Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1").
},
"maxReplicaCount": 42, # Immutable. The maximum number of machine replicas the batch operation may be scaled to. The default value is 10.
"startingReplicaCount": 42, # Immutable. The number of machine replicas used at the start of the batch operation. If not set, Vertex AI decides starting number, not greater than max_replica_count
},
"defaultAlertCondition": { # Monitoring alert triggered condition. # Default alert condition for all the features.
"threshold": 3.14, # A condition that compares a stats value against a threshold. Alert will be triggered if value above the threshold.
},
"featureAlertConditions": { # Per feature alert condition will override default alert condition.
"a_key": { # Monitoring alert triggered condition.
"threshold": 3.14, # A condition that compares a stats value against a threshold. Alert will be triggered if value above the threshold.
},
},
"features": [ # Feature names interested in monitoring. These should be a subset of the input feature names specified in the monitoring schema. If the field is not specified all features outlied in the monitoring schema will be used.
"A String",
],
},
"featureDriftSpec": { # Data drift monitoring spec. Data drift measures the distribution distance between the current dataset and a baseline dataset. A typical use case is to detect data drift between the recent production serving dataset and the training dataset, or to compare the recent production dataset with a dataset from a previous period. # Input feature distribution drift monitoring spec.
"categoricalMetricType": "A String", # Supported metrics type: * l_infinity * jensen_shannon_divergence
"defaultCategoricalAlertCondition": { # Monitoring alert triggered condition. # Default alert condition for all the categorical features.
"threshold": 3.14, # A condition that compares a stats value against a threshold. Alert will be triggered if value above the threshold.
},
"defaultNumericAlertCondition": { # Monitoring alert triggered condition. # Default alert condition for all the numeric features.
"threshold": 3.14, # A condition that compares a stats value against a threshold. Alert will be triggered if value above the threshold.
},
"featureAlertConditions": { # Per feature alert condition will override default alert condition.
"a_key": { # Monitoring alert triggered condition.
"threshold": 3.14, # A condition that compares a stats value against a threshold. Alert will be triggered if value above the threshold.
},
},
"features": [ # Feature names / Prediction output names interested in monitoring. These should be a subset of the input feature names or prediction output names specified in the monitoring schema. If the field is not specified all features / prediction outputs outlied in the monitoring schema will be used.
"A String",
],
"numericMetricType": "A String", # Supported metrics type: * jensen_shannon_divergence
},
"predictionOutputDriftSpec": { # Data drift monitoring spec. Data drift measures the distribution distance between the current dataset and a baseline dataset. A typical use case is to detect data drift between the recent production serving dataset and the training dataset, or to compare the recent production dataset with a dataset from a previous period. # Prediction output distribution drift monitoring spec.
"categoricalMetricType": "A String", # Supported metrics type: * l_infinity * jensen_shannon_divergence
"defaultCategoricalAlertCondition": { # Monitoring alert triggered condition. # Default alert condition for all the categorical features.
"threshold": 3.14, # A condition that compares a stats value against a threshold. Alert will be triggered if value above the threshold.
},
"defaultNumericAlertCondition": { # Monitoring alert triggered condition. # Default alert condition for all the numeric features.
"threshold": 3.14, # A condition that compares a stats value against a threshold. Alert will be triggered if value above the threshold.
},
"featureAlertConditions": { # Per feature alert condition will override default alert condition.
"a_key": { # Monitoring alert triggered condition.
"threshold": 3.14, # A condition that compares a stats value against a threshold. Alert will be triggered if value above the threshold.
},
},
"features": [ # Feature names / Prediction output names interested in monitoring. These should be a subset of the input feature names or prediction output names specified in the monitoring schema. If the field is not specified all features / prediction outputs outlied in the monitoring schema will be used.
"A String",
],
"numericMetricType": "A String", # Supported metrics type: * jensen_shannon_divergence
},
},
"targetDataset": { # Model monitoring data input spec. # Target dataset.
"batchPredictionOutput": { # Data from Vertex AI Batch prediction job output. # Vertex AI Batch prediction Job.
"batchPredictionJob": "A String", # Vertex AI Batch prediction job resource name. The job must match the model version specified in [ModelMonitor].[model_monitoring_target].
},
"columnizedDataset": { # Input dataset spec. # Columnized dataset.
"bigquerySource": { # Dataset spec for data sotred in BigQuery. # BigQuery data source.
"query": "A String", # Standard SQL to be used instead of the `table_uri`.
"tableUri": "A String", # BigQuery URI to a table, up to 2000 characters long. All the columns in the table will be selected. Accepted forms: * BigQuery path. For example: `bq://projectId.bqDatasetId.bqTableId`.
},
"gcsSource": { # Dataset spec for data stored in Google Cloud Storage. # Google Cloud Storage data source.
"format": "A String", # Data format of the dataset.
"gcsUri": "A String", # Google Cloud Storage URI to the input file(s). May contain wildcards. For more information on wildcards, see https://cloud.google.com/storage/docs/gsutil/addlhelp/WildcardNames.
},
"timestampField": "A String", # The timestamp field. Usually for serving data.
"vertexDataset": "A String", # Resource name of the Vertex AI managed dataset.
},
"timeInterval": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # The time interval (pair of start_time and end_time) for which results should be returned.
"endTime": "A String", # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
"startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
},
"timeOffset": { # Time offset setting. # The time offset setting for which results should be returned.
"offset": "A String", # [offset] is the time difference from the cut-off time. For scheduled jobs, the cut-off time is the scheduled time. For non-scheduled jobs, it's the time when the job was created. Currently we support the following format: 'w|W': Week, 'd|D': Day, 'h|H': Hour E.g. '1h' stands for 1 hour, '2d' stands for 2 days.
"window": "A String", # [window] refers to the scope of data selected for analysis. It allows you to specify the quantity of data you wish to examine. Currently we support the following format: 'w|W': Week, 'd|D': Day, 'h|H': Hour E.g. '1h' stands for 1 hour, '2d' stands for 2 days.
},
"vertexEndpointLogs": { # Data from Vertex AI Endpoint request response logging. # Vertex AI Endpoint request & response logging.
"endpoints": [ # List of endpoint resource names. The endpoints must enable the logging with the [Endpoint].[request_response_logging_config], and must contain the deployed model corresponding to the model version specified in [ModelMonitor].[model_monitoring_target].
"A String",
],
},
},
},
"outputSpec": { # Specification for the export destination of monitoring results, including metrics, logs, etc. # The Output destination spec for metrics, error logs, etc.
"gcsBaseDirectory": { # The Google Cloud Storage location where the output is to be written to. # Google Cloud Storage base folder path for metrics, error logs, etc.
"outputUriPrefix": "A String", # Required. Google Cloud Storage URI to output directory. If the uri doesn't end with '/', a '/' will be automatically appended. The directory is created if it doesn't exist.
},
},
},
"name": "A String", # Output only. Resource name of a ModelMonitoringJob. Format: `projects/{project_id}/locations/{location_id}/modelMonitors/{model_monitor_id}/modelMonitoringJobs/{model_monitoring_job_id}`
"schedule": "A String", # Output only. Schedule resource name. It will only appear when this job is triggered by a schedule.
"scheduleTime": "A String", # Output only. Timestamp when this ModelMonitoringJob was scheduled. It will only appear when this job is triggered by a schedule.
"state": "A String", # Output only. The state of the monitoring job. * When the job is still creating, the state will be 'JOB_STATE_PENDING'. * Once the job is successfully created, the state will be 'JOB_STATE_RUNNING'. * Once the job is finished, the state will be one of 'JOB_STATE_FAILED', 'JOB_STATE_SUCCEEDED', 'JOB_STATE_PARTIALLY_SUCCEEDED'.
"updateTime": "A String", # Output only. Timestamp when this ModelMonitoringJob was updated most recently.
},
"modelMonitoringJobId": "A String", # Optional. The ID to use for the Model Monitoring Job, which will become the final component of the model monitoring job resource name. The maximum length is 63 characters, and valid characters are `/^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$/`.
"parent": "A String", # Required. The parent of the ModelMonitoringJob. Format: `projects/{project}/locations/{location}/modelMoniitors/{model_monitor}`
},
"createNotebookExecutionJobRequest": { # Request message for [NotebookService.CreateNotebookExecutionJob] # Request for NotebookService.CreateNotebookExecutionJob.
"notebookExecutionJob": { # NotebookExecutionJob represents an instance of a notebook execution. # Required. The NotebookExecutionJob to create.
"createTime": "A String", # Output only. Timestamp when this NotebookExecutionJob was created.
"customEnvironmentSpec": { # Compute configuration to use for an execution job. # The custom compute configuration for an execution job.
"machineSpec": { # Specification of a single machine. # The specification of a single machine for the execution job.
"acceleratorCount": 42, # The number of accelerators to attach to the machine.
"acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count.
"machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required.
"reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation.
"key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value.
"reservationAffinityType": "A String", # Required. Specifies the reservation affinity type.
"values": [ # Optional. Corresponds to the label values of a reservation resource. This must be the full resource name of the reservation.
"A String",
],
},
"tpuTopology": "A String", # Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1").
},
"networkSpec": { # Network spec. # The network configuration to use for the execution job.
"enableInternetAccess": True or False, # Whether to enable public internet access. Default false.
"network": "A String", # The full name of the Google Compute Engine [network](https://cloud.google.com//compute/docs/networks-and-firewalls#networks)
"subnetwork": "A String", # The name of the subnet that this instance is in. Format: `projects/{project_id_or_number}/regions/{region}/subnetworks/{subnetwork_id}`
},
"persistentDiskSpec": { # Represents the spec of persistent disk options. # The specification of a persistent disk to attach for the execution job.
"diskSizeGb": "A String", # Size in GB of the disk (default is 100GB).
"diskType": "A String", # Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) "pd-extreme" (Extreme Persistent Disk)
},
},
"dataformRepositorySource": { # The Dataform Repository containing the input notebook. # The Dataform Repository pointing to a single file notebook repository.
"commitSha": "A String", # The commit SHA to read repository with. If unset, the file will be read at HEAD.
"dataformRepositoryResourceName": "A String", # The resource name of the Dataform Repository. Format: `projects/{project_id}/locations/{location}/repositories/{repository_id}`
},
"directNotebookSource": { # The content of the input notebook in ipynb format. # The contents of an input notebook file.
"content": "A String", # The base64-encoded contents of the input notebook file.
},
"displayName": "A String", # The display name of the NotebookExecutionJob. The name can be up to 128 characters long and can consist of any UTF-8 characters.
"encryptionSpec": { # Represents a customer-managed encryption key spec that can be applied to a top-level resource. # Customer-managed encryption key spec for the notebook execution job. This field is auto-populated if the NotebookService.NotebookRuntimeTemplate has an encryption spec.
"kmsKeyName": "A String", # Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. The key needs to be in the same region as where the compute resource is created.
},
"executionTimeout": "A String", # Max running time of the execution job in seconds (default 86400s / 24 hrs).
"executionUser": "A String", # The user email to run the execution as. Only supported by Colab runtimes.
"gcsNotebookSource": { # The Cloud Storage uri for the input notebook. # The Cloud Storage url pointing to the ipynb file. Format: `gs://bucket/notebook_file.ipynb`
"generation": "A String", # The version of the Cloud Storage object to read. If unset, the current version of the object is read. See https://cloud.google.com/storage/docs/metadata#generation-number.
"uri": "A String", # The Cloud Storage uri pointing to the ipynb file. Format: `gs://bucket/notebook_file.ipynb`
},
"gcsOutputUri": "A String", # The Cloud Storage location to upload the result to. Format: `gs://bucket-name`
"jobState": "A String", # Output only. The state of the NotebookExecutionJob.
"labels": { # The labels with user-defined metadata to organize NotebookExecutionJobs. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.
"a_key": "A String",
},
"name": "A String", # Output only. The resource name of this NotebookExecutionJob. Format: `projects/{project_id}/locations/{location}/notebookExecutionJobs/{job_id}`
"notebookRuntimeTemplateResourceName": "A String", # The NotebookRuntimeTemplate to source compute configuration from.
"scheduleResourceName": "A String", # Output only. The Schedule resource name if this job is triggered by one. Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}`
"serviceAccount": "A String", # The service account to run the execution as.
"status": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Populated when the NotebookExecutionJob is completed. When there is an error during notebook execution, the error details are populated.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"updateTime": "A String", # Output only. Timestamp when this NotebookExecutionJob was most recently updated.
},
"notebookExecutionJobId": "A String", # Optional. User specified ID for the NotebookExecutionJob.
"parent": "A String", # Required. The resource name of the Location to create the NotebookExecutionJob. Format: `projects/{project}/locations/{location}`
},
"createPipelineJobRequest": { # Request message for PipelineService.CreatePipelineJob. # Request for PipelineService.CreatePipelineJob. CreatePipelineJobRequest.parent field is required (format: projects/{project}/locations/{location}).
"parent": "A String", # Required. The resource name of the Location to create the PipelineJob in. Format: `projects/{project}/locations/{location}`
"pipelineJob": { # An instance of a machine learning PipelineJob. # Required. The PipelineJob to create.
"createTime": "A String", # Output only. Pipeline creation time.
"displayName": "A String", # The display name of the Pipeline. The name can be up to 128 characters long and can consist of any UTF-8 characters.
"encryptionSpec": { # Represents a customer-managed encryption key spec that can be applied to a top-level resource. # Customer-managed encryption key spec for a pipelineJob. If set, this PipelineJob and all of its sub-resources will be secured by this key.
"kmsKeyName": "A String", # Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. The key needs to be in the same region as where the compute resource is created.
},
"endTime": "A String", # Output only. Pipeline end time.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. The error that occurred during pipeline execution. Only populated when the pipeline's state is FAILED or CANCELLED.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"jobDetail": { # The runtime detail of PipelineJob. # Output only. The details of pipeline run. Not available in the list view.
"pipelineContext": { # Instance of a general context. # Output only. The context of the pipeline.
"createTime": "A String", # Output only. Timestamp when this Context was created.
"description": "A String", # Description of the Context
"displayName": "A String", # User provided display name of the Context. May be up to 128 Unicode characters.
"etag": "A String", # An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
"labels": { # The labels with user-defined metadata to organize your Contexts. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Context (System labels are excluded).
"a_key": "A String",
},
"metadata": { # Properties of the Context. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB.
"a_key": "", # Properties of the object.
},
"name": "A String", # Immutable. The resource name of the Context.
"parentContexts": [ # Output only. A list of resource names of Contexts that are parents of this Context. A Context may have at most 10 parent_contexts.
"A String",
],
"schemaTitle": "A String", # The title of the schema describing the metadata. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"schemaVersion": "A String", # The version of the schema in schema_name to use. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"updateTime": "A String", # Output only. Timestamp when this Context was last updated.
},
"pipelineRunContext": { # Instance of a general context. # Output only. The context of the current pipeline run.
"createTime": "A String", # Output only. Timestamp when this Context was created.
"description": "A String", # Description of the Context
"displayName": "A String", # User provided display name of the Context. May be up to 128 Unicode characters.
"etag": "A String", # An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
"labels": { # The labels with user-defined metadata to organize your Contexts. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Context (System labels are excluded).
"a_key": "A String",
},
"metadata": { # Properties of the Context. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB.
"a_key": "", # Properties of the object.
},
"name": "A String", # Immutable. The resource name of the Context.
"parentContexts": [ # Output only. A list of resource names of Contexts that are parents of this Context. A Context may have at most 10 parent_contexts.
"A String",
],
"schemaTitle": "A String", # The title of the schema describing the metadata. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"schemaVersion": "A String", # The version of the schema in schema_name to use. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"updateTime": "A String", # Output only. Timestamp when this Context was last updated.
},
"taskDetails": [ # Output only. The runtime details of the tasks under the pipeline.
{ # The runtime detail of a task execution.
"createTime": "A String", # Output only. Task create time.
"endTime": "A String", # Output only. Task end time.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. The error that occurred during task execution. Only populated when the task's state is FAILED or CANCELLED.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"execution": { # Instance of a general execution. # Output only. The execution metadata of the task.
"createTime": "A String", # Output only. Timestamp when this Execution was created.
"description": "A String", # Description of the Execution
"displayName": "A String", # User provided display name of the Execution. May be up to 128 Unicode characters.
"etag": "A String", # An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
"labels": { # The labels with user-defined metadata to organize your Executions. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Execution (System labels are excluded).
"a_key": "A String",
},
"metadata": { # Properties of the Execution. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB.
"a_key": "", # Properties of the object.
},
"name": "A String", # Output only. The resource name of the Execution.
"schemaTitle": "A String", # The title of the schema describing the metadata. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"schemaVersion": "A String", # The version of the schema in `schema_title` to use. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"state": "A String", # The state of this Execution. This is a property of the Execution, and does not imply or capture any ongoing process. This property is managed by clients (such as Vertex AI Pipelines) and the system does not prescribe or check the validity of state transitions.
"updateTime": "A String", # Output only. Timestamp when this Execution was last updated.
},
"executorDetail": { # The runtime detail of a pipeline executor. # Output only. The detailed execution info.
"containerDetail": { # The detail of a container execution. It contains the job names of the lifecycle of a container execution. # Output only. The detailed info for a container executor.
"failedMainJobs": [ # Output only. The names of the previously failed CustomJob for the main container executions. The list includes the all attempts in chronological order.
"A String",
],
"failedPreCachingCheckJobs": [ # Output only. The names of the previously failed CustomJob for the pre-caching-check container executions. This job will be available if the PipelineJob.pipeline_spec specifies the `pre_caching_check` hook in the lifecycle events. The list includes the all attempts in chronological order.
"A String",
],
"mainJob": "A String", # Output only. The name of the CustomJob for the main container execution.
"preCachingCheckJob": "A String", # Output only. The name of the CustomJob for the pre-caching-check container execution. This job will be available if the PipelineJob.pipeline_spec specifies the `pre_caching_check` hook in the lifecycle events.
},
"customJobDetail": { # The detailed info for a custom job executor. # Output only. The detailed info for a custom job executor.
"failedJobs": [ # Output only. The names of the previously failed CustomJob. The list includes the all attempts in chronological order.
"A String",
],
"job": "A String", # Output only. The name of the CustomJob.
},
},
"inputs": { # Output only. The runtime input artifacts of the task.
"a_key": { # A list of artifact metadata.
"artifacts": [ # Output only. A list of artifact metadata.
{ # Instance of a general artifact.
"createTime": "A String", # Output only. Timestamp when this Artifact was created.
"description": "A String", # Description of the Artifact
"displayName": "A String", # User provided display name of the Artifact. May be up to 128 Unicode characters.
"etag": "A String", # An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
"labels": { # The labels with user-defined metadata to organize your Artifacts. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Artifact (System labels are excluded).
"a_key": "A String",
},
"metadata": { # Properties of the Artifact. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB.
"a_key": "", # Properties of the object.
},
"name": "A String", # Output only. The resource name of the Artifact.
"schemaTitle": "A String", # The title of the schema describing the metadata. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"schemaVersion": "A String", # The version of the schema in schema_name to use. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"state": "A String", # The state of this Artifact. This is a property of the Artifact, and does not imply or capture any ongoing process. This property is managed by clients (such as Vertex AI Pipelines), and the system does not prescribe or check the validity of state transitions.
"updateTime": "A String", # Output only. Timestamp when this Artifact was last updated.
"uri": "A String", # The uniform resource identifier of the artifact file. May be empty if there is no actual artifact file.
},
],
},
},
"outputs": { # Output only. The runtime output artifacts of the task.
"a_key": { # A list of artifact metadata.
"artifacts": [ # Output only. A list of artifact metadata.
{ # Instance of a general artifact.
"createTime": "A String", # Output only. Timestamp when this Artifact was created.
"description": "A String", # Description of the Artifact
"displayName": "A String", # User provided display name of the Artifact. May be up to 128 Unicode characters.
"etag": "A String", # An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
"labels": { # The labels with user-defined metadata to organize your Artifacts. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Artifact (System labels are excluded).
"a_key": "A String",
},
"metadata": { # Properties of the Artifact. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB.
"a_key": "", # Properties of the object.
},
"name": "A String", # Output only. The resource name of the Artifact.
"schemaTitle": "A String", # The title of the schema describing the metadata. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"schemaVersion": "A String", # The version of the schema in schema_name to use. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"state": "A String", # The state of this Artifact. This is a property of the Artifact, and does not imply or capture any ongoing process. This property is managed by clients (such as Vertex AI Pipelines), and the system does not prescribe or check the validity of state transitions.
"updateTime": "A String", # Output only. Timestamp when this Artifact was last updated.
"uri": "A String", # The uniform resource identifier of the artifact file. May be empty if there is no actual artifact file.
},
],
},
},
"parentTaskId": "A String", # Output only. The id of the parent task if the task is within a component scope. Empty if the task is at the root level.
"pipelineTaskStatus": [ # Output only. A list of task status. This field keeps a record of task status evolving over time.
{ # A single record of the task status.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # 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.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"state": "A String", # Output only. The state of the task.
"updateTime": "A String", # Output only. Update time of this status.
},
],
"startTime": "A String", # Output only. Task start time.
"state": "A String", # Output only. State of the task.
"taskId": "A String", # Output only. The system generated ID of the task.
"taskName": "A String", # Output only. The user specified name of the task that is defined in pipeline_spec.
},
],
},
"labels": { # The labels with user-defined metadata to organize PipelineJob. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. Note there is some reserved label key for Vertex AI Pipelines. - `vertex-ai-pipelines-run-billing-id`, user set value will get overrided.
"a_key": "A String",
},
"name": "A String", # Output only. The resource name of the PipelineJob.
"network": "A String", # The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the Pipeline Job's workload should be peered. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. Private services access must already be configured for the network. Pipeline job will apply the network configuration to the Google Cloud resources being launched, if applied, such as Vertex AI Training or Dataflow job. If left unspecified, the workload is not peered with any network.
"originalPipelineJobId": "A String", # Optional. The original pipeline job id if this pipeline job is a rerun of a previous pipeline job.
"pipelineSpec": { # The spec of the pipeline.
"a_key": "", # Properties of the object.
},
"pipelineTaskRerunConfigs": [ # Optional. The rerun configs for each task in the pipeline job. By default, the rerun will: 1. Use the same input artifacts as the original run. 2. Use the same input parameters as the original run. 3. Skip all the tasks that are already succeeded in the original run. 4. Rerun all the tasks that are not succeeded in the original run. By providing this field, users can override the default behavior and specify the rerun config for each task.
{ # User provided rerun config to submit a rerun pipelinejob. This includes 1. Which task to rerun 2. User override input parameters and artifacts.
"inputs": { # Runtime inputs data of the task. # Optional. The runtime input of the task overridden by the user.
"artifacts": { # Optional. Input artifacts.
"a_key": { # A list of artifact metadata.
"artifacts": [ # Optional. A list of artifact metadata.
{ # The definition of a runtime artifact.
"customProperties": { # The custom properties of the artifact. Deprecated. Use RuntimeArtifact.metadata instead.
"a_key": { # Value is the value of the field.
"doubleValue": 3.14, # A double value.
"intValue": "A String", # An integer value.
"stringValue": "A String", # A string value.
},
},
"metadata": { # Properties of the Artifact.
"a_key": "", # Properties of the object.
},
"name": "A String", # The name of an artifact.
"properties": { # The properties of the artifact. Deprecated. Use RuntimeArtifact.metadata instead.
"a_key": { # Value is the value of the field.
"doubleValue": 3.14, # A double value.
"intValue": "A String", # An integer value.
"stringValue": "A String", # A string value.
},
},
"type": { # The definition of a artifact type in MLMD. # The type of the artifact.
"instanceSchema": "A String", # Contains a raw YAML string, describing the format of the properties of the type.
"schemaTitle": "A String", # The name of the type. The format of the title must be: `.`. Examples: - `aiplatform.Model` - `acme.CustomModel` When this field is set, the type must be pre-registered in the MLMD store.
"schemaUri": "A String", # Points to a YAML file stored on Cloud Storage describing the format. Deprecated. Use PipelineArtifactTypeSchema.schema_title or PipelineArtifactTypeSchema.instance_schema instead.
"schemaVersion": "A String", # The schema version of the artifact. If the value is not set, it defaults to the latest version in the system.
},
"uri": "A String", # The URI of the artifact.
},
],
},
},
"parameterValues": { # Optional. Input parameters.
"a_key": "",
},
},
"skipDownstreamTasks": True or False, # Optional. Whether to skip downstream tasks. Default value is False.
"skipTask": True or False, # Optional. Whether to skip this task. Default value is False.
"taskId": "A String", # Optional. The system generated ID of the task. Retrieved from original run.
"taskName": "A String", # Optional. The name of the task.
},
],
"preflightValidations": True or False, # Optional. Whether to do component level validations before job creation.
"pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I for PipelineJob.
"networkAttachment": "A String", # Optional. The name of the Compute Engine [network attachment](https://cloud.google.com/vpc/docs/about-network-attachments) to attach to the resource within the region and user project. To specify this field, you must have already [created a network attachment] (https://cloud.google.com/vpc/docs/create-manage-network-attachments#create-network-attachments). This field is only used for resources using PSC-I.
},
"reservedIpRanges": [ # A list of names for the reserved ip ranges under the VPC network that can be used for this Pipeline Job's workload. If set, we will deploy the Pipeline Job's workload within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network. Example: ['vertex-ai-ip-range'].
"A String",
],
"runtimeConfig": { # The runtime config of a PipelineJob. # Runtime config of the pipeline.
"defaultRuntime": { # The default runtime for the PipelineJob. # Optional. The default runtime for the PipelineJob. If not provided, Vertex Custom Job(on demand) is used as the runtime. For Vertex Custom Job, please refer to https://cloud.google.com/vertex-ai/docs/training/overview.
"persistentResourceRuntimeDetail": { # Persistent resource based runtime detail. For more information, refer to https://cloud.google.com/vertex-ai/docs/training/persistent-resource-overview # Persistent resource based runtime detail.
"persistentResourceName": "A String", # Persistent resource name. Format: `projects/{project}/locations/{location}/persistentResources/{persistent_resource}`
"taskResourceUnavailableTimeoutBehavior": "A String", # Specifies the behavior to take if the timeout is reached.
"taskResourceUnavailableWaitTimeMs": "A String", # The max time a pipeline task waits for the required CPU, memory, or accelerator resource to become available from the specified persistent resource. Default wait time is 0.
},
},
"failurePolicy": "A String", # Represents the failure policy of a pipeline. Currently, the default of a pipeline is that the pipeline will continue to run until no more tasks can be executed, also known as PIPELINE_FAILURE_POLICY_FAIL_SLOW. However, if a pipeline is set to PIPELINE_FAILURE_POLICY_FAIL_FAST, it will stop scheduling any new tasks when a task has failed. Any scheduled tasks will continue to completion.
"gcsOutputDirectory": "A String", # Required. A path in a Cloud Storage bucket, which will be treated as the root output directory of the pipeline. It is used by the system to generate the paths of output artifacts. The artifact paths are generated with a sub-path pattern `{job_id}/{task_id}/{output_key}` under the specified output directory. The service account specified in this pipeline must have the `storage.objects.get` and `storage.objects.create` permissions for this bucket.
"inputArtifacts": { # The runtime artifacts of the PipelineJob. The key will be the input artifact name and the value would be one of the InputArtifact.
"a_key": { # The type of an input artifact.
"artifactId": "A String", # Artifact resource id from MLMD. Which is the last portion of an artifact resource name: `projects/{project}/locations/{location}/metadataStores/default/artifacts/{artifact_id}`. The artifact must stay within the same project, location and default metadatastore as the pipeline.
},
},
"parameterValues": { # The runtime parameters of the PipelineJob. The parameters will be passed into PipelineJob.pipeline_spec to replace the placeholders at runtime. This field is used by pipelines built using `PipelineJob.pipeline_spec.schema_version` 2.1.0, such as pipelines built using Kubeflow Pipelines SDK 1.9 or higher and the v2 DSL.
"a_key": "",
},
"parameters": { # Deprecated. Use RuntimeConfig.parameter_values instead. The runtime parameters of the PipelineJob. The parameters will be passed into PipelineJob.pipeline_spec to replace the placeholders at runtime. This field is used by pipelines built using `PipelineJob.pipeline_spec.schema_version` 2.0.0 or lower, such as pipelines built using Kubeflow Pipelines SDK 1.8 or lower.
"a_key": { # Value is the value of the field.
"doubleValue": 3.14, # A double value.
"intValue": "A String", # An integer value.
"stringValue": "A String", # A string value.
},
},
},
"satisfiesPzi": True or False, # Output only. Reserved for future use.
"satisfiesPzs": True or False, # Output only. Reserved for future use.
"scheduleName": "A String", # Output only. The schedule resource name. Only returned if the Pipeline is created by Schedule API.
"serviceAccount": "A String", # The service account that the pipeline workload runs as. If not specified, the Compute Engine default service account in the project will be used. See https://cloud.google.com/compute/docs/access/service-accounts#default_service_account Users starting the pipeline must have the `iam.serviceAccounts.actAs` permission on this service account.
"startTime": "A String", # Output only. Pipeline start time.
"state": "A String", # Output only. The detailed state of the job.
"templateMetadata": { # Pipeline template metadata if PipelineJob.template_uri is from supported template registry. Currently, the only supported registry is Artifact Registry. # Output only. Pipeline template metadata. Will fill up fields if PipelineJob.template_uri is from supported template registry.
"version": "A String", # The version_name in artifact registry. Will always be presented in output if the PipelineJob.template_uri is from supported template registry. Format is "sha256:abcdef123456...".
},
"templateUri": "A String", # A template uri from where the PipelineJob.pipeline_spec, if empty, will be downloaded. Currently, only uri from Vertex Template Registry & Gallery is supported. Reference to https://cloud.google.com/vertex-ai/docs/pipelines/create-pipeline-template.
"updateTime": "A String", # Output only. Timestamp when this PipelineJob was most recently updated.
},
"pipelineJobId": "A String", # The ID to use for the PipelineJob, which will become the final component of the PipelineJob name. If not provided, an ID will be automatically generated. This value should be less than 128 characters, and valid characters are `/a-z-/`.
},
"createTime": "A String", # Output only. Timestamp when this Schedule was created.
"cron": "A String", # Cron schedule (https://en.wikipedia.org/wiki/Cron) to launch scheduled runs. To explicitly set a timezone to the cron tab, apply a prefix in the cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or "TZ=${IANA_TIME_ZONE}". The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone database. For example, "CRON_TZ=America/New_York 1 * * * *", or "TZ=America/New_York 1 * * * *".
"displayName": "A String", # Required. User provided name of the Schedule. The name can be up to 128 characters long and can consist of any UTF-8 characters.
"endTime": "A String", # Optional. Timestamp after which no new runs can be scheduled. If specified, The schedule will be completed when either end_time is reached or when scheduled_run_count >= max_run_count. If not specified, new runs will keep getting scheduled until this Schedule is paused or deleted. Already scheduled runs will be allowed to complete. Unset if not specified.
"lastPauseTime": "A String", # Output only. Timestamp when this Schedule was last paused. Unset if never paused.
"lastResumeTime": "A String", # Output only. Timestamp when this Schedule was last resumed. Unset if never resumed from pause.
"lastScheduledRunResponse": { # Status of a scheduled run. # Output only. Response of the last scheduled run. This is the response for starting the scheduled requests and not the execution of the operations/jobs created by the requests (if applicable). Unset if no run has been scheduled yet.
"runResponse": "A String", # The response of the scheduled run.
"scheduledRunTime": "A String", # The scheduled run time based on the user-specified schedule.
},
"maxConcurrentRunCount": "A String", # Required. Maximum number of runs that can be started concurrently for this Schedule. This is the limit for starting the scheduled requests and not the execution of the operations/jobs created by the requests (if applicable).
"maxRunCount": "A String", # Optional. Maximum run count of the schedule. If specified, The schedule will be completed when either started_run_count >= max_run_count or when end_time is reached. If not specified, new runs will keep getting scheduled until this Schedule is paused or deleted. Already scheduled runs will be allowed to complete. Unset if not specified.
"name": "A String", # Immutable. The resource name of the Schedule.
"nextRunTime": "A String", # Output only. Timestamp when this Schedule should schedule the next run. Having a next_run_time in the past means the runs are being started behind schedule.
"startTime": "A String", # Optional. Timestamp after which the first run can be scheduled. Default to Schedule create time if not specified.
"startedRunCount": "A String", # Output only. The number of runs started by this schedule.
"state": "A String", # Output only. The state of this Schedule.
"updateTime": "A String", # Output only. Timestamp when this Schedule was updated.
}

x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # An instance of a Schedule periodically schedules runs to make API calls based on user specified time specification and API request type.
"allowQueueing": True or False, # Optional. Whether new scheduled runs can be queued when max_concurrent_runs limit is reached. If set to true, new runs will be queued instead of skipped. Default to false.
"catchUp": True or False, # Output only. Whether to backfill missed runs when the schedule is resumed from PAUSED state. If set to true, all missed runs will be scheduled. New runs will be scheduled after the backfill is complete. Default to false.
"createModelMonitoringJobRequest": { # Request message for ModelMonitoringService.CreateModelMonitoringJob. # Request for ModelMonitoringService.CreateModelMonitoringJob.
"modelMonitoringJob": { # Represents a model monitoring job that analyze dataset using different monitoring algorithm. # Required. The ModelMonitoringJob to create
"createTime": "A String", # Output only. Timestamp when this ModelMonitoringJob was created.
"displayName": "A String", # The display name of the ModelMonitoringJob. The name can be up to 128 characters long and can consist of any UTF-8.
"jobExecutionDetail": { # Represent the execution details of the job. # Output only. Execution results for all the monitoring objectives.
"baselineDatasets": [ # Processed baseline datasets.
{ # Processed dataset information.
"location": "A String", # Actual data location of the processed dataset.
"timeRange": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Dataset time range information if any.
"endTime": "A String", # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
"startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
},
},
],
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Additional job error status.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"objectiveStatus": { # Status of data processing for each monitoring objective. Key is the objective.
"a_key": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
},
"targetDatasets": [ # Processed target datasets.
{ # Processed dataset information.
"location": "A String", # Actual data location of the processed dataset.
"timeRange": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Dataset time range information if any.
"endTime": "A String", # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
"startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
},
},
],
},
"modelMonitoringSpec": { # Monitoring monitoring job spec. It outlines the specifications for monitoring objectives, notifications, and result exports. # Monitoring monitoring job spec. It outlines the specifications for monitoring objectives, notifications, and result exports. If left blank, the default monitoring specifications from the top-level resource 'ModelMonitor' will be applied. If provided, we will use the specification defined here rather than the default one.
"notificationSpec": { # Notification spec(email, notification channel) for model monitoring statistics/alerts. # The model monitoring notification spec.
"emailConfig": { # The config for email alerts. # Email alert config.
"userEmails": [ # The email addresses to send the alerts.
"A String",
],
},
"enableCloudLogging": True or False, # Dump the anomalies to Cloud Logging. The anomalies will be put to json payload encoded from proto google.cloud.aiplatform.logging.ModelMonitoringAnomaliesLogEntry. This can be further sinked to Pub/Sub or any other services supported by Cloud Logging.
"notificationChannelConfigs": [ # Notification channel config.
{ # Google Cloud Notification Channel config.
"notificationChannel": "A String", # Resource names of the NotificationChannels. Must be of the format `projects//notificationChannels/`
},
],
},
"objectiveSpec": { # Monitoring objectives spec. # The monitoring objective spec.
"baselineDataset": { # Model monitoring data input spec. # Baseline dataset. It could be the training dataset or production serving dataset from a previous period.
"batchPredictionOutput": { # Data from Vertex AI Batch prediction job output. # Vertex AI Batch prediction Job.
"batchPredictionJob": "A String", # Vertex AI Batch prediction job resource name. The job must match the model version specified in [ModelMonitor].[model_monitoring_target].
},
"columnizedDataset": { # Input dataset spec. # Columnized dataset.
"bigquerySource": { # Dataset spec for data sotred in BigQuery. # BigQuery data source.
"query": "A String", # Standard SQL to be used instead of the `table_uri`.
"tableUri": "A String", # BigQuery URI to a table, up to 2000 characters long. All the columns in the table will be selected. Accepted forms: * BigQuery path. For example: `bq://projectId.bqDatasetId.bqTableId`.
},
"gcsSource": { # Dataset spec for data stored in Google Cloud Storage. # Google Cloud Storage data source.
"format": "A String", # Data format of the dataset.
"gcsUri": "A String", # Google Cloud Storage URI to the input file(s). May contain wildcards. For more information on wildcards, see https://cloud.google.com/storage/docs/gsutil/addlhelp/WildcardNames.
},
"timestampField": "A String", # The timestamp field. Usually for serving data.
"vertexDataset": "A String", # Resource name of the Vertex AI managed dataset.
},
"timeInterval": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # The time interval (pair of start_time and end_time) for which results should be returned.
"endTime": "A String", # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
"startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
},
"timeOffset": { # Time offset setting. # The time offset setting for which results should be returned.
"offset": "A String", # [offset] is the time difference from the cut-off time. For scheduled jobs, the cut-off time is the scheduled time. For non-scheduled jobs, it's the time when the job was created. Currently we support the following format: 'w|W': Week, 'd|D': Day, 'h|H': Hour E.g. '1h' stands for 1 hour, '2d' stands for 2 days.
"window": "A String", # [window] refers to the scope of data selected for analysis. It allows you to specify the quantity of data you wish to examine. Currently we support the following format: 'w|W': Week, 'd|D': Day, 'h|H': Hour E.g. '1h' stands for 1 hour, '2d' stands for 2 days.
},
"vertexEndpointLogs": { # Data from Vertex AI Endpoint request response logging. # Vertex AI Endpoint request & response logging.
"endpoints": [ # List of endpoint resource names. The endpoints must enable the logging with the [Endpoint].[request_response_logging_config], and must contain the deployed model corresponding to the model version specified in [ModelMonitor].[model_monitoring_target].
"A String",
],
},
},
"explanationSpec": { # Specification of Model explanation. # The explanation spec. This spec is required when the objectives spec includes feature attribution objectives.
"metadata": { # Metadata describing the Model's input and output for explanation. # Optional. Metadata describing the Model's input and output for explanation.
"featureAttributionsSchemaUri": "A String", # Points to a YAML file stored on Google Cloud Storage describing the format of the feature attributions. The schema is defined as an OpenAPI 3.0.2 [Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). AutoML tabular Models always have this field populated by Vertex AI. Note: The URI given on output may be different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.
"inputs": { # Required. Map from feature names to feature input metadata. Keys are the name of the features. Values are the specification of the feature. An empty InputMetadata is valid. It describes a text feature which has the name specified as the key in ExplanationMetadata.inputs. The baseline of the empty feature is chosen by Vertex AI. For Vertex AI-provided Tensorflow images, the key can be any friendly name of the feature. Once specified, featureAttributions are keyed by this key (if not grouped with another feature). For custom images, the key must match with the key in instance.
"a_key": { # Metadata of the input of a feature. Fields other than InputMetadata.input_baselines are applicable only for Models that are using Vertex AI-provided images for Tensorflow.
"denseShapeTensorName": "A String", # Specifies the shape of the values of the input if the input is a sparse representation. Refer to Tensorflow documentation for more details: https://www.tensorflow.org/api_docs/python/tf/sparse/SparseTensor.
"encodedBaselines": [ # A list of baselines for the encoded tensor. The shape of each baseline should match the shape of the encoded tensor. If a scalar is provided, Vertex AI broadcasts to the same shape as the encoded tensor.
"",
],
"encodedTensorName": "A String", # Encoded tensor is a transformation of the input tensor. Must be provided if choosing Integrated Gradients attribution or XRAI attribution and the input tensor is not differentiable. An encoded tensor is generated if the input tensor is encoded by a lookup table.
"encoding": "A String", # Defines how the feature is encoded into the input tensor. Defaults to IDENTITY.
"featureValueDomain": { # Domain details of the input feature value. Provides numeric information about the feature, such as its range (min, max). If the feature has been pre-processed, for example with z-scoring, then it provides information about how to recover the original feature. For example, if the input feature is an image and it has been pre-processed to obtain 0-mean and stddev = 1 values, then original_mean, and original_stddev refer to the mean and stddev of the original feature (e.g. image tensor) from which input feature (with mean = 0 and stddev = 1) was obtained. # The domain details of the input feature value. Like min/max, original mean or standard deviation if normalized.
"maxValue": 3.14, # The maximum permissible value for this feature.
"minValue": 3.14, # The minimum permissible value for this feature.
"originalMean": 3.14, # If this input feature has been normalized to a mean value of 0, the original_mean specifies the mean value of the domain prior to normalization.
"originalStddev": 3.14, # If this input feature has been normalized to a standard deviation of 1.0, the original_stddev specifies the standard deviation of the domain prior to normalization.
},
"groupName": "A String", # Name of the group that the input belongs to. Features with the same group name will be treated as one feature when computing attributions. Features grouped together can have different shapes in value. If provided, there will be one single attribution generated in Attribution.feature_attributions, keyed by the group name.
"indexFeatureMapping": [ # A list of feature names for each index in the input tensor. Required when the input InputMetadata.encoding is BAG_OF_FEATURES, BAG_OF_FEATURES_SPARSE, INDICATOR.
"A String",
],
"indicesTensorName": "A String", # Specifies the index of the values of the input tensor. Required when the input tensor is a sparse representation. Refer to Tensorflow documentation for more details: https://www.tensorflow.org/api_docs/python/tf/sparse/SparseTensor.
"inputBaselines": [ # Baseline inputs for this feature. If no baseline is specified, Vertex AI chooses the baseline for this feature. If multiple baselines are specified, Vertex AI returns the average attributions across them in Attribution.feature_attributions. For Vertex AI-provided Tensorflow images (both 1.x and 2.x), the shape of each baseline must match the shape of the input tensor. If a scalar is provided, we broadcast to the same shape as the input tensor. For custom images, the element of the baselines must be in the same format as the feature's input in the instance[]. The schema of any single instance may be specified via Endpoint's DeployedModels' Model's PredictSchemata's instance_schema_uri.
"",
],
"inputTensorName": "A String", # Name of the input tensor for this feature. Required and is only applicable to Vertex AI-provided images for Tensorflow.
"modality": "A String", # Modality of the feature. Valid values are: numeric, image. Defaults to numeric.
"visualization": { # Visualization configurations for image explanation. # Visualization configurations for image explanation.
"clipPercentLowerbound": 3.14, # Excludes attributions below the specified percentile, from the highlighted areas. Defaults to 62.
"clipPercentUpperbound": 3.14, # Excludes attributions above the specified percentile from the highlighted areas. Using the clip_percent_upperbound and clip_percent_lowerbound together can be useful for filtering out noise and making it easier to see areas of strong attribution. Defaults to 99.9.
"colorMap": "A String", # The color scheme used for the highlighted areas. Defaults to PINK_GREEN for Integrated Gradients attribution, which shows positive attributions in green and negative in pink. Defaults to VIRIDIS for XRAI attribution, which highlights the most influential regions in yellow and the least influential in blue.
"overlayType": "A String", # How the original image is displayed in the visualization. Adjusting the overlay can help increase visual clarity if the original image makes it difficult to view the visualization. Defaults to NONE.
"polarity": "A String", # Whether to only highlight pixels with positive contributions, negative or both. Defaults to POSITIVE.
"type": "A String", # Type of the image visualization. Only applicable to Integrated Gradients attribution. OUTLINES shows regions of attribution, while PIXELS shows per-pixel attribution. Defaults to OUTLINES.
},
},
},
"latentSpaceSource": "A String", # Name of the source to generate embeddings for example based explanations.
"outputs": { # Required. Map from output names to output metadata. For Vertex AI-provided Tensorflow images, keys can be any user defined string that consists of any UTF-8 characters. For custom images, keys are the name of the output field in the prediction to be explained. Currently only one key is allowed.
"a_key": { # Metadata of the prediction output to be explained.
"displayNameMappingKey": "A String", # Specify a field name in the prediction to look for the display name. Use this if the prediction contains the display names for the outputs. The display names in the prediction must have the same shape of the outputs, so that it can be located by Attribution.output_index for a specific output.
"indexDisplayNameMapping": "", # Static mapping between the index and display name. Use this if the outputs are a deterministic n-dimensional array, e.g. a list of scores of all the classes in a pre-defined order for a multi-classification Model. It's not feasible if the outputs are non-deterministic, e.g. the Model produces top-k classes or sort the outputs by their values. The shape of the value must be an n-dimensional array of strings. The number of dimensions must match that of the outputs to be explained. The Attribution.output_display_name is populated by locating in the mapping with Attribution.output_index.
"outputTensorName": "A String", # Name of the output tensor. Required and is only applicable to Vertex AI provided images for Tensorflow.
},
},
},
"parameters": { # Parameters to configure explaining for Model's predictions. # Required. Parameters that configure explaining of the Model's predictions.
"examples": { # Example-based explainability that returns the nearest neighbors from the provided dataset. # Example-based explanations that returns the nearest neighbors from the provided dataset.
"exampleGcsSource": { # The Cloud Storage input instances. # The Cloud Storage input instances.
"dataFormat": "A String", # The format in which instances are given, if not specified, assume it's JSONL format. Currently only JSONL format is supported.
"gcsSource": { # The Google Cloud Storage location for the input content. # The Cloud Storage location for the input instances.
"uris": [ # Required. Google Cloud Storage URI(-s) to the input file(s). May contain wildcards. For more information on wildcards, see https://cloud.google.com/storage/docs/gsutil/addlhelp/WildcardNames.
"A String",
],
},
},
"gcsSource": { # The Google Cloud Storage location for the input content. # The Cloud Storage locations that contain the instances to be indexed for approximate nearest neighbor search.
"uris": [ # Required. Google Cloud Storage URI(-s) to the input file(s). May contain wildcards. For more information on wildcards, see https://cloud.google.com/storage/docs/gsutil/addlhelp/WildcardNames.
"A String",
],
},
"nearestNeighborSearchConfig": "", # The full configuration for the generated index, the semantics are the same as metadata and should match [NearestNeighborSearchConfig](https://cloud.google.com/vertex-ai/docs/explainable-ai/configuring-explanations-example-based#nearest-neighbor-search-config).
"neighborCount": 42, # The number of neighbors to return when querying for examples.
"presets": { # Preset configuration for example-based explanations # Simplified preset configuration, which automatically sets configuration values based on the desired query speed-precision trade-off and modality.
"modality": "A String", # The modality of the uploaded model, which automatically configures the distance measurement and feature normalization for the underlying example index and queries. If your model does not precisely fit one of these types, it is okay to choose the closest type.
"query": "A String", # Preset option controlling parameters for speed-precision trade-off when querying for examples. If omitted, defaults to `PRECISE`.
},
},
"integratedGradientsAttribution": { # An attribution method that computes the Aumann-Shapley value taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1703.01365 # An attribution method that computes Aumann-Shapley values taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1703.01365
"blurBaselineConfig": { # Config for blur baseline. When enabled, a linear path from the maximally blurred image to the input image is created. Using a blurred baseline instead of zero (black image) is motivated by the BlurIG approach explained here: https://arxiv.org/abs/2004.03383 # Config for IG with blur baseline. When enabled, a linear path from the maximally blurred image to the input image is created. Using a blurred baseline instead of zero (black image) is motivated by the BlurIG approach explained here: https://arxiv.org/abs/2004.03383
"maxBlurSigma": 3.14, # The standard deviation of the blur kernel for the blurred baseline. The same blurring parameter is used for both the height and the width dimension. If not set, the method defaults to the zero (i.e. black for images) baseline.
},
"smoothGradConfig": { # Config for SmoothGrad approximation of gradients. When enabled, the gradients are approximated by averaging the gradients from noisy samples in the vicinity of the inputs. Adding noise can help improve the computed gradients. Refer to this paper for more details: https://arxiv.org/pdf/1706.03825.pdf # Config for SmoothGrad approximation of gradients. When enabled, the gradients are approximated by averaging the gradients from noisy samples in the vicinity of the inputs. Adding noise can help improve the computed gradients. Refer to this paper for more details: https://arxiv.org/pdf/1706.03825.pdf
"featureNoiseSigma": { # Noise sigma by features. Noise sigma represents the standard deviation of the gaussian kernel that will be used to add noise to interpolated inputs prior to computing gradients. # This is similar to noise_sigma, but provides additional flexibility. A separate noise sigma can be provided for each feature, which is useful if their distributions are different. No noise is added to features that are not set. If this field is unset, noise_sigma will be used for all features.
"noiseSigma": [ # Noise sigma per feature. No noise is added to features that are not set.
{ # Noise sigma for a single feature.
"name": "A String", # The name of the input feature for which noise sigma is provided. The features are defined in explanation metadata inputs.
"sigma": 3.14, # This represents the standard deviation of the Gaussian kernel that will be used to add noise to the feature prior to computing gradients. Similar to noise_sigma but represents the noise added to the current feature. Defaults to 0.1.
},
],
},
"noiseSigma": 3.14, # This is a single float value and will be used to add noise to all the features. Use this field when all features are normalized to have the same distribution: scale to range [0, 1], [-1, 1] or z-scoring, where features are normalized to have 0-mean and 1-variance. Learn more about [normalization](https://developers.google.com/machine-learning/data-prep/transform/normalization). For best results the recommended value is about 10% - 20% of the standard deviation of the input feature. Refer to section 3.2 of the SmoothGrad paper: https://arxiv.org/pdf/1706.03825.pdf. Defaults to 0.1. If the distribution is different per feature, set feature_noise_sigma instead for each feature.
"noisySampleCount": 42, # The number of gradient samples to use for approximation. The higher this number, the more accurate the gradient is, but the runtime complexity increases by this factor as well. Valid range of its value is [1, 50]. Defaults to 3.
},
"stepCount": 42, # Required. The number of steps for approximating the path integral. A good value to start is 50 and gradually increase until the sum to diff property is within the desired error range. Valid range of its value is [1, 100], inclusively.
},
"outputIndices": [ # If populated, only returns attributions that have output_index contained in output_indices. It must be an ndarray of integers, with the same shape of the output it's explaining. If not populated, returns attributions for top_k indices of outputs. If neither top_k nor output_indices is populated, returns the argmax index of the outputs. Only applicable to Models that predict multiple outputs (e,g, multi-class Models that predict multiple classes).
"",
],
"sampledShapleyAttribution": { # An attribution method that approximates Shapley values for features that contribute to the label being predicted. A sampling strategy is used to approximate the value rather than considering all subsets of features. # An attribution method that approximates Shapley values for features that contribute to the label being predicted. A sampling strategy is used to approximate the value rather than considering all subsets of features. Refer to this paper for model details: https://arxiv.org/abs/1306.4265.
"pathCount": 42, # Required. The number of feature permutations to consider when approximating the Shapley values. Valid range of its value is [1, 50], inclusively.
},
"topK": 42, # If populated, returns attributions for top K indices of outputs (defaults to 1). Only applies to Models that predicts more than one outputs (e,g, multi-class Models). When set to -1, returns explanations for all outputs.
"xraiAttribution": { # An explanation method that redistributes Integrated Gradients attributions to segmented regions, taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1906.02825 Supported only by image Models. # An attribution method that redistributes Integrated Gradients attribution to segmented regions, taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1906.02825 XRAI currently performs better on natural images, like a picture of a house or an animal. If the images are taken in artificial environments, like a lab or manufacturing line, or from diagnostic equipment, like x-rays or quality-control cameras, use Integrated Gradients instead.
"blurBaselineConfig": { # Config for blur baseline. When enabled, a linear path from the maximally blurred image to the input image is created. Using a blurred baseline instead of zero (black image) is motivated by the BlurIG approach explained here: https://arxiv.org/abs/2004.03383 # Config for XRAI with blur baseline. When enabled, a linear path from the maximally blurred image to the input image is created. Using a blurred baseline instead of zero (black image) is motivated by the BlurIG approach explained here: https://arxiv.org/abs/2004.03383
"maxBlurSigma": 3.14, # The standard deviation of the blur kernel for the blurred baseline. The same blurring parameter is used for both the height and the width dimension. If not set, the method defaults to the zero (i.e. black for images) baseline.
},
"smoothGradConfig": { # Config for SmoothGrad approximation of gradients. When enabled, the gradients are approximated by averaging the gradients from noisy samples in the vicinity of the inputs. Adding noise can help improve the computed gradients. Refer to this paper for more details: https://arxiv.org/pdf/1706.03825.pdf # Config for SmoothGrad approximation of gradients. When enabled, the gradients are approximated by averaging the gradients from noisy samples in the vicinity of the inputs. Adding noise can help improve the computed gradients. Refer to this paper for more details: https://arxiv.org/pdf/1706.03825.pdf
"featureNoiseSigma": { # Noise sigma by features. Noise sigma represents the standard deviation of the gaussian kernel that will be used to add noise to interpolated inputs prior to computing gradients. # This is similar to noise_sigma, but provides additional flexibility. A separate noise sigma can be provided for each feature, which is useful if their distributions are different. No noise is added to features that are not set. If this field is unset, noise_sigma will be used for all features.
"noiseSigma": [ # Noise sigma per feature. No noise is added to features that are not set.
{ # Noise sigma for a single feature.
"name": "A String", # The name of the input feature for which noise sigma is provided. The features are defined in explanation metadata inputs.
"sigma": 3.14, # This represents the standard deviation of the Gaussian kernel that will be used to add noise to the feature prior to computing gradients. Similar to noise_sigma but represents the noise added to the current feature. Defaults to 0.1.
},
],
},
"noiseSigma": 3.14, # This is a single float value and will be used to add noise to all the features. Use this field when all features are normalized to have the same distribution: scale to range [0, 1], [-1, 1] or z-scoring, where features are normalized to have 0-mean and 1-variance. Learn more about [normalization](https://developers.google.com/machine-learning/data-prep/transform/normalization). For best results the recommended value is about 10% - 20% of the standard deviation of the input feature. Refer to section 3.2 of the SmoothGrad paper: https://arxiv.org/pdf/1706.03825.pdf. Defaults to 0.1. If the distribution is different per feature, set feature_noise_sigma instead for each feature.
"noisySampleCount": 42, # The number of gradient samples to use for approximation. The higher this number, the more accurate the gradient is, but the runtime complexity increases by this factor as well. Valid range of its value is [1, 50]. Defaults to 3.
},
"stepCount": 42, # Required. The number of steps for approximating the path integral. A good value to start is 50 and gradually increase until the sum to diff property is met within the desired error range. Valid range of its value is [1, 100], inclusively.
},
},
},
"tabularObjective": { # Tabular monitoring objective. # Tabular monitoring objective.
"featureAttributionSpec": { # Feature attribution monitoring spec. # Feature attribution monitoring spec.
"batchExplanationDedicatedResources": { # A description of resources that are used for performing batch operations, are dedicated to a Model, and need manual configuration. # The config of resources used by the Model Monitoring during the batch explanation for non-AutoML models. If not set, `n1-standard-2` machine type will be used by default.
"machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine.
"acceleratorCount": 42, # The number of accelerators to attach to the machine.
"acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count.
"machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required.
"reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation.
"key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value.
"reservationAffinityType": "A String", # Required. Specifies the reservation affinity type.
"values": [ # Optional. Corresponds to the label values of a reservation resource. This must be the full resource name of the reservation.
"A String",
],
},
"tpuTopology": "A String", # Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1").
},
"maxReplicaCount": 42, # Immutable. The maximum number of machine replicas the batch operation may be scaled to. The default value is 10.
"startingReplicaCount": 42, # Immutable. The number of machine replicas used at the start of the batch operation. If not set, Vertex AI decides starting number, not greater than max_replica_count
},
"defaultAlertCondition": { # Monitoring alert triggered condition. # Default alert condition for all the features.
"threshold": 3.14, # A condition that compares a stats value against a threshold. Alert will be triggered if value above the threshold.
},
"featureAlertConditions": { # Per feature alert condition will override default alert condition.
"a_key": { # Monitoring alert triggered condition.
"threshold": 3.14, # A condition that compares a stats value against a threshold. Alert will be triggered if value above the threshold.
},
},
"features": [ # Feature names interested in monitoring. These should be a subset of the input feature names specified in the monitoring schema. If the field is not specified all features outlied in the monitoring schema will be used.
"A String",
],
},
"featureDriftSpec": { # Data drift monitoring spec. Data drift measures the distribution distance between the current dataset and a baseline dataset. A typical use case is to detect data drift between the recent production serving dataset and the training dataset, or to compare the recent production dataset with a dataset from a previous period. # Input feature distribution drift monitoring spec.
"categoricalMetricType": "A String", # Supported metrics type: * l_infinity * jensen_shannon_divergence
"defaultCategoricalAlertCondition": { # Monitoring alert triggered condition. # Default alert condition for all the categorical features.
"threshold": 3.14, # A condition that compares a stats value against a threshold. Alert will be triggered if value above the threshold.
},
"defaultNumericAlertCondition": { # Monitoring alert triggered condition. # Default alert condition for all the numeric features.
"threshold": 3.14, # A condition that compares a stats value against a threshold. Alert will be triggered if value above the threshold.
},
"featureAlertConditions": { # Per feature alert condition will override default alert condition.
"a_key": { # Monitoring alert triggered condition.
"threshold": 3.14, # A condition that compares a stats value against a threshold. Alert will be triggered if value above the threshold.
},
},
"features": [ # Feature names / Prediction output names interested in monitoring. These should be a subset of the input feature names or prediction output names specified in the monitoring schema. If the field is not specified all features / prediction outputs outlied in the monitoring schema will be used.
"A String",
],
"numericMetricType": "A String", # Supported metrics type: * jensen_shannon_divergence
},
"predictionOutputDriftSpec": { # Data drift monitoring spec. Data drift measures the distribution distance between the current dataset and a baseline dataset. A typical use case is to detect data drift between the recent production serving dataset and the training dataset, or to compare the recent production dataset with a dataset from a previous period. # Prediction output distribution drift monitoring spec.
"categoricalMetricType": "A String", # Supported metrics type: * l_infinity * jensen_shannon_divergence
"defaultCategoricalAlertCondition": { # Monitoring alert triggered condition. # Default alert condition for all the categorical features.
"threshold": 3.14, # A condition that compares a stats value against a threshold. Alert will be triggered if value above the threshold.
},
"defaultNumericAlertCondition": { # Monitoring alert triggered condition. # Default alert condition for all the numeric features.
"threshold": 3.14, # A condition that compares a stats value against a threshold. Alert will be triggered if value above the threshold.
},
"featureAlertConditions": { # Per feature alert condition will override default alert condition.
"a_key": { # Monitoring alert triggered condition.
"threshold": 3.14, # A condition that compares a stats value against a threshold. Alert will be triggered if value above the threshold.
},
},
"features": [ # Feature names / Prediction output names interested in monitoring. These should be a subset of the input feature names or prediction output names specified in the monitoring schema. If the field is not specified all features / prediction outputs outlied in the monitoring schema will be used.
"A String",
],
"numericMetricType": "A String", # Supported metrics type: * jensen_shannon_divergence
},
},
"targetDataset": { # Model monitoring data input spec. # Target dataset.
"batchPredictionOutput": { # Data from Vertex AI Batch prediction job output. # Vertex AI Batch prediction Job.
"batchPredictionJob": "A String", # Vertex AI Batch prediction job resource name. The job must match the model version specified in [ModelMonitor].[model_monitoring_target].
},
"columnizedDataset": { # Input dataset spec. # Columnized dataset.
"bigquerySource": { # Dataset spec for data sotred in BigQuery. # BigQuery data source.
"query": "A String", # Standard SQL to be used instead of the `table_uri`.
"tableUri": "A String", # BigQuery URI to a table, up to 2000 characters long. All the columns in the table will be selected. Accepted forms: * BigQuery path. For example: `bq://projectId.bqDatasetId.bqTableId`.
},
"gcsSource": { # Dataset spec for data stored in Google Cloud Storage. # Google Cloud Storage data source.
"format": "A String", # Data format of the dataset.
"gcsUri": "A String", # Google Cloud Storage URI to the input file(s). May contain wildcards. For more information on wildcards, see https://cloud.google.com/storage/docs/gsutil/addlhelp/WildcardNames.
},
"timestampField": "A String", # The timestamp field. Usually for serving data.
"vertexDataset": "A String", # Resource name of the Vertex AI managed dataset.
},
"timeInterval": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # The time interval (pair of start_time and end_time) for which results should be returned.
"endTime": "A String", # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
"startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
},
"timeOffset": { # Time offset setting. # The time offset setting for which results should be returned.
"offset": "A String", # [offset] is the time difference from the cut-off time. For scheduled jobs, the cut-off time is the scheduled time. For non-scheduled jobs, it's the time when the job was created. Currently we support the following format: 'w|W': Week, 'd|D': Day, 'h|H': Hour E.g. '1h' stands for 1 hour, '2d' stands for 2 days.
"window": "A String", # [window] refers to the scope of data selected for analysis. It allows you to specify the quantity of data you wish to examine. Currently we support the following format: 'w|W': Week, 'd|D': Day, 'h|H': Hour E.g. '1h' stands for 1 hour, '2d' stands for 2 days.
},
"vertexEndpointLogs": { # Data from Vertex AI Endpoint request response logging. # Vertex AI Endpoint request & response logging.
"endpoints": [ # List of endpoint resource names. The endpoints must enable the logging with the [Endpoint].[request_response_logging_config], and must contain the deployed model corresponding to the model version specified in [ModelMonitor].[model_monitoring_target].
"A String",
],
},
},
},
"outputSpec": { # Specification for the export destination of monitoring results, including metrics, logs, etc. # The Output destination spec for metrics, error logs, etc.
"gcsBaseDirectory": { # The Google Cloud Storage location where the output is to be written to. # Google Cloud Storage base folder path for metrics, error logs, etc.
"outputUriPrefix": "A String", # Required. Google Cloud Storage URI to output directory. If the uri doesn't end with '/', a '/' will be automatically appended. The directory is created if it doesn't exist.
},
},
},
"name": "A String", # Output only. Resource name of a ModelMonitoringJob. Format: `projects/{project_id}/locations/{location_id}/modelMonitors/{model_monitor_id}/modelMonitoringJobs/{model_monitoring_job_id}`
"schedule": "A String", # Output only. Schedule resource name. It will only appear when this job is triggered by a schedule.
"scheduleTime": "A String", # Output only. Timestamp when this ModelMonitoringJob was scheduled. It will only appear when this job is triggered by a schedule.
"state": "A String", # Output only. The state of the monitoring job. * When the job is still creating, the state will be 'JOB_STATE_PENDING'. * Once the job is successfully created, the state will be 'JOB_STATE_RUNNING'. * Once the job is finished, the state will be one of 'JOB_STATE_FAILED', 'JOB_STATE_SUCCEEDED', 'JOB_STATE_PARTIALLY_SUCCEEDED'.
"updateTime": "A String", # Output only. Timestamp when this ModelMonitoringJob was updated most recently.
},
"modelMonitoringJobId": "A String", # Optional. The ID to use for the Model Monitoring Job, which will become the final component of the model monitoring job resource name. The maximum length is 63 characters, and valid characters are `/^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$/`.
"parent": "A String", # Required. The parent of the ModelMonitoringJob. Format: `projects/{project}/locations/{location}/modelMoniitors/{model_monitor}`
},
"createNotebookExecutionJobRequest": { # Request message for [NotebookService.CreateNotebookExecutionJob] # Request for NotebookService.CreateNotebookExecutionJob.
"notebookExecutionJob": { # NotebookExecutionJob represents an instance of a notebook execution. # Required. The NotebookExecutionJob to create.
"createTime": "A String", # Output only. Timestamp when this NotebookExecutionJob was created.
"customEnvironmentSpec": { # Compute configuration to use for an execution job. # The custom compute configuration for an execution job.
"machineSpec": { # Specification of a single machine. # The specification of a single machine for the execution job.
"acceleratorCount": 42, # The number of accelerators to attach to the machine.
"acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count.
"machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required.
"reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation.
"key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value.
"reservationAffinityType": "A String", # Required. Specifies the reservation affinity type.
"values": [ # Optional. Corresponds to the label values of a reservation resource. This must be the full resource name of the reservation.
"A String",
],
},
"tpuTopology": "A String", # Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1").
},
"networkSpec": { # Network spec. # The network configuration to use for the execution job.
"enableInternetAccess": True or False, # Whether to enable public internet access. Default false.
"network": "A String", # The full name of the Google Compute Engine [network](https://cloud.google.com//compute/docs/networks-and-firewalls#networks)
"subnetwork": "A String", # The name of the subnet that this instance is in. Format: `projects/{project_id_or_number}/regions/{region}/subnetworks/{subnetwork_id}`
},
"persistentDiskSpec": { # Represents the spec of persistent disk options. # The specification of a persistent disk to attach for the execution job.
"diskSizeGb": "A String", # Size in GB of the disk (default is 100GB).
"diskType": "A String", # Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) "pd-extreme" (Extreme Persistent Disk)
},
},
"dataformRepositorySource": { # The Dataform Repository containing the input notebook. # The Dataform Repository pointing to a single file notebook repository.
"commitSha": "A String", # The commit SHA to read repository with. If unset, the file will be read at HEAD.
"dataformRepositoryResourceName": "A String", # The resource name of the Dataform Repository. Format: `projects/{project_id}/locations/{location}/repositories/{repository_id}`
},
"directNotebookSource": { # The content of the input notebook in ipynb format. # The contents of an input notebook file.
"content": "A String", # The base64-encoded contents of the input notebook file.
},
"displayName": "A String", # The display name of the NotebookExecutionJob. The name can be up to 128 characters long and can consist of any UTF-8 characters.
"encryptionSpec": { # Represents a customer-managed encryption key spec that can be applied to a top-level resource. # Customer-managed encryption key spec for the notebook execution job. This field is auto-populated if the NotebookService.NotebookRuntimeTemplate has an encryption spec.
"kmsKeyName": "A String", # Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. The key needs to be in the same region as where the compute resource is created.
},
"executionTimeout": "A String", # Max running time of the execution job in seconds (default 86400s / 24 hrs).
"executionUser": "A String", # The user email to run the execution as. Only supported by Colab runtimes.
"gcsNotebookSource": { # The Cloud Storage uri for the input notebook. # The Cloud Storage url pointing to the ipynb file. Format: `gs://bucket/notebook_file.ipynb`
"generation": "A String", # The version of the Cloud Storage object to read. If unset, the current version of the object is read. See https://cloud.google.com/storage/docs/metadata#generation-number.
"uri": "A String", # The Cloud Storage uri pointing to the ipynb file. Format: `gs://bucket/notebook_file.ipynb`
},
"gcsOutputUri": "A String", # The Cloud Storage location to upload the result to. Format: `gs://bucket-name`
"jobState": "A String", # Output only. The state of the NotebookExecutionJob.
"labels": { # The labels with user-defined metadata to organize NotebookExecutionJobs. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.
"a_key": "A String",
},
"name": "A String", # Output only. The resource name of this NotebookExecutionJob. Format: `projects/{project_id}/locations/{location}/notebookExecutionJobs/{job_id}`
"notebookRuntimeTemplateResourceName": "A String", # The NotebookRuntimeTemplate to source compute configuration from.
"scheduleResourceName": "A String", # Output only. The Schedule resource name if this job is triggered by one. Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}`
"serviceAccount": "A String", # The service account to run the execution as.
"status": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Populated when the NotebookExecutionJob is completed. When there is an error during notebook execution, the error details are populated.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"updateTime": "A String", # Output only. Timestamp when this NotebookExecutionJob was most recently updated.
},
"notebookExecutionJobId": "A String", # Optional. User specified ID for the NotebookExecutionJob.
"parent": "A String", # Required. The resource name of the Location to create the NotebookExecutionJob. Format: `projects/{project}/locations/{location}`
},
"createPipelineJobRequest": { # Request message for PipelineService.CreatePipelineJob. # Request for PipelineService.CreatePipelineJob. CreatePipelineJobRequest.parent field is required (format: projects/{project}/locations/{location}).
"parent": "A String", # Required. The resource name of the Location to create the PipelineJob in. Format: `projects/{project}/locations/{location}`
"pipelineJob": { # An instance of a machine learning PipelineJob. # Required. The PipelineJob to create.
"createTime": "A String", # Output only. Pipeline creation time.
"displayName": "A String", # The display name of the Pipeline. The name can be up to 128 characters long and can consist of any UTF-8 characters.
"encryptionSpec": { # Represents a customer-managed encryption key spec that can be applied to a top-level resource. # Customer-managed encryption key spec for a pipelineJob. If set, this PipelineJob and all of its sub-resources will be secured by this key.
"kmsKeyName": "A String", # Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. The key needs to be in the same region as where the compute resource is created.
},
"endTime": "A String", # Output only. Pipeline end time.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. The error that occurred during pipeline execution. Only populated when the pipeline's state is FAILED or CANCELLED.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"jobDetail": { # The runtime detail of PipelineJob. # Output only. The details of pipeline run. Not available in the list view.
"pipelineContext": { # Instance of a general context. # Output only. The context of the pipeline.
"createTime": "A String", # Output only. Timestamp when this Context was created.
"description": "A String", # Description of the Context
"displayName": "A String", # User provided display name of the Context. May be up to 128 Unicode characters.
"etag": "A String", # An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
"labels": { # The labels with user-defined metadata to organize your Contexts. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Context (System labels are excluded).
"a_key": "A String",
},
"metadata": { # Properties of the Context. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB.
"a_key": "", # Properties of the object.
},
"name": "A String", # Immutable. The resource name of the Context.
"parentContexts": [ # Output only. A list of resource names of Contexts that are parents of this Context. A Context may have at most 10 parent_contexts.
"A String",
],
"schemaTitle": "A String", # The title of the schema describing the metadata. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"schemaVersion": "A String", # The version of the schema in schema_name to use. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"updateTime": "A String", # Output only. Timestamp when this Context was last updated.
},
"pipelineRunContext": { # Instance of a general context. # Output only. The context of the current pipeline run.
"createTime": "A String", # Output only. Timestamp when this Context was created.
"description": "A String", # Description of the Context
"displayName": "A String", # User provided display name of the Context. May be up to 128 Unicode characters.
"etag": "A String", # An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
"labels": { # The labels with user-defined metadata to organize your Contexts. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Context (System labels are excluded).
"a_key": "A String",
},
"metadata": { # Properties of the Context. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB.
"a_key": "", # Properties of the object.
},
"name": "A String", # Immutable. The resource name of the Context.
"parentContexts": [ # Output only. A list of resource names of Contexts that are parents of this Context. A Context may have at most 10 parent_contexts.
"A String",
],
"schemaTitle": "A String", # The title of the schema describing the metadata. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"schemaVersion": "A String", # The version of the schema in schema_name to use. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"updateTime": "A String", # Output only. Timestamp when this Context was last updated.
},
"taskDetails": [ # Output only. The runtime details of the tasks under the pipeline.
{ # The runtime detail of a task execution.
"createTime": "A String", # Output only. Task create time.
"endTime": "A String", # Output only. Task end time.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. The error that occurred during task execution. Only populated when the task's state is FAILED or CANCELLED.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"execution": { # Instance of a general execution. # Output only. The execution metadata of the task.
"createTime": "A String", # Output only. Timestamp when this Execution was created.
"description": "A String", # Description of the Execution
"displayName": "A String", # User provided display name of the Execution. May be up to 128 Unicode characters.
"etag": "A String", # An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
"labels": { # The labels with user-defined metadata to organize your Executions. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Execution (System labels are excluded).
"a_key": "A String",
},
"metadata": { # Properties of the Execution. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB.
"a_key": "", # Properties of the object.
},
"name": "A String", # Output only. The resource name of the Execution.
"schemaTitle": "A String", # The title of the schema describing the metadata. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"schemaVersion": "A String", # The version of the schema in `schema_title` to use. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"state": "A String", # The state of this Execution. This is a property of the Execution, and does not imply or capture any ongoing process. This property is managed by clients (such as Vertex AI Pipelines) and the system does not prescribe or check the validity of state transitions.
"updateTime": "A String", # Output only. Timestamp when this Execution was last updated.
},
"executorDetail": { # The runtime detail of a pipeline executor. # Output only. The detailed execution info.
"containerDetail": { # The detail of a container execution. It contains the job names of the lifecycle of a container execution. # Output only. The detailed info for a container executor.
"failedMainJobs": [ # Output only. The names of the previously failed CustomJob for the main container executions. The list includes the all attempts in chronological order.
"A String",
],
"failedPreCachingCheckJobs": [ # Output only. The names of the previously failed CustomJob for the pre-caching-check container executions. This job will be available if the PipelineJob.pipeline_spec specifies the `pre_caching_check` hook in the lifecycle events. The list includes the all attempts in chronological order.
"A String",
],
"mainJob": "A String", # Output only. The name of the CustomJob for the main container execution.
"preCachingCheckJob": "A String", # Output only. The name of the CustomJob for the pre-caching-check container execution. This job will be available if the PipelineJob.pipeline_spec specifies the `pre_caching_check` hook in the lifecycle events.
},
"customJobDetail": { # The detailed info for a custom job executor. # Output only. The detailed info for a custom job executor.
"failedJobs": [ # Output only. The names of the previously failed CustomJob. The list includes the all attempts in chronological order.
"A String",
],
"job": "A String", # Output only. The name of the CustomJob.
},
},
"inputs": { # Output only. The runtime input artifacts of the task.
"a_key": { # A list of artifact metadata.
"artifacts": [ # Output only. A list of artifact metadata.
{ # Instance of a general artifact.
"createTime": "A String", # Output only. Timestamp when this Artifact was created.
"description": "A String", # Description of the Artifact
"displayName": "A String", # User provided display name of the Artifact. May be up to 128 Unicode characters.
"etag": "A String", # An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
"labels": { # The labels with user-defined metadata to organize your Artifacts. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Artifact (System labels are excluded).
"a_key": "A String",
},
"metadata": { # Properties of the Artifact. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB.
"a_key": "", # Properties of the object.
},
"name": "A String", # Output only. The resource name of the Artifact.
"schemaTitle": "A String", # The title of the schema describing the metadata. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"schemaVersion": "A String", # The version of the schema in schema_name to use. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"state": "A String", # The state of this Artifact. This is a property of the Artifact, and does not imply or capture any ongoing process. This property is managed by clients (such as Vertex AI Pipelines), and the system does not prescribe or check the validity of state transitions.
"updateTime": "A String", # Output only. Timestamp when this Artifact was last updated.
"uri": "A String", # The uniform resource identifier of the artifact file. May be empty if there is no actual artifact file.
},
],
},
},
"outputs": { # Output only. The runtime output artifacts of the task.
"a_key": { # A list of artifact metadata.
"artifacts": [ # Output only. A list of artifact metadata.
{ # Instance of a general artifact.
"createTime": "A String", # Output only. Timestamp when this Artifact was created.
"description": "A String", # Description of the Artifact
"displayName": "A String", # User provided display name of the Artifact. May be up to 128 Unicode characters.
"etag": "A String", # An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
"labels": { # The labels with user-defined metadata to organize your Artifacts. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Artifact (System labels are excluded).
"a_key": "A String",
},
"metadata": { # Properties of the Artifact. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB.
"a_key": "", # Properties of the object.
},
"name": "A String", # Output only. The resource name of the Artifact.
"schemaTitle": "A String", # The title of the schema describing the metadata. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"schemaVersion": "A String", # The version of the schema in schema_name to use. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"state": "A String", # The state of this Artifact. This is a property of the Artifact, and does not imply or capture any ongoing process. This property is managed by clients (such as Vertex AI Pipelines), and the system does not prescribe or check the validity of state transitions.
"updateTime": "A String", # Output only. Timestamp when this Artifact was last updated.
"uri": "A String", # The uniform resource identifier of the artifact file. May be empty if there is no actual artifact file.
},
],
},
},
"parentTaskId": "A String", # Output only. The id of the parent task if the task is within a component scope. Empty if the task is at the root level.
"pipelineTaskStatus": [ # Output only. A list of task status. This field keeps a record of task status evolving over time.
{ # A single record of the task status.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # 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.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"state": "A String", # Output only. The state of the task.
"updateTime": "A String", # Output only. Update time of this status.
},
],
"startTime": "A String", # Output only. Task start time.
"state": "A String", # Output only. State of the task.
"taskId": "A String", # Output only. The system generated ID of the task.
"taskName": "A String", # Output only. The user specified name of the task that is defined in pipeline_spec.
},
],
},
"labels": { # The labels with user-defined metadata to organize PipelineJob. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. Note there is some reserved label key for Vertex AI Pipelines. - `vertex-ai-pipelines-run-billing-id`, user set value will get overrided.
"a_key": "A String",
},
"name": "A String", # Output only. The resource name of the PipelineJob.
"network": "A String", # The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the Pipeline Job's workload should be peered. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. Private services access must already be configured for the network. Pipeline job will apply the network configuration to the Google Cloud resources being launched, if applied, such as Vertex AI Training or Dataflow job. If left unspecified, the workload is not peered with any network.
"originalPipelineJobId": "A String", # Optional. The original pipeline job id if this pipeline job is a rerun of a previous pipeline job.
"pipelineSpec": { # The spec of the pipeline.
"a_key": "", # Properties of the object.
},
"pipelineTaskRerunConfigs": [ # Optional. The rerun configs for each task in the pipeline job. By default, the rerun will: 1. Use the same input artifacts as the original run. 2. Use the same input parameters as the original run. 3. Skip all the tasks that are already succeeded in the original run. 4. Rerun all the tasks that are not succeeded in the original run. By providing this field, users can override the default behavior and specify the rerun config for each task.
{ # User provided rerun config to submit a rerun pipelinejob. This includes 1. Which task to rerun 2. User override input parameters and artifacts.
"inputs": { # Runtime inputs data of the task. # Optional. The runtime input of the task overridden by the user.
"artifacts": { # Optional. Input artifacts.
"a_key": { # A list of artifact metadata.
"artifacts": [ # Optional. A list of artifact metadata.
{ # The definition of a runtime artifact.
"customProperties": { # The custom properties of the artifact. Deprecated. Use RuntimeArtifact.metadata instead.
"a_key": { # Value is the value of the field.
"doubleValue": 3.14, # A double value.
"intValue": "A String", # An integer value.
"stringValue": "A String", # A string value.
},
},
"metadata": { # Properties of the Artifact.
"a_key": "", # Properties of the object.
},
"name": "A String", # The name of an artifact.
"properties": { # The properties of the artifact. Deprecated. Use RuntimeArtifact.metadata instead.
"a_key": { # Value is the value of the field.
"doubleValue": 3.14, # A double value.
"intValue": "A String", # An integer value.
"stringValue": "A String", # A string value.
},
},
"type": { # The definition of a artifact type in MLMD. # The type of the artifact.
"instanceSchema": "A String", # Contains a raw YAML string, describing the format of the properties of the type.
"schemaTitle": "A String", # The name of the type. The format of the title must be: `.`. Examples: - `aiplatform.Model` - `acme.CustomModel` When this field is set, the type must be pre-registered in the MLMD store.
"schemaUri": "A String", # Points to a YAML file stored on Cloud Storage describing the format. Deprecated. Use PipelineArtifactTypeSchema.schema_title or PipelineArtifactTypeSchema.instance_schema instead.
"schemaVersion": "A String", # The schema version of the artifact. If the value is not set, it defaults to the latest version in the system.
},
"uri": "A String", # The URI of the artifact.
},
],
},
},
"parameterValues": { # Optional. Input parameters.
"a_key": "",
},
},
"skipDownstreamTasks": True or False, # Optional. Whether to skip downstream tasks. Default value is False.
"skipTask": True or False, # Optional. Whether to skip this task. Default value is False.
"taskId": "A String", # Optional. The system generated ID of the task. Retrieved from original run.
"taskName": "A String", # Optional. The name of the task.
},
],
"preflightValidations": True or False, # Optional. Whether to do component level validations before job creation.
"pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I for PipelineJob.
"networkAttachment": "A String", # Optional. The name of the Compute Engine [network attachment](https://cloud.google.com/vpc/docs/about-network-attachments) to attach to the resource within the region and user project. To specify this field, you must have already [created a network attachment] (https://cloud.google.com/vpc/docs/create-manage-network-attachments#create-network-attachments). This field is only used for resources using PSC-I.
},
"reservedIpRanges": [ # A list of names for the reserved ip ranges under the VPC network that can be used for this Pipeline Job's workload. If set, we will deploy the Pipeline Job's workload within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network. Example: ['vertex-ai-ip-range'].
"A String",
],
"runtimeConfig": { # The runtime config of a PipelineJob. # Runtime config of the pipeline.
"defaultRuntime": { # The default runtime for the PipelineJob. # Optional. The default runtime for the PipelineJob. If not provided, Vertex Custom Job(on demand) is used as the runtime. For Vertex Custom Job, please refer to https://cloud.google.com/vertex-ai/docs/training/overview.
"persistentResourceRuntimeDetail": { # Persistent resource based runtime detail. For more information, refer to https://cloud.google.com/vertex-ai/docs/training/persistent-resource-overview # Persistent resource based runtime detail.
"persistentResourceName": "A String", # Persistent resource name. Format: `projects/{project}/locations/{location}/persistentResources/{persistent_resource}`
"taskResourceUnavailableTimeoutBehavior": "A String", # Specifies the behavior to take if the timeout is reached.
"taskResourceUnavailableWaitTimeMs": "A String", # The max time a pipeline task waits for the required CPU, memory, or accelerator resource to become available from the specified persistent resource. Default wait time is 0.
},
},
"failurePolicy": "A String", # Represents the failure policy of a pipeline. Currently, the default of a pipeline is that the pipeline will continue to run until no more tasks can be executed, also known as PIPELINE_FAILURE_POLICY_FAIL_SLOW. However, if a pipeline is set to PIPELINE_FAILURE_POLICY_FAIL_FAST, it will stop scheduling any new tasks when a task has failed. Any scheduled tasks will continue to completion.
"gcsOutputDirectory": "A String", # Required. A path in a Cloud Storage bucket, which will be treated as the root output directory of the pipeline. It is used by the system to generate the paths of output artifacts. The artifact paths are generated with a sub-path pattern `{job_id}/{task_id}/{output_key}` under the specified output directory. The service account specified in this pipeline must have the `storage.objects.get` and `storage.objects.create` permissions for this bucket.
"inputArtifacts": { # The runtime artifacts of the PipelineJob. The key will be the input artifact name and the value would be one of the InputArtifact.
"a_key": { # The type of an input artifact.
"artifactId": "A String", # Artifact resource id from MLMD. Which is the last portion of an artifact resource name: `projects/{project}/locations/{location}/metadataStores/default/artifacts/{artifact_id}`. The artifact must stay within the same project, location and default metadatastore as the pipeline.
},
},
"parameterValues": { # The runtime parameters of the PipelineJob. The parameters will be passed into PipelineJob.pipeline_spec to replace the placeholders at runtime. This field is used by pipelines built using `PipelineJob.pipeline_spec.schema_version` 2.1.0, such as pipelines built using Kubeflow Pipelines SDK 1.9 or higher and the v2 DSL.
"a_key": "",
},
"parameters": { # Deprecated. Use RuntimeConfig.parameter_values instead. The runtime parameters of the PipelineJob. The parameters will be passed into PipelineJob.pipeline_spec to replace the placeholders at runtime. This field is used by pipelines built using `PipelineJob.pipeline_spec.schema_version` 2.0.0 or lower, such as pipelines built using Kubeflow Pipelines SDK 1.8 or lower.
"a_key": { # Value is the value of the field.
"doubleValue": 3.14, # A double value.
"intValue": "A String", # An integer value.
"stringValue": "A String", # A string value.
},
},
},
"satisfiesPzi": True or False, # Output only. Reserved for future use.
"satisfiesPzs": True or False, # Output only. Reserved for future use.
"scheduleName": "A String", # Output only. The schedule resource name. Only returned if the Pipeline is created by Schedule API.
"serviceAccount": "A String", # The service account that the pipeline workload runs as. If not specified, the Compute Engine default service account in the project will be used. See https://cloud.google.com/compute/docs/access/service-accounts#default_service_account Users starting the pipeline must have the `iam.serviceAccounts.actAs` permission on this service account.
"startTime": "A String", # Output only. Pipeline start time.
"state": "A String", # Output only. The detailed state of the job.
"templateMetadata": { # Pipeline template metadata if PipelineJob.template_uri is from supported template registry. Currently, the only supported registry is Artifact Registry. # Output only. Pipeline template metadata. Will fill up fields if PipelineJob.template_uri is from supported template registry.
"version": "A String", # The version_name in artifact registry. Will always be presented in output if the PipelineJob.template_uri is from supported template registry. Format is "sha256:abcdef123456...".
},
"templateUri": "A String", # A template uri from where the PipelineJob.pipeline_spec, if empty, will be downloaded. Currently, only uri from Vertex Template Registry & Gallery is supported. Reference to https://cloud.google.com/vertex-ai/docs/pipelines/create-pipeline-template.
"updateTime": "A String", # Output only. Timestamp when this PipelineJob was most recently updated.
},
"pipelineJobId": "A String", # The ID to use for the PipelineJob, which will become the final component of the PipelineJob name. If not provided, an ID will be automatically generated. This value should be less than 128 characters, and valid characters are `/a-z-/`.
},
"createTime": "A String", # Output only. Timestamp when this Schedule was created.
"cron": "A String", # Cron schedule (https://en.wikipedia.org/wiki/Cron) to launch scheduled runs. To explicitly set a timezone to the cron tab, apply a prefix in the cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or "TZ=${IANA_TIME_ZONE}". The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone database. For example, "CRON_TZ=America/New_York 1 * * * *", or "TZ=America/New_York 1 * * * *".
"displayName": "A String", # Required. User provided name of the Schedule. The name can be up to 128 characters long and can consist of any UTF-8 characters.
"endTime": "A String", # Optional. Timestamp after which no new runs can be scheduled. If specified, The schedule will be completed when either end_time is reached or when scheduled_run_count >= max_run_count. If not specified, new runs will keep getting scheduled until this Schedule is paused or deleted. Already scheduled runs will be allowed to complete. Unset if not specified.
"lastPauseTime": "A String", # Output only. Timestamp when this Schedule was last paused. Unset if never paused.
"lastResumeTime": "A String", # Output only. Timestamp when this Schedule was last resumed. Unset if never resumed from pause.
"lastScheduledRunResponse": { # Status of a scheduled run. # Output only. Response of the last scheduled run. This is the response for starting the scheduled requests and not the execution of the operations/jobs created by the requests (if applicable). Unset if no run has been scheduled yet.
"runResponse": "A String", # The response of the scheduled run.
"scheduledRunTime": "A String", # The scheduled run time based on the user-specified schedule.
},
"maxConcurrentRunCount": "A String", # Required. Maximum number of runs that can be started concurrently for this Schedule. This is the limit for starting the scheduled requests and not the execution of the operations/jobs created by the requests (if applicable).
"maxRunCount": "A String", # Optional. Maximum run count of the schedule. If specified, The schedule will be completed when either started_run_count >= max_run_count or when end_time is reached. If not specified, new runs will keep getting scheduled until this Schedule is paused or deleted. Already scheduled runs will be allowed to complete. Unset if not specified.
"name": "A String", # Immutable. The resource name of the Schedule.
"nextRunTime": "A String", # Output only. Timestamp when this Schedule should schedule the next run. Having a next_run_time in the past means the runs are being started behind schedule.
"startTime": "A String", # Optional. Timestamp after which the first run can be scheduled. Default to Schedule create time if not specified.
"startedRunCount": "A String", # Output only. The number of runs started by this schedule.
"state": "A String", # Output only. The state of this Schedule.
"updateTime": "A String", # Output only. Timestamp when this Schedule was updated.
}

delete(name, x__xgafv=None)

Deletes a Schedule.

Args:
name: string, Required. The name of the Schedule resource to be deleted. Format: `projects/{project}/locations/{location}/schedules/{schedule}` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}

get(name, x__xgafv=None)

Gets a Schedule.

Args:
name: string, Required. The name of the Schedule resource. Format: `projects/{project}/locations/{location}/schedules/{schedule}` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # An instance of a Schedule periodically schedules runs to make API calls based on user specified time specification and API request type.
"allowQueueing": True or False, # Optional. Whether new scheduled runs can be queued when max_concurrent_runs limit is reached. If set to true, new runs will be queued instead of skipped. Default to false.
"catchUp": True or False, # Output only. Whether to backfill missed runs when the schedule is resumed from PAUSED state. If set to true, all missed runs will be scheduled. New runs will be scheduled after the backfill is complete. Default to false.
"createModelMonitoringJobRequest": { # Request message for ModelMonitoringService.CreateModelMonitoringJob. # Request for ModelMonitoringService.CreateModelMonitoringJob.
"modelMonitoringJob": { # Represents a model monitoring job that analyze dataset using different monitoring algorithm. # Required. The ModelMonitoringJob to create
"createTime": "A String", # Output only. Timestamp when this ModelMonitoringJob was created.
"displayName": "A String", # The display name of the ModelMonitoringJob. The name can be up to 128 characters long and can consist of any UTF-8.
"jobExecutionDetail": { # Represent the execution details of the job. # Output only. Execution results for all the monitoring objectives.
"baselineDatasets": [ # Processed baseline datasets.
{ # Processed dataset information.
"location": "A String", # Actual data location of the processed dataset.
"timeRange": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Dataset time range information if any.
"endTime": "A String", # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
"startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
},
},
],
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Additional job error status.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"objectiveStatus": { # Status of data processing for each monitoring objective. Key is the objective.
"a_key": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
},
"targetDatasets": [ # Processed target datasets.
{ # Processed dataset information.
"location": "A String", # Actual data location of the processed dataset.
"timeRange": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Dataset time range information if any.
"endTime": "A String", # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
"startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
},
},
],
},
"modelMonitoringSpec": { # Monitoring monitoring job spec. It outlines the specifications for monitoring objectives, notifications, and result exports. # Monitoring monitoring job spec. It outlines the specifications for monitoring objectives, notifications, and result exports. If left blank, the default monitoring specifications from the top-level resource 'ModelMonitor' will be applied. If provided, we will use the specification defined here rather than the default one.
"notificationSpec": { # Notification spec(email, notification channel) for model monitoring statistics/alerts. # The model monitoring notification spec.
"emailConfig": { # The config for email alerts. # Email alert config.
"userEmails": [ # The email addresses to send the alerts.
"A String",
],
},
"enableCloudLogging": True or False, # Dump the anomalies to Cloud Logging. The anomalies will be put to json payload encoded from proto google.cloud.aiplatform.logging.ModelMonitoringAnomaliesLogEntry. This can be further sinked to Pub/Sub or any other services supported by Cloud Logging.
"notificationChannelConfigs": [ # Notification channel config.
{ # Google Cloud Notification Channel config.
"notificationChannel": "A String", # Resource names of the NotificationChannels. Must be of the format `projects//notificationChannels/`
},
],
},
"objectiveSpec": { # Monitoring objectives spec. # The monitoring objective spec.
"baselineDataset": { # Model monitoring data input spec. # Baseline dataset. It could be the training dataset or production serving dataset from a previous period.
"batchPredictionOutput": { # Data from Vertex AI Batch prediction job output. # Vertex AI Batch prediction Job.
"batchPredictionJob": "A String", # Vertex AI Batch prediction job resource name. The job must match the model version specified in [ModelMonitor].[model_monitoring_target].
},
"columnizedDataset": { # Input dataset spec. # Columnized dataset.
"bigquerySource": { # Dataset spec for data sotred in BigQuery. # BigQuery data source.
"query": "A String", # Standard SQL to be used instead of the `table_uri`.
"tableUri": "A String", # BigQuery URI to a table, up to 2000 characters long. All the columns in the table will be selected. Accepted forms: * BigQuery path. For example: `bq://projectId.bqDatasetId.bqTableId`.
},
"gcsSource": { # Dataset spec for data stored in Google Cloud Storage. # Google Cloud Storage data source.
"format": "A String", # Data format of the dataset.
"gcsUri": "A String", # Google Cloud Storage URI to the input file(s). May contain wildcards. For more information on wildcards, see https://cloud.google.com/storage/docs/gsutil/addlhelp/WildcardNames.
},
"timestampField": "A String", # The timestamp field. Usually for serving data.
"vertexDataset": "A String", # Resource name of the Vertex AI managed dataset.
},
"timeInterval": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # The time interval (pair of start_time and end_time) for which results should be returned.
"endTime": "A String", # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
"startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
},
"timeOffset": { # Time offset setting. # The time offset setting for which results should be returned.
"offset": "A String", # [offset] is the time difference from the cut-off time. For scheduled jobs, the cut-off time is the scheduled time. For non-scheduled jobs, it's the time when the job was created. Currently we support the following format: 'w|W': Week, 'd|D': Day, 'h|H': Hour E.g. '1h' stands for 1 hour, '2d' stands for 2 days.
"window": "A String", # [window] refers to the scope of data selected for analysis. It allows you to specify the quantity of data you wish to examine. Currently we support the following format: 'w|W': Week, 'd|D': Day, 'h|H': Hour E.g. '1h' stands for 1 hour, '2d' stands for 2 days.
},
"vertexEndpointLogs": { # Data from Vertex AI Endpoint request response logging. # Vertex AI Endpoint request & response logging.
"endpoints": [ # List of endpoint resource names. The endpoints must enable the logging with the [Endpoint].[request_response_logging_config], and must contain the deployed model corresponding to the model version specified in [ModelMonitor].[model_monitoring_target].
"A String",
],
},
},
"explanationSpec": { # Specification of Model explanation. # The explanation spec. This spec is required when the objectives spec includes feature attribution objectives.
"metadata": { # Metadata describing the Model's input and output for explanation. # Optional. Metadata describing the Model's input and output for explanation.
"featureAttributionsSchemaUri": "A String", # Points to a YAML file stored on Google Cloud Storage describing the format of the feature attributions. The schema is defined as an OpenAPI 3.0.2 [Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). AutoML tabular Models always have this field populated by Vertex AI. Note: The URI given on output may be different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.
"inputs": { # Required. Map from feature names to feature input metadata. Keys are the name of the features. Values are the specification of the feature. An empty InputMetadata is valid. It describes a text feature which has the name specified as the key in ExplanationMetadata.inputs. The baseline of the empty feature is chosen by Vertex AI. For Vertex AI-provided Tensorflow images, the key can be any friendly name of the feature. Once specified, featureAttributions are keyed by this key (if not grouped with another feature). For custom images, the key must match with the key in instance.
"a_key": { # Metadata of the input of a feature. Fields other than InputMetadata.input_baselines are applicable only for Models that are using Vertex AI-provided images for Tensorflow.
"denseShapeTensorName": "A String", # Specifies the shape of the values of the input if the input is a sparse representation. Refer to Tensorflow documentation for more details: https://www.tensorflow.org/api_docs/python/tf/sparse/SparseTensor.
"encodedBaselines": [ # A list of baselines for the encoded tensor. The shape of each baseline should match the shape of the encoded tensor. If a scalar is provided, Vertex AI broadcasts to the same shape as the encoded tensor.
"",
],
"encodedTensorName": "A String", # Encoded tensor is a transformation of the input tensor. Must be provided if choosing Integrated Gradients attribution or XRAI attribution and the input tensor is not differentiable. An encoded tensor is generated if the input tensor is encoded by a lookup table.
"encoding": "A String", # Defines how the feature is encoded into the input tensor. Defaults to IDENTITY.
"featureValueDomain": { # Domain details of the input feature value. Provides numeric information about the feature, such as its range (min, max). If the feature has been pre-processed, for example with z-scoring, then it provides information about how to recover the original feature. For example, if the input feature is an image and it has been pre-processed to obtain 0-mean and stddev = 1 values, then original_mean, and original_stddev refer to the mean and stddev of the original feature (e.g. image tensor) from which input feature (with mean = 0 and stddev = 1) was obtained. # The domain details of the input feature value. Like min/max, original mean or standard deviation if normalized.
"maxValue": 3.14, # The maximum permissible value for this feature.
"minValue": 3.14, # The minimum permissible value for this feature.
"originalMean": 3.14, # If this input feature has been normalized to a mean value of 0, the original_mean specifies the mean value of the domain prior to normalization.
"originalStddev": 3.14, # If this input feature has been normalized to a standard deviation of 1.0, the original_stddev specifies the standard deviation of the domain prior to normalization.
},
"groupName": "A String", # Name of the group that the input belongs to. Features with the same group name will be treated as one feature when computing attributions. Features grouped together can have different shapes in value. If provided, there will be one single attribution generated in Attribution.feature_attributions, keyed by the group name.
"indexFeatureMapping": [ # A list of feature names for each index in the input tensor. Required when the input InputMetadata.encoding is BAG_OF_FEATURES, BAG_OF_FEATURES_SPARSE, INDICATOR.
"A String",
],
"indicesTensorName": "A String", # Specifies the index of the values of the input tensor. Required when the input tensor is a sparse representation. Refer to Tensorflow documentation for more details: https://www.tensorflow.org/api_docs/python/tf/sparse/SparseTensor.
"inputBaselines": [ # Baseline inputs for this feature. If no baseline is specified, Vertex AI chooses the baseline for this feature. If multiple baselines are specified, Vertex AI returns the average attributions across them in Attribution.feature_attributions. For Vertex AI-provided Tensorflow images (both 1.x and 2.x), the shape of each baseline must match the shape of the input tensor. If a scalar is provided, we broadcast to the same shape as the input tensor. For custom images, the element of the baselines must be in the same format as the feature's input in the instance[]. The schema of any single instance may be specified via Endpoint's DeployedModels' Model's PredictSchemata's instance_schema_uri.
"",
],
"inputTensorName": "A String", # Name of the input tensor for this feature. Required and is only applicable to Vertex AI-provided images for Tensorflow.
"modality": "A String", # Modality of the feature. Valid values are: numeric, image. Defaults to numeric.
"visualization": { # Visualization configurations for image explanation. # Visualization configurations for image explanation.
"clipPercentLowerbound": 3.14, # Excludes attributions below the specified percentile, from the highlighted areas. Defaults to 62.
"clipPercentUpperbound": 3.14, # Excludes attributions above the specified percentile from the highlighted areas. Using the clip_percent_upperbound and clip_percent_lowerbound together can be useful for filtering out noise and making it easier to see areas of strong attribution. Defaults to 99.9.
"colorMap": "A String", # The color scheme used for the highlighted areas. Defaults to PINK_GREEN for Integrated Gradients attribution, which shows positive attributions in green and negative in pink. Defaults to VIRIDIS for XRAI attribution, which highlights the most influential regions in yellow and the least influential in blue.
"overlayType": "A String", # How the original image is displayed in the visualization. Adjusting the overlay can help increase visual clarity if the original image makes it difficult to view the visualization. Defaults to NONE.
"polarity": "A String", # Whether to only highlight pixels with positive contributions, negative or both. Defaults to POSITIVE.
"type": "A String", # Type of the image visualization. Only applicable to Integrated Gradients attribution. OUTLINES shows regions of attribution, while PIXELS shows per-pixel attribution. Defaults to OUTLINES.
},
},
},
"latentSpaceSource": "A String", # Name of the source to generate embeddings for example based explanations.
"outputs": { # Required. Map from output names to output metadata. For Vertex AI-provided Tensorflow images, keys can be any user defined string that consists of any UTF-8 characters. For custom images, keys are the name of the output field in the prediction to be explained. Currently only one key is allowed.
"a_key": { # Metadata of the prediction output to be explained.
"displayNameMappingKey": "A String", # Specify a field name in the prediction to look for the display name. Use this if the prediction contains the display names for the outputs. The display names in the prediction must have the same shape of the outputs, so that it can be located by Attribution.output_index for a specific output.
"indexDisplayNameMapping": "", # Static mapping between the index and display name. Use this if the outputs are a deterministic n-dimensional array, e.g. a list of scores of all the classes in a pre-defined order for a multi-classification Model. It's not feasible if the outputs are non-deterministic, e.g. the Model produces top-k classes or sort the outputs by their values. The shape of the value must be an n-dimensional array of strings. The number of dimensions must match that of the outputs to be explained. The Attribution.output_display_name is populated by locating in the mapping with Attribution.output_index.
"outputTensorName": "A String", # Name of the output tensor. Required and is only applicable to Vertex AI provided images for Tensorflow.
},
},
},
"parameters": { # Parameters to configure explaining for Model's predictions. # Required. Parameters that configure explaining of the Model's predictions.
"examples": { # Example-based explainability that returns the nearest neighbors from the provided dataset. # Example-based explanations that returns the nearest neighbors from the provided dataset.
"exampleGcsSource": { # The Cloud Storage input instances. # The Cloud Storage input instances.
"dataFormat": "A String", # The format in which instances are given, if not specified, assume it's JSONL format. Currently only JSONL format is supported.
"gcsSource": { # The Google Cloud Storage location for the input content. # The Cloud Storage location for the input instances.
"uris": [ # Required. Google Cloud Storage URI(-s) to the input file(s). May contain wildcards. For more information on wildcards, see https://cloud.google.com/storage/docs/gsutil/addlhelp/WildcardNames.
"A String",
],
},
},
"gcsSource": { # The Google Cloud Storage location for the input content. # The Cloud Storage locations that contain the instances to be indexed for approximate nearest neighbor search.
"uris": [ # Required. Google Cloud Storage URI(-s) to the input file(s). May contain wildcards. For more information on wildcards, see https://cloud.google.com/storage/docs/gsutil/addlhelp/WildcardNames.
"A String",
],
},
"nearestNeighborSearchConfig": "", # The full configuration for the generated index, the semantics are the same as metadata and should match [NearestNeighborSearchConfig](https://cloud.google.com/vertex-ai/docs/explainable-ai/configuring-explanations-example-based#nearest-neighbor-search-config).
"neighborCount": 42, # The number of neighbors to return when querying for examples.
"presets": { # Preset configuration for example-based explanations # Simplified preset configuration, which automatically sets configuration values based on the desired query speed-precision trade-off and modality.
"modality": "A String", # The modality of the uploaded model, which automatically configures the distance measurement and feature normalization for the underlying example index and queries. If your model does not precisely fit one of these types, it is okay to choose the closest type.
"query": "A String", # Preset option controlling parameters for speed-precision trade-off when querying for examples. If omitted, defaults to `PRECISE`.
},
},
"integratedGradientsAttribution": { # An attribution method that computes the Aumann-Shapley value taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1703.01365 # An attribution method that computes Aumann-Shapley values taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1703.01365
"blurBaselineConfig": { # Config for blur baseline. When enabled, a linear path from the maximally blurred image to the input image is created. Using a blurred baseline instead of zero (black image) is motivated by the BlurIG approach explained here: https://arxiv.org/abs/2004.03383 # Config for IG with blur baseline. When enabled, a linear path from the maximally blurred image to the input image is created. Using a blurred baseline instead of zero (black image) is motivated by the BlurIG approach explained here: https://arxiv.org/abs/2004.03383
"maxBlurSigma": 3.14, # The standard deviation of the blur kernel for the blurred baseline. The same blurring parameter is used for both the height and the width dimension. If not set, the method defaults to the zero (i.e. black for images) baseline.
},
"smoothGradConfig": { # Config for SmoothGrad approximation of gradients. When enabled, the gradients are approximated by averaging the gradients from noisy samples in the vicinity of the inputs. Adding noise can help improve the computed gradients. Refer to this paper for more details: https://arxiv.org/pdf/1706.03825.pdf # Config for SmoothGrad approximation of gradients. When enabled, the gradients are approximated by averaging the gradients from noisy samples in the vicinity of the inputs. Adding noise can help improve the computed gradients. Refer to this paper for more details: https://arxiv.org/pdf/1706.03825.pdf
"featureNoiseSigma": { # Noise sigma by features. Noise sigma represents the standard deviation of the gaussian kernel that will be used to add noise to interpolated inputs prior to computing gradients. # This is similar to noise_sigma, but provides additional flexibility. A separate noise sigma can be provided for each feature, which is useful if their distributions are different. No noise is added to features that are not set. If this field is unset, noise_sigma will be used for all features.
"noiseSigma": [ # Noise sigma per feature. No noise is added to features that are not set.
{ # Noise sigma for a single feature.
"name": "A String", # The name of the input feature for which noise sigma is provided. The features are defined in explanation metadata inputs.
"sigma": 3.14, # This represents the standard deviation of the Gaussian kernel that will be used to add noise to the feature prior to computing gradients. Similar to noise_sigma but represents the noise added to the current feature. Defaults to 0.1.
},
],
},
"noiseSigma": 3.14, # This is a single float value and will be used to add noise to all the features. Use this field when all features are normalized to have the same distribution: scale to range [0, 1], [-1, 1] or z-scoring, where features are normalized to have 0-mean and 1-variance. Learn more about [normalization](https://developers.google.com/machine-learning/data-prep/transform/normalization). For best results the recommended value is about 10% - 20% of the standard deviation of the input feature. Refer to section 3.2 of the SmoothGrad paper: https://arxiv.org/pdf/1706.03825.pdf. Defaults to 0.1. If the distribution is different per feature, set feature_noise_sigma instead for each feature.
"noisySampleCount": 42, # The number of gradient samples to use for approximation. The higher this number, the more accurate the gradient is, but the runtime complexity increases by this factor as well. Valid range of its value is [1, 50]. Defaults to 3.
},
"stepCount": 42, # Required. The number of steps for approximating the path integral. A good value to start is 50 and gradually increase until the sum to diff property is within the desired error range. Valid range of its value is [1, 100], inclusively.
},
"outputIndices": [ # If populated, only returns attributions that have output_index contained in output_indices. It must be an ndarray of integers, with the same shape of the output it's explaining. If not populated, returns attributions for top_k indices of outputs. If neither top_k nor output_indices is populated, returns the argmax index of the outputs. Only applicable to Models that predict multiple outputs (e,g, multi-class Models that predict multiple classes).
"",
],
"sampledShapleyAttribution": { # An attribution method that approximates Shapley values for features that contribute to the label being predicted. A sampling strategy is used to approximate the value rather than considering all subsets of features. # An attribution method that approximates Shapley values for features that contribute to the label being predicted. A sampling strategy is used to approximate the value rather than considering all subsets of features. Refer to this paper for model details: https://arxiv.org/abs/1306.4265.
"pathCount": 42, # Required. The number of feature permutations to consider when approximating the Shapley values. Valid range of its value is [1, 50], inclusively.
},
"topK": 42, # If populated, returns attributions for top K indices of outputs (defaults to 1). Only applies to Models that predicts more than one outputs (e,g, multi-class Models). When set to -1, returns explanations for all outputs.
"xraiAttribution": { # An explanation method that redistributes Integrated Gradients attributions to segmented regions, taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1906.02825 Supported only by image Models. # An attribution method that redistributes Integrated Gradients attribution to segmented regions, taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1906.02825 XRAI currently performs better on natural images, like a picture of a house or an animal. If the images are taken in artificial environments, like a lab or manufacturing line, or from diagnostic equipment, like x-rays or quality-control cameras, use Integrated Gradients instead.
"blurBaselineConfig": { # Config for blur baseline. When enabled, a linear path from the maximally blurred image to the input image is created. Using a blurred baseline instead of zero (black image) is motivated by the BlurIG approach explained here: https://arxiv.org/abs/2004.03383 # Config for XRAI with blur baseline. When enabled, a linear path from the maximally blurred image to the input image is created. Using a blurred baseline instead of zero (black image) is motivated by the BlurIG approach explained here: https://arxiv.org/abs/2004.03383
"maxBlurSigma": 3.14, # The standard deviation of the blur kernel for the blurred baseline. The same blurring parameter is used for both the height and the width dimension. If not set, the method defaults to the zero (i.e. black for images) baseline.
},
"smoothGradConfig": { # Config for SmoothGrad approximation of gradients. When enabled, the gradients are approximated by averaging the gradients from noisy samples in the vicinity of the inputs. Adding noise can help improve the computed gradients. Refer to this paper for more details: https://arxiv.org/pdf/1706.03825.pdf # Config for SmoothGrad approximation of gradients. When enabled, the gradients are approximated by averaging the gradients from noisy samples in the vicinity of the inputs. Adding noise can help improve the computed gradients. Refer to this paper for more details: https://arxiv.org/pdf/1706.03825.pdf
"featureNoiseSigma": { # Noise sigma by features. Noise sigma represents the standard deviation of the gaussian kernel that will be used to add noise to interpolated inputs prior to computing gradients. # This is similar to noise_sigma, but provides additional flexibility. A separate noise sigma can be provided for each feature, which is useful if their distributions are different. No noise is added to features that are not set. If this field is unset, noise_sigma will be used for all features.
"noiseSigma": [ # Noise sigma per feature. No noise is added to features that are not set.
{ # Noise sigma for a single feature.
"name": "A String", # The name of the input feature for which noise sigma is provided. The features are defined in explanation metadata inputs.
"sigma": 3.14, # This represents the standard deviation of the Gaussian kernel that will be used to add noise to the feature prior to computing gradients. Similar to noise_sigma but represents the noise added to the current feature. Defaults to 0.1.
},
],
},
"noiseSigma": 3.14, # This is a single float value and will be used to add noise to all the features. Use this field when all features are normalized to have the same distribution: scale to range [0, 1], [-1, 1] or z-scoring, where features are normalized to have 0-mean and 1-variance. Learn more about [normalization](https://developers.google.com/machine-learning/data-prep/transform/normalization). For best results the recommended value is about 10% - 20% of the standard deviation of the input feature. Refer to section 3.2 of the SmoothGrad paper: https://arxiv.org/pdf/1706.03825.pdf. Defaults to 0.1. If the distribution is different per feature, set feature_noise_sigma instead for each feature.
"noisySampleCount": 42, # The number of gradient samples to use for approximation. The higher this number, the more accurate the gradient is, but the runtime complexity increases by this factor as well. Valid range of its value is [1, 50]. Defaults to 3.
},
"stepCount": 42, # Required. The number of steps for approximating the path integral. A good value to start is 50 and gradually increase until the sum to diff property is met within the desired error range. Valid range of its value is [1, 100], inclusively.
},
},
},
"tabularObjective": { # Tabular monitoring objective. # Tabular monitoring objective.
"featureAttributionSpec": { # Feature attribution monitoring spec. # Feature attribution monitoring spec.
"batchExplanationDedicatedResources": { # A description of resources that are used for performing batch operations, are dedicated to a Model, and need manual configuration. # The config of resources used by the Model Monitoring during the batch explanation for non-AutoML models. If not set, `n1-standard-2` machine type will be used by default.
"machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine.
"acceleratorCount": 42, # The number of accelerators to attach to the machine.
"acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count.
"machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required.
"reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation.
"key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value.
"reservationAffinityType": "A String", # Required. Specifies the reservation affinity type.
"values": [ # Optional. Corresponds to the label values of a reservation resource. This must be the full resource name of the reservation.
"A String",
],
},
"tpuTopology": "A String", # Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1").
},
"maxReplicaCount": 42, # Immutable. The maximum number of machine replicas the batch operation may be scaled to. The default value is 10.
"startingReplicaCount": 42, # Immutable. The number of machine replicas used at the start of the batch operation. If not set, Vertex AI decides starting number, not greater than max_replica_count
},
"defaultAlertCondition": { # Monitoring alert triggered condition. # Default alert condition for all the features.
"threshold": 3.14, # A condition that compares a stats value against a threshold. Alert will be triggered if value above the threshold.
},
"featureAlertConditions": { # Per feature alert condition will override default alert condition.
"a_key": { # Monitoring alert triggered condition.
"threshold": 3.14, # A condition that compares a stats value against a threshold. Alert will be triggered if value above the threshold.
},
},
"features": [ # Feature names interested in monitoring. These should be a subset of the input feature names specified in the monitoring schema. If the field is not specified all features outlied in the monitoring schema will be used.
"A String",
],
},
"featureDriftSpec": { # Data drift monitoring spec. Data drift measures the distribution distance between the current dataset and a baseline dataset. A typical use case is to detect data drift between the recent production serving dataset and the training dataset, or to compare the recent production dataset with a dataset from a previous period. # Input feature distribution drift monitoring spec.
"categoricalMetricType": "A String", # Supported metrics type: * l_infinity * jensen_shannon_divergence
"defaultCategoricalAlertCondition": { # Monitoring alert triggered condition. # Default alert condition for all the categorical features.
"threshold": 3.14, # A condition that compares a stats value against a threshold. Alert will be triggered if value above the threshold.
},
"defaultNumericAlertCondition": { # Monitoring alert triggered condition. # Default alert condition for all the numeric features.
"threshold": 3.14, # A condition that compares a stats value against a threshold. Alert will be triggered if value above the threshold.
},
"featureAlertConditions": { # Per feature alert condition will override default alert condition.
"a_key": { # Monitoring alert triggered condition.
"threshold": 3.14, # A condition that compares a stats value against a threshold. Alert will be triggered if value above the threshold.
},
},
"features": [ # Feature names / Prediction output names interested in monitoring. These should be a subset of the input feature names or prediction output names specified in the monitoring schema. If the field is not specified all features / prediction outputs outlied in the monitoring schema will be used.
"A String",
],
"numericMetricType": "A String", # Supported metrics type: * jensen_shannon_divergence
},
"predictionOutputDriftSpec": { # Data drift monitoring spec. Data drift measures the distribution distance between the current dataset and a baseline dataset. A typical use case is to detect data drift between the recent production serving dataset and the training dataset, or to compare the recent production dataset with a dataset from a previous period. # Prediction output distribution drift monitoring spec.
"categoricalMetricType": "A String", # Supported metrics type: * l_infinity * jensen_shannon_divergence
"defaultCategoricalAlertCondition": { # Monitoring alert triggered condition. # Default alert condition for all the categorical features.
"threshold": 3.14, # A condition that compares a stats value against a threshold. Alert will be triggered if value above the threshold.
},
"defaultNumericAlertCondition": { # Monitoring alert triggered condition. # Default alert condition for all the numeric features.
"threshold": 3.14, # A condition that compares a stats value against a threshold. Alert will be triggered if value above the threshold.
},
"featureAlertConditions": { # Per feature alert condition will override default alert condition.
"a_key": { # Monitoring alert triggered condition.
"threshold": 3.14, # A condition that compares a stats value against a threshold. Alert will be triggered if value above the threshold.
},
},
"features": [ # Feature names / Prediction output names interested in monitoring. These should be a subset of the input feature names or prediction output names specified in the monitoring schema. If the field is not specified all features / prediction outputs outlied in the monitoring schema will be used.
"A String",
],
"numericMetricType": "A String", # Supported metrics type: * jensen_shannon_divergence
},
},
"targetDataset": { # Model monitoring data input spec. # Target dataset.
"batchPredictionOutput": { # Data from Vertex AI Batch prediction job output. # Vertex AI Batch prediction Job.
"batchPredictionJob": "A String", # Vertex AI Batch prediction job resource name. The job must match the model version specified in [ModelMonitor].[model_monitoring_target].
},
"columnizedDataset": { # Input dataset spec. # Columnized dataset.
"bigquerySource": { # Dataset spec for data sotred in BigQuery. # BigQuery data source.
"query": "A String", # Standard SQL to be used instead of the `table_uri`.
"tableUri": "A String", # BigQuery URI to a table, up to 2000 characters long. All the columns in the table will be selected. Accepted forms: * BigQuery path. For example: `bq://projectId.bqDatasetId.bqTableId`.
},
"gcsSource": { # Dataset spec for data stored in Google Cloud Storage. # Google Cloud Storage data source.
"format": "A String", # Data format of the dataset.
"gcsUri": "A String", # Google Cloud Storage URI to the input file(s). May contain wildcards. For more information on wildcards, see https://cloud.google.com/storage/docs/gsutil/addlhelp/WildcardNames.
},
"timestampField": "A String", # The timestamp field. Usually for serving data.
"vertexDataset": "A String", # Resource name of the Vertex AI managed dataset.
},
"timeInterval": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # The time interval (pair of start_time and end_time) for which results should be returned.
"endTime": "A String", # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
"startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
},
"timeOffset": { # Time offset setting. # The time offset setting for which results should be returned.
"offset": "A String", # [offset] is the time difference from the cut-off time. For scheduled jobs, the cut-off time is the scheduled time. For non-scheduled jobs, it's the time when the job was created. Currently we support the following format: 'w|W': Week, 'd|D': Day, 'h|H': Hour E.g. '1h' stands for 1 hour, '2d' stands for 2 days.
"window": "A String", # [window] refers to the scope of data selected for analysis. It allows you to specify the quantity of data you wish to examine. Currently we support the following format: 'w|W': Week, 'd|D': Day, 'h|H': Hour E.g. '1h' stands for 1 hour, '2d' stands for 2 days.
},
"vertexEndpointLogs": { # Data from Vertex AI Endpoint request response logging. # Vertex AI Endpoint request & response logging.
"endpoints": [ # List of endpoint resource names. The endpoints must enable the logging with the [Endpoint].[request_response_logging_config], and must contain the deployed model corresponding to the model version specified in [ModelMonitor].[model_monitoring_target].
"A String",
],
},
},
},
"outputSpec": { # Specification for the export destination of monitoring results, including metrics, logs, etc. # The Output destination spec for metrics, error logs, etc.
"gcsBaseDirectory": { # The Google Cloud Storage location where the output is to be written to. # Google Cloud Storage base folder path for metrics, error logs, etc.
"outputUriPrefix": "A String", # Required. Google Cloud Storage URI to output directory. If the uri doesn't end with '/', a '/' will be automatically appended. The directory is created if it doesn't exist.
},
},
},
"name": "A String", # Output only. Resource name of a ModelMonitoringJob. Format: `projects/{project_id}/locations/{location_id}/modelMonitors/{model_monitor_id}/modelMonitoringJobs/{model_monitoring_job_id}`
"schedule": "A String", # Output only. Schedule resource name. It will only appear when this job is triggered by a schedule.
"scheduleTime": "A String", # Output only. Timestamp when this ModelMonitoringJob was scheduled. It will only appear when this job is triggered by a schedule.
"state": "A String", # Output only. The state of the monitoring job. * When the job is still creating, the state will be 'JOB_STATE_PENDING'. * Once the job is successfully created, the state will be 'JOB_STATE_RUNNING'. * Once the job is finished, the state will be one of 'JOB_STATE_FAILED', 'JOB_STATE_SUCCEEDED', 'JOB_STATE_PARTIALLY_SUCCEEDED'.
"updateTime": "A String", # Output only. Timestamp when this ModelMonitoringJob was updated most recently.
},
"modelMonitoringJobId": "A String", # Optional. The ID to use for the Model Monitoring Job, which will become the final component of the model monitoring job resource name. The maximum length is 63 characters, and valid characters are `/^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$/`.
"parent": "A String", # Required. The parent of the ModelMonitoringJob. Format: `projects/{project}/locations/{location}/modelMoniitors/{model_monitor}`
},
"createNotebookExecutionJobRequest": { # Request message for [NotebookService.CreateNotebookExecutionJob] # Request for NotebookService.CreateNotebookExecutionJob.
"notebookExecutionJob": { # NotebookExecutionJob represents an instance of a notebook execution. # Required. The NotebookExecutionJob to create.
"createTime": "A String", # Output only. Timestamp when this NotebookExecutionJob was created.
"customEnvironmentSpec": { # Compute configuration to use for an execution job. # The custom compute configuration for an execution job.
"machineSpec": { # Specification of a single machine. # The specification of a single machine for the execution job.
"acceleratorCount": 42, # The number of accelerators to attach to the machine.
"acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count.
"machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required.
"reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation.
"key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value.
"reservationAffinityType": "A String", # Required. Specifies the reservation affinity type.
"values": [ # Optional. Corresponds to the label values of a reservation resource. This must be the full resource name of the reservation.
"A String",
],
},
"tpuTopology": "A String", # Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1").
},
"networkSpec": { # Network spec. # The network configuration to use for the execution job.
"enableInternetAccess": True or False, # Whether to enable public internet access. Default false.
"network": "A String", # The full name of the Google Compute Engine [network](https://cloud.google.com//compute/docs/networks-and-firewalls#networks)
"subnetwork": "A String", # The name of the subnet that this instance is in. Format: `projects/{project_id_or_number}/regions/{region}/subnetworks/{subnetwork_id}`
},
"persistentDiskSpec": { # Represents the spec of persistent disk options. # The specification of a persistent disk to attach for the execution job.
"diskSizeGb": "A String", # Size in GB of the disk (default is 100GB).
"diskType": "A String", # Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) "pd-extreme" (Extreme Persistent Disk)
},
},
"dataformRepositorySource": { # The Dataform Repository containing the input notebook. # The Dataform Repository pointing to a single file notebook repository.
"commitSha": "A String", # The commit SHA to read repository with. If unset, the file will be read at HEAD.
"dataformRepositoryResourceName": "A String", # The resource name of the Dataform Repository. Format: `projects/{project_id}/locations/{location}/repositories/{repository_id}`
},
"directNotebookSource": { # The content of the input notebook in ipynb format. # The contents of an input notebook file.
"content": "A String", # The base64-encoded contents of the input notebook file.
},
"displayName": "A String", # The display name of the NotebookExecutionJob. The name can be up to 128 characters long and can consist of any UTF-8 characters.
"encryptionSpec": { # Represents a customer-managed encryption key spec that can be applied to a top-level resource. # Customer-managed encryption key spec for the notebook execution job. This field is auto-populated if the NotebookService.NotebookRuntimeTemplate has an encryption spec.
"kmsKeyName": "A String", # Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. The key needs to be in the same region as where the compute resource is created.
},
"executionTimeout": "A String", # Max running time of the execution job in seconds (default 86400s / 24 hrs).
"executionUser": "A String", # The user email to run the execution as. Only supported by Colab runtimes.
"gcsNotebookSource": { # The Cloud Storage uri for the input notebook. # The Cloud Storage url pointing to the ipynb file. Format: `gs://bucket/notebook_file.ipynb`
"generation": "A String", # The version of the Cloud Storage object to read. If unset, the current version of the object is read. See https://cloud.google.com/storage/docs/metadata#generation-number.
"uri": "A String", # The Cloud Storage uri pointing to the ipynb file. Format: `gs://bucket/notebook_file.ipynb`
},
"gcsOutputUri": "A String", # The Cloud Storage location to upload the result to. Format: `gs://bucket-name`
"jobState": "A String", # Output only. The state of the NotebookExecutionJob.
"labels": { # The labels with user-defined metadata to organize NotebookExecutionJobs. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.
"a_key": "A String",
},
"name": "A String", # Output only. The resource name of this NotebookExecutionJob. Format: `projects/{project_id}/locations/{location}/notebookExecutionJobs/{job_id}`
"notebookRuntimeTemplateResourceName": "A String", # The NotebookRuntimeTemplate to source compute configuration from.
"scheduleResourceName": "A String", # Output only. The Schedule resource name if this job is triggered by one. Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}`
"serviceAccount": "A String", # The service account to run the execution as.
"status": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Populated when the NotebookExecutionJob is completed. When there is an error during notebook execution, the error details are populated.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"updateTime": "A String", # Output only. Timestamp when this NotebookExecutionJob was most recently updated.
},
"notebookExecutionJobId": "A String", # Optional. User specified ID for the NotebookExecutionJob.
"parent": "A String", # Required. The resource name of the Location to create the NotebookExecutionJob. Format: `projects/{project}/locations/{location}`
},
"createPipelineJobRequest": { # Request message for PipelineService.CreatePipelineJob. # Request for PipelineService.CreatePipelineJob. CreatePipelineJobRequest.parent field is required (format: projects/{project}/locations/{location}).
"parent": "A String", # Required. The resource name of the Location to create the PipelineJob in. Format: `projects/{project}/locations/{location}`
"pipelineJob": { # An instance of a machine learning PipelineJob. # Required. The PipelineJob to create.
"createTime": "A String", # Output only. Pipeline creation time.
"displayName": "A String", # The display name of the Pipeline. The name can be up to 128 characters long and can consist of any UTF-8 characters.
"encryptionSpec": { # Represents a customer-managed encryption key spec that can be applied to a top-level resource. # Customer-managed encryption key spec for a pipelineJob. If set, this PipelineJob and all of its sub-resources will be secured by this key.
"kmsKeyName": "A String", # Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. The key needs to be in the same region as where the compute resource is created.
},
"endTime": "A String", # Output only. Pipeline end time.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. The error that occurred during pipeline execution. Only populated when the pipeline's state is FAILED or CANCELLED.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"jobDetail": { # The runtime detail of PipelineJob. # Output only. The details of pipeline run. Not available in the list view.
"pipelineContext": { # Instance of a general context. # Output only. The context of the pipeline.
"createTime": "A String", # Output only. Timestamp when this Context was created.
"description": "A String", # Description of the Context
"displayName": "A String", # User provided display name of the Context. May be up to 128 Unicode characters.
"etag": "A String", # An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
"labels": { # The labels with user-defined metadata to organize your Contexts. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Context (System labels are excluded).
"a_key": "A String",
},
"metadata": { # Properties of the Context. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB.
"a_key": "", # Properties of the object.
},
"name": "A String", # Immutable. The resource name of the Context.
"parentContexts": [ # Output only. A list of resource names of Contexts that are parents of this Context. A Context may have at most 10 parent_contexts.
"A String",
],
"schemaTitle": "A String", # The title of the schema describing the metadata. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"schemaVersion": "A String", # The version of the schema in schema_name to use. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"updateTime": "A String", # Output only. Timestamp when this Context was last updated.
},
"pipelineRunContext": { # Instance of a general context. # Output only. The context of the current pipeline run.
"createTime": "A String", # Output only. Timestamp when this Context was created.
"description": "A String", # Description of the Context
"displayName": "A String", # User provided display name of the Context. May be up to 128 Unicode characters.
"etag": "A String", # An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
"labels": { # The labels with user-defined metadata to organize your Contexts. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Context (System labels are excluded).
"a_key": "A String",
},
"metadata": { # Properties of the Context. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB.
"a_key": "", # Properties of the object.
},
"name": "A String", # Immutable. The resource name of the Context.
"parentContexts": [ # Output only. A list of resource names of Contexts that are parents of this Context. A Context may have at most 10 parent_contexts.
"A String",
],
"schemaTitle": "A String", # The title of the schema describing the metadata. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"schemaVersion": "A String", # The version of the schema in schema_name to use. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"updateTime": "A String", # Output only. Timestamp when this Context was last updated.
},
"taskDetails": [ # Output only. The runtime details of the tasks under the pipeline.
{ # The runtime detail of a task execution.
"createTime": "A String", # Output only. Task create time.
"endTime": "A String", # Output only. Task end time.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. The error that occurred during task execution. Only populated when the task's state is FAILED or CANCELLED.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"execution": { # Instance of a general execution. # Output only. The execution metadata of the task.
"createTime": "A String", # Output only. Timestamp when this Execution was created.
"description": "A String", # Description of the Execution
"displayName": "A String", # User provided display name of the Execution. May be up to 128 Unicode characters.
"etag": "A String", # An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
"labels": { # The labels with user-defined metadata to organize your Executions. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Execution (System labels are excluded).
"a_key": "A String",
},
"metadata": { # Properties of the Execution. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB.
"a_key": "", # Properties of the object.
},
"name": "A String", # Output only. The resource name of the Execution.
"schemaTitle": "A String", # The title of the schema describing the metadata. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"schemaVersion": "A String", # The version of the schema in `schema_title` to use. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"state": "A String", # The state of this Execution. This is a property of the Execution, and does not imply or capture any ongoing process. This property is managed by clients (such as Vertex AI Pipelines) and the system does not prescribe or check the validity of state transitions.
"updateTime": "A String", # Output only. Timestamp when this Execution was last updated.
},
"executorDetail": { # The runtime detail of a pipeline executor. # Output only. The detailed execution info.
"containerDetail": { # The detail of a container execution. It contains the job names of the lifecycle of a container execution. # Output only. The detailed info for a container executor.
"failedMainJobs": [ # Output only. The names of the previously failed CustomJob for the main container executions. The list includes the all attempts in chronological order.
"A String",
],
"failedPreCachingCheckJobs": [ # Output only. The names of the previously failed CustomJob for the pre-caching-check container executions. This job will be available if the PipelineJob.pipeline_spec specifies the `pre_caching_check` hook in the lifecycle events. The list includes the all attempts in chronological order.
"A String",
],
"mainJob": "A String", # Output only. The name of the CustomJob for the main container execution.
"preCachingCheckJob": "A String", # Output only. The name of the CustomJob for the pre-caching-check container execution. This job will be available if the PipelineJob.pipeline_spec specifies the `pre_caching_check` hook in the lifecycle events.
},
"customJobDetail": { # The detailed info for a custom job executor. # Output only. The detailed info for a custom job executor.
"failedJobs": [ # Output only. The names of the previously failed CustomJob. The list includes the all attempts in chronological order.
"A String",
],
"job": "A String", # Output only. The name of the CustomJob.
},
},
"inputs": { # Output only. The runtime input artifacts of the task.
"a_key": { # A list of artifact metadata.
"artifacts": [ # Output only. A list of artifact metadata.
{ # Instance of a general artifact.
"createTime": "A String", # Output only. Timestamp when this Artifact was created.
"description": "A String", # Description of the Artifact
"displayName": "A String", # User provided display name of the Artifact. May be up to 128 Unicode characters.
"etag": "A String", # An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
"labels": { # The labels with user-defined metadata to organize your Artifacts. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Artifact (System labels are excluded).
"a_key": "A String",
},
"metadata": { # Properties of the Artifact. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB.
"a_key": "", # Properties of the object.
},
"name": "A String", # Output only. The resource name of the Artifact.
"schemaTitle": "A String", # The title of the schema describing the metadata. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"schemaVersion": "A String", # The version of the schema in schema_name to use. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"state": "A String", # The state of this Artifact. This is a property of the Artifact, and does not imply or capture any ongoing process. This property is managed by clients (such as Vertex AI Pipelines), and the system does not prescribe or check the validity of state transitions.
"updateTime": "A String", # Output only. Timestamp when this Artifact was last updated.
"uri": "A String", # The uniform resource identifier of the artifact file. May be empty if there is no actual artifact file.
},
],
},
},
"outputs": { # Output only. The runtime output artifacts of the task.
"a_key": { # A list of artifact metadata.
"artifacts": [ # Output only. A list of artifact metadata.
{ # Instance of a general artifact.
"createTime": "A String", # Output only. Timestamp when this Artifact was created.
"description": "A String", # Description of the Artifact
"displayName": "A String", # User provided display name of the Artifact. May be up to 128 Unicode characters.
"etag": "A String", # An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
"labels": { # The labels with user-defined metadata to organize your Artifacts. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Artifact (System labels are excluded).
"a_key": "A String",
},
"metadata": { # Properties of the Artifact. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB.
"a_key": "", # Properties of the object.
},
"name": "A String", # Output only. The resource name of the Artifact.
"schemaTitle": "A String", # The title of the schema describing the metadata. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"schemaVersion": "A String", # The version of the schema in schema_name to use. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"state": "A String", # The state of this Artifact. This is a property of the Artifact, and does not imply or capture any ongoing process. This property is managed by clients (such as Vertex AI Pipelines), and the system does not prescribe or check the validity of state transitions.
"updateTime": "A String", # Output only. Timestamp when this Artifact was last updated.
"uri": "A String", # The uniform resource identifier of the artifact file. May be empty if there is no actual artifact file.
},
],
},
},
"parentTaskId": "A String", # Output only. The id of the parent task if the task is within a component scope. Empty if the task is at the root level.
"pipelineTaskStatus": [ # Output only. A list of task status. This field keeps a record of task status evolving over time.
{ # A single record of the task status.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # 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.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"state": "A String", # Output only. The state of the task.
"updateTime": "A String", # Output only. Update time of this status.
},
],
"startTime": "A String", # Output only. Task start time.
"state": "A String", # Output only. State of the task.
"taskId": "A String", # Output only. The system generated ID of the task.
"taskName": "A String", # Output only. The user specified name of the task that is defined in pipeline_spec.
},
],
},
"labels": { # The labels with user-defined metadata to organize PipelineJob. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. Note there is some reserved label key for Vertex AI Pipelines. - `vertex-ai-pipelines-run-billing-id`, user set value will get overrided.
"a_key": "A String",
},
"name": "A String", # Output only. The resource name of the PipelineJob.
"network": "A String", # The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the Pipeline Job's workload should be peered. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. Private services access must already be configured for the network. Pipeline job will apply the network configuration to the Google Cloud resources being launched, if applied, such as Vertex AI Training or Dataflow job. If left unspecified, the workload is not peered with any network.
"originalPipelineJobId": "A String", # Optional. The original pipeline job id if this pipeline job is a rerun of a previous pipeline job.
"pipelineSpec": { # The spec of the pipeline.
"a_key": "", # Properties of the object.
},
"pipelineTaskRerunConfigs": [ # Optional. The rerun configs for each task in the pipeline job. By default, the rerun will: 1. Use the same input artifacts as the original run. 2. Use the same input parameters as the original run. 3. Skip all the tasks that are already succeeded in the original run. 4. Rerun all the tasks that are not succeeded in the original run. By providing this field, users can override the default behavior and specify the rerun config for each task.
{ # User provided rerun config to submit a rerun pipelinejob. This includes 1. Which task to rerun 2. User override input parameters and artifacts.
"inputs": { # Runtime inputs data of the task. # Optional. The runtime input of the task overridden by the user.
"artifacts": { # Optional. Input artifacts.
"a_key": { # A list of artifact metadata.
"artifacts": [ # Optional. A list of artifact metadata.
{ # The definition of a runtime artifact.
"customProperties": { # The custom properties of the artifact. Deprecated. Use RuntimeArtifact.metadata instead.
"a_key": { # Value is the value of the field.
"doubleValue": 3.14, # A double value.
"intValue": "A String", # An integer value.
"stringValue": "A String", # A string value.
},
},
"metadata": { # Properties of the Artifact.
"a_key": "", # Properties of the object.
},
"name": "A String", # The name of an artifact.
"properties": { # The properties of the artifact. Deprecated. Use RuntimeArtifact.metadata instead.
"a_key": { # Value is the value of the field.
"doubleValue": 3.14, # A double value.
"intValue": "A String", # An integer value.
"stringValue": "A String", # A string value.
},
},
"type": { # The definition of a artifact type in MLMD. # The type of the artifact.
"instanceSchema": "A String", # Contains a raw YAML string, describing the format of the properties of the type.
"schemaTitle": "A String", # The name of the type. The format of the title must be: `.`. Examples: - `aiplatform.Model` - `acme.CustomModel` When this field is set, the type must be pre-registered in the MLMD store.
"schemaUri": "A String", # Points to a YAML file stored on Cloud Storage describing the format. Deprecated. Use PipelineArtifactTypeSchema.schema_title or PipelineArtifactTypeSchema.instance_schema instead.
"schemaVersion": "A String", # The schema version of the artifact. If the value is not set, it defaults to the latest version in the system.
},
"uri": "A String", # The URI of the artifact.
},
],
},
},
"parameterValues": { # Optional. Input parameters.
"a_key": "",
},
},
"skipDownstreamTasks": True or False, # Optional. Whether to skip downstream tasks. Default value is False.
"skipTask": True or False, # Optional. Whether to skip this task. Default value is False.
"taskId": "A String", # Optional. The system generated ID of the task. Retrieved from original run.
"taskName": "A String", # Optional. The name of the task.
},
],
"preflightValidations": True or False, # Optional. Whether to do component level validations before job creation.
"pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I for PipelineJob.
"networkAttachment": "A String", # Optional. The name of the Compute Engine [network attachment](https://cloud.google.com/vpc/docs/about-network-attachments) to attach to the resource within the region and user project. To specify this field, you must have already [created a network attachment] (https://cloud.google.com/vpc/docs/create-manage-network-attachments#create-network-attachments). This field is only used for resources using PSC-I.
},
"reservedIpRanges": [ # A list of names for the reserved ip ranges under the VPC network that can be used for this Pipeline Job's workload. If set, we will deploy the Pipeline Job's workload within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network. Example: ['vertex-ai-ip-range'].
"A String",
],
"runtimeConfig": { # The runtime config of a PipelineJob. # Runtime config of the pipeline.
"defaultRuntime": { # The default runtime for the PipelineJob. # Optional. The default runtime for the PipelineJob. If not provided, Vertex Custom Job(on demand) is used as the runtime. For Vertex Custom Job, please refer to https://cloud.google.com/vertex-ai/docs/training/overview.
"persistentResourceRuntimeDetail": { # Persistent resource based runtime detail. For more information, refer to https://cloud.google.com/vertex-ai/docs/training/persistent-resource-overview # Persistent resource based runtime detail.
"persistentResourceName": "A String", # Persistent resource name. Format: `projects/{project}/locations/{location}/persistentResources/{persistent_resource}`
"taskResourceUnavailableTimeoutBehavior": "A String", # Specifies the behavior to take if the timeout is reached.
"taskResourceUnavailableWaitTimeMs": "A String", # The max time a pipeline task waits for the required CPU, memory, or accelerator resource to become available from the specified persistent resource. Default wait time is 0.
},
},
"failurePolicy": "A String", # Represents the failure policy of a pipeline. Currently, the default of a pipeline is that the pipeline will continue to run until no more tasks can be executed, also known as PIPELINE_FAILURE_POLICY_FAIL_SLOW. However, if a pipeline is set to PIPELINE_FAILURE_POLICY_FAIL_FAST, it will stop scheduling any new tasks when a task has failed. Any scheduled tasks will continue to completion.
"gcsOutputDirectory": "A String", # Required. A path in a Cloud Storage bucket, which will be treated as the root output directory of the pipeline. It is used by the system to generate the paths of output artifacts. The artifact paths are generated with a sub-path pattern `{job_id}/{task_id}/{output_key}` under the specified output directory. The service account specified in this pipeline must have the `storage.objects.get` and `storage.objects.create` permissions for this bucket.
"inputArtifacts": { # The runtime artifacts of the PipelineJob. The key will be the input artifact name and the value would be one of the InputArtifact.
"a_key": { # The type of an input artifact.
"artifactId": "A String", # Artifact resource id from MLMD. Which is the last portion of an artifact resource name: `projects/{project}/locations/{location}/metadataStores/default/artifacts/{artifact_id}`. The artifact must stay within the same project, location and default metadatastore as the pipeline.
},
},
"parameterValues": { # The runtime parameters of the PipelineJob. The parameters will be passed into PipelineJob.pipeline_spec to replace the placeholders at runtime. This field is used by pipelines built using `PipelineJob.pipeline_spec.schema_version` 2.1.0, such as pipelines built using Kubeflow Pipelines SDK 1.9 or higher and the v2 DSL.
"a_key": "",
},
"parameters": { # Deprecated. Use RuntimeConfig.parameter_values instead. The runtime parameters of the PipelineJob. The parameters will be passed into PipelineJob.pipeline_spec to replace the placeholders at runtime. This field is used by pipelines built using `PipelineJob.pipeline_spec.schema_version` 2.0.0 or lower, such as pipelines built using Kubeflow Pipelines SDK 1.8 or lower.
"a_key": { # Value is the value of the field.
"doubleValue": 3.14, # A double value.
"intValue": "A String", # An integer value.
"stringValue": "A String", # A string value.
},
},
},
"satisfiesPzi": True or False, # Output only. Reserved for future use.
"satisfiesPzs": True or False, # Output only. Reserved for future use.
"scheduleName": "A String", # Output only. The schedule resource name. Only returned if the Pipeline is created by Schedule API.
"serviceAccount": "A String", # The service account that the pipeline workload runs as. If not specified, the Compute Engine default service account in the project will be used. See https://cloud.google.com/compute/docs/access/service-accounts#default_service_account Users starting the pipeline must have the `iam.serviceAccounts.actAs` permission on this service account.
"startTime": "A String", # Output only. Pipeline start time.
"state": "A String", # Output only. The detailed state of the job.
"templateMetadata": { # Pipeline template metadata if PipelineJob.template_uri is from supported template registry. Currently, the only supported registry is Artifact Registry. # Output only. Pipeline template metadata. Will fill up fields if PipelineJob.template_uri is from supported template registry.
"version": "A String", # The version_name in artifact registry. Will always be presented in output if the PipelineJob.template_uri is from supported template registry. Format is "sha256:abcdef123456...".
},
"templateUri": "A String", # A template uri from where the PipelineJob.pipeline_spec, if empty, will be downloaded. Currently, only uri from Vertex Template Registry & Gallery is supported. Reference to https://cloud.google.com/vertex-ai/docs/pipelines/create-pipeline-template.
"updateTime": "A String", # Output only. Timestamp when this PipelineJob was most recently updated.
},
"pipelineJobId": "A String", # The ID to use for the PipelineJob, which will become the final component of the PipelineJob name. If not provided, an ID will be automatically generated. This value should be less than 128 characters, and valid characters are `/a-z-/`.
},
"createTime": "A String", # Output only. Timestamp when this Schedule was created.
"cron": "A String", # Cron schedule (https://en.wikipedia.org/wiki/Cron) to launch scheduled runs. To explicitly set a timezone to the cron tab, apply a prefix in the cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or "TZ=${IANA_TIME_ZONE}". The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone database. For example, "CRON_TZ=America/New_York 1 * * * *", or "TZ=America/New_York 1 * * * *".
"displayName": "A String", # Required. User provided name of the Schedule. The name can be up to 128 characters long and can consist of any UTF-8 characters.
"endTime": "A String", # Optional. Timestamp after which no new runs can be scheduled. If specified, The schedule will be completed when either end_time is reached or when scheduled_run_count >= max_run_count. If not specified, new runs will keep getting scheduled until this Schedule is paused or deleted. Already scheduled runs will be allowed to complete. Unset if not specified.
"lastPauseTime": "A String", # Output only. Timestamp when this Schedule was last paused. Unset if never paused.
"lastResumeTime": "A String", # Output only. Timestamp when this Schedule was last resumed. Unset if never resumed from pause.
"lastScheduledRunResponse": { # Status of a scheduled run. # Output only. Response of the last scheduled run. This is the response for starting the scheduled requests and not the execution of the operations/jobs created by the requests (if applicable). Unset if no run has been scheduled yet.
"runResponse": "A String", # The response of the scheduled run.
"scheduledRunTime": "A String", # The scheduled run time based on the user-specified schedule.
},
"maxConcurrentRunCount": "A String", # Required. Maximum number of runs that can be started concurrently for this Schedule. This is the limit for starting the scheduled requests and not the execution of the operations/jobs created by the requests (if applicable).
"maxRunCount": "A String", # Optional. Maximum run count of the schedule. If specified, The schedule will be completed when either started_run_count >= max_run_count or when end_time is reached. If not specified, new runs will keep getting scheduled until this Schedule is paused or deleted. Already scheduled runs will be allowed to complete. Unset if not specified.
"name": "A String", # Immutable. The resource name of the Schedule.
"nextRunTime": "A String", # Output only. Timestamp when this Schedule should schedule the next run. Having a next_run_time in the past means the runs are being started behind schedule.
"startTime": "A String", # Optional. Timestamp after which the first run can be scheduled. Default to Schedule create time if not specified.
"startedRunCount": "A String", # Output only. The number of runs started by this schedule.
"state": "A String", # Output only. The state of this Schedule.
"updateTime": "A String", # Output only. Timestamp when this Schedule was updated.
}

list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

Lists Schedules in a Location.

Args:
parent: string, Required. The resource name of the Location to list the Schedules from. Format: `projects/{project}/locations/{location}` (required)
filter: string, Lists the Schedules that match the filter expression. The following fields are supported: * `display_name`: Supports `=`, `!=` comparisons, and `:` wildcard. * `state`: Supports `=` and `!=` comparisons. * `request`: Supports existence of the check. (e.g. `create_pipeline_job_request:*` --> Schedule has create_pipeline_job_request). * `create_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `start_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `end_time`: Supports `=`, `!=`, `<`, `>`, `<=`, `>=` comparisons and `:*` existence check. Values must be in RFC 3339 format. * `next_run_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. Filter expressions can be combined together using logical operators (`NOT`, `AND` & `OR`). The syntax to define filter expression is based on https://google.aip.dev/160. Examples: * `state="ACTIVE" AND display_name:"my_schedule_*"` * `NOT display_name="my_schedule"` * `create_time>"2021-05-18T00:00:00Z"` * `end_time>"2021-05-18T00:00:00Z" OR NOT end_time:*` * `create_pipeline_job_request:*`
orderBy: string, 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. For example, using "create_time desc, end_time" will order results by create time in descending order, and if there are multiple schedules 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 with create_time in descending order. Supported fields: * `create_time` * `start_time` * `end_time` * `next_run_time`
pageSize: integer, The standard list page size. Default to 100 if not specified.
pageToken: string, The standard list page token. Typically obtained via ListSchedulesResponse.next_page_token of the previous ScheduleService.ListSchedules call.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # Response message for ScheduleService.ListSchedules
"nextPageToken": "A String", # A token to retrieve the next page of results. Pass to ListSchedulesRequest.page_token to obtain that page.
"schedules": [ # List of Schedules in the requested page.
{ # An instance of a Schedule periodically schedules runs to make API calls based on user specified time specification and API request type.
"allowQueueing": True or False, # Optional. Whether new scheduled runs can be queued when max_concurrent_runs limit is reached. If set to true, new runs will be queued instead of skipped. Default to false.
"catchUp": True or False, # Output only. Whether to backfill missed runs when the schedule is resumed from PAUSED state. If set to true, all missed runs will be scheduled. New runs will be scheduled after the backfill is complete. Default to false.
"createModelMonitoringJobRequest": { # Request message for ModelMonitoringService.CreateModelMonitoringJob. # Request for ModelMonitoringService.CreateModelMonitoringJob.
"modelMonitoringJob": { # Represents a model monitoring job that analyze dataset using different monitoring algorithm. # Required. The ModelMonitoringJob to create
"createTime": "A String", # Output only. Timestamp when this ModelMonitoringJob was created.
"displayName": "A String", # The display name of the ModelMonitoringJob. The name can be up to 128 characters long and can consist of any UTF-8.
"jobExecutionDetail": { # Represent the execution details of the job. # Output only. Execution results for all the monitoring objectives.
"baselineDatasets": [ # Processed baseline datasets.
{ # Processed dataset information.
"location": "A String", # Actual data location of the processed dataset.
"timeRange": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Dataset time range information if any.
"endTime": "A String", # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
"startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
},
},
],
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Additional job error status.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"objectiveStatus": { # Status of data processing for each monitoring objective. Key is the objective.
"a_key": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
},
"targetDatasets": [ # Processed target datasets.
{ # Processed dataset information.
"location": "A String", # Actual data location of the processed dataset.
"timeRange": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Dataset time range information if any.
"endTime": "A String", # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
"startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
},
},
],
},
"modelMonitoringSpec": { # Monitoring monitoring job spec. It outlines the specifications for monitoring objectives, notifications, and result exports. # Monitoring monitoring job spec. It outlines the specifications for monitoring objectives, notifications, and result exports. If left blank, the default monitoring specifications from the top-level resource 'ModelMonitor' will be applied. If provided, we will use the specification defined here rather than the default one.
"notificationSpec": { # Notification spec(email, notification channel) for model monitoring statistics/alerts. # The model monitoring notification spec.
"emailConfig": { # The config for email alerts. # Email alert config.
"userEmails": [ # The email addresses to send the alerts.
"A String",
],
},
"enableCloudLogging": True or False, # Dump the anomalies to Cloud Logging. The anomalies will be put to json payload encoded from proto google.cloud.aiplatform.logging.ModelMonitoringAnomaliesLogEntry. This can be further sinked to Pub/Sub or any other services supported by Cloud Logging.
"notificationChannelConfigs": [ # Notification channel config.
{ # Google Cloud Notification Channel config.
"notificationChannel": "A String", # Resource names of the NotificationChannels. Must be of the format `projects//notificationChannels/`
},
],
},
"objectiveSpec": { # Monitoring objectives spec. # The monitoring objective spec.
"baselineDataset": { # Model monitoring data input spec. # Baseline dataset. It could be the training dataset or production serving dataset from a previous period.
"batchPredictionOutput": { # Data from Vertex AI Batch prediction job output. # Vertex AI Batch prediction Job.
"batchPredictionJob": "A String", # Vertex AI Batch prediction job resource name. The job must match the model version specified in [ModelMonitor].[model_monitoring_target].
},
"columnizedDataset": { # Input dataset spec. # Columnized dataset.
"bigquerySource": { # Dataset spec for data sotred in BigQuery. # BigQuery data source.
"query": "A String", # Standard SQL to be used instead of the `table_uri`.
"tableUri": "A String", # BigQuery URI to a table, up to 2000 characters long. All the columns in the table will be selected. Accepted forms: * BigQuery path. For example: `bq://projectId.bqDatasetId.bqTableId`.
},
"gcsSource": { # Dataset spec for data stored in Google Cloud Storage. # Google Cloud Storage data source.
"format": "A String", # Data format of the dataset.
"gcsUri": "A String", # Google Cloud Storage URI to the input file(s). May contain wildcards. For more information on wildcards, see https://cloud.google.com/storage/docs/gsutil/addlhelp/WildcardNames.
},
"timestampField": "A String", # The timestamp field. Usually for serving data.
"vertexDataset": "A String", # Resource name of the Vertex AI managed dataset.
},
"timeInterval": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # The time interval (pair of start_time and end_time) for which results should be returned.
"endTime": "A String", # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
"startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
},
"timeOffset": { # Time offset setting. # The time offset setting for which results should be returned.
"offset": "A String", # [offset] is the time difference from the cut-off time. For scheduled jobs, the cut-off time is the scheduled time. For non-scheduled jobs, it's the time when the job was created. Currently we support the following format: 'w|W': Week, 'd|D': Day, 'h|H': Hour E.g. '1h' stands for 1 hour, '2d' stands for 2 days.
"window": "A String", # [window] refers to the scope of data selected for analysis. It allows you to specify the quantity of data you wish to examine. Currently we support the following format: 'w|W': Week, 'd|D': Day, 'h|H': Hour E.g. '1h' stands for 1 hour, '2d' stands for 2 days.
},
"vertexEndpointLogs": { # Data from Vertex AI Endpoint request response logging. # Vertex AI Endpoint request & response logging.
"endpoints": [ # List of endpoint resource names. The endpoints must enable the logging with the [Endpoint].[request_response_logging_config], and must contain the deployed model corresponding to the model version specified in [ModelMonitor].[model_monitoring_target].
"A String",
],
},
},
"explanationSpec": { # Specification of Model explanation. # The explanation spec. This spec is required when the objectives spec includes feature attribution objectives.
"metadata": { # Metadata describing the Model's input and output for explanation. # Optional. Metadata describing the Model's input and output for explanation.
"featureAttributionsSchemaUri": "A String", # Points to a YAML file stored on Google Cloud Storage describing the format of the feature attributions. The schema is defined as an OpenAPI 3.0.2 [Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). AutoML tabular Models always have this field populated by Vertex AI. Note: The URI given on output may be different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.
"inputs": { # Required. Map from feature names to feature input metadata. Keys are the name of the features. Values are the specification of the feature. An empty InputMetadata is valid. It describes a text feature which has the name specified as the key in ExplanationMetadata.inputs. The baseline of the empty feature is chosen by Vertex AI. For Vertex AI-provided Tensorflow images, the key can be any friendly name of the feature. Once specified, featureAttributions are keyed by this key (if not grouped with another feature). For custom images, the key must match with the key in instance.
"a_key": { # Metadata of the input of a feature. Fields other than InputMetadata.input_baselines are applicable only for Models that are using Vertex AI-provided images for Tensorflow.
"denseShapeTensorName": "A String", # Specifies the shape of the values of the input if the input is a sparse representation. Refer to Tensorflow documentation for more details: https://www.tensorflow.org/api_docs/python/tf/sparse/SparseTensor.
"encodedBaselines": [ # A list of baselines for the encoded tensor. The shape of each baseline should match the shape of the encoded tensor. If a scalar is provided, Vertex AI broadcasts to the same shape as the encoded tensor.
"",
],
"encodedTensorName": "A String", # Encoded tensor is a transformation of the input tensor. Must be provided if choosing Integrated Gradients attribution or XRAI attribution and the input tensor is not differentiable. An encoded tensor is generated if the input tensor is encoded by a lookup table.
"encoding": "A String", # Defines how the feature is encoded into the input tensor. Defaults to IDENTITY.
"featureValueDomain": { # Domain details of the input feature value. Provides numeric information about the feature, such as its range (min, max). If the feature has been pre-processed, for example with z-scoring, then it provides information about how to recover the original feature. For example, if the input feature is an image and it has been pre-processed to obtain 0-mean and stddev = 1 values, then original_mean, and original_stddev refer to the mean and stddev of the original feature (e.g. image tensor) from which input feature (with mean = 0 and stddev = 1) was obtained. # The domain details of the input feature value. Like min/max, original mean or standard deviation if normalized.
"maxValue": 3.14, # The maximum permissible value for this feature.
"minValue": 3.14, # The minimum permissible value for this feature.
"originalMean": 3.14, # If this input feature has been normalized to a mean value of 0, the original_mean specifies the mean value of the domain prior to normalization.
"originalStddev": 3.14, # If this input feature has been normalized to a standard deviation of 1.0, the original_stddev specifies the standard deviation of the domain prior to normalization.
},
"groupName": "A String", # Name of the group that the input belongs to. Features with the same group name will be treated as one feature when computing attributions. Features grouped together can have different shapes in value. If provided, there will be one single attribution generated in Attribution.feature_attributions, keyed by the group name.
"indexFeatureMapping": [ # A list of feature names for each index in the input tensor. Required when the input InputMetadata.encoding is BAG_OF_FEATURES, BAG_OF_FEATURES_SPARSE, INDICATOR.
"A String",
],
"indicesTensorName": "A String", # Specifies the index of the values of the input tensor. Required when the input tensor is a sparse representation. Refer to Tensorflow documentation for more details: https://www.tensorflow.org/api_docs/python/tf/sparse/SparseTensor.
"inputBaselines": [ # Baseline inputs for this feature. If no baseline is specified, Vertex AI chooses the baseline for this feature. If multiple baselines are specified, Vertex AI returns the average attributions across them in Attribution.feature_attributions. For Vertex AI-provided Tensorflow images (both 1.x and 2.x), the shape of each baseline must match the shape of the input tensor. If a scalar is provided, we broadcast to the same shape as the input tensor. For custom images, the element of the baselines must be in the same format as the feature's input in the instance[]. The schema of any single instance may be specified via Endpoint's DeployedModels' Model's PredictSchemata's instance_schema_uri.
"",
],
"inputTensorName": "A String", # Name of the input tensor for this feature. Required and is only applicable to Vertex AI-provided images for Tensorflow.
"modality": "A String", # Modality of the feature. Valid values are: numeric, image. Defaults to numeric.
"visualization": { # Visualization configurations for image explanation. # Visualization configurations for image explanation.
"clipPercentLowerbound": 3.14, # Excludes attributions below the specified percentile, from the highlighted areas. Defaults to 62.
"clipPercentUpperbound": 3.14, # Excludes attributions above the specified percentile from the highlighted areas. Using the clip_percent_upperbound and clip_percent_lowerbound together can be useful for filtering out noise and making it easier to see areas of strong attribution. Defaults to 99.9.
"colorMap": "A String", # The color scheme used for the highlighted areas. Defaults to PINK_GREEN for Integrated Gradients attribution, which shows positive attributions in green and negative in pink. Defaults to VIRIDIS for XRAI attribution, which highlights the most influential regions in yellow and the least influential in blue.
"overlayType": "A String", # How the original image is displayed in the visualization. Adjusting the overlay can help increase visual clarity if the original image makes it difficult to view the visualization. Defaults to NONE.
"polarity": "A String", # Whether to only highlight pixels with positive contributions, negative or both. Defaults to POSITIVE.
"type": "A String", # Type of the image visualization. Only applicable to Integrated Gradients attribution. OUTLINES shows regions of attribution, while PIXELS shows per-pixel attribution. Defaults to OUTLINES.
},
},
},
"latentSpaceSource": "A String", # Name of the source to generate embeddings for example based explanations.
"outputs": { # Required. Map from output names to output metadata. For Vertex AI-provided Tensorflow images, keys can be any user defined string that consists of any UTF-8 characters. For custom images, keys are the name of the output field in the prediction to be explained. Currently only one key is allowed.
"a_key": { # Metadata of the prediction output to be explained.
"displayNameMappingKey": "A String", # Specify a field name in the prediction to look for the display name. Use this if the prediction contains the display names for the outputs. The display names in the prediction must have the same shape of the outputs, so that it can be located by Attribution.output_index for a specific output.
"indexDisplayNameMapping": "", # Static mapping between the index and display name. Use this if the outputs are a deterministic n-dimensional array, e.g. a list of scores of all the classes in a pre-defined order for a multi-classification Model. It's not feasible if the outputs are non-deterministic, e.g. the Model produces top-k classes or sort the outputs by their values. The shape of the value must be an n-dimensional array of strings. The number of dimensions must match that of the outputs to be explained. The Attribution.output_display_name is populated by locating in the mapping with Attribution.output_index.
"outputTensorName": "A String", # Name of the output tensor. Required and is only applicable to Vertex AI provided images for Tensorflow.
},
},
},
"parameters": { # Parameters to configure explaining for Model's predictions. # Required. Parameters that configure explaining of the Model's predictions.
"examples": { # Example-based explainability that returns the nearest neighbors from the provided dataset. # Example-based explanations that returns the nearest neighbors from the provided dataset.
"exampleGcsSource": { # The Cloud Storage input instances. # The Cloud Storage input instances.
"dataFormat": "A String", # The format in which instances are given, if not specified, assume it's JSONL format. Currently only JSONL format is supported.
"gcsSource": { # The Google Cloud Storage location for the input content. # The Cloud Storage location for the input instances.
"uris": [ # Required. Google Cloud Storage URI(-s) to the input file(s). May contain wildcards. For more information on wildcards, see https://cloud.google.com/storage/docs/gsutil/addlhelp/WildcardNames.
"A String",
],
},
},
"gcsSource": { # The Google Cloud Storage location for the input content. # The Cloud Storage locations that contain the instances to be indexed for approximate nearest neighbor search.
"uris": [ # Required. Google Cloud Storage URI(-s) to the input file(s). May contain wildcards. For more information on wildcards, see https://cloud.google.com/storage/docs/gsutil/addlhelp/WildcardNames.
"A String",
],
},
"nearestNeighborSearchConfig": "", # The full configuration for the generated index, the semantics are the same as metadata and should match [NearestNeighborSearchConfig](https://cloud.google.com/vertex-ai/docs/explainable-ai/configuring-explanations-example-based#nearest-neighbor-search-config).
"neighborCount": 42, # The number of neighbors to return when querying for examples.
"presets": { # Preset configuration for example-based explanations # Simplified preset configuration, which automatically sets configuration values based on the desired query speed-precision trade-off and modality.
"modality": "A String", # The modality of the uploaded model, which automatically configures the distance measurement and feature normalization for the underlying example index and queries. If your model does not precisely fit one of these types, it is okay to choose the closest type.
"query": "A String", # Preset option controlling parameters for speed-precision trade-off when querying for examples. If omitted, defaults to `PRECISE`.
},
},
"integratedGradientsAttribution": { # An attribution method that computes the Aumann-Shapley value taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1703.01365 # An attribution method that computes Aumann-Shapley values taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1703.01365
"blurBaselineConfig": { # Config for blur baseline. When enabled, a linear path from the maximally blurred image to the input image is created. Using a blurred baseline instead of zero (black image) is motivated by the BlurIG approach explained here: https://arxiv.org/abs/2004.03383 # Config for IG with blur baseline. When enabled, a linear path from the maximally blurred image to the input image is created. Using a blurred baseline instead of zero (black image) is motivated by the BlurIG approach explained here: https://arxiv.org/abs/2004.03383
"maxBlurSigma": 3.14, # The standard deviation of the blur kernel for the blurred baseline. The same blurring parameter is used for both the height and the width dimension. If not set, the method defaults to the zero (i.e. black for images) baseline.
},
"smoothGradConfig": { # Config for SmoothGrad approximation of gradients. When enabled, the gradients are approximated by averaging the gradients from noisy samples in the vicinity of the inputs. Adding noise can help improve the computed gradients. Refer to this paper for more details: https://arxiv.org/pdf/1706.03825.pdf # Config for SmoothGrad approximation of gradients. When enabled, the gradients are approximated by averaging the gradients from noisy samples in the vicinity of the inputs. Adding noise can help improve the computed gradients. Refer to this paper for more details: https://arxiv.org/pdf/1706.03825.pdf
"featureNoiseSigma": { # Noise sigma by features. Noise sigma represents the standard deviation of the gaussian kernel that will be used to add noise to interpolated inputs prior to computing gradients. # This is similar to noise_sigma, but provides additional flexibility. A separate noise sigma can be provided for each feature, which is useful if their distributions are different. No noise is added to features that are not set. If this field is unset, noise_sigma will be used for all features.
"noiseSigma": [ # Noise sigma per feature. No noise is added to features that are not set.
{ # Noise sigma for a single feature.
"name": "A String", # The name of the input feature for which noise sigma is provided. The features are defined in explanation metadata inputs.
"sigma": 3.14, # This represents the standard deviation of the Gaussian kernel that will be used to add noise to the feature prior to computing gradients. Similar to noise_sigma but represents the noise added to the current feature. Defaults to 0.1.
},
],
},
"noiseSigma": 3.14, # This is a single float value and will be used to add noise to all the features. Use this field when all features are normalized to have the same distribution: scale to range [0, 1], [-1, 1] or z-scoring, where features are normalized to have 0-mean and 1-variance. Learn more about [normalization](https://developers.google.com/machine-learning/data-prep/transform/normalization). For best results the recommended value is about 10% - 20% of the standard deviation of the input feature. Refer to section 3.2 of the SmoothGrad paper: https://arxiv.org/pdf/1706.03825.pdf. Defaults to 0.1. If the distribution is different per feature, set feature_noise_sigma instead for each feature.
"noisySampleCount": 42, # The number of gradient samples to use for approximation. The higher this number, the more accurate the gradient is, but the runtime complexity increases by this factor as well. Valid range of its value is [1, 50]. Defaults to 3.
},
"stepCount": 42, # Required. The number of steps for approximating the path integral. A good value to start is 50 and gradually increase until the sum to diff property is within the desired error range. Valid range of its value is [1, 100], inclusively.
},
"outputIndices": [ # If populated, only returns attributions that have output_index contained in output_indices. It must be an ndarray of integers, with the same shape of the output it's explaining. If not populated, returns attributions for top_k indices of outputs. If neither top_k nor output_indices is populated, returns the argmax index of the outputs. Only applicable to Models that predict multiple outputs (e,g, multi-class Models that predict multiple classes).
"",
],
"sampledShapleyAttribution": { # An attribution method that approximates Shapley values for features that contribute to the label being predicted. A sampling strategy is used to approximate the value rather than considering all subsets of features. # An attribution method that approximates Shapley values for features that contribute to the label being predicted. A sampling strategy is used to approximate the value rather than considering all subsets of features. Refer to this paper for model details: https://arxiv.org/abs/1306.4265.
"pathCount": 42, # Required. The number of feature permutations to consider when approximating the Shapley values. Valid range of its value is [1, 50], inclusively.
},
"topK": 42, # If populated, returns attributions for top K indices of outputs (defaults to 1). Only applies to Models that predicts more than one outputs (e,g, multi-class Models). When set to -1, returns explanations for all outputs.
"xraiAttribution": { # An explanation method that redistributes Integrated Gradients attributions to segmented regions, taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1906.02825 Supported only by image Models. # An attribution method that redistributes Integrated Gradients attribution to segmented regions, taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1906.02825 XRAI currently performs better on natural images, like a picture of a house or an animal. If the images are taken in artificial environments, like a lab or manufacturing line, or from diagnostic equipment, like x-rays or quality-control cameras, use Integrated Gradients instead.
"blurBaselineConfig": { # Config for blur baseline. When enabled, a linear path from the maximally blurred image to the input image is created. Using a blurred baseline instead of zero (black image) is motivated by the BlurIG approach explained here: https://arxiv.org/abs/2004.03383 # Config for XRAI with blur baseline. When enabled, a linear path from the maximally blurred image to the input image is created. Using a blurred baseline instead of zero (black image) is motivated by the BlurIG approach explained here: https://arxiv.org/abs/2004.03383
"maxBlurSigma": 3.14, # The standard deviation of the blur kernel for the blurred baseline. The same blurring parameter is used for both the height and the width dimension. If not set, the method defaults to the zero (i.e. black for images) baseline.
},
"smoothGradConfig": { # Config for SmoothGrad approximation of gradients. When enabled, the gradients are approximated by averaging the gradients from noisy samples in the vicinity of the inputs. Adding noise can help improve the computed gradients. Refer to this paper for more details: https://arxiv.org/pdf/1706.03825.pdf # Config for SmoothGrad approximation of gradients. When enabled, the gradients are approximated by averaging the gradients from noisy samples in the vicinity of the inputs. Adding noise can help improve the computed gradients. Refer to this paper for more details: https://arxiv.org/pdf/1706.03825.pdf
"featureNoiseSigma": { # Noise sigma by features. Noise sigma represents the standard deviation of the gaussian kernel that will be used to add noise to interpolated inputs prior to computing gradients. # This is similar to noise_sigma, but provides additional flexibility. A separate noise sigma can be provided for each feature, which is useful if their distributions are different. No noise is added to features that are not set. If this field is unset, noise_sigma will be used for all features.
"noiseSigma": [ # Noise sigma per feature. No noise is added to features that are not set.
{ # Noise sigma for a single feature.
"name": "A String", # The name of the input feature for which noise sigma is provided. The features are defined in explanation metadata inputs.
"sigma": 3.14, # This represents the standard deviation of the Gaussian kernel that will be used to add noise to the feature prior to computing gradients. Similar to noise_sigma but represents the noise added to the current feature. Defaults to 0.1.
},
],
},
"noiseSigma": 3.14, # This is a single float value and will be used to add noise to all the features. Use this field when all features are normalized to have the same distribution: scale to range [0, 1], [-1, 1] or z-scoring, where features are normalized to have 0-mean and 1-variance. Learn more about [normalization](https://developers.google.com/machine-learning/data-prep/transform/normalization). For best results the recommended value is about 10% - 20% of the standard deviation of the input feature. Refer to section 3.2 of the SmoothGrad paper: https://arxiv.org/pdf/1706.03825.pdf. Defaults to 0.1. If the distribution is different per feature, set feature_noise_sigma instead for each feature.
"noisySampleCount": 42, # The number of gradient samples to use for approximation. The higher this number, the more accurate the gradient is, but the runtime complexity increases by this factor as well. Valid range of its value is [1, 50]. Defaults to 3.
},
"stepCount": 42, # Required. The number of steps for approximating the path integral. A good value to start is 50 and gradually increase until the sum to diff property is met within the desired error range. Valid range of its value is [1, 100], inclusively.
},
},
},
"tabularObjective": { # Tabular monitoring objective. # Tabular monitoring objective.
"featureAttributionSpec": { # Feature attribution monitoring spec. # Feature attribution monitoring spec.
"batchExplanationDedicatedResources": { # A description of resources that are used for performing batch operations, are dedicated to a Model, and need manual configuration. # The config of resources used by the Model Monitoring during the batch explanation for non-AutoML models. If not set, `n1-standard-2` machine type will be used by default.
"machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine.
"acceleratorCount": 42, # The number of accelerators to attach to the machine.
"acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count.
"machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required.
"reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation.
"key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value.
"reservationAffinityType": "A String", # Required. Specifies the reservation affinity type.
"values": [ # Optional. Corresponds to the label values of a reservation resource. This must be the full resource name of the reservation.
"A String",
],
},
"tpuTopology": "A String", # Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1").
},
"maxReplicaCount": 42, # Immutable. The maximum number of machine replicas the batch operation may be scaled to. The default value is 10.
"startingReplicaCount": 42, # Immutable. The number of machine replicas used at the start of the batch operation. If not set, Vertex AI decides starting number, not greater than max_replica_count
},
"defaultAlertCondition": { # Monitoring alert triggered condition. # Default alert condition for all the features.
"threshold": 3.14, # A condition that compares a stats value against a threshold. Alert will be triggered if value above the threshold.
},
"featureAlertConditions": { # Per feature alert condition will override default alert condition.
"a_key": { # Monitoring alert triggered condition.
"threshold": 3.14, # A condition that compares a stats value against a threshold. Alert will be triggered if value above the threshold.
},
},
"features": [ # Feature names interested in monitoring. These should be a subset of the input feature names specified in the monitoring schema. If the field is not specified all features outlied in the monitoring schema will be used.
"A String",
],
},
"featureDriftSpec": { # Data drift monitoring spec. Data drift measures the distribution distance between the current dataset and a baseline dataset. A typical use case is to detect data drift between the recent production serving dataset and the training dataset, or to compare the recent production dataset with a dataset from a previous period. # Input feature distribution drift monitoring spec.
"categoricalMetricType": "A String", # Supported metrics type: * l_infinity * jensen_shannon_divergence
"defaultCategoricalAlertCondition": { # Monitoring alert triggered condition. # Default alert condition for all the categorical features.
"threshold": 3.14, # A condition that compares a stats value against a threshold. Alert will be triggered if value above the threshold.
},
"defaultNumericAlertCondition": { # Monitoring alert triggered condition. # Default alert condition for all the numeric features.
"threshold": 3.14, # A condition that compares a stats value against a threshold. Alert will be triggered if value above the threshold.
},
"featureAlertConditions": { # Per feature alert condition will override default alert condition.
"a_key": { # Monitoring alert triggered condition.
"threshold": 3.14, # A condition that compares a stats value against a threshold. Alert will be triggered if value above the threshold.
},
},
"features": [ # Feature names / Prediction output names interested in monitoring. These should be a subset of the input feature names or prediction output names specified in the monitoring schema. If the field is not specified all features / prediction outputs outlied in the monitoring schema will be used.
"A String",
],
"numericMetricType": "A String", # Supported metrics type: * jensen_shannon_divergence
},
"predictionOutputDriftSpec": { # Data drift monitoring spec. Data drift measures the distribution distance between the current dataset and a baseline dataset. A typical use case is to detect data drift between the recent production serving dataset and the training dataset, or to compare the recent production dataset with a dataset from a previous period. # Prediction output distribution drift monitoring spec.
"categoricalMetricType": "A String", # Supported metrics type: * l_infinity * jensen_shannon_divergence
"defaultCategoricalAlertCondition": { # Monitoring alert triggered condition. # Default alert condition for all the categorical features.
"threshold": 3.14, # A condition that compares a stats value against a threshold. Alert will be triggered if value above the threshold.
},
"defaultNumericAlertCondition": { # Monitoring alert triggered condition. # Default alert condition for all the numeric features.
"threshold": 3.14, # A condition that compares a stats value against a threshold. Alert will be triggered if value above the threshold.
},
"featureAlertConditions": { # Per feature alert condition will override default alert condition.
"a_key": { # Monitoring alert triggered condition.
"threshold": 3.14, # A condition that compares a stats value against a threshold. Alert will be triggered if value above the threshold.
},
},
"features": [ # Feature names / Prediction output names interested in monitoring. These should be a subset of the input feature names or prediction output names specified in the monitoring schema. If the field is not specified all features / prediction outputs outlied in the monitoring schema will be used.
"A String",
],
"numericMetricType": "A String", # Supported metrics type: * jensen_shannon_divergence
},
},
"targetDataset": { # Model monitoring data input spec. # Target dataset.
"batchPredictionOutput": { # Data from Vertex AI Batch prediction job output. # Vertex AI Batch prediction Job.
"batchPredictionJob": "A String", # Vertex AI Batch prediction job resource name. The job must match the model version specified in [ModelMonitor].[model_monitoring_target].
},
"columnizedDataset": { # Input dataset spec. # Columnized dataset.
"bigquerySource": { # Dataset spec for data sotred in BigQuery. # BigQuery data source.
"query": "A String", # Standard SQL to be used instead of the `table_uri`.
"tableUri": "A String", # BigQuery URI to a table, up to 2000 characters long. All the columns in the table will be selected. Accepted forms: * BigQuery path. For example: `bq://projectId.bqDatasetId.bqTableId`.
},
"gcsSource": { # Dataset spec for data stored in Google Cloud Storage. # Google Cloud Storage data source.
"format": "A String", # Data format of the dataset.
"gcsUri": "A String", # Google Cloud Storage URI to the input file(s). May contain wildcards. For more information on wildcards, see https://cloud.google.com/storage/docs/gsutil/addlhelp/WildcardNames.
},
"timestampField": "A String", # The timestamp field. Usually for serving data.
"vertexDataset": "A String", # Resource name of the Vertex AI managed dataset.
},
"timeInterval": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # The time interval (pair of start_time and end_time) for which results should be returned.
"endTime": "A String", # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
"startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
},
"timeOffset": { # Time offset setting. # The time offset setting for which results should be returned.
"offset": "A String", # [offset] is the time difference from the cut-off time. For scheduled jobs, the cut-off time is the scheduled time. For non-scheduled jobs, it's the time when the job was created. Currently we support the following format: 'w|W': Week, 'd|D': Day, 'h|H': Hour E.g. '1h' stands for 1 hour, '2d' stands for 2 days.
"window": "A String", # [window] refers to the scope of data selected for analysis. It allows you to specify the quantity of data you wish to examine. Currently we support the following format: 'w|W': Week, 'd|D': Day, 'h|H': Hour E.g. '1h' stands for 1 hour, '2d' stands for 2 days.
},
"vertexEndpointLogs": { # Data from Vertex AI Endpoint request response logging. # Vertex AI Endpoint request & response logging.
"endpoints": [ # List of endpoint resource names. The endpoints must enable the logging with the [Endpoint].[request_response_logging_config], and must contain the deployed model corresponding to the model version specified in [ModelMonitor].[model_monitoring_target].
"A String",
],
},
},
},
"outputSpec": { # Specification for the export destination of monitoring results, including metrics, logs, etc. # The Output destination spec for metrics, error logs, etc.
"gcsBaseDirectory": { # The Google Cloud Storage location where the output is to be written to. # Google Cloud Storage base folder path for metrics, error logs, etc.
"outputUriPrefix": "A String", # Required. Google Cloud Storage URI to output directory. If the uri doesn't end with '/', a '/' will be automatically appended. The directory is created if it doesn't exist.
},
},
},
"name": "A String", # Output only. Resource name of a ModelMonitoringJob. Format: `projects/{project_id}/locations/{location_id}/modelMonitors/{model_monitor_id}/modelMonitoringJobs/{model_monitoring_job_id}`
"schedule": "A String", # Output only. Schedule resource name. It will only appear when this job is triggered by a schedule.
"scheduleTime": "A String", # Output only. Timestamp when this ModelMonitoringJob was scheduled. It will only appear when this job is triggered by a schedule.
"state": "A String", # Output only. The state of the monitoring job. * When the job is still creating, the state will be 'JOB_STATE_PENDING'. * Once the job is successfully created, the state will be 'JOB_STATE_RUNNING'. * Once the job is finished, the state will be one of 'JOB_STATE_FAILED', 'JOB_STATE_SUCCEEDED', 'JOB_STATE_PARTIALLY_SUCCEEDED'.
"updateTime": "A String", # Output only. Timestamp when this ModelMonitoringJob was updated most recently.
},
"modelMonitoringJobId": "A String", # Optional. The ID to use for the Model Monitoring Job, which will become the final component of the model monitoring job resource name. The maximum length is 63 characters, and valid characters are `/^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$/`.
"parent": "A String", # Required. The parent of the ModelMonitoringJob. Format: `projects/{project}/locations/{location}/modelMoniitors/{model_monitor}`
},
"createNotebookExecutionJobRequest": { # Request message for [NotebookService.CreateNotebookExecutionJob] # Request for NotebookService.CreateNotebookExecutionJob.
"notebookExecutionJob": { # NotebookExecutionJob represents an instance of a notebook execution. # Required. The NotebookExecutionJob to create.
"createTime": "A String", # Output only. Timestamp when this NotebookExecutionJob was created.
"customEnvironmentSpec": { # Compute configuration to use for an execution job. # The custom compute configuration for an execution job.
"machineSpec": { # Specification of a single machine. # The specification of a single machine for the execution job.
"acceleratorCount": 42, # The number of accelerators to attach to the machine.
"acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count.
"machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required.
"reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation.
"key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value.
"reservationAffinityType": "A String", # Required. Specifies the reservation affinity type.
"values": [ # Optional. Corresponds to the label values of a reservation resource. This must be the full resource name of the reservation.
"A String",
],
},
"tpuTopology": "A String", # Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1").
},
"networkSpec": { # Network spec. # The network configuration to use for the execution job.
"enableInternetAccess": True or False, # Whether to enable public internet access. Default false.
"network": "A String", # The full name of the Google Compute Engine [network](https://cloud.google.com//compute/docs/networks-and-firewalls#networks)
"subnetwork": "A String", # The name of the subnet that this instance is in. Format: `projects/{project_id_or_number}/regions/{region}/subnetworks/{subnetwork_id}`
},
"persistentDiskSpec": { # Represents the spec of persistent disk options. # The specification of a persistent disk to attach for the execution job.
"diskSizeGb": "A String", # Size in GB of the disk (default is 100GB).
"diskType": "A String", # Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) "pd-extreme" (Extreme Persistent Disk)
},
},
"dataformRepositorySource": { # The Dataform Repository containing the input notebook. # The Dataform Repository pointing to a single file notebook repository.
"commitSha": "A String", # The commit SHA to read repository with. If unset, the file will be read at HEAD.
"dataformRepositoryResourceName": "A String", # The resource name of the Dataform Repository. Format: `projects/{project_id}/locations/{location}/repositories/{repository_id}`
},
"directNotebookSource": { # The content of the input notebook in ipynb format. # The contents of an input notebook file.
"content": "A String", # The base64-encoded contents of the input notebook file.
},
"displayName": "A String", # The display name of the NotebookExecutionJob. The name can be up to 128 characters long and can consist of any UTF-8 characters.
"encryptionSpec": { # Represents a customer-managed encryption key spec that can be applied to a top-level resource. # Customer-managed encryption key spec for the notebook execution job. This field is auto-populated if the NotebookService.NotebookRuntimeTemplate has an encryption spec.
"kmsKeyName": "A String", # Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. The key needs to be in the same region as where the compute resource is created.
},
"executionTimeout": "A String", # Max running time of the execution job in seconds (default 86400s / 24 hrs).
"executionUser": "A String", # The user email to run the execution as. Only supported by Colab runtimes.
"gcsNotebookSource": { # The Cloud Storage uri for the input notebook. # The Cloud Storage url pointing to the ipynb file. Format: `gs://bucket/notebook_file.ipynb`
"generation": "A String", # The version of the Cloud Storage object to read. If unset, the current version of the object is read. See https://cloud.google.com/storage/docs/metadata#generation-number.
"uri": "A String", # The Cloud Storage uri pointing to the ipynb file. Format: `gs://bucket/notebook_file.ipynb`
},
"gcsOutputUri": "A String", # The Cloud Storage location to upload the result to. Format: `gs://bucket-name`
"jobState": "A String", # Output only. The state of the NotebookExecutionJob.
"labels": { # The labels with user-defined metadata to organize NotebookExecutionJobs. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.
"a_key": "A String",
},
"name": "A String", # Output only. The resource name of this NotebookExecutionJob. Format: `projects/{project_id}/locations/{location}/notebookExecutionJobs/{job_id}`
"notebookRuntimeTemplateResourceName": "A String", # The NotebookRuntimeTemplate to source compute configuration from.
"scheduleResourceName": "A String", # Output only. The Schedule resource name if this job is triggered by one. Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}`
"serviceAccount": "A String", # The service account to run the execution as.
"status": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Populated when the NotebookExecutionJob is completed. When there is an error during notebook execution, the error details are populated.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"updateTime": "A String", # Output only. Timestamp when this NotebookExecutionJob was most recently updated.
},
"notebookExecutionJobId": "A String", # Optional. User specified ID for the NotebookExecutionJob.
"parent": "A String", # Required. The resource name of the Location to create the NotebookExecutionJob. Format: `projects/{project}/locations/{location}`
},
"createPipelineJobRequest": { # Request message for PipelineService.CreatePipelineJob. # Request for PipelineService.CreatePipelineJob. CreatePipelineJobRequest.parent field is required (format: projects/{project}/locations/{location}).
"parent": "A String", # Required. The resource name of the Location to create the PipelineJob in. Format: `projects/{project}/locations/{location}`
"pipelineJob": { # An instance of a machine learning PipelineJob. # Required. The PipelineJob to create.
"createTime": "A String", # Output only. Pipeline creation time.
"displayName": "A String", # The display name of the Pipeline. The name can be up to 128 characters long and can consist of any UTF-8 characters.
"encryptionSpec": { # Represents a customer-managed encryption key spec that can be applied to a top-level resource. # Customer-managed encryption key spec for a pipelineJob. If set, this PipelineJob and all of its sub-resources will be secured by this key.
"kmsKeyName": "A String", # Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. The key needs to be in the same region as where the compute resource is created.
},
"endTime": "A String", # Output only. Pipeline end time.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. The error that occurred during pipeline execution. Only populated when the pipeline's state is FAILED or CANCELLED.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"jobDetail": { # The runtime detail of PipelineJob. # Output only. The details of pipeline run. Not available in the list view.
"pipelineContext": { # Instance of a general context. # Output only. The context of the pipeline.
"createTime": "A String", # Output only. Timestamp when this Context was created.
"description": "A String", # Description of the Context
"displayName": "A String", # User provided display name of the Context. May be up to 128 Unicode characters.
"etag": "A String", # An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
"labels": { # The labels with user-defined metadata to organize your Contexts. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Context (System labels are excluded).
"a_key": "A String",
},
"metadata": { # Properties of the Context. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB.
"a_key": "", # Properties of the object.
},
"name": "A String", # Immutable. The resource name of the Context.
"parentContexts": [ # Output only. A list of resource names of Contexts that are parents of this Context. A Context may have at most 10 parent_contexts.
"A String",
],
"schemaTitle": "A String", # The title of the schema describing the metadata. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"schemaVersion": "A String", # The version of the schema in schema_name to use. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"updateTime": "A String", # Output only. Timestamp when this Context was last updated.
},
"pipelineRunContext": { # Instance of a general context. # Output only. The context of the current pipeline run.
"createTime": "A String", # Output only. Timestamp when this Context was created.
"description": "A String", # Description of the Context
"displayName": "A String", # User provided display name of the Context. May be up to 128 Unicode characters.
"etag": "A String", # An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
"labels": { # The labels with user-defined metadata to organize your Contexts. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Context (System labels are excluded).
"a_key": "A String",
},
"metadata": { # Properties of the Context. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB.
"a_key": "", # Properties of the object.
},
"name": "A String", # Immutable. The resource name of the Context.
"parentContexts": [ # Output only. A list of resource names of Contexts that are parents of this Context. A Context may have at most 10 parent_contexts.
"A String",
],
"schemaTitle": "A String", # The title of the schema describing the metadata. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"schemaVersion": "A String", # The version of the schema in schema_name to use. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"updateTime": "A String", # Output only. Timestamp when this Context was last updated.
},
"taskDetails": [ # Output only. The runtime details of the tasks under the pipeline.
{ # The runtime detail of a task execution.
"createTime": "A String", # Output only. Task create time.
"endTime": "A String", # Output only. Task end time.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. The error that occurred during task execution. Only populated when the task's state is FAILED or CANCELLED.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"execution": { # Instance of a general execution. # Output only. The execution metadata of the task.
"createTime": "A String", # Output only. Timestamp when this Execution was created.
"description": "A String", # Description of the Execution
"displayName": "A String", # User provided display name of the Execution. May be up to 128 Unicode characters.
"etag": "A String", # An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
"labels": { # The labels with user-defined metadata to organize your Executions. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Execution (System labels are excluded).
"a_key": "A String",
},
"metadata": { # Properties of the Execution. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB.
"a_key": "", # Properties of the object.
},
"name": "A String", # Output only. The resource name of the Execution.
"schemaTitle": "A String", # The title of the schema describing the metadata. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"schemaVersion": "A String", # The version of the schema in `schema_title` to use. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"state": "A String", # The state of this Execution. This is a property of the Execution, and does not imply or capture any ongoing process. This property is managed by clients (such as Vertex AI Pipelines) and the system does not prescribe or check the validity of state transitions.
"updateTime": "A String", # Output only. Timestamp when this Execution was last updated.
},
"executorDetail": { # The runtime detail of a pipeline executor. # Output only. The detailed execution info.
"containerDetail": { # The detail of a container execution. It contains the job names of the lifecycle of a container execution. # Output only. The detailed info for a container executor.
"failedMainJobs": [ # Output only. The names of the previously failed CustomJob for the main container executions. The list includes the all attempts in chronological order.
"A String",
],
"failedPreCachingCheckJobs": [ # Output only. The names of the previously failed CustomJob for the pre-caching-check container executions. This job will be available if the PipelineJob.pipeline_spec specifies the `pre_caching_check` hook in the lifecycle events. The list includes the all attempts in chronological order.
"A String",
],
"mainJob": "A String", # Output only. The name of the CustomJob for the main container execution.
"preCachingCheckJob": "A String", # Output only. The name of the CustomJob for the pre-caching-check container execution. This job will be available if the PipelineJob.pipeline_spec specifies the `pre_caching_check` hook in the lifecycle events.
},
"customJobDetail": { # The detailed info for a custom job executor. # Output only. The detailed info for a custom job executor.
"failedJobs": [ # Output only. The names of the previously failed CustomJob. The list includes the all attempts in chronological order.
"A String",
],
"job": "A String", # Output only. The name of the CustomJob.
},
},
"inputs": { # Output only. The runtime input artifacts of the task.
"a_key": { # A list of artifact metadata.
"artifacts": [ # Output only. A list of artifact metadata.
{ # Instance of a general artifact.
"createTime": "A String", # Output only. Timestamp when this Artifact was created.
"description": "A String", # Description of the Artifact
"displayName": "A String", # User provided display name of the Artifact. May be up to 128 Unicode characters.
"etag": "A String", # An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
"labels": { # The labels with user-defined metadata to organize your Artifacts. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Artifact (System labels are excluded).
"a_key": "A String",
},
"metadata": { # Properties of the Artifact. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB.
"a_key": "", # Properties of the object.
},
"name": "A String", # Output only. The resource name of the Artifact.
"schemaTitle": "A String", # The title of the schema describing the metadata. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"schemaVersion": "A String", # The version of the schema in schema_name to use. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"state": "A String", # The state of this Artifact. This is a property of the Artifact, and does not imply or capture any ongoing process. This property is managed by clients (such as Vertex AI Pipelines), and the system does not prescribe or check the validity of state transitions.
"updateTime": "A String", # Output only. Timestamp when this Artifact was last updated.
"uri": "A String", # The uniform resource identifier of the artifact file. May be empty if there is no actual artifact file.
},
],
},
},
"outputs": { # Output only. The runtime output artifacts of the task.
"a_key": { # A list of artifact metadata.
"artifacts": [ # Output only. A list of artifact metadata.
{ # Instance of a general artifact.
"createTime": "A String", # Output only. Timestamp when this Artifact was created.
"description": "A String", # Description of the Artifact
"displayName": "A String", # User provided display name of the Artifact. May be up to 128 Unicode characters.
"etag": "A String", # An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
"labels": { # The labels with user-defined metadata to organize your Artifacts. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Artifact (System labels are excluded).
"a_key": "A String",
},
"metadata": { # Properties of the Artifact. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB.
"a_key": "", # Properties of the object.
},
"name": "A String", # Output only. The resource name of the Artifact.
"schemaTitle": "A String", # The title of the schema describing the metadata. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"schemaVersion": "A String", # The version of the schema in schema_name to use. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"state": "A String", # The state of this Artifact. This is a property of the Artifact, and does not imply or capture any ongoing process. This property is managed by clients (such as Vertex AI Pipelines), and the system does not prescribe or check the validity of state transitions.
"updateTime": "A String", # Output only. Timestamp when this Artifact was last updated.
"uri": "A String", # The uniform resource identifier of the artifact file. May be empty if there is no actual artifact file.
},
],
},
},
"parentTaskId": "A String", # Output only. The id of the parent task if the task is within a component scope. Empty if the task is at the root level.
"pipelineTaskStatus": [ # Output only. A list of task status. This field keeps a record of task status evolving over time.
{ # A single record of the task status.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # 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.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"state": "A String", # Output only. The state of the task.
"updateTime": "A String", # Output only. Update time of this status.
},
],
"startTime": "A String", # Output only. Task start time.
"state": "A String", # Output only. State of the task.
"taskId": "A String", # Output only. The system generated ID of the task.
"taskName": "A String", # Output only. The user specified name of the task that is defined in pipeline_spec.
},
],
},
"labels": { # The labels with user-defined metadata to organize PipelineJob. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. Note there is some reserved label key for Vertex AI Pipelines. - `vertex-ai-pipelines-run-billing-id`, user set value will get overrided.
"a_key": "A String",
},
"name": "A String", # Output only. The resource name of the PipelineJob.
"network": "A String", # The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the Pipeline Job's workload should be peered. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. Private services access must already be configured for the network. Pipeline job will apply the network configuration to the Google Cloud resources being launched, if applied, such as Vertex AI Training or Dataflow job. If left unspecified, the workload is not peered with any network.
"originalPipelineJobId": "A String", # Optional. The original pipeline job id if this pipeline job is a rerun of a previous pipeline job.
"pipelineSpec": { # The spec of the pipeline.
"a_key": "", # Properties of the object.
},
"pipelineTaskRerunConfigs": [ # Optional. The rerun configs for each task in the pipeline job. By default, the rerun will: 1. Use the same input artifacts as the original run. 2. Use the same input parameters as the original run. 3. Skip all the tasks that are already succeeded in the original run. 4. Rerun all the tasks that are not succeeded in the original run. By providing this field, users can override the default behavior and specify the rerun config for each task.
{ # User provided rerun config to submit a rerun pipelinejob. This includes 1. Which task to rerun 2. User override input parameters and artifacts.
"inputs": { # Runtime inputs data of the task. # Optional. The runtime input of the task overridden by the user.
"artifacts": { # Optional. Input artifacts.
"a_key": { # A list of artifact metadata.
"artifacts": [ # Optional. A list of artifact metadata.
{ # The definition of a runtime artifact.
"customProperties": { # The custom properties of the artifact. Deprecated. Use RuntimeArtifact.metadata instead.
"a_key": { # Value is the value of the field.
"doubleValue": 3.14, # A double value.
"intValue": "A String", # An integer value.
"stringValue": "A String", # A string value.
},
},
"metadata": { # Properties of the Artifact.
"a_key": "", # Properties of the object.
},
"name": "A String", # The name of an artifact.
"properties": { # The properties of the artifact. Deprecated. Use RuntimeArtifact.metadata instead.
"a_key": { # Value is the value of the field.
"doubleValue": 3.14, # A double value.
"intValue": "A String", # An integer value.
"stringValue": "A String", # A string value.
},
},
"type": { # The definition of a artifact type in MLMD. # The type of the artifact.
"instanceSchema": "A String", # Contains a raw YAML string, describing the format of the properties of the type.
"schemaTitle": "A String", # The name of the type. The format of the title must be: `.`. Examples: - `aiplatform.Model` - `acme.CustomModel` When this field is set, the type must be pre-registered in the MLMD store.
"schemaUri": "A String", # Points to a YAML file stored on Cloud Storage describing the format. Deprecated. Use PipelineArtifactTypeSchema.schema_title or PipelineArtifactTypeSchema.instance_schema instead.
"schemaVersion": "A String", # The schema version of the artifact. If the value is not set, it defaults to the latest version in the system.
},
"uri": "A String", # The URI of the artifact.
},
],
},
},
"parameterValues": { # Optional. Input parameters.
"a_key": "",
},
},
"skipDownstreamTasks": True or False, # Optional. Whether to skip downstream tasks. Default value is False.
"skipTask": True or False, # Optional. Whether to skip this task. Default value is False.
"taskId": "A String", # Optional. The system generated ID of the task. Retrieved from original run.
"taskName": "A String", # Optional. The name of the task.
},
],
"preflightValidations": True or False, # Optional. Whether to do component level validations before job creation.
"pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I for PipelineJob.
"networkAttachment": "A String", # Optional. The name of the Compute Engine [network attachment](https://cloud.google.com/vpc/docs/about-network-attachments) to attach to the resource within the region and user project. To specify this field, you must have already [created a network attachment] (https://cloud.google.com/vpc/docs/create-manage-network-attachments#create-network-attachments). This field is only used for resources using PSC-I.
},
"reservedIpRanges": [ # A list of names for the reserved ip ranges under the VPC network that can be used for this Pipeline Job's workload. If set, we will deploy the Pipeline Job's workload within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network. Example: ['vertex-ai-ip-range'].
"A String",
],
"runtimeConfig": { # The runtime config of a PipelineJob. # Runtime config of the pipeline.
"defaultRuntime": { # The default runtime for the PipelineJob. # Optional. The default runtime for the PipelineJob. If not provided, Vertex Custom Job(on demand) is used as the runtime. For Vertex Custom Job, please refer to https://cloud.google.com/vertex-ai/docs/training/overview.
"persistentResourceRuntimeDetail": { # Persistent resource based runtime detail. For more information, refer to https://cloud.google.com/vertex-ai/docs/training/persistent-resource-overview # Persistent resource based runtime detail.
"persistentResourceName": "A String", # Persistent resource name. Format: `projects/{project}/locations/{location}/persistentResources/{persistent_resource}`
"taskResourceUnavailableTimeoutBehavior": "A String", # Specifies the behavior to take if the timeout is reached.
"taskResourceUnavailableWaitTimeMs": "A String", # The max time a pipeline task waits for the required CPU, memory, or accelerator resource to become available from the specified persistent resource. Default wait time is 0.
},
},
"failurePolicy": "A String", # Represents the failure policy of a pipeline. Currently, the default of a pipeline is that the pipeline will continue to run until no more tasks can be executed, also known as PIPELINE_FAILURE_POLICY_FAIL_SLOW. However, if a pipeline is set to PIPELINE_FAILURE_POLICY_FAIL_FAST, it will stop scheduling any new tasks when a task has failed. Any scheduled tasks will continue to completion.
"gcsOutputDirectory": "A String", # Required. A path in a Cloud Storage bucket, which will be treated as the root output directory of the pipeline. It is used by the system to generate the paths of output artifacts. The artifact paths are generated with a sub-path pattern `{job_id}/{task_id}/{output_key}` under the specified output directory. The service account specified in this pipeline must have the `storage.objects.get` and `storage.objects.create` permissions for this bucket.
"inputArtifacts": { # The runtime artifacts of the PipelineJob. The key will be the input artifact name and the value would be one of the InputArtifact.
"a_key": { # The type of an input artifact.
"artifactId": "A String", # Artifact resource id from MLMD. Which is the last portion of an artifact resource name: `projects/{project}/locations/{location}/metadataStores/default/artifacts/{artifact_id}`. The artifact must stay within the same project, location and default metadatastore as the pipeline.
},
},
"parameterValues": { # The runtime parameters of the PipelineJob. The parameters will be passed into PipelineJob.pipeline_spec to replace the placeholders at runtime. This field is used by pipelines built using `PipelineJob.pipeline_spec.schema_version` 2.1.0, such as pipelines built using Kubeflow Pipelines SDK 1.9 or higher and the v2 DSL.
"a_key": "",
},
"parameters": { # Deprecated. Use RuntimeConfig.parameter_values instead. The runtime parameters of the PipelineJob. The parameters will be passed into PipelineJob.pipeline_spec to replace the placeholders at runtime. This field is used by pipelines built using `PipelineJob.pipeline_spec.schema_version` 2.0.0 or lower, such as pipelines built using Kubeflow Pipelines SDK 1.8 or lower.
"a_key": { # Value is the value of the field.
"doubleValue": 3.14, # A double value.
"intValue": "A String", # An integer value.
"stringValue": "A String", # A string value.
},
},
},
"satisfiesPzi": True or False, # Output only. Reserved for future use.
"satisfiesPzs": True or False, # Output only. Reserved for future use.
"scheduleName": "A String", # Output only. The schedule resource name. Only returned if the Pipeline is created by Schedule API.
"serviceAccount": "A String", # The service account that the pipeline workload runs as. If not specified, the Compute Engine default service account in the project will be used. See https://cloud.google.com/compute/docs/access/service-accounts#default_service_account Users starting the pipeline must have the `iam.serviceAccounts.actAs` permission on this service account.
"startTime": "A String", # Output only. Pipeline start time.
"state": "A String", # Output only. The detailed state of the job.
"templateMetadata": { # Pipeline template metadata if PipelineJob.template_uri is from supported template registry. Currently, the only supported registry is Artifact Registry. # Output only. Pipeline template metadata. Will fill up fields if PipelineJob.template_uri is from supported template registry.
"version": "A String", # The version_name in artifact registry. Will always be presented in output if the PipelineJob.template_uri is from supported template registry. Format is "sha256:abcdef123456...".
},
"templateUri": "A String", # A template uri from where the PipelineJob.pipeline_spec, if empty, will be downloaded. Currently, only uri from Vertex Template Registry & Gallery is supported. Reference to https://cloud.google.com/vertex-ai/docs/pipelines/create-pipeline-template.
"updateTime": "A String", # Output only. Timestamp when this PipelineJob was most recently updated.
},
"pipelineJobId": "A String", # The ID to use for the PipelineJob, which will become the final component of the PipelineJob name. If not provided, an ID will be automatically generated. This value should be less than 128 characters, and valid characters are `/a-z-/`.
},
"createTime": "A String", # Output only. Timestamp when this Schedule was created.
"cron": "A String", # Cron schedule (https://en.wikipedia.org/wiki/Cron) to launch scheduled runs. To explicitly set a timezone to the cron tab, apply a prefix in the cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or "TZ=${IANA_TIME_ZONE}". The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone database. For example, "CRON_TZ=America/New_York 1 * * * *", or "TZ=America/New_York 1 * * * *".
"displayName": "A String", # Required. User provided name of the Schedule. The name can be up to 128 characters long and can consist of any UTF-8 characters.
"endTime": "A String", # Optional. Timestamp after which no new runs can be scheduled. If specified, The schedule will be completed when either end_time is reached or when scheduled_run_count >= max_run_count. If not specified, new runs will keep getting scheduled until this Schedule is paused or deleted. Already scheduled runs will be allowed to complete. Unset if not specified.
"lastPauseTime": "A String", # Output only. Timestamp when this Schedule was last paused. Unset if never paused.
"lastResumeTime": "A String", # Output only. Timestamp when this Schedule was last resumed. Unset if never resumed from pause.
"lastScheduledRunResponse": { # Status of a scheduled run. # Output only. Response of the last scheduled run. This is the response for starting the scheduled requests and not the execution of the operations/jobs created by the requests (if applicable). Unset if no run has been scheduled yet.
"runResponse": "A String", # The response of the scheduled run.
"scheduledRunTime": "A String", # The scheduled run time based on the user-specified schedule.
},
"maxConcurrentRunCount": "A String", # Required. Maximum number of runs that can be started concurrently for this Schedule. This is the limit for starting the scheduled requests and not the execution of the operations/jobs created by the requests (if applicable).
"maxRunCount": "A String", # Optional. Maximum run count of the schedule. If specified, The schedule will be completed when either started_run_count >= max_run_count or when end_time is reached. If not specified, new runs will keep getting scheduled until this Schedule is paused or deleted. Already scheduled runs will be allowed to complete. Unset if not specified.
"name": "A String", # Immutable. The resource name of the Schedule.
"nextRunTime": "A String", # Output only. Timestamp when this Schedule should schedule the next run. Having a next_run_time in the past means the runs are being started behind schedule.
"startTime": "A String", # Optional. Timestamp after which the first run can be scheduled. Default to Schedule create time if not specified.
"startedRunCount": "A String", # Output only. The number of runs started by this schedule.
"state": "A String", # Output only. The state of this Schedule.
"updateTime": "A String", # Output only. Timestamp when this Schedule was updated.
},
],
}

list_next()

Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.

patch(name, body=None, updateMask=None, x__xgafv=None)

Updates an active or paused Schedule. When the Schedule is updated, new runs will be scheduled starting from the updated next execution time after the update time based on the time_specification in the updated Schedule. All unstarted runs before the update time will be skipped while already created runs will NOT be paused or canceled.

Args:
name: string, Immutable. The resource name of the Schedule. (required)
body: object, The request body.
The object takes the form of:

{ # An instance of a Schedule periodically schedules runs to make API calls based on user specified time specification and API request type.
"allowQueueing": True or False, # Optional. Whether new scheduled runs can be queued when max_concurrent_runs limit is reached. If set to true, new runs will be queued instead of skipped. Default to false.
"catchUp": True or False, # Output only. Whether to backfill missed runs when the schedule is resumed from PAUSED state. If set to true, all missed runs will be scheduled. New runs will be scheduled after the backfill is complete. Default to false.
"createModelMonitoringJobRequest": { # Request message for ModelMonitoringService.CreateModelMonitoringJob. # Request for ModelMonitoringService.CreateModelMonitoringJob.
"modelMonitoringJob": { # Represents a model monitoring job that analyze dataset using different monitoring algorithm. # Required. The ModelMonitoringJob to create
"createTime": "A String", # Output only. Timestamp when this ModelMonitoringJob was created.
"displayName": "A String", # The display name of the ModelMonitoringJob. The name can be up to 128 characters long and can consist of any UTF-8.
"jobExecutionDetail": { # Represent the execution details of the job. # Output only. Execution results for all the monitoring objectives.
"baselineDatasets": [ # Processed baseline datasets.
{ # Processed dataset information.
"location": "A String", # Actual data location of the processed dataset.
"timeRange": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Dataset time range information if any.
"endTime": "A String", # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
"startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
},
},
],
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Additional job error status.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"objectiveStatus": { # Status of data processing for each monitoring objective. Key is the objective.
"a_key": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
},
"targetDatasets": [ # Processed target datasets.
{ # Processed dataset information.
"location": "A String", # Actual data location of the processed dataset.
"timeRange": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Dataset time range information if any.
"endTime": "A String", # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
"startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
},
},
],
},
"modelMonitoringSpec": { # Monitoring monitoring job spec. It outlines the specifications for monitoring objectives, notifications, and result exports. # Monitoring monitoring job spec. It outlines the specifications for monitoring objectives, notifications, and result exports. If left blank, the default monitoring specifications from the top-level resource 'ModelMonitor' will be applied. If provided, we will use the specification defined here rather than the default one.
"notificationSpec": { # Notification spec(email, notification channel) for model monitoring statistics/alerts. # The model monitoring notification spec.
"emailConfig": { # The config for email alerts. # Email alert config.
"userEmails": [ # The email addresses to send the alerts.
"A String",
],
},
"enableCloudLogging": True or False, # Dump the anomalies to Cloud Logging. The anomalies will be put to json payload encoded from proto google.cloud.aiplatform.logging.ModelMonitoringAnomaliesLogEntry. This can be further sinked to Pub/Sub or any other services supported by Cloud Logging.
"notificationChannelConfigs": [ # Notification channel config.
{ # Google Cloud Notification Channel config.
"notificationChannel": "A String", # Resource names of the NotificationChannels. Must be of the format `projects//notificationChannels/`
},
],
},
"objectiveSpec": { # Monitoring objectives spec. # The monitoring objective spec.
"baselineDataset": { # Model monitoring data input spec. # Baseline dataset. It could be the training dataset or production serving dataset from a previous period.
"batchPredictionOutput": { # Data from Vertex AI Batch prediction job output. # Vertex AI Batch prediction Job.
"batchPredictionJob": "A String", # Vertex AI Batch prediction job resource name. The job must match the model version specified in [ModelMonitor].[model_monitoring_target].
},
"columnizedDataset": { # Input dataset spec. # Columnized dataset.
"bigquerySource": { # Dataset spec for data sotred in BigQuery. # BigQuery data source.
"query": "A String", # Standard SQL to be used instead of the `table_uri`.
"tableUri": "A String", # BigQuery URI to a table, up to 2000 characters long. All the columns in the table will be selected. Accepted forms: * BigQuery path. For example: `bq://projectId.bqDatasetId.bqTableId`.
},
"gcsSource": { # Dataset spec for data stored in Google Cloud Storage. # Google Cloud Storage data source.
"format": "A String", # Data format of the dataset.
"gcsUri": "A String", # Google Cloud Storage URI to the input file(s). May contain wildcards. For more information on wildcards, see https://cloud.google.com/storage/docs/gsutil/addlhelp/WildcardNames.
},
"timestampField": "A String", # The timestamp field. Usually for serving data.
"vertexDataset": "A String", # Resource name of the Vertex AI managed dataset.
},
"timeInterval": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # The time interval (pair of start_time and end_time) for which results should be returned.
"endTime": "A String", # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
"startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
},
"timeOffset": { # Time offset setting. # The time offset setting for which results should be returned.
"offset": "A String", # [offset] is the time difference from the cut-off time. For scheduled jobs, the cut-off time is the scheduled time. For non-scheduled jobs, it's the time when the job was created. Currently we support the following format: 'w|W': Week, 'd|D': Day, 'h|H': Hour E.g. '1h' stands for 1 hour, '2d' stands for 2 days.
"window": "A String", # [window] refers to the scope of data selected for analysis. It allows you to specify the quantity of data you wish to examine. Currently we support the following format: 'w|W': Week, 'd|D': Day, 'h|H': Hour E.g. '1h' stands for 1 hour, '2d' stands for 2 days.
},
"vertexEndpointLogs": { # Data from Vertex AI Endpoint request response logging. # Vertex AI Endpoint request & response logging.
"endpoints": [ # List of endpoint resource names. The endpoints must enable the logging with the [Endpoint].[request_response_logging_config], and must contain the deployed model corresponding to the model version specified in [ModelMonitor].[model_monitoring_target].
"A String",
],
},
},
"explanationSpec": { # Specification of Model explanation. # The explanation spec. This spec is required when the objectives spec includes feature attribution objectives.
"metadata": { # Metadata describing the Model's input and output for explanation. # Optional. Metadata describing the Model's input and output for explanation.
"featureAttributionsSchemaUri": "A String", # Points to a YAML file stored on Google Cloud Storage describing the format of the feature attributions. The schema is defined as an OpenAPI 3.0.2 [Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). AutoML tabular Models always have this field populated by Vertex AI. Note: The URI given on output may be different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.
"inputs": { # Required. Map from feature names to feature input metadata. Keys are the name of the features. Values are the specification of the feature. An empty InputMetadata is valid. It describes a text feature which has the name specified as the key in ExplanationMetadata.inputs. The baseline of the empty feature is chosen by Vertex AI. For Vertex AI-provided Tensorflow images, the key can be any friendly name of the feature. Once specified, featureAttributions are keyed by this key (if not grouped with another feature). For custom images, the key must match with the key in instance.
"a_key": { # Metadata of the input of a feature. Fields other than InputMetadata.input_baselines are applicable only for Models that are using Vertex AI-provided images for Tensorflow.
"denseShapeTensorName": "A String", # Specifies the shape of the values of the input if the input is a sparse representation. Refer to Tensorflow documentation for more details: https://www.tensorflow.org/api_docs/python/tf/sparse/SparseTensor.
"encodedBaselines": [ # A list of baselines for the encoded tensor. The shape of each baseline should match the shape of the encoded tensor. If a scalar is provided, Vertex AI broadcasts to the same shape as the encoded tensor.
"",
],
"encodedTensorName": "A String", # Encoded tensor is a transformation of the input tensor. Must be provided if choosing Integrated Gradients attribution or XRAI attribution and the input tensor is not differentiable. An encoded tensor is generated if the input tensor is encoded by a lookup table.
"encoding": "A String", # Defines how the feature is encoded into the input tensor. Defaults to IDENTITY.
"featureValueDomain": { # Domain details of the input feature value. Provides numeric information about the feature, such as its range (min, max). If the feature has been pre-processed, for example with z-scoring, then it provides information about how to recover the original feature. For example, if the input feature is an image and it has been pre-processed to obtain 0-mean and stddev = 1 values, then original_mean, and original_stddev refer to the mean and stddev of the original feature (e.g. image tensor) from which input feature (with mean = 0 and stddev = 1) was obtained. # The domain details of the input feature value. Like min/max, original mean or standard deviation if normalized.
"maxValue": 3.14, # The maximum permissible value for this feature.
"minValue": 3.14, # The minimum permissible value for this feature.
"originalMean": 3.14, # If this input feature has been normalized to a mean value of 0, the original_mean specifies the mean value of the domain prior to normalization.
"originalStddev": 3.14, # If this input feature has been normalized to a standard deviation of 1.0, the original_stddev specifies the standard deviation of the domain prior to normalization.
},
"groupName": "A String", # Name of the group that the input belongs to. Features with the same group name will be treated as one feature when computing attributions. Features grouped together can have different shapes in value. If provided, there will be one single attribution generated in Attribution.feature_attributions, keyed by the group name.
"indexFeatureMapping": [ # A list of feature names for each index in the input tensor. Required when the input InputMetadata.encoding is BAG_OF_FEATURES, BAG_OF_FEATURES_SPARSE, INDICATOR.
"A String",
],
"indicesTensorName": "A String", # Specifies the index of the values of the input tensor. Required when the input tensor is a sparse representation. Refer to Tensorflow documentation for more details: https://www.tensorflow.org/api_docs/python/tf/sparse/SparseTensor.
"inputBaselines": [ # Baseline inputs for this feature. If no baseline is specified, Vertex AI chooses the baseline for this feature. If multiple baselines are specified, Vertex AI returns the average attributions across them in Attribution.feature_attributions. For Vertex AI-provided Tensorflow images (both 1.x and 2.x), the shape of each baseline must match the shape of the input tensor. If a scalar is provided, we broadcast to the same shape as the input tensor. For custom images, the element of the baselines must be in the same format as the feature's input in the instance[]. The schema of any single instance may be specified via Endpoint's DeployedModels' Model's PredictSchemata's instance_schema_uri.
"",
],
"inputTensorName": "A String", # Name of the input tensor for this feature. Required and is only applicable to Vertex AI-provided images for Tensorflow.
"modality": "A String", # Modality of the feature. Valid values are: numeric, image. Defaults to numeric.
"visualization": { # Visualization configurations for image explanation. # Visualization configurations for image explanation.
"clipPercentLowerbound": 3.14, # Excludes attributions below the specified percentile, from the highlighted areas. Defaults to 62.
"clipPercentUpperbound": 3.14, # Excludes attributions above the specified percentile from the highlighted areas. Using the clip_percent_upperbound and clip_percent_lowerbound together can be useful for filtering out noise and making it easier to see areas of strong attribution. Defaults to 99.9.
"colorMap": "A String", # The color scheme used for the highlighted areas. Defaults to PINK_GREEN for Integrated Gradients attribution, which shows positive attributions in green and negative in pink. Defaults to VIRIDIS for XRAI attribution, which highlights the most influential regions in yellow and the least influential in blue.
"overlayType": "A String", # How the original image is displayed in the visualization. Adjusting the overlay can help increase visual clarity if the original image makes it difficult to view the visualization. Defaults to NONE.
"polarity": "A String", # Whether to only highlight pixels with positive contributions, negative or both. Defaults to POSITIVE.
"type": "A String", # Type of the image visualization. Only applicable to Integrated Gradients attribution. OUTLINES shows regions of attribution, while PIXELS shows per-pixel attribution. Defaults to OUTLINES.
},
},
},
"latentSpaceSource": "A String", # Name of the source to generate embeddings for example based explanations.
"outputs": { # Required. Map from output names to output metadata. For Vertex AI-provided Tensorflow images, keys can be any user defined string that consists of any UTF-8 characters. For custom images, keys are the name of the output field in the prediction to be explained. Currently only one key is allowed.
"a_key": { # Metadata of the prediction output to be explained.
"displayNameMappingKey": "A String", # Specify a field name in the prediction to look for the display name. Use this if the prediction contains the display names for the outputs. The display names in the prediction must have the same shape of the outputs, so that it can be located by Attribution.output_index for a specific output.
"indexDisplayNameMapping": "", # Static mapping between the index and display name. Use this if the outputs are a deterministic n-dimensional array, e.g. a list of scores of all the classes in a pre-defined order for a multi-classification Model. It's not feasible if the outputs are non-deterministic, e.g. the Model produces top-k classes or sort the outputs by their values. The shape of the value must be an n-dimensional array of strings. The number of dimensions must match that of the outputs to be explained. The Attribution.output_display_name is populated by locating in the mapping with Attribution.output_index.
"outputTensorName": "A String", # Name of the output tensor. Required and is only applicable to Vertex AI provided images for Tensorflow.
},
},
},
"parameters": { # Parameters to configure explaining for Model's predictions. # Required. Parameters that configure explaining of the Model's predictions.
"examples": { # Example-based explainability that returns the nearest neighbors from the provided dataset. # Example-based explanations that returns the nearest neighbors from the provided dataset.
"exampleGcsSource": { # The Cloud Storage input instances. # The Cloud Storage input instances.
"dataFormat": "A String", # The format in which instances are given, if not specified, assume it's JSONL format. Currently only JSONL format is supported.
"gcsSource": { # The Google Cloud Storage location for the input content. # The Cloud Storage location for the input instances.
"uris": [ # Required. Google Cloud Storage URI(-s) to the input file(s). May contain wildcards. For more information on wildcards, see https://cloud.google.com/storage/docs/gsutil/addlhelp/WildcardNames.
"A String",
],
},
},
"gcsSource": { # The Google Cloud Storage location for the input content. # The Cloud Storage locations that contain the instances to be indexed for approximate nearest neighbor search.
"uris": [ # Required. Google Cloud Storage URI(-s) to the input file(s). May contain wildcards. For more information on wildcards, see https://cloud.google.com/storage/docs/gsutil/addlhelp/WildcardNames.
"A String",
],
},
"nearestNeighborSearchConfig": "", # The full configuration for the generated index, the semantics are the same as metadata and should match [NearestNeighborSearchConfig](https://cloud.google.com/vertex-ai/docs/explainable-ai/configuring-explanations-example-based#nearest-neighbor-search-config).
"neighborCount": 42, # The number of neighbors to return when querying for examples.
"presets": { # Preset configuration for example-based explanations # Simplified preset configuration, which automatically sets configuration values based on the desired query speed-precision trade-off and modality.
"modality": "A String", # The modality of the uploaded model, which automatically configures the distance measurement and feature normalization for the underlying example index and queries. If your model does not precisely fit one of these types, it is okay to choose the closest type.
"query": "A String", # Preset option controlling parameters for speed-precision trade-off when querying for examples. If omitted, defaults to `PRECISE`.
},
},
"integratedGradientsAttribution": { # An attribution method that computes the Aumann-Shapley value taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1703.01365 # An attribution method that computes Aumann-Shapley values taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1703.01365
"blurBaselineConfig": { # Config for blur baseline. When enabled, a linear path from the maximally blurred image to the input image is created. Using a blurred baseline instead of zero (black image) is motivated by the BlurIG approach explained here: https://arxiv.org/abs/2004.03383 # Config for IG with blur baseline. When enabled, a linear path from the maximally blurred image to the input image is created. Using a blurred baseline instead of zero (black image) is motivated by the BlurIG approach explained here: https://arxiv.org/abs/2004.03383
"maxBlurSigma": 3.14, # The standard deviation of the blur kernel for the blurred baseline. The same blurring parameter is used for both the height and the width dimension. If not set, the method defaults to the zero (i.e. black for images) baseline.
},
"smoothGradConfig": { # Config for SmoothGrad approximation of gradients. When enabled, the gradients are approximated by averaging the gradients from noisy samples in the vicinity of the inputs. Adding noise can help improve the computed gradients. Refer to this paper for more details: https://arxiv.org/pdf/1706.03825.pdf # Config for SmoothGrad approximation of gradients. When enabled, the gradients are approximated by averaging the gradients from noisy samples in the vicinity of the inputs. Adding noise can help improve the computed gradients. Refer to this paper for more details: https://arxiv.org/pdf/1706.03825.pdf
"featureNoiseSigma": { # Noise sigma by features. Noise sigma represents the standard deviation of the gaussian kernel that will be used to add noise to interpolated inputs prior to computing gradients. # This is similar to noise_sigma, but provides additional flexibility. A separate noise sigma can be provided for each feature, which is useful if their distributions are different. No noise is added to features that are not set. If this field is unset, noise_sigma will be used for all features.
"noiseSigma": [ # Noise sigma per feature. No noise is added to features that are not set.
{ # Noise sigma for a single feature.
"name": "A String", # The name of the input feature for which noise sigma is provided. The features are defined in explanation metadata inputs.
"sigma": 3.14, # This represents the standard deviation of the Gaussian kernel that will be used to add noise to the feature prior to computing gradients. Similar to noise_sigma but represents the noise added to the current feature. Defaults to 0.1.
},
],
},
"noiseSigma": 3.14, # This is a single float value and will be used to add noise to all the features. Use this field when all features are normalized to have the same distribution: scale to range [0, 1], [-1, 1] or z-scoring, where features are normalized to have 0-mean and 1-variance. Learn more about [normalization](https://developers.google.com/machine-learning/data-prep/transform/normalization). For best results the recommended value is about 10% - 20% of the standard deviation of the input feature. Refer to section 3.2 of the SmoothGrad paper: https://arxiv.org/pdf/1706.03825.pdf. Defaults to 0.1. If the distribution is different per feature, set feature_noise_sigma instead for each feature.
"noisySampleCount": 42, # The number of gradient samples to use for approximation. The higher this number, the more accurate the gradient is, but the runtime complexity increases by this factor as well. Valid range of its value is [1, 50]. Defaults to 3.
},
"stepCount": 42, # Required. The number of steps for approximating the path integral. A good value to start is 50 and gradually increase until the sum to diff property is within the desired error range. Valid range of its value is [1, 100], inclusively.
},
"outputIndices": [ # If populated, only returns attributions that have output_index contained in output_indices. It must be an ndarray of integers, with the same shape of the output it's explaining. If not populated, returns attributions for top_k indices of outputs. If neither top_k nor output_indices is populated, returns the argmax index of the outputs. Only applicable to Models that predict multiple outputs (e,g, multi-class Models that predict multiple classes).
"",
],
"sampledShapleyAttribution": { # An attribution method that approximates Shapley values for features that contribute to the label being predicted. A sampling strategy is used to approximate the value rather than considering all subsets of features. # An attribution method that approximates Shapley values for features that contribute to the label being predicted. A sampling strategy is used to approximate the value rather than considering all subsets of features. Refer to this paper for model details: https://arxiv.org/abs/1306.4265.
"pathCount": 42, # Required. The number of feature permutations to consider when approximating the Shapley values. Valid range of its value is [1, 50], inclusively.
},
"topK": 42, # If populated, returns attributions for top K indices of outputs (defaults to 1). Only applies to Models that predicts more than one outputs (e,g, multi-class Models). When set to -1, returns explanations for all outputs.
"xraiAttribution": { # An explanation method that redistributes Integrated Gradients attributions to segmented regions, taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1906.02825 Supported only by image Models. # An attribution method that redistributes Integrated Gradients attribution to segmented regions, taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1906.02825 XRAI currently performs better on natural images, like a picture of a house or an animal. If the images are taken in artificial environments, like a lab or manufacturing line, or from diagnostic equipment, like x-rays or quality-control cameras, use Integrated Gradients instead.
"blurBaselineConfig": { # Config for blur baseline. When enabled, a linear path from the maximally blurred image to the input image is created. Using a blurred baseline instead of zero (black image) is motivated by the BlurIG approach explained here: https://arxiv.org/abs/2004.03383 # Config for XRAI with blur baseline. When enabled, a linear path from the maximally blurred image to the input image is created. Using a blurred baseline instead of zero (black image) is motivated by the BlurIG approach explained here: https://arxiv.org/abs/2004.03383
"maxBlurSigma": 3.14, # The standard deviation of the blur kernel for the blurred baseline. The same blurring parameter is used for both the height and the width dimension. If not set, the method defaults to the zero (i.e. black for images) baseline.
},
"smoothGradConfig": { # Config for SmoothGrad approximation of gradients. When enabled, the gradients are approximated by averaging the gradients from noisy samples in the vicinity of the inputs. Adding noise can help improve the computed gradients. Refer to this paper for more details: https://arxiv.org/pdf/1706.03825.pdf # Config for SmoothGrad approximation of gradients. When enabled, the gradients are approximated by averaging the gradients from noisy samples in the vicinity of the inputs. Adding noise can help improve the computed gradients. Refer to this paper for more details: https://arxiv.org/pdf/1706.03825.pdf
"featureNoiseSigma": { # Noise sigma by features. Noise sigma represents the standard deviation of the gaussian kernel that will be used to add noise to interpolated inputs prior to computing gradients. # This is similar to noise_sigma, but provides additional flexibility. A separate noise sigma can be provided for each feature, which is useful if their distributions are different. No noise is added to features that are not set. If this field is unset, noise_sigma will be used for all features.
"noiseSigma": [ # Noise sigma per feature. No noise is added to features that are not set.
{ # Noise sigma for a single feature.
"name": "A String", # The name of the input feature for which noise sigma is provided. The features are defined in explanation metadata inputs.
"sigma": 3.14, # This represents the standard deviation of the Gaussian kernel that will be used to add noise to the feature prior to computing gradients. Similar to noise_sigma but represents the noise added to the current feature. Defaults to 0.1.
},
],
},
"noiseSigma": 3.14, # This is a single float value and will be used to add noise to all the features. Use this field when all features are normalized to have the same distribution: scale to range [0, 1], [-1, 1] or z-scoring, where features are normalized to have 0-mean and 1-variance. Learn more about [normalization](https://developers.google.com/machine-learning/data-prep/transform/normalization). For best results the recommended value is about 10% - 20% of the standard deviation of the input feature. Refer to section 3.2 of the SmoothGrad paper: https://arxiv.org/pdf/1706.03825.pdf. Defaults to 0.1. If the distribution is different per feature, set feature_noise_sigma instead for each feature.
"noisySampleCount": 42, # The number of gradient samples to use for approximation. The higher this number, the more accurate the gradient is, but the runtime complexity increases by this factor as well. Valid range of its value is [1, 50]. Defaults to 3.
},
"stepCount": 42, # Required. The number of steps for approximating the path integral. A good value to start is 50 and gradually increase until the sum to diff property is met within the desired error range. Valid range of its value is [1, 100], inclusively.
},
},
},
"tabularObjective": { # Tabular monitoring objective. # Tabular monitoring objective.
"featureAttributionSpec": { # Feature attribution monitoring spec. # Feature attribution monitoring spec.
"batchExplanationDedicatedResources": { # A description of resources that are used for performing batch operations, are dedicated to a Model, and need manual configuration. # The config of resources used by the Model Monitoring during the batch explanation for non-AutoML models. If not set, `n1-standard-2` machine type will be used by default.
"machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine.
"acceleratorCount": 42, # The number of accelerators to attach to the machine.
"acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count.
"machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required.
"reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation.
"key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value.
"reservationAffinityType": "A String", # Required. Specifies the reservation affinity type.
"values": [ # Optional. Corresponds to the label values of a reservation resource. This must be the full resource name of the reservation.
"A String",
],
},
"tpuTopology": "A String", # Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1").
},
"maxReplicaCount": 42, # Immutable. The maximum number of machine replicas the batch operation may be scaled to. The default value is 10.
"startingReplicaCount": 42, # Immutable. The number of machine replicas used at the start of the batch operation. If not set, Vertex AI decides starting number, not greater than max_replica_count
},
"defaultAlertCondition": { # Monitoring alert triggered condition. # Default alert condition for all the features.
"threshold": 3.14, # A condition that compares a stats value against a threshold. Alert will be triggered if value above the threshold.
},
"featureAlertConditions": { # Per feature alert condition will override default alert condition.
"a_key": { # Monitoring alert triggered condition.
"threshold": 3.14, # A condition that compares a stats value against a threshold. Alert will be triggered if value above the threshold.
},
},
"features": [ # Feature names interested in monitoring. These should be a subset of the input feature names specified in the monitoring schema. If the field is not specified all features outlied in the monitoring schema will be used.
"A String",
],
},
"featureDriftSpec": { # Data drift monitoring spec. Data drift measures the distribution distance between the current dataset and a baseline dataset. A typical use case is to detect data drift between the recent production serving dataset and the training dataset, or to compare the recent production dataset with a dataset from a previous period. # Input feature distribution drift monitoring spec.
"categoricalMetricType": "A String", # Supported metrics type: * l_infinity * jensen_shannon_divergence
"defaultCategoricalAlertCondition": { # Monitoring alert triggered condition. # Default alert condition for all the categorical features.
"threshold": 3.14, # A condition that compares a stats value against a threshold. Alert will be triggered if value above the threshold.
},
"defaultNumericAlertCondition": { # Monitoring alert triggered condition. # Default alert condition for all the numeric features.
"threshold": 3.14, # A condition that compares a stats value against a threshold. Alert will be triggered if value above the threshold.
},
"featureAlertConditions": { # Per feature alert condition will override default alert condition.
"a_key": { # Monitoring alert triggered condition.
"threshold": 3.14, # A condition that compares a stats value against a threshold. Alert will be triggered if value above the threshold.
},
},
"features": [ # Feature names / Prediction output names interested in monitoring. These should be a subset of the input feature names or prediction output names specified in the monitoring schema. If the field is not specified all features / prediction outputs outlied in the monitoring schema will be used.
"A String",
],
"numericMetricType": "A String", # Supported metrics type: * jensen_shannon_divergence
},
"predictionOutputDriftSpec": { # Data drift monitoring spec. Data drift measures the distribution distance between the current dataset and a baseline dataset. A typical use case is to detect data drift between the recent production serving dataset and the training dataset, or to compare the recent production dataset with a dataset from a previous period. # Prediction output distribution drift monitoring spec.
"categoricalMetricType": "A String", # Supported metrics type: * l_infinity * jensen_shannon_divergence
"defaultCategoricalAlertCondition": { # Monitoring alert triggered condition. # Default alert condition for all the categorical features.
"threshold": 3.14, # A condition that compares a stats value against a threshold. Alert will be triggered if value above the threshold.
},
"defaultNumericAlertCondition": { # Monitoring alert triggered condition. # Default alert condition for all the numeric features.
"threshold": 3.14, # A condition that compares a stats value against a threshold. Alert will be triggered if value above the threshold.
},
"featureAlertConditions": { # Per feature alert condition will override default alert condition.
"a_key": { # Monitoring alert triggered condition.
"threshold": 3.14, # A condition that compares a stats value against a threshold. Alert will be triggered if value above the threshold.
},
},
"features": [ # Feature names / Prediction output names interested in monitoring. These should be a subset of the input feature names or prediction output names specified in the monitoring schema. If the field is not specified all features / prediction outputs outlied in the monitoring schema will be used.
"A String",
],
"numericMetricType": "A String", # Supported metrics type: * jensen_shannon_divergence
},
},
"targetDataset": { # Model monitoring data input spec. # Target dataset.
"batchPredictionOutput": { # Data from Vertex AI Batch prediction job output. # Vertex AI Batch prediction Job.
"batchPredictionJob": "A String", # Vertex AI Batch prediction job resource name. The job must match the model version specified in [ModelMonitor].[model_monitoring_target].
},
"columnizedDataset": { # Input dataset spec. # Columnized dataset.
"bigquerySource": { # Dataset spec for data sotred in BigQuery. # BigQuery data source.
"query": "A String", # Standard SQL to be used instead of the `table_uri`.
"tableUri": "A String", # BigQuery URI to a table, up to 2000 characters long. All the columns in the table will be selected. Accepted forms: * BigQuery path. For example: `bq://projectId.bqDatasetId.bqTableId`.
},
"gcsSource": { # Dataset spec for data stored in Google Cloud Storage. # Google Cloud Storage data source.
"format": "A String", # Data format of the dataset.
"gcsUri": "A String", # Google Cloud Storage URI to the input file(s). May contain wildcards. For more information on wildcards, see https://cloud.google.com/storage/docs/gsutil/addlhelp/WildcardNames.
},
"timestampField": "A String", # The timestamp field. Usually for serving data.
"vertexDataset": "A String", # Resource name of the Vertex AI managed dataset.
},
"timeInterval": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # The time interval (pair of start_time and end_time) for which results should be returned.
"endTime": "A String", # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
"startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
},
"timeOffset": { # Time offset setting. # The time offset setting for which results should be returned.
"offset": "A String", # [offset] is the time difference from the cut-off time. For scheduled jobs, the cut-off time is the scheduled time. For non-scheduled jobs, it's the time when the job was created. Currently we support the following format: 'w|W': Week, 'd|D': Day, 'h|H': Hour E.g. '1h' stands for 1 hour, '2d' stands for 2 days.
"window": "A String", # [window] refers to the scope of data selected for analysis. It allows you to specify the quantity of data you wish to examine. Currently we support the following format: 'w|W': Week, 'd|D': Day, 'h|H': Hour E.g. '1h' stands for 1 hour, '2d' stands for 2 days.
},
"vertexEndpointLogs": { # Data from Vertex AI Endpoint request response logging. # Vertex AI Endpoint request & response logging.
"endpoints": [ # List of endpoint resource names. The endpoints must enable the logging with the [Endpoint].[request_response_logging_config], and must contain the deployed model corresponding to the model version specified in [ModelMonitor].[model_monitoring_target].
"A String",
],
},
},
},
"outputSpec": { # Specification for the export destination of monitoring results, including metrics, logs, etc. # The Output destination spec for metrics, error logs, etc.
"gcsBaseDirectory": { # The Google Cloud Storage location where the output is to be written to. # Google Cloud Storage base folder path for metrics, error logs, etc.
"outputUriPrefix": "A String", # Required. Google Cloud Storage URI to output directory. If the uri doesn't end with '/', a '/' will be automatically appended. The directory is created if it doesn't exist.
},
},
},
"name": "A String", # Output only. Resource name of a ModelMonitoringJob. Format: `projects/{project_id}/locations/{location_id}/modelMonitors/{model_monitor_id}/modelMonitoringJobs/{model_monitoring_job_id}`
"schedule": "A String", # Output only. Schedule resource name. It will only appear when this job is triggered by a schedule.
"scheduleTime": "A String", # Output only. Timestamp when this ModelMonitoringJob was scheduled. It will only appear when this job is triggered by a schedule.
"state": "A String", # Output only. The state of the monitoring job. * When the job is still creating, the state will be 'JOB_STATE_PENDING'. * Once the job is successfully created, the state will be 'JOB_STATE_RUNNING'. * Once the job is finished, the state will be one of 'JOB_STATE_FAILED', 'JOB_STATE_SUCCEEDED', 'JOB_STATE_PARTIALLY_SUCCEEDED'.
"updateTime": "A String", # Output only. Timestamp when this ModelMonitoringJob was updated most recently.
},
"modelMonitoringJobId": "A String", # Optional. The ID to use for the Model Monitoring Job, which will become the final component of the model monitoring job resource name. The maximum length is 63 characters, and valid characters are `/^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$/`.
"parent": "A String", # Required. The parent of the ModelMonitoringJob. Format: `projects/{project}/locations/{location}/modelMoniitors/{model_monitor}`
},
"createNotebookExecutionJobRequest": { # Request message for [NotebookService.CreateNotebookExecutionJob] # Request for NotebookService.CreateNotebookExecutionJob.
"notebookExecutionJob": { # NotebookExecutionJob represents an instance of a notebook execution. # Required. The NotebookExecutionJob to create.
"createTime": "A String", # Output only. Timestamp when this NotebookExecutionJob was created.
"customEnvironmentSpec": { # Compute configuration to use for an execution job. # The custom compute configuration for an execution job.
"machineSpec": { # Specification of a single machine. # The specification of a single machine for the execution job.
"acceleratorCount": 42, # The number of accelerators to attach to the machine.
"acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count.
"machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required.
"reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation.
"key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value.
"reservationAffinityType": "A String", # Required. Specifies the reservation affinity type.
"values": [ # Optional. Corresponds to the label values of a reservation resource. This must be the full resource name of the reservation.
"A String",
],
},
"tpuTopology": "A String", # Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1").
},
"networkSpec": { # Network spec. # The network configuration to use for the execution job.
"enableInternetAccess": True or False, # Whether to enable public internet access. Default false.
"network": "A String", # The full name of the Google Compute Engine [network](https://cloud.google.com//compute/docs/networks-and-firewalls#networks)
"subnetwork": "A String", # The name of the subnet that this instance is in. Format: `projects/{project_id_or_number}/regions/{region}/subnetworks/{subnetwork_id}`
},
"persistentDiskSpec": { # Represents the spec of persistent disk options. # The specification of a persistent disk to attach for the execution job.
"diskSizeGb": "A String", # Size in GB of the disk (default is 100GB).
"diskType": "A String", # Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) "pd-extreme" (Extreme Persistent Disk)
},
},
"dataformRepositorySource": { # The Dataform Repository containing the input notebook. # The Dataform Repository pointing to a single file notebook repository.
"commitSha": "A String", # The commit SHA to read repository with. If unset, the file will be read at HEAD.
"dataformRepositoryResourceName": "A String", # The resource name of the Dataform Repository. Format: `projects/{project_id}/locations/{location}/repositories/{repository_id}`
},
"directNotebookSource": { # The content of the input notebook in ipynb format. # The contents of an input notebook file.
"content": "A String", # The base64-encoded contents of the input notebook file.
},
"displayName": "A String", # The display name of the NotebookExecutionJob. The name can be up to 128 characters long and can consist of any UTF-8 characters.
"encryptionSpec": { # Represents a customer-managed encryption key spec that can be applied to a top-level resource. # Customer-managed encryption key spec for the notebook execution job. This field is auto-populated if the NotebookService.NotebookRuntimeTemplate has an encryption spec.
"kmsKeyName": "A String", # Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. The key needs to be in the same region as where the compute resource is created.
},
"executionTimeout": "A String", # Max running time of the execution job in seconds (default 86400s / 24 hrs).
"executionUser": "A String", # The user email to run the execution as. Only supported by Colab runtimes.
"gcsNotebookSource": { # The Cloud Storage uri for the input notebook. # The Cloud Storage url pointing to the ipynb file. Format: `gs://bucket/notebook_file.ipynb`
"generation": "A String", # The version of the Cloud Storage object to read. If unset, the current version of the object is read. See https://cloud.google.com/storage/docs/metadata#generation-number.
"uri": "A String", # The Cloud Storage uri pointing to the ipynb file. Format: `gs://bucket/notebook_file.ipynb`
},
"gcsOutputUri": "A String", # The Cloud Storage location to upload the result to. Format: `gs://bucket-name`
"jobState": "A String", # Output only. The state of the NotebookExecutionJob.
"labels": { # The labels with user-defined metadata to organize NotebookExecutionJobs. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.
"a_key": "A String",
},
"name": "A String", # Output only. The resource name of this NotebookExecutionJob. Format: `projects/{project_id}/locations/{location}/notebookExecutionJobs/{job_id}`
"notebookRuntimeTemplateResourceName": "A String", # The NotebookRuntimeTemplate to source compute configuration from.
"scheduleResourceName": "A String", # Output only. The Schedule resource name if this job is triggered by one. Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}`
"serviceAccount": "A String", # The service account to run the execution as.
"status": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Populated when the NotebookExecutionJob is completed. When there is an error during notebook execution, the error details are populated.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"updateTime": "A String", # Output only. Timestamp when this NotebookExecutionJob was most recently updated.
},
"notebookExecutionJobId": "A String", # Optional. User specified ID for the NotebookExecutionJob.
"parent": "A String", # Required. The resource name of the Location to create the NotebookExecutionJob. Format: `projects/{project}/locations/{location}`
},
"createPipelineJobRequest": { # Request message for PipelineService.CreatePipelineJob. # Request for PipelineService.CreatePipelineJob. CreatePipelineJobRequest.parent field is required (format: projects/{project}/locations/{location}).
"parent": "A String", # Required. The resource name of the Location to create the PipelineJob in. Format: `projects/{project}/locations/{location}`
"pipelineJob": { # An instance of a machine learning PipelineJob. # Required. The PipelineJob to create.
"createTime": "A String", # Output only. Pipeline creation time.
"displayName": "A String", # The display name of the Pipeline. The name can be up to 128 characters long and can consist of any UTF-8 characters.
"encryptionSpec": { # Represents a customer-managed encryption key spec that can be applied to a top-level resource. # Customer-managed encryption key spec for a pipelineJob. If set, this PipelineJob and all of its sub-resources will be secured by this key.
"kmsKeyName": "A String", # Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. The key needs to be in the same region as where the compute resource is created.
},
"endTime": "A String", # Output only. Pipeline end time.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. The error that occurred during pipeline execution. Only populated when the pipeline's state is FAILED or CANCELLED.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"jobDetail": { # The runtime detail of PipelineJob. # Output only. The details of pipeline run. Not available in the list view.
"pipelineContext": { # Instance of a general context. # Output only. The context of the pipeline.
"createTime": "A String", # Output only. Timestamp when this Context was created.
"description": "A String", # Description of the Context
"displayName": "A String", # User provided display name of the Context. May be up to 128 Unicode characters.
"etag": "A String", # An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
"labels": { # The labels with user-defined metadata to organize your Contexts. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Context (System labels are excluded).
"a_key": "A String",
},
"metadata": { # Properties of the Context. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB.
"a_key": "", # Properties of the object.
},
"name": "A String", # Immutable. The resource name of the Context.
"parentContexts": [ # Output only. A list of resource names of Contexts that are parents of this Context. A Context may have at most 10 parent_contexts.
"A String",
],
"schemaTitle": "A String", # The title of the schema describing the metadata. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"schemaVersion": "A String", # The version of the schema in schema_name to use. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"updateTime": "A String", # Output only. Timestamp when this Context was last updated.
},
"pipelineRunContext": { # Instance of a general context. # Output only. The context of the current pipeline run.
"createTime": "A String", # Output only. Timestamp when this Context was created.
"description": "A String", # Description of the Context
"displayName": "A String", # User provided display name of the Context. May be up to 128 Unicode characters.
"etag": "A String", # An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
"labels": { # The labels with user-defined metadata to organize your Contexts. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Context (System labels are excluded).
"a_key": "A String",
},
"metadata": { # Properties of the Context. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB.
"a_key": "", # Properties of the object.
},
"name": "A String", # Immutable. The resource name of the Context.
"parentContexts": [ # Output only. A list of resource names of Contexts that are parents of this Context. A Context may have at most 10 parent_contexts.
"A String",
],
"schemaTitle": "A String", # The title of the schema describing the metadata. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"schemaVersion": "A String", # The version of the schema in schema_name to use. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"updateTime": "A String", # Output only. Timestamp when this Context was last updated.
},
"taskDetails": [ # Output only. The runtime details of the tasks under the pipeline.
{ # The runtime detail of a task execution.
"createTime": "A String", # Output only. Task create time.
"endTime": "A String", # Output only. Task end time.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. The error that occurred during task execution. Only populated when the task's state is FAILED or CANCELLED.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"execution": { # Instance of a general execution. # Output only. The execution metadata of the task.
"createTime": "A String", # Output only. Timestamp when this Execution was created.
"description": "A String", # Description of the Execution
"displayName": "A String", # User provided display name of the Execution. May be up to 128 Unicode characters.
"etag": "A String", # An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
"labels": { # The labels with user-defined metadata to organize your Executions. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Execution (System labels are excluded).
"a_key": "A String",
},
"metadata": { # Properties of the Execution. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB.
"a_key": "", # Properties of the object.
},
"name": "A String", # Output only. The resource name of the Execution.
"schemaTitle": "A String", # The title of the schema describing the metadata. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"schemaVersion": "A String", # The version of the schema in `schema_title` to use. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"state": "A String", # The state of this Execution. This is a property of the Execution, and does not imply or capture any ongoing process. This property is managed by clients (such as Vertex AI Pipelines) and the system does not prescribe or check the validity of state transitions.
"updateTime": "A String", # Output only. Timestamp when this Execution was last updated.
},
"executorDetail": { # The runtime detail of a pipeline executor. # Output only. The detailed execution info.
"containerDetail": { # The detail of a container execution. It contains the job names of the lifecycle of a container execution. # Output only. The detailed info for a container executor.
"failedMainJobs": [ # Output only. The names of the previously failed CustomJob for the main container executions. The list includes the all attempts in chronological order.
"A String",
],
"failedPreCachingCheckJobs": [ # Output only. The names of the previously failed CustomJob for the pre-caching-check container executions. This job will be available if the PipelineJob.pipeline_spec specifies the `pre_caching_check` hook in the lifecycle events. The list includes the all attempts in chronological order.
"A String",
],
"mainJob": "A String", # Output only. The name of the CustomJob for the main container execution.
"preCachingCheckJob": "A String", # Output only. The name of the CustomJob for the pre-caching-check container execution. This job will be available if the PipelineJob.pipeline_spec specifies the `pre_caching_check` hook in the lifecycle events.
},
"customJobDetail": { # The detailed info for a custom job executor. # Output only. The detailed info for a custom job executor.
"failedJobs": [ # Output only. The names of the previously failed CustomJob. The list includes the all attempts in chronological order.
"A String",
],
"job": "A String", # Output only. The name of the CustomJob.
},
},
"inputs": { # Output only. The runtime input artifacts of the task.
"a_key": { # A list of artifact metadata.
"artifacts": [ # Output only. A list of artifact metadata.
{ # Instance of a general artifact.
"createTime": "A String", # Output only. Timestamp when this Artifact was created.
"description": "A String", # Description of the Artifact
"displayName": "A String", # User provided display name of the Artifact. May be up to 128 Unicode characters.
"etag": "A String", # An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
"labels": { # The labels with user-defined metadata to organize your Artifacts. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Artifact (System labels are excluded).
"a_key": "A String",
},
"metadata": { # Properties of the Artifact. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB.
"a_key": "", # Properties of the object.
},
"name": "A String", # Output only. The resource name of the Artifact.
"schemaTitle": "A String", # The title of the schema describing the metadata. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"schemaVersion": "A String", # The version of the schema in schema_name to use. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"state": "A String", # The state of this Artifact. This is a property of the Artifact, and does not imply or capture any ongoing process. This property is managed by clients (such as Vertex AI Pipelines), and the system does not prescribe or check the validity of state transitions.
"updateTime": "A String", # Output only. Timestamp when this Artifact was last updated.
"uri": "A String", # The uniform resource identifier of the artifact file. May be empty if there is no actual artifact file.
},
],
},
},
"outputs": { # Output only. The runtime output artifacts of the task.
"a_key": { # A list of artifact metadata.
"artifacts": [ # Output only. A list of artifact metadata.
{ # Instance of a general artifact.
"createTime": "A String", # Output only. Timestamp when this Artifact was created.
"description": "A String", # Description of the Artifact
"displayName": "A String", # User provided display name of the Artifact. May be up to 128 Unicode characters.
"etag": "A String", # An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
"labels": { # The labels with user-defined metadata to organize your Artifacts. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Artifact (System labels are excluded).
"a_key": "A String",
},
"metadata": { # Properties of the Artifact. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB.
"a_key": "", # Properties of the object.
},
"name": "A String", # Output only. The resource name of the Artifact.
"schemaTitle": "A String", # The title of the schema describing the metadata. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"schemaVersion": "A String", # The version of the schema in schema_name to use. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"state": "A String", # The state of this Artifact. This is a property of the Artifact, and does not imply or capture any ongoing process. This property is managed by clients (such as Vertex AI Pipelines), and the system does not prescribe or check the validity of state transitions.
"updateTime": "A String", # Output only. Timestamp when this Artifact was last updated.
"uri": "A String", # The uniform resource identifier of the artifact file. May be empty if there is no actual artifact file.
},
],
},
},
"parentTaskId": "A String", # Output only. The id of the parent task if the task is within a component scope. Empty if the task is at the root level.
"pipelineTaskStatus": [ # Output only. A list of task status. This field keeps a record of task status evolving over time.
{ # A single record of the task status.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # 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.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"state": "A String", # Output only. The state of the task.
"updateTime": "A String", # Output only. Update time of this status.
},
],
"startTime": "A String", # Output only. Task start time.
"state": "A String", # Output only. State of the task.
"taskId": "A String", # Output only. The system generated ID of the task.
"taskName": "A String", # Output only. The user specified name of the task that is defined in pipeline_spec.
},
],
},
"labels": { # The labels with user-defined metadata to organize PipelineJob. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. Note there is some reserved label key for Vertex AI Pipelines. - `vertex-ai-pipelines-run-billing-id`, user set value will get overrided.
"a_key": "A String",
},
"name": "A String", # Output only. The resource name of the PipelineJob.
"network": "A String", # The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the Pipeline Job's workload should be peered. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. Private services access must already be configured for the network. Pipeline job will apply the network configuration to the Google Cloud resources being launched, if applied, such as Vertex AI Training or Dataflow job. If left unspecified, the workload is not peered with any network.
"originalPipelineJobId": "A String", # Optional. The original pipeline job id if this pipeline job is a rerun of a previous pipeline job.
"pipelineSpec": { # The spec of the pipeline.
"a_key": "", # Properties of the object.
},
"pipelineTaskRerunConfigs": [ # Optional. The rerun configs for each task in the pipeline job. By default, the rerun will: 1. Use the same input artifacts as the original run. 2. Use the same input parameters as the original run. 3. Skip all the tasks that are already succeeded in the original run. 4. Rerun all the tasks that are not succeeded in the original run. By providing this field, users can override the default behavior and specify the rerun config for each task.
{ # User provided rerun config to submit a rerun pipelinejob. This includes 1. Which task to rerun 2. User override input parameters and artifacts.
"inputs": { # Runtime inputs data of the task. # Optional. The runtime input of the task overridden by the user.
"artifacts": { # Optional. Input artifacts.
"a_key": { # A list of artifact metadata.
"artifacts": [ # Optional. A list of artifact metadata.
{ # The definition of a runtime artifact.
"customProperties": { # The custom properties of the artifact. Deprecated. Use RuntimeArtifact.metadata instead.
"a_key": { # Value is the value of the field.
"doubleValue": 3.14, # A double value.
"intValue": "A String", # An integer value.
"stringValue": "A String", # A string value.
},
},
"metadata": { # Properties of the Artifact.
"a_key": "", # Properties of the object.
},
"name": "A String", # The name of an artifact.
"properties": { # The properties of the artifact. Deprecated. Use RuntimeArtifact.metadata instead.
"a_key": { # Value is the value of the field.
"doubleValue": 3.14, # A double value.
"intValue": "A String", # An integer value.
"stringValue": "A String", # A string value.
},
},
"type": { # The definition of a artifact type in MLMD. # The type of the artifact.
"instanceSchema": "A String", # Contains a raw YAML string, describing the format of the properties of the type.
"schemaTitle": "A String", # The name of the type. The format of the title must be: `.`. Examples: - `aiplatform.Model` - `acme.CustomModel` When this field is set, the type must be pre-registered in the MLMD store.
"schemaUri": "A String", # Points to a YAML file stored on Cloud Storage describing the format. Deprecated. Use PipelineArtifactTypeSchema.schema_title or PipelineArtifactTypeSchema.instance_schema instead.
"schemaVersion": "A String", # The schema version of the artifact. If the value is not set, it defaults to the latest version in the system.
},
"uri": "A String", # The URI of the artifact.
},
],
},
},
"parameterValues": { # Optional. Input parameters.
"a_key": "",
},
},
"skipDownstreamTasks": True or False, # Optional. Whether to skip downstream tasks. Default value is False.
"skipTask": True or False, # Optional. Whether to skip this task. Default value is False.
"taskId": "A String", # Optional. The system generated ID of the task. Retrieved from original run.
"taskName": "A String", # Optional. The name of the task.
},
],
"preflightValidations": True or False, # Optional. Whether to do component level validations before job creation.
"pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I for PipelineJob.
"networkAttachment": "A String", # Optional. The name of the Compute Engine [network attachment](https://cloud.google.com/vpc/docs/about-network-attachments) to attach to the resource within the region and user project. To specify this field, you must have already [created a network attachment] (https://cloud.google.com/vpc/docs/create-manage-network-attachments#create-network-attachments). This field is only used for resources using PSC-I.
},
"reservedIpRanges": [ # A list of names for the reserved ip ranges under the VPC network that can be used for this Pipeline Job's workload. If set, we will deploy the Pipeline Job's workload within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network. Example: ['vertex-ai-ip-range'].
"A String",
],
"runtimeConfig": { # The runtime config of a PipelineJob. # Runtime config of the pipeline.
"defaultRuntime": { # The default runtime for the PipelineJob. # Optional. The default runtime for the PipelineJob. If not provided, Vertex Custom Job(on demand) is used as the runtime. For Vertex Custom Job, please refer to https://cloud.google.com/vertex-ai/docs/training/overview.
"persistentResourceRuntimeDetail": { # Persistent resource based runtime detail. For more information, refer to https://cloud.google.com/vertex-ai/docs/training/persistent-resource-overview # Persistent resource based runtime detail.
"persistentResourceName": "A String", # Persistent resource name. Format: `projects/{project}/locations/{location}/persistentResources/{persistent_resource}`
"taskResourceUnavailableTimeoutBehavior": "A String", # Specifies the behavior to take if the timeout is reached.
"taskResourceUnavailableWaitTimeMs": "A String", # The max time a pipeline task waits for the required CPU, memory, or accelerator resource to become available from the specified persistent resource. Default wait time is 0.
},
},
"failurePolicy": "A String", # Represents the failure policy of a pipeline. Currently, the default of a pipeline is that the pipeline will continue to run until no more tasks can be executed, also known as PIPELINE_FAILURE_POLICY_FAIL_SLOW. However, if a pipeline is set to PIPELINE_FAILURE_POLICY_FAIL_FAST, it will stop scheduling any new tasks when a task has failed. Any scheduled tasks will continue to completion.
"gcsOutputDirectory": "A String", # Required. A path in a Cloud Storage bucket, which will be treated as the root output directory of the pipeline. It is used by the system to generate the paths of output artifacts. The artifact paths are generated with a sub-path pattern `{job_id}/{task_id}/{output_key}` under the specified output directory. The service account specified in this pipeline must have the `storage.objects.get` and `storage.objects.create` permissions for this bucket.
"inputArtifacts": { # The runtime artifacts of the PipelineJob. The key will be the input artifact name and the value would be one of the InputArtifact.
"a_key": { # The type of an input artifact.
"artifactId": "A String", # Artifact resource id from MLMD. Which is the last portion of an artifact resource name: `projects/{project}/locations/{location}/metadataStores/default/artifacts/{artifact_id}`. The artifact must stay within the same project, location and default metadatastore as the pipeline.
},
},
"parameterValues": { # The runtime parameters of the PipelineJob. The parameters will be passed into PipelineJob.pipeline_spec to replace the placeholders at runtime. This field is used by pipelines built using `PipelineJob.pipeline_spec.schema_version` 2.1.0, such as pipelines built using Kubeflow Pipelines SDK 1.9 or higher and the v2 DSL.
"a_key": "",
},
"parameters": { # Deprecated. Use RuntimeConfig.parameter_values instead. The runtime parameters of the PipelineJob. The parameters will be passed into PipelineJob.pipeline_spec to replace the placeholders at runtime. This field is used by pipelines built using `PipelineJob.pipeline_spec.schema_version` 2.0.0 or lower, such as pipelines built using Kubeflow Pipelines SDK 1.8 or lower.
"a_key": { # Value is the value of the field.
"doubleValue": 3.14, # A double value.
"intValue": "A String", # An integer value.
"stringValue": "A String", # A string value.
},
},
},
"satisfiesPzi": True or False, # Output only. Reserved for future use.
"satisfiesPzs": True or False, # Output only. Reserved for future use.
"scheduleName": "A String", # Output only. The schedule resource name. Only returned if the Pipeline is created by Schedule API.
"serviceAccount": "A String", # The service account that the pipeline workload runs as. If not specified, the Compute Engine default service account in the project will be used. See https://cloud.google.com/compute/docs/access/service-accounts#default_service_account Users starting the pipeline must have the `iam.serviceAccounts.actAs` permission on this service account.
"startTime": "A String", # Output only. Pipeline start time.
"state": "A String", # Output only. The detailed state of the job.
"templateMetadata": { # Pipeline template metadata if PipelineJob.template_uri is from supported template registry. Currently, the only supported registry is Artifact Registry. # Output only. Pipeline template metadata. Will fill up fields if PipelineJob.template_uri is from supported template registry.
"version": "A String", # The version_name in artifact registry. Will always be presented in output if the PipelineJob.template_uri is from supported template registry. Format is "sha256:abcdef123456...".
},
"templateUri": "A String", # A template uri from where the PipelineJob.pipeline_spec, if empty, will be downloaded. Currently, only uri from Vertex Template Registry & Gallery is supported. Reference to https://cloud.google.com/vertex-ai/docs/pipelines/create-pipeline-template.
"updateTime": "A String", # Output only. Timestamp when this PipelineJob was most recently updated.
},
"pipelineJobId": "A String", # The ID to use for the PipelineJob, which will become the final component of the PipelineJob name. If not provided, an ID will be automatically generated. This value should be less than 128 characters, and valid characters are `/a-z-/`.
},
"createTime": "A String", # Output only. Timestamp when this Schedule was created.
"cron": "A String", # Cron schedule (https://en.wikipedia.org/wiki/Cron) to launch scheduled runs. To explicitly set a timezone to the cron tab, apply a prefix in the cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or "TZ=${IANA_TIME_ZONE}". The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone database. For example, "CRON_TZ=America/New_York 1 * * * *", or "TZ=America/New_York 1 * * * *".
"displayName": "A String", # Required. User provided name of the Schedule. The name can be up to 128 characters long and can consist of any UTF-8 characters.
"endTime": "A String", # Optional. Timestamp after which no new runs can be scheduled. If specified, The schedule will be completed when either end_time is reached or when scheduled_run_count >= max_run_count. If not specified, new runs will keep getting scheduled until this Schedule is paused or deleted. Already scheduled runs will be allowed to complete. Unset if not specified.
"lastPauseTime": "A String", # Output only. Timestamp when this Schedule was last paused. Unset if never paused.
"lastResumeTime": "A String", # Output only. Timestamp when this Schedule was last resumed. Unset if never resumed from pause.
"lastScheduledRunResponse": { # Status of a scheduled run. # Output only. Response of the last scheduled run. This is the response for starting the scheduled requests and not the execution of the operations/jobs created by the requests (if applicable). Unset if no run has been scheduled yet.
"runResponse": "A String", # The response of the scheduled run.
"scheduledRunTime": "A String", # The scheduled run time based on the user-specified schedule.
},
"maxConcurrentRunCount": "A String", # Required. Maximum number of runs that can be started concurrently for this Schedule. This is the limit for starting the scheduled requests and not the execution of the operations/jobs created by the requests (if applicable).
"maxRunCount": "A String", # Optional. Maximum run count of the schedule. If specified, The schedule will be completed when either started_run_count >= max_run_count or when end_time is reached. If not specified, new runs will keep getting scheduled until this Schedule is paused or deleted. Already scheduled runs will be allowed to complete. Unset if not specified.
"name": "A String", # Immutable. The resource name of the Schedule.
"nextRunTime": "A String", # Output only. Timestamp when this Schedule should schedule the next run. Having a next_run_time in the past means the runs are being started behind schedule.
"startTime": "A String", # Optional. Timestamp after which the first run can be scheduled. Default to Schedule create time if not specified.
"startedRunCount": "A String", # Output only. The number of runs started by this schedule.
"state": "A String", # Output only. The state of this Schedule.
"updateTime": "A String", # Output only. Timestamp when this Schedule was updated.
}

updateMask: string, Required. The update mask applies to the resource. See google.protobuf.FieldMask.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # An instance of a Schedule periodically schedules runs to make API calls based on user specified time specification and API request type.
"allowQueueing": True or False, # Optional. Whether new scheduled runs can be queued when max_concurrent_runs limit is reached. If set to true, new runs will be queued instead of skipped. Default to false.
"catchUp": True or False, # Output only. Whether to backfill missed runs when the schedule is resumed from PAUSED state. If set to true, all missed runs will be scheduled. New runs will be scheduled after the backfill is complete. Default to false.
"createModelMonitoringJobRequest": { # Request message for ModelMonitoringService.CreateModelMonitoringJob. # Request for ModelMonitoringService.CreateModelMonitoringJob.
"modelMonitoringJob": { # Represents a model monitoring job that analyze dataset using different monitoring algorithm. # Required. The ModelMonitoringJob to create
"createTime": "A String", # Output only. Timestamp when this ModelMonitoringJob was created.
"displayName": "A String", # The display name of the ModelMonitoringJob. The name can be up to 128 characters long and can consist of any UTF-8.
"jobExecutionDetail": { # Represent the execution details of the job. # Output only. Execution results for all the monitoring objectives.
"baselineDatasets": [ # Processed baseline datasets.
{ # Processed dataset information.
"location": "A String", # Actual data location of the processed dataset.
"timeRange": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Dataset time range information if any.
"endTime": "A String", # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
"startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
},
},
],
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Additional job error status.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"objectiveStatus": { # Status of data processing for each monitoring objective. Key is the objective.
"a_key": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
},
"targetDatasets": [ # Processed target datasets.
{ # Processed dataset information.
"location": "A String", # Actual data location of the processed dataset.
"timeRange": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Dataset time range information if any.
"endTime": "A String", # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
"startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
},
},
],
},
"modelMonitoringSpec": { # Monitoring monitoring job spec. It outlines the specifications for monitoring objectives, notifications, and result exports. # Monitoring monitoring job spec. It outlines the specifications for monitoring objectives, notifications, and result exports. If left blank, the default monitoring specifications from the top-level resource 'ModelMonitor' will be applied. If provided, we will use the specification defined here rather than the default one.
"notificationSpec": { # Notification spec(email, notification channel) for model monitoring statistics/alerts. # The model monitoring notification spec.
"emailConfig": { # The config for email alerts. # Email alert config.
"userEmails": [ # The email addresses to send the alerts.
"A String",
],
},
"enableCloudLogging": True or False, # Dump the anomalies to Cloud Logging. The anomalies will be put to json payload encoded from proto google.cloud.aiplatform.logging.ModelMonitoringAnomaliesLogEntry. This can be further sinked to Pub/Sub or any other services supported by Cloud Logging.
"notificationChannelConfigs": [ # Notification channel config.
{ # Google Cloud Notification Channel config.
"notificationChannel": "A String", # Resource names of the NotificationChannels. Must be of the format `projects//notificationChannels/`
},
],
},
"objectiveSpec": { # Monitoring objectives spec. # The monitoring objective spec.
"baselineDataset": { # Model monitoring data input spec. # Baseline dataset. It could be the training dataset or production serving dataset from a previous period.
"batchPredictionOutput": { # Data from Vertex AI Batch prediction job output. # Vertex AI Batch prediction Job.
"batchPredictionJob": "A String", # Vertex AI Batch prediction job resource name. The job must match the model version specified in [ModelMonitor].[model_monitoring_target].
},
"columnizedDataset": { # Input dataset spec. # Columnized dataset.
"bigquerySource": { # Dataset spec for data sotred in BigQuery. # BigQuery data source.
"query": "A String", # Standard SQL to be used instead of the `table_uri`.
"tableUri": "A String", # BigQuery URI to a table, up to 2000 characters long. All the columns in the table will be selected. Accepted forms: * BigQuery path. For example: `bq://projectId.bqDatasetId.bqTableId`.
},
"gcsSource": { # Dataset spec for data stored in Google Cloud Storage. # Google Cloud Storage data source.
"format": "A String", # Data format of the dataset.
"gcsUri": "A String", # Google Cloud Storage URI to the input file(s). May contain wildcards. For more information on wildcards, see https://cloud.google.com/storage/docs/gsutil/addlhelp/WildcardNames.
},
"timestampField": "A String", # The timestamp field. Usually for serving data.
"vertexDataset": "A String", # Resource name of the Vertex AI managed dataset.
},
"timeInterval": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # The time interval (pair of start_time and end_time) for which results should be returned.
"endTime": "A String", # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
"startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
},
"timeOffset": { # Time offset setting. # The time offset setting for which results should be returned.
"offset": "A String", # [offset] is the time difference from the cut-off time. For scheduled jobs, the cut-off time is the scheduled time. For non-scheduled jobs, it's the time when the job was created. Currently we support the following format: 'w|W': Week, 'd|D': Day, 'h|H': Hour E.g. '1h' stands for 1 hour, '2d' stands for 2 days.
"window": "A String", # [window] refers to the scope of data selected for analysis. It allows you to specify the quantity of data you wish to examine. Currently we support the following format: 'w|W': Week, 'd|D': Day, 'h|H': Hour E.g. '1h' stands for 1 hour, '2d' stands for 2 days.
},
"vertexEndpointLogs": { # Data from Vertex AI Endpoint request response logging. # Vertex AI Endpoint request & response logging.
"endpoints": [ # List of endpoint resource names. The endpoints must enable the logging with the [Endpoint].[request_response_logging_config], and must contain the deployed model corresponding to the model version specified in [ModelMonitor].[model_monitoring_target].
"A String",
],
},
},
"explanationSpec": { # Specification of Model explanation. # The explanation spec. This spec is required when the objectives spec includes feature attribution objectives.
"metadata": { # Metadata describing the Model's input and output for explanation. # Optional. Metadata describing the Model's input and output for explanation.
"featureAttributionsSchemaUri": "A String", # Points to a YAML file stored on Google Cloud Storage describing the format of the feature attributions. The schema is defined as an OpenAPI 3.0.2 [Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). AutoML tabular Models always have this field populated by Vertex AI. Note: The URI given on output may be different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.
"inputs": { # Required. Map from feature names to feature input metadata. Keys are the name of the features. Values are the specification of the feature. An empty InputMetadata is valid. It describes a text feature which has the name specified as the key in ExplanationMetadata.inputs. The baseline of the empty feature is chosen by Vertex AI. For Vertex AI-provided Tensorflow images, the key can be any friendly name of the feature. Once specified, featureAttributions are keyed by this key (if not grouped with another feature). For custom images, the key must match with the key in instance.
"a_key": { # Metadata of the input of a feature. Fields other than InputMetadata.input_baselines are applicable only for Models that are using Vertex AI-provided images for Tensorflow.
"denseShapeTensorName": "A String", # Specifies the shape of the values of the input if the input is a sparse representation. Refer to Tensorflow documentation for more details: https://www.tensorflow.org/api_docs/python/tf/sparse/SparseTensor.
"encodedBaselines": [ # A list of baselines for the encoded tensor. The shape of each baseline should match the shape of the encoded tensor. If a scalar is provided, Vertex AI broadcasts to the same shape as the encoded tensor.
"",
],
"encodedTensorName": "A String", # Encoded tensor is a transformation of the input tensor. Must be provided if choosing Integrated Gradients attribution or XRAI attribution and the input tensor is not differentiable. An encoded tensor is generated if the input tensor is encoded by a lookup table.
"encoding": "A String", # Defines how the feature is encoded into the input tensor. Defaults to IDENTITY.
"featureValueDomain": { # Domain details of the input feature value. Provides numeric information about the feature, such as its range (min, max). If the feature has been pre-processed, for example with z-scoring, then it provides information about how to recover the original feature. For example, if the input feature is an image and it has been pre-processed to obtain 0-mean and stddev = 1 values, then original_mean, and original_stddev refer to the mean and stddev of the original feature (e.g. image tensor) from which input feature (with mean = 0 and stddev = 1) was obtained. # The domain details of the input feature value. Like min/max, original mean or standard deviation if normalized.
"maxValue": 3.14, # The maximum permissible value for this feature.
"minValue": 3.14, # The minimum permissible value for this feature.
"originalMean": 3.14, # If this input feature has been normalized to a mean value of 0, the original_mean specifies the mean value of the domain prior to normalization.
"originalStddev": 3.14, # If this input feature has been normalized to a standard deviation of 1.0, the original_stddev specifies the standard deviation of the domain prior to normalization.
},
"groupName": "A String", # Name of the group that the input belongs to. Features with the same group name will be treated as one feature when computing attributions. Features grouped together can have different shapes in value. If provided, there will be one single attribution generated in Attribution.feature_attributions, keyed by the group name.
"indexFeatureMapping": [ # A list of feature names for each index in the input tensor. Required when the input InputMetadata.encoding is BAG_OF_FEATURES, BAG_OF_FEATURES_SPARSE, INDICATOR.
"A String",
],
"indicesTensorName": "A String", # Specifies the index of the values of the input tensor. Required when the input tensor is a sparse representation. Refer to Tensorflow documentation for more details: https://www.tensorflow.org/api_docs/python/tf/sparse/SparseTensor.
"inputBaselines": [ # Baseline inputs for this feature. If no baseline is specified, Vertex AI chooses the baseline for this feature. If multiple baselines are specified, Vertex AI returns the average attributions across them in Attribution.feature_attributions. For Vertex AI-provided Tensorflow images (both 1.x and 2.x), the shape of each baseline must match the shape of the input tensor. If a scalar is provided, we broadcast to the same shape as the input tensor. For custom images, the element of the baselines must be in the same format as the feature's input in the instance[]. The schema of any single instance may be specified via Endpoint's DeployedModels' Model's PredictSchemata's instance_schema_uri.
"",
],
"inputTensorName": "A String", # Name of the input tensor for this feature. Required and is only applicable to Vertex AI-provided images for Tensorflow.
"modality": "A String", # Modality of the feature. Valid values are: numeric, image. Defaults to numeric.
"visualization": { # Visualization configurations for image explanation. # Visualization configurations for image explanation.
"clipPercentLowerbound": 3.14, # Excludes attributions below the specified percentile, from the highlighted areas. Defaults to 62.
"clipPercentUpperbound": 3.14, # Excludes attributions above the specified percentile from the highlighted areas. Using the clip_percent_upperbound and clip_percent_lowerbound together can be useful for filtering out noise and making it easier to see areas of strong attribution. Defaults to 99.9.
"colorMap": "A String", # The color scheme used for the highlighted areas. Defaults to PINK_GREEN for Integrated Gradients attribution, which shows positive attributions in green and negative in pink. Defaults to VIRIDIS for XRAI attribution, which highlights the most influential regions in yellow and the least influential in blue.
"overlayType": "A String", # How the original image is displayed in the visualization. Adjusting the overlay can help increase visual clarity if the original image makes it difficult to view the visualization. Defaults to NONE.
"polarity": "A String", # Whether to only highlight pixels with positive contributions, negative or both. Defaults to POSITIVE.
"type": "A String", # Type of the image visualization. Only applicable to Integrated Gradients attribution. OUTLINES shows regions of attribution, while PIXELS shows per-pixel attribution. Defaults to OUTLINES.
},
},
},
"latentSpaceSource": "A String", # Name of the source to generate embeddings for example based explanations.
"outputs": { # Required. Map from output names to output metadata. For Vertex AI-provided Tensorflow images, keys can be any user defined string that consists of any UTF-8 characters. For custom images, keys are the name of the output field in the prediction to be explained. Currently only one key is allowed.
"a_key": { # Metadata of the prediction output to be explained.
"displayNameMappingKey": "A String", # Specify a field name in the prediction to look for the display name. Use this if the prediction contains the display names for the outputs. The display names in the prediction must have the same shape of the outputs, so that it can be located by Attribution.output_index for a specific output.
"indexDisplayNameMapping": "", # Static mapping between the index and display name. Use this if the outputs are a deterministic n-dimensional array, e.g. a list of scores of all the classes in a pre-defined order for a multi-classification Model. It's not feasible if the outputs are non-deterministic, e.g. the Model produces top-k classes or sort the outputs by their values. The shape of the value must be an n-dimensional array of strings. The number of dimensions must match that of the outputs to be explained. The Attribution.output_display_name is populated by locating in the mapping with Attribution.output_index.
"outputTensorName": "A String", # Name of the output tensor. Required and is only applicable to Vertex AI provided images for Tensorflow.
},
},
},
"parameters": { # Parameters to configure explaining for Model's predictions. # Required. Parameters that configure explaining of the Model's predictions.
"examples": { # Example-based explainability that returns the nearest neighbors from the provided dataset. # Example-based explanations that returns the nearest neighbors from the provided dataset.
"exampleGcsSource": { # The Cloud Storage input instances. # The Cloud Storage input instances.
"dataFormat": "A String", # The format in which instances are given, if not specified, assume it's JSONL format. Currently only JSONL format is supported.
"gcsSource": { # The Google Cloud Storage location for the input content. # The Cloud Storage location for the input instances.
"uris": [ # Required. Google Cloud Storage URI(-s) to the input file(s). May contain wildcards. For more information on wildcards, see https://cloud.google.com/storage/docs/gsutil/addlhelp/WildcardNames.
"A String",
],
},
},
"gcsSource": { # The Google Cloud Storage location for the input content. # The Cloud Storage locations that contain the instances to be indexed for approximate nearest neighbor search.
"uris": [ # Required. Google Cloud Storage URI(-s) to the input file(s). May contain wildcards. For more information on wildcards, see https://cloud.google.com/storage/docs/gsutil/addlhelp/WildcardNames.
"A String",
],
},
"nearestNeighborSearchConfig": "", # The full configuration for the generated index, the semantics are the same as metadata and should match [NearestNeighborSearchConfig](https://cloud.google.com/vertex-ai/docs/explainable-ai/configuring-explanations-example-based#nearest-neighbor-search-config).
"neighborCount": 42, # The number of neighbors to return when querying for examples.
"presets": { # Preset configuration for example-based explanations # Simplified preset configuration, which automatically sets configuration values based on the desired query speed-precision trade-off and modality.
"modality": "A String", # The modality of the uploaded model, which automatically configures the distance measurement and feature normalization for the underlying example index and queries. If your model does not precisely fit one of these types, it is okay to choose the closest type.
"query": "A String", # Preset option controlling parameters for speed-precision trade-off when querying for examples. If omitted, defaults to `PRECISE`.
},
},
"integratedGradientsAttribution": { # An attribution method that computes the Aumann-Shapley value taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1703.01365 # An attribution method that computes Aumann-Shapley values taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1703.01365
"blurBaselineConfig": { # Config for blur baseline. When enabled, a linear path from the maximally blurred image to the input image is created. Using a blurred baseline instead of zero (black image) is motivated by the BlurIG approach explained here: https://arxiv.org/abs/2004.03383 # Config for IG with blur baseline. When enabled, a linear path from the maximally blurred image to the input image is created. Using a blurred baseline instead of zero (black image) is motivated by the BlurIG approach explained here: https://arxiv.org/abs/2004.03383
"maxBlurSigma": 3.14, # The standard deviation of the blur kernel for the blurred baseline. The same blurring parameter is used for both the height and the width dimension. If not set, the method defaults to the zero (i.e. black for images) baseline.
},
"smoothGradConfig": { # Config for SmoothGrad approximation of gradients. When enabled, the gradients are approximated by averaging the gradients from noisy samples in the vicinity of the inputs. Adding noise can help improve the computed gradients. Refer to this paper for more details: https://arxiv.org/pdf/1706.03825.pdf # Config for SmoothGrad approximation of gradients. When enabled, the gradients are approximated by averaging the gradients from noisy samples in the vicinity of the inputs. Adding noise can help improve the computed gradients. Refer to this paper for more details: https://arxiv.org/pdf/1706.03825.pdf
"featureNoiseSigma": { # Noise sigma by features. Noise sigma represents the standard deviation of the gaussian kernel that will be used to add noise to interpolated inputs prior to computing gradients. # This is similar to noise_sigma, but provides additional flexibility. A separate noise sigma can be provided for each feature, which is useful if their distributions are different. No noise is added to features that are not set. If this field is unset, noise_sigma will be used for all features.
"noiseSigma": [ # Noise sigma per feature. No noise is added to features that are not set.
{ # Noise sigma for a single feature.
"name": "A String", # The name of the input feature for which noise sigma is provided. The features are defined in explanation metadata inputs.
"sigma": 3.14, # This represents the standard deviation of the Gaussian kernel that will be used to add noise to the feature prior to computing gradients. Similar to noise_sigma but represents the noise added to the current feature. Defaults to 0.1.
},
],
},
"noiseSigma": 3.14, # This is a single float value and will be used to add noise to all the features. Use this field when all features are normalized to have the same distribution: scale to range [0, 1], [-1, 1] or z-scoring, where features are normalized to have 0-mean and 1-variance. Learn more about [normalization](https://developers.google.com/machine-learning/data-prep/transform/normalization). For best results the recommended value is about 10% - 20% of the standard deviation of the input feature. Refer to section 3.2 of the SmoothGrad paper: https://arxiv.org/pdf/1706.03825.pdf. Defaults to 0.1. If the distribution is different per feature, set feature_noise_sigma instead for each feature.
"noisySampleCount": 42, # The number of gradient samples to use for approximation. The higher this number, the more accurate the gradient is, but the runtime complexity increases by this factor as well. Valid range of its value is [1, 50]. Defaults to 3.
},
"stepCount": 42, # Required. The number of steps for approximating the path integral. A good value to start is 50 and gradually increase until the sum to diff property is within the desired error range. Valid range of its value is [1, 100], inclusively.
},
"outputIndices": [ # If populated, only returns attributions that have output_index contained in output_indices. It must be an ndarray of integers, with the same shape of the output it's explaining. If not populated, returns attributions for top_k indices of outputs. If neither top_k nor output_indices is populated, returns the argmax index of the outputs. Only applicable to Models that predict multiple outputs (e,g, multi-class Models that predict multiple classes).
"",
],
"sampledShapleyAttribution": { # An attribution method that approximates Shapley values for features that contribute to the label being predicted. A sampling strategy is used to approximate the value rather than considering all subsets of features. # An attribution method that approximates Shapley values for features that contribute to the label being predicted. A sampling strategy is used to approximate the value rather than considering all subsets of features. Refer to this paper for model details: https://arxiv.org/abs/1306.4265.
"pathCount": 42, # Required. The number of feature permutations to consider when approximating the Shapley values. Valid range of its value is [1, 50], inclusively.
},
"topK": 42, # If populated, returns attributions for top K indices of outputs (defaults to 1). Only applies to Models that predicts more than one outputs (e,g, multi-class Models). When set to -1, returns explanations for all outputs.
"xraiAttribution": { # An explanation method that redistributes Integrated Gradients attributions to segmented regions, taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1906.02825 Supported only by image Models. # An attribution method that redistributes Integrated Gradients attribution to segmented regions, taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1906.02825 XRAI currently performs better on natural images, like a picture of a house or an animal. If the images are taken in artificial environments, like a lab or manufacturing line, or from diagnostic equipment, like x-rays or quality-control cameras, use Integrated Gradients instead.
"blurBaselineConfig": { # Config for blur baseline. When enabled, a linear path from the maximally blurred image to the input image is created. Using a blurred baseline instead of zero (black image) is motivated by the BlurIG approach explained here: https://arxiv.org/abs/2004.03383 # Config for XRAI with blur baseline. When enabled, a linear path from the maximally blurred image to the input image is created. Using a blurred baseline instead of zero (black image) is motivated by the BlurIG approach explained here: https://arxiv.org/abs/2004.03383
"maxBlurSigma": 3.14, # The standard deviation of the blur kernel for the blurred baseline. The same blurring parameter is used for both the height and the width dimension. If not set, the method defaults to the zero (i.e. black for images) baseline.
},
"smoothGradConfig": { # Config for SmoothGrad approximation of gradients. When enabled, the gradients are approximated by averaging the gradients from noisy samples in the vicinity of the inputs. Adding noise can help improve the computed gradients. Refer to this paper for more details: https://arxiv.org/pdf/1706.03825.pdf # Config for SmoothGrad approximation of gradients. When enabled, the gradients are approximated by averaging the gradients from noisy samples in the vicinity of the inputs. Adding noise can help improve the computed gradients. Refer to this paper for more details: https://arxiv.org/pdf/1706.03825.pdf
"featureNoiseSigma": { # Noise sigma by features. Noise sigma represents the standard deviation of the gaussian kernel that will be used to add noise to interpolated inputs prior to computing gradients. # This is similar to noise_sigma, but provides additional flexibility. A separate noise sigma can be provided for each feature, which is useful if their distributions are different. No noise is added to features that are not set. If this field is unset, noise_sigma will be used for all features.
"noiseSigma": [ # Noise sigma per feature. No noise is added to features that are not set.
{ # Noise sigma for a single feature.
"name": "A String", # The name of the input feature for which noise sigma is provided. The features are defined in explanation metadata inputs.
"sigma": 3.14, # This represents the standard deviation of the Gaussian kernel that will be used to add noise to the feature prior to computing gradients. Similar to noise_sigma but represents the noise added to the current feature. Defaults to 0.1.
},
],
},
"noiseSigma": 3.14, # This is a single float value and will be used to add noise to all the features. Use this field when all features are normalized to have the same distribution: scale to range [0, 1], [-1, 1] or z-scoring, where features are normalized to have 0-mean and 1-variance. Learn more about [normalization](https://developers.google.com/machine-learning/data-prep/transform/normalization). For best results the recommended value is about 10% - 20% of the standard deviation of the input feature. Refer to section 3.2 of the SmoothGrad paper: https://arxiv.org/pdf/1706.03825.pdf. Defaults to 0.1. If the distribution is different per feature, set feature_noise_sigma instead for each feature.
"noisySampleCount": 42, # The number of gradient samples to use for approximation. The higher this number, the more accurate the gradient is, but the runtime complexity increases by this factor as well. Valid range of its value is [1, 50]. Defaults to 3.
},
"stepCount": 42, # Required. The number of steps for approximating the path integral. A good value to start is 50 and gradually increase until the sum to diff property is met within the desired error range. Valid range of its value is [1, 100], inclusively.
},
},
},
"tabularObjective": { # Tabular monitoring objective. # Tabular monitoring objective.
"featureAttributionSpec": { # Feature attribution monitoring spec. # Feature attribution monitoring spec.
"batchExplanationDedicatedResources": { # A description of resources that are used for performing batch operations, are dedicated to a Model, and need manual configuration. # The config of resources used by the Model Monitoring during the batch explanation for non-AutoML models. If not set, `n1-standard-2` machine type will be used by default.
"machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine.
"acceleratorCount": 42, # The number of accelerators to attach to the machine.
"acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count.
"machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required.
"reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation.
"key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value.
"reservationAffinityType": "A String", # Required. Specifies the reservation affinity type.
"values": [ # Optional. Corresponds to the label values of a reservation resource. This must be the full resource name of the reservation.
"A String",
],
},
"tpuTopology": "A String", # Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1").
},
"maxReplicaCount": 42, # Immutable. The maximum number of machine replicas the batch operation may be scaled to. The default value is 10.
"startingReplicaCount": 42, # Immutable. The number of machine replicas used at the start of the batch operation. If not set, Vertex AI decides starting number, not greater than max_replica_count
},
"defaultAlertCondition": { # Monitoring alert triggered condition. # Default alert condition for all the features.
"threshold": 3.14, # A condition that compares a stats value against a threshold. Alert will be triggered if value above the threshold.
},
"featureAlertConditions": { # Per feature alert condition will override default alert condition.
"a_key": { # Monitoring alert triggered condition.
"threshold": 3.14, # A condition that compares a stats value against a threshold. Alert will be triggered if value above the threshold.
},
},
"features": [ # Feature names interested in monitoring. These should be a subset of the input feature names specified in the monitoring schema. If the field is not specified all features outlied in the monitoring schema will be used.
"A String",
],
},
"featureDriftSpec": { # Data drift monitoring spec. Data drift measures the distribution distance between the current dataset and a baseline dataset. A typical use case is to detect data drift between the recent production serving dataset and the training dataset, or to compare the recent production dataset with a dataset from a previous period. # Input feature distribution drift monitoring spec.
"categoricalMetricType": "A String", # Supported metrics type: * l_infinity * jensen_shannon_divergence
"defaultCategoricalAlertCondition": { # Monitoring alert triggered condition. # Default alert condition for all the categorical features.
"threshold": 3.14, # A condition that compares a stats value against a threshold. Alert will be triggered if value above the threshold.
},
"defaultNumericAlertCondition": { # Monitoring alert triggered condition. # Default alert condition for all the numeric features.
"threshold": 3.14, # A condition that compares a stats value against a threshold. Alert will be triggered if value above the threshold.
},
"featureAlertConditions": { # Per feature alert condition will override default alert condition.
"a_key": { # Monitoring alert triggered condition.
"threshold": 3.14, # A condition that compares a stats value against a threshold. Alert will be triggered if value above the threshold.
},
},
"features": [ # Feature names / Prediction output names interested in monitoring. These should be a subset of the input feature names or prediction output names specified in the monitoring schema. If the field is not specified all features / prediction outputs outlied in the monitoring schema will be used.
"A String",
],
"numericMetricType": "A String", # Supported metrics type: * jensen_shannon_divergence
},
"predictionOutputDriftSpec": { # Data drift monitoring spec. Data drift measures the distribution distance between the current dataset and a baseline dataset. A typical use case is to detect data drift between the recent production serving dataset and the training dataset, or to compare the recent production dataset with a dataset from a previous period. # Prediction output distribution drift monitoring spec.
"categoricalMetricType": "A String", # Supported metrics type: * l_infinity * jensen_shannon_divergence
"defaultCategoricalAlertCondition": { # Monitoring alert triggered condition. # Default alert condition for all the categorical features.
"threshold": 3.14, # A condition that compares a stats value against a threshold. Alert will be triggered if value above the threshold.
},
"defaultNumericAlertCondition": { # Monitoring alert triggered condition. # Default alert condition for all the numeric features.
"threshold": 3.14, # A condition that compares a stats value against a threshold. Alert will be triggered if value above the threshold.
},
"featureAlertConditions": { # Per feature alert condition will override default alert condition.
"a_key": { # Monitoring alert triggered condition.
"threshold": 3.14, # A condition that compares a stats value against a threshold. Alert will be triggered if value above the threshold.
},
},
"features": [ # Feature names / Prediction output names interested in monitoring. These should be a subset of the input feature names or prediction output names specified in the monitoring schema. If the field is not specified all features / prediction outputs outlied in the monitoring schema will be used.
"A String",
],
"numericMetricType": "A String", # Supported metrics type: * jensen_shannon_divergence
},
},
"targetDataset": { # Model monitoring data input spec. # Target dataset.
"batchPredictionOutput": { # Data from Vertex AI Batch prediction job output. # Vertex AI Batch prediction Job.
"batchPredictionJob": "A String", # Vertex AI Batch prediction job resource name. The job must match the model version specified in [ModelMonitor].[model_monitoring_target].
},
"columnizedDataset": { # Input dataset spec. # Columnized dataset.
"bigquerySource": { # Dataset spec for data sotred in BigQuery. # BigQuery data source.
"query": "A String", # Standard SQL to be used instead of the `table_uri`.
"tableUri": "A String", # BigQuery URI to a table, up to 2000 characters long. All the columns in the table will be selected. Accepted forms: * BigQuery path. For example: `bq://projectId.bqDatasetId.bqTableId`.
},
"gcsSource": { # Dataset spec for data stored in Google Cloud Storage. # Google Cloud Storage data source.
"format": "A String", # Data format of the dataset.
"gcsUri": "A String", # Google Cloud Storage URI to the input file(s). May contain wildcards. For more information on wildcards, see https://cloud.google.com/storage/docs/gsutil/addlhelp/WildcardNames.
},
"timestampField": "A String", # The timestamp field. Usually for serving data.
"vertexDataset": "A String", # Resource name of the Vertex AI managed dataset.
},
"timeInterval": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # The time interval (pair of start_time and end_time) for which results should be returned.
"endTime": "A String", # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
"startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
},
"timeOffset": { # Time offset setting. # The time offset setting for which results should be returned.
"offset": "A String", # [offset] is the time difference from the cut-off time. For scheduled jobs, the cut-off time is the scheduled time. For non-scheduled jobs, it's the time when the job was created. Currently we support the following format: 'w|W': Week, 'd|D': Day, 'h|H': Hour E.g. '1h' stands for 1 hour, '2d' stands for 2 days.
"window": "A String", # [window] refers to the scope of data selected for analysis. It allows you to specify the quantity of data you wish to examine. Currently we support the following format: 'w|W': Week, 'd|D': Day, 'h|H': Hour E.g. '1h' stands for 1 hour, '2d' stands for 2 days.
},
"vertexEndpointLogs": { # Data from Vertex AI Endpoint request response logging. # Vertex AI Endpoint request & response logging.
"endpoints": [ # List of endpoint resource names. The endpoints must enable the logging with the [Endpoint].[request_response_logging_config], and must contain the deployed model corresponding to the model version specified in [ModelMonitor].[model_monitoring_target].
"A String",
],
},
},
},
"outputSpec": { # Specification for the export destination of monitoring results, including metrics, logs, etc. # The Output destination spec for metrics, error logs, etc.
"gcsBaseDirectory": { # The Google Cloud Storage location where the output is to be written to. # Google Cloud Storage base folder path for metrics, error logs, etc.
"outputUriPrefix": "A String", # Required. Google Cloud Storage URI to output directory. If the uri doesn't end with '/', a '/' will be automatically appended. The directory is created if it doesn't exist.
},
},
},
"name": "A String", # Output only. Resource name of a ModelMonitoringJob. Format: `projects/{project_id}/locations/{location_id}/modelMonitors/{model_monitor_id}/modelMonitoringJobs/{model_monitoring_job_id}`
"schedule": "A String", # Output only. Schedule resource name. It will only appear when this job is triggered by a schedule.
"scheduleTime": "A String", # Output only. Timestamp when this ModelMonitoringJob was scheduled. It will only appear when this job is triggered by a schedule.
"state": "A String", # Output only. The state of the monitoring job. * When the job is still creating, the state will be 'JOB_STATE_PENDING'. * Once the job is successfully created, the state will be 'JOB_STATE_RUNNING'. * Once the job is finished, the state will be one of 'JOB_STATE_FAILED', 'JOB_STATE_SUCCEEDED', 'JOB_STATE_PARTIALLY_SUCCEEDED'.
"updateTime": "A String", # Output only. Timestamp when this ModelMonitoringJob was updated most recently.
},
"modelMonitoringJobId": "A String", # Optional. The ID to use for the Model Monitoring Job, which will become the final component of the model monitoring job resource name. The maximum length is 63 characters, and valid characters are `/^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$/`.
"parent": "A String", # Required. The parent of the ModelMonitoringJob. Format: `projects/{project}/locations/{location}/modelMoniitors/{model_monitor}`
},
"createNotebookExecutionJobRequest": { # Request message for [NotebookService.CreateNotebookExecutionJob] # Request for NotebookService.CreateNotebookExecutionJob.
"notebookExecutionJob": { # NotebookExecutionJob represents an instance of a notebook execution. # Required. The NotebookExecutionJob to create.
"createTime": "A String", # Output only. Timestamp when this NotebookExecutionJob was created.
"customEnvironmentSpec": { # Compute configuration to use for an execution job. # The custom compute configuration for an execution job.
"machineSpec": { # Specification of a single machine. # The specification of a single machine for the execution job.
"acceleratorCount": 42, # The number of accelerators to attach to the machine.
"acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count.
"machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required.
"reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation.
"key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value.
"reservationAffinityType": "A String", # Required. Specifies the reservation affinity type.
"values": [ # Optional. Corresponds to the label values of a reservation resource. This must be the full resource name of the reservation.
"A String",
],
},
"tpuTopology": "A String", # Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1").
},
"networkSpec": { # Network spec. # The network configuration to use for the execution job.
"enableInternetAccess": True or False, # Whether to enable public internet access. Default false.
"network": "A String", # The full name of the Google Compute Engine [network](https://cloud.google.com//compute/docs/networks-and-firewalls#networks)
"subnetwork": "A String", # The name of the subnet that this instance is in. Format: `projects/{project_id_or_number}/regions/{region}/subnetworks/{subnetwork_id}`
},
"persistentDiskSpec": { # Represents the spec of persistent disk options. # The specification of a persistent disk to attach for the execution job.
"diskSizeGb": "A String", # Size in GB of the disk (default is 100GB).
"diskType": "A String", # Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) "pd-extreme" (Extreme Persistent Disk)
},
},
"dataformRepositorySource": { # The Dataform Repository containing the input notebook. # The Dataform Repository pointing to a single file notebook repository.
"commitSha": "A String", # The commit SHA to read repository with. If unset, the file will be read at HEAD.
"dataformRepositoryResourceName": "A String", # The resource name of the Dataform Repository. Format: `projects/{project_id}/locations/{location}/repositories/{repository_id}`
},
"directNotebookSource": { # The content of the input notebook in ipynb format. # The contents of an input notebook file.
"content": "A String", # The base64-encoded contents of the input notebook file.
},
"displayName": "A String", # The display name of the NotebookExecutionJob. The name can be up to 128 characters long and can consist of any UTF-8 characters.
"encryptionSpec": { # Represents a customer-managed encryption key spec that can be applied to a top-level resource. # Customer-managed encryption key spec for the notebook execution job. This field is auto-populated if the NotebookService.NotebookRuntimeTemplate has an encryption spec.
"kmsKeyName": "A String", # Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. The key needs to be in the same region as where the compute resource is created.
},
"executionTimeout": "A String", # Max running time of the execution job in seconds (default 86400s / 24 hrs).
"executionUser": "A String", # The user email to run the execution as. Only supported by Colab runtimes.
"gcsNotebookSource": { # The Cloud Storage uri for the input notebook. # The Cloud Storage url pointing to the ipynb file. Format: `gs://bucket/notebook_file.ipynb`
"generation": "A String", # The version of the Cloud Storage object to read. If unset, the current version of the object is read. See https://cloud.google.com/storage/docs/metadata#generation-number.
"uri": "A String", # The Cloud Storage uri pointing to the ipynb file. Format: `gs://bucket/notebook_file.ipynb`
},
"gcsOutputUri": "A String", # The Cloud Storage location to upload the result to. Format: `gs://bucket-name`
"jobState": "A String", # Output only. The state of the NotebookExecutionJob.
"labels": { # The labels with user-defined metadata to organize NotebookExecutionJobs. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.
"a_key": "A String",
},
"name": "A String", # Output only. The resource name of this NotebookExecutionJob. Format: `projects/{project_id}/locations/{location}/notebookExecutionJobs/{job_id}`
"notebookRuntimeTemplateResourceName": "A String", # The NotebookRuntimeTemplate to source compute configuration from.
"scheduleResourceName": "A String", # Output only. The Schedule resource name if this job is triggered by one. Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}`
"serviceAccount": "A String", # The service account to run the execution as.
"status": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Populated when the NotebookExecutionJob is completed. When there is an error during notebook execution, the error details are populated.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"updateTime": "A String", # Output only. Timestamp when this NotebookExecutionJob was most recently updated.
},
"notebookExecutionJobId": "A String", # Optional. User specified ID for the NotebookExecutionJob.
"parent": "A String", # Required. The resource name of the Location to create the NotebookExecutionJob. Format: `projects/{project}/locations/{location}`
},
"createPipelineJobRequest": { # Request message for PipelineService.CreatePipelineJob. # Request for PipelineService.CreatePipelineJob. CreatePipelineJobRequest.parent field is required (format: projects/{project}/locations/{location}).
"parent": "A String", # Required. The resource name of the Location to create the PipelineJob in. Format: `projects/{project}/locations/{location}`
"pipelineJob": { # An instance of a machine learning PipelineJob. # Required. The PipelineJob to create.
"createTime": "A String", # Output only. Pipeline creation time.
"displayName": "A String", # The display name of the Pipeline. The name can be up to 128 characters long and can consist of any UTF-8 characters.
"encryptionSpec": { # Represents a customer-managed encryption key spec that can be applied to a top-level resource. # Customer-managed encryption key spec for a pipelineJob. If set, this PipelineJob and all of its sub-resources will be secured by this key.
"kmsKeyName": "A String", # Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. The key needs to be in the same region as where the compute resource is created.
},
"endTime": "A String", # Output only. Pipeline end time.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. The error that occurred during pipeline execution. Only populated when the pipeline's state is FAILED or CANCELLED.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"jobDetail": { # The runtime detail of PipelineJob. # Output only. The details of pipeline run. Not available in the list view.
"pipelineContext": { # Instance of a general context. # Output only. The context of the pipeline.
"createTime": "A String", # Output only. Timestamp when this Context was created.
"description": "A String", # Description of the Context
"displayName": "A String", # User provided display name of the Context. May be up to 128 Unicode characters.
"etag": "A String", # An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
"labels": { # The labels with user-defined metadata to organize your Contexts. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Context (System labels are excluded).
"a_key": "A String",
},
"metadata": { # Properties of the Context. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB.
"a_key": "", # Properties of the object.
},
"name": "A String", # Immutable. The resource name of the Context.
"parentContexts": [ # Output only. A list of resource names of Contexts that are parents of this Context. A Context may have at most 10 parent_contexts.
"A String",
],
"schemaTitle": "A String", # The title of the schema describing the metadata. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"schemaVersion": "A String", # The version of the schema in schema_name to use. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"updateTime": "A String", # Output only. Timestamp when this Context was last updated.
},
"pipelineRunContext": { # Instance of a general context. # Output only. The context of the current pipeline run.
"createTime": "A String", # Output only. Timestamp when this Context was created.
"description": "A String", # Description of the Context
"displayName": "A String", # User provided display name of the Context. May be up to 128 Unicode characters.
"etag": "A String", # An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
"labels": { # The labels with user-defined metadata to organize your Contexts. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Context (System labels are excluded).
"a_key": "A String",
},
"metadata": { # Properties of the Context. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB.
"a_key": "", # Properties of the object.
},
"name": "A String", # Immutable. The resource name of the Context.
"parentContexts": [ # Output only. A list of resource names of Contexts that are parents of this Context. A Context may have at most 10 parent_contexts.
"A String",
],
"schemaTitle": "A String", # The title of the schema describing the metadata. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"schemaVersion": "A String", # The version of the schema in schema_name to use. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"updateTime": "A String", # Output only. Timestamp when this Context was last updated.
},
"taskDetails": [ # Output only. The runtime details of the tasks under the pipeline.
{ # The runtime detail of a task execution.
"createTime": "A String", # Output only. Task create time.
"endTime": "A String", # Output only. Task end time.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. The error that occurred during task execution. Only populated when the task's state is FAILED or CANCELLED.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"execution": { # Instance of a general execution. # Output only. The execution metadata of the task.
"createTime": "A String", # Output only. Timestamp when this Execution was created.
"description": "A String", # Description of the Execution
"displayName": "A String", # User provided display name of the Execution. May be up to 128 Unicode characters.
"etag": "A String", # An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
"labels": { # The labels with user-defined metadata to organize your Executions. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Execution (System labels are excluded).
"a_key": "A String",
},
"metadata": { # Properties of the Execution. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB.
"a_key": "", # Properties of the object.
},
"name": "A String", # Output only. The resource name of the Execution.
"schemaTitle": "A String", # The title of the schema describing the metadata. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"schemaVersion": "A String", # The version of the schema in `schema_title` to use. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"state": "A String", # The state of this Execution. This is a property of the Execution, and does not imply or capture any ongoing process. This property is managed by clients (such as Vertex AI Pipelines) and the system does not prescribe or check the validity of state transitions.
"updateTime": "A String", # Output only. Timestamp when this Execution was last updated.
},
"executorDetail": { # The runtime detail of a pipeline executor. # Output only. The detailed execution info.
"containerDetail": { # The detail of a container execution. It contains the job names of the lifecycle of a container execution. # Output only. The detailed info for a container executor.
"failedMainJobs": [ # Output only. The names of the previously failed CustomJob for the main container executions. The list includes the all attempts in chronological order.
"A String",
],
"failedPreCachingCheckJobs": [ # Output only. The names of the previously failed CustomJob for the pre-caching-check container executions. This job will be available if the PipelineJob.pipeline_spec specifies the `pre_caching_check` hook in the lifecycle events. The list includes the all attempts in chronological order.
"A String",
],
"mainJob": "A String", # Output only. The name of the CustomJob for the main container execution.
"preCachingCheckJob": "A String", # Output only. The name of the CustomJob for the pre-caching-check container execution. This job will be available if the PipelineJob.pipeline_spec specifies the `pre_caching_check` hook in the lifecycle events.
},
"customJobDetail": { # The detailed info for a custom job executor. # Output only. The detailed info for a custom job executor.
"failedJobs": [ # Output only. The names of the previously failed CustomJob. The list includes the all attempts in chronological order.
"A String",
],
"job": "A String", # Output only. The name of the CustomJob.
},
},
"inputs": { # Output only. The runtime input artifacts of the task.
"a_key": { # A list of artifact metadata.
"artifacts": [ # Output only. A list of artifact metadata.
{ # Instance of a general artifact.
"createTime": "A String", # Output only. Timestamp when this Artifact was created.
"description": "A String", # Description of the Artifact
"displayName": "A String", # User provided display name of the Artifact. May be up to 128 Unicode characters.
"etag": "A String", # An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
"labels": { # The labels with user-defined metadata to organize your Artifacts. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Artifact (System labels are excluded).
"a_key": "A String",
},
"metadata": { # Properties of the Artifact. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB.
"a_key": "", # Properties of the object.
},
"name": "A String", # Output only. The resource name of the Artifact.
"schemaTitle": "A String", # The title of the schema describing the metadata. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"schemaVersion": "A String", # The version of the schema in schema_name to use. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"state": "A String", # The state of this Artifact. This is a property of the Artifact, and does not imply or capture any ongoing process. This property is managed by clients (such as Vertex AI Pipelines), and the system does not prescribe or check the validity of state transitions.
"updateTime": "A String", # Output only. Timestamp when this Artifact was last updated.
"uri": "A String", # The uniform resource identifier of the artifact file. May be empty if there is no actual artifact file.
},
],
},
},
"outputs": { # Output only. The runtime output artifacts of the task.
"a_key": { # A list of artifact metadata.
"artifacts": [ # Output only. A list of artifact metadata.
{ # Instance of a general artifact.
"createTime": "A String", # Output only. Timestamp when this Artifact was created.
"description": "A String", # Description of the Artifact
"displayName": "A String", # User provided display name of the Artifact. May be up to 128 Unicode characters.
"etag": "A String", # An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
"labels": { # The labels with user-defined metadata to organize your Artifacts. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Artifact (System labels are excluded).
"a_key": "A String",
},
"metadata": { # Properties of the Artifact. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB.
"a_key": "", # Properties of the object.
},
"name": "A String", # Output only. The resource name of the Artifact.
"schemaTitle": "A String", # The title of the schema describing the metadata. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"schemaVersion": "A String", # The version of the schema in schema_name to use. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
"state": "A String", # The state of this Artifact. This is a property of the Artifact, and does not imply or capture any ongoing process. This property is managed by clients (such as Vertex AI Pipelines), and the system does not prescribe or check the validity of state transitions.
"updateTime": "A String", # Output only. Timestamp when this Artifact was last updated.
"uri": "A String", # The uniform resource identifier of the artifact file. May be empty if there is no actual artifact file.
},
],
},
},
"parentTaskId": "A String", # Output only. The id of the parent task if the task is within a component scope. Empty if the task is at the root level.
"pipelineTaskStatus": [ # Output only. A list of task status. This field keeps a record of task status evolving over time.
{ # A single record of the task status.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # 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.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"state": "A String", # Output only. The state of the task.
"updateTime": "A String", # Output only. Update time of this status.
},
],
"startTime": "A String", # Output only. Task start time.
"state": "A String", # Output only. State of the task.
"taskId": "A String", # Output only. The system generated ID of the task.
"taskName": "A String", # Output only. The user specified name of the task that is defined in pipeline_spec.
},
],
},
"labels": { # The labels with user-defined metadata to organize PipelineJob. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. Note there is some reserved label key for Vertex AI Pipelines. - `vertex-ai-pipelines-run-billing-id`, user set value will get overrided.
"a_key": "A String",
},
"name": "A String", # Output only. The resource name of the PipelineJob.
"network": "A String", # The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the Pipeline Job's workload should be peered. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. Private services access must already be configured for the network. Pipeline job will apply the network configuration to the Google Cloud resources being launched, if applied, such as Vertex AI Training or Dataflow job. If left unspecified, the workload is not peered with any network.
"originalPipelineJobId": "A String", # Optional. The original pipeline job id if this pipeline job is a rerun of a previous pipeline job.
"pipelineSpec": { # The spec of the pipeline.
"a_key": "", # Properties of the object.
},
"pipelineTaskRerunConfigs": [ # Optional. The rerun configs for each task in the pipeline job. By default, the rerun will: 1. Use the same input artifacts as the original run. 2. Use the same input parameters as the original run. 3. Skip all the tasks that are already succeeded in the original run. 4. Rerun all the tasks that are not succeeded in the original run. By providing this field, users can override the default behavior and specify the rerun config for each task.
{ # User provided rerun config to submit a rerun pipelinejob. This includes 1. Which task to rerun 2. User override input parameters and artifacts.
"inputs": { # Runtime inputs data of the task. # Optional. The runtime input of the task overridden by the user.
"artifacts": { # Optional. Input artifacts.
"a_key": { # A list of artifact metadata.
"artifacts": [ # Optional. A list of artifact metadata.
{ # The definition of a runtime artifact.
"customProperties": { # The custom properties of the artifact. Deprecated. Use RuntimeArtifact.metadata instead.
"a_key": { # Value is the value of the field.
"doubleValue": 3.14, # A double value.
"intValue": "A String", # An integer value.
"stringValue": "A String", # A string value.
},
},
"metadata": { # Properties of the Artifact.
"a_key": "", # Properties of the object.
},
"name": "A String", # The name of an artifact.
"properties": { # The properties of the artifact. Deprecated. Use RuntimeArtifact.metadata instead.
"a_key": { # Value is the value of the field.
"doubleValue": 3.14, # A double value.
"intValue": "A String", # An integer value.
"stringValue": "A String", # A string value.
},
},
"type": { # The definition of a artifact type in MLMD. # The type of the artifact.
"instanceSchema": "A String", # Contains a raw YAML string, describing the format of the properties of the type.
"schemaTitle": "A String", # The name of the type. The format of the title must be: `.`. Examples: - `aiplatform.Model` - `acme.CustomModel` When this field is set, the type must be pre-registered in the MLMD store.
"schemaUri": "A String", # Points to a YAML file stored on Cloud Storage describing the format. Deprecated. Use PipelineArtifactTypeSchema.schema_title or PipelineArtifactTypeSchema.instance_schema instead.
"schemaVersion": "A String", # The schema version of the artifact. If the value is not set, it defaults to the latest version in the system.
},
"uri": "A String", # The URI of the artifact.
},
],
},
},
"parameterValues": { # Optional. Input parameters.
"a_key": "",
},
},
"skipDownstreamTasks": True or False, # Optional. Whether to skip downstream tasks. Default value is False.
"skipTask": True or False, # Optional. Whether to skip this task. Default value is False.
"taskId": "A String", # Optional. The system generated ID of the task. Retrieved from original run.
"taskName": "A String", # Optional. The name of the task.
},
],
"preflightValidations": True or False, # Optional. Whether to do component level validations before job creation.
"pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I for PipelineJob.
"networkAttachment": "A String", # Optional. The name of the Compute Engine [network attachment](https://cloud.google.com/vpc/docs/about-network-attachments) to attach to the resource within the region and user project. To specify this field, you must have already [created a network attachment] (https://cloud.google.com/vpc/docs/create-manage-network-attachments#create-network-attachments). This field is only used for resources using PSC-I.
},
"reservedIpRanges": [ # A list of names for the reserved ip ranges under the VPC network that can be used for this Pipeline Job's workload. If set, we will deploy the Pipeline Job's workload within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network. Example: ['vertex-ai-ip-range'].
"A String",
],
"runtimeConfig": { # The runtime config of a PipelineJob. # Runtime config of the pipeline.
"defaultRuntime": { # The default runtime for the PipelineJob. # Optional. The default runtime for the PipelineJob. If not provided, Vertex Custom Job(on demand) is used as the runtime. For Vertex Custom Job, please refer to https://cloud.google.com/vertex-ai/docs/training/overview.
"persistentResourceRuntimeDetail": { # Persistent resource based runtime detail. For more information, refer to https://cloud.google.com/vertex-ai/docs/training/persistent-resource-overview # Persistent resource based runtime detail.
"persistentResourceName": "A String", # Persistent resource name. Format: `projects/{project}/locations/{location}/persistentResources/{persistent_resource}`
"taskResourceUnavailableTimeoutBehavior": "A String", # Specifies the behavior to take if the timeout is reached.
"taskResourceUnavailableWaitTimeMs": "A String", # The max time a pipeline task waits for the required CPU, memory, or accelerator resource to become available from the specified persistent resource. Default wait time is 0.
},
},
"failurePolicy": "A String", # Represents the failure policy of a pipeline. Currently, the default of a pipeline is that the pipeline will continue to run until no more tasks can be executed, also known as PIPELINE_FAILURE_POLICY_FAIL_SLOW. However, if a pipeline is set to PIPELINE_FAILURE_POLICY_FAIL_FAST, it will stop scheduling any new tasks when a task has failed. Any scheduled tasks will continue to completion.
"gcsOutputDirectory": "A String", # Required. A path in a Cloud Storage bucket, which will be treated as the root output directory of the pipeline. It is used by the system to generate the paths of output artifacts. The artifact paths are generated with a sub-path pattern `{job_id}/{task_id}/{output_key}` under the specified output directory. The service account specified in this pipeline must have the `storage.objects.get` and `storage.objects.create` permissions for this bucket.
"inputArtifacts": { # The runtime artifacts of the PipelineJob. The key will be the input artifact name and the value would be one of the InputArtifact.
"a_key": { # The type of an input artifact.
"artifactId": "A String", # Artifact resource id from MLMD. Which is the last portion of an artifact resource name: `projects/{project}/locations/{location}/metadataStores/default/artifacts/{artifact_id}`. The artifact must stay within the same project, location and default metadatastore as the pipeline.
},
},
"parameterValues": { # The runtime parameters of the PipelineJob. The parameters will be passed into PipelineJob.pipeline_spec to replace the placeholders at runtime. This field is used by pipelines built using `PipelineJob.pipeline_spec.schema_version` 2.1.0, such as pipelines built using Kubeflow Pipelines SDK 1.9 or higher and the v2 DSL.
"a_key": "",
},
"parameters": { # Deprecated. Use RuntimeConfig.parameter_values instead. The runtime parameters of the PipelineJob. The parameters will be passed into PipelineJob.pipeline_spec to replace the placeholders at runtime. This field is used by pipelines built using `PipelineJob.pipeline_spec.schema_version` 2.0.0 or lower, such as pipelines built using Kubeflow Pipelines SDK 1.8 or lower.
"a_key": { # Value is the value of the field.
"doubleValue": 3.14, # A double value.
"intValue": "A String", # An integer value.
"stringValue": "A String", # A string value.
},
},
},
"satisfiesPzi": True or False, # Output only. Reserved for future use.
"satisfiesPzs": True or False, # Output only. Reserved for future use.
"scheduleName": "A String", # Output only. The schedule resource name. Only returned if the Pipeline is created by Schedule API.
"serviceAccount": "A String", # The service account that the pipeline workload runs as. If not specified, the Compute Engine default service account in the project will be used. See https://cloud.google.com/compute/docs/access/service-accounts#default_service_account Users starting the pipeline must have the `iam.serviceAccounts.actAs` permission on this service account.
"startTime": "A String", # Output only. Pipeline start time.
"state": "A String", # Output only. The detailed state of the job.
"templateMetadata": { # Pipeline template metadata if PipelineJob.template_uri is from supported template registry. Currently, the only supported registry is Artifact Registry. # Output only. Pipeline template metadata. Will fill up fields if PipelineJob.template_uri is from supported template registry.
"version": "A String", # The version_name in artifact registry. Will always be presented in output if the PipelineJob.template_uri is from supported template registry. Format is "sha256:abcdef123456...".
},
"templateUri": "A String", # A template uri from where the PipelineJob.pipeline_spec, if empty, will be downloaded. Currently, only uri from Vertex Template Registry & Gallery is supported. Reference to https://cloud.google.com/vertex-ai/docs/pipelines/create-pipeline-template.
"updateTime": "A String", # Output only. Timestamp when this PipelineJob was most recently updated.
},
"pipelineJobId": "A String", # The ID to use for the PipelineJob, which will become the final component of the PipelineJob name. If not provided, an ID will be automatically generated. This value should be less than 128 characters, and valid characters are `/a-z-/`.
},
"createTime": "A String", # Output only. Timestamp when this Schedule was created.
"cron": "A String", # Cron schedule (https://en.wikipedia.org/wiki/Cron) to launch scheduled runs. To explicitly set a timezone to the cron tab, apply a prefix in the cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or "TZ=${IANA_TIME_ZONE}". The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone database. For example, "CRON_TZ=America/New_York 1 * * * *", or "TZ=America/New_York 1 * * * *".
"displayName": "A String", # Required. User provided name of the Schedule. The name can be up to 128 characters long and can consist of any UTF-8 characters.
"endTime": "A String", # Optional. Timestamp after which no new runs can be scheduled. If specified, The schedule will be completed when either end_time is reached or when scheduled_run_count >= max_run_count. If not specified, new runs will keep getting scheduled until this Schedule is paused or deleted. Already scheduled runs will be allowed to complete. Unset if not specified.
"lastPauseTime": "A String", # Output only. Timestamp when this Schedule was last paused. Unset if never paused.
"lastResumeTime": "A String", # Output only. Timestamp when this Schedule was last resumed. Unset if never resumed from pause.
"lastScheduledRunResponse": { # Status of a scheduled run. # Output only. Response of the last scheduled run. This is the response for starting the scheduled requests and not the execution of the operations/jobs created by the requests (if applicable). Unset if no run has been scheduled yet.
"runResponse": "A String", # The response of the scheduled run.
"scheduledRunTime": "A String", # The scheduled run time based on the user-specified schedule.
},
"maxConcurrentRunCount": "A String", # Required. Maximum number of runs that can be started concurrently for this Schedule. This is the limit for starting the scheduled requests and not the execution of the operations/jobs created by the requests (if applicable).
"maxRunCount": "A String", # Optional. Maximum run count of the schedule. If specified, The schedule will be completed when either started_run_count >= max_run_count or when end_time is reached. If not specified, new runs will keep getting scheduled until this Schedule is paused or deleted. Already scheduled runs will be allowed to complete. Unset if not specified.
"name": "A String", # Immutable. The resource name of the Schedule.
"nextRunTime": "A String", # Output only. Timestamp when this Schedule should schedule the next run. Having a next_run_time in the past means the runs are being started behind schedule.
"startTime": "A String", # Optional. Timestamp after which the first run can be scheduled. Default to Schedule create time if not specified.
"startedRunCount": "A String", # Output only. The number of runs started by this schedule.
"state": "A String", # Output only. The state of this Schedule.
"updateTime": "A String", # Output only. Timestamp when this Schedule was updated.
}

pause(name, body=None, x__xgafv=None)

Pauses a Schedule. Will mark Schedule.state to 'PAUSED'. If the schedule is paused, no new runs will be created. Already created runs will NOT be paused or canceled.

Args:
  name: string, Required. The name of the Schedule resource to be paused. Format: `projects/{project}/locations/{location}/schedules/{schedule}` (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for ScheduleService.PauseSchedule.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}

resume(name, body=None, x__xgafv=None)

Resumes a paused Schedule to start scheduling new runs. Will mark Schedule.state to 'ACTIVE'. Only paused Schedule can be resumed. When the Schedule is resumed, new runs will be scheduled starting from the next execution time after the current time based on the time_specification in the Schedule. If Schedule.catchUp is set up true, all missed runs will be scheduled for backfill first.

Args:
  name: string, Required. The name of the Schedule resource to be resumed. Format: `projects/{project}/locations/{location}/schedules/{schedule}` (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for ScheduleService.ResumeSchedule.
  "catchUp": True or False, # Optional. Whether to backfill missed runs when the schedule is resumed from PAUSED state. If set to true, all missed runs will be scheduled. New runs will be scheduled after the backfill is complete. This will also update Schedule.catch_up field. Default to false.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}

Vertex AI API . projects . locations . schedules

Instance Methods

Method Details