Vertex AI API . projects . locations . modelMonitors

close()

Close httplib2 connections.

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

Creates a ModelMonitor.

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

{ # Vertex AI Model Monitoring Service serves as a central hub for the analysis and visualization of data quality and performance related to models. ModelMonitor stands as a top level resource for overseeing your model monitoring tasks.
  "createTime": "A String", # Output only. Timestamp when this ModelMonitor was created.
  "displayName": "A String", # The display name of the ModelMonitor. The name can be up to 128 characters long and can consist of any UTF-8.
  "explanationSpec": { # Specification of Model explanation. # Optional model explanation spec. It is used for feature attribution monitoring.
    "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.
      },
    },
  },
  "modelMonitoringSchema": { # The Model Monitoring Schema definition. # Monitoring Schema is to specify the model's features, prediction outputs and ground truth properties. It is used to extract pertinent data from the dataset and to process features based on their properties. Make sure that the schema aligns with your dataset, if it does not, we will be unable to extract data from the dataset. It is required for most models, but optional for Vertex AI AutoML Tables unless the schem information is not available.
    "featureFields": [ # Feature names of the model. Vertex AI will try to match the features from your dataset as follows: * For 'csv' files, the header names are required, and we will extract the corresponding feature values when the header names align with the feature names. * For 'jsonl' files, we will extract the corresponding feature values if the key names match the feature names. Note: Nested features are not supported, so please ensure your features are flattened. Ensure the feature values are scalar or an array of scalars. * For 'bigquery' dataset, we will extract the corresponding feature values if the column names match the feature names. Note: The column type can be a scalar or an array of scalars. STRUCT or JSON types are not supported. You may use SQL queries to select or aggregate the relevant features from your original table. However, ensure that the 'schema' of the query results meets our requirements. * For the Vertex AI Endpoint Request Response Logging table or Vertex AI Batch Prediction Job results. If the instance_type is an array, ensure that the sequence in feature_fields matches the order of features in the prediction instance. We will match the feature with the array in the order specified in [feature_fields].
      { # Schema field definition.
        "dataType": "A String", # Supported data types are: `float` `integer` `boolean` `string` `categorical`
        "name": "A String", # Field name.
        "repeated": True or False, # Describes if the schema field is an array of given data type.
      },
    ],
    "groundTruthFields": [ # Target /ground truth names of the model.
      { # Schema field definition.
        "dataType": "A String", # Supported data types are: `float` `integer` `boolean` `string` `categorical`
        "name": "A String", # Field name.
        "repeated": True or False, # Describes if the schema field is an array of given data type.
      },
    ],
    "predictionFields": [ # Prediction output names of the model. The requirements are the same as the feature_fields. For AutoML Tables, the prediction output name presented in schema will be: `predicted_{target_column}`, the `target_column` is the one you specified when you train the model. For Prediction output drift analysis: * AutoML Classification, the distribution of the argmax label will be analyzed. * AutoML Regression, the distribution of the value will be analyzed.
      { # Schema field definition.
        "dataType": "A String", # Supported data types are: `float` `integer` `boolean` `string` `categorical`
        "name": "A String", # Field name.
        "repeated": True or False, # Describes if the schema field is an array of given data type.
      },
    ],
  },
  "modelMonitoringTarget": { # The monitoring target refers to the entity that is subject to analysis. e.g. Vertex AI Model version. # The entity that is subject to analysis. Currently only models in Vertex AI Model Registry are supported. If you want to analyze the model which is outside the Vertex AI, you could register a model in Vertex AI Model Registry using just a display name.
    "vertexModel": { # Model in Vertex AI Model Registry. # Model in Vertex AI Model Registry.
      "model": "A String", # Model resource name. Format: projects/{project}/locations/{location}/models/{model}.
      "modelVersionId": "A String", # Model version id.
    },
  },
  "name": "A String", # Immutable. Resource name of the ModelMonitor. Format: `projects/{project}/locations/{location}/modelMonitors/{model_monitor}`.
  "notificationSpec": { # Notification spec(email, notification channel) for model monitoring statistics/alerts. # Optional default notification spec, it can be overridden in the ModelMonitoringJob 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/`
      },
    ],
  },
  "outputSpec": { # Specification for the export destination of monitoring results, including metrics, logs, etc. # Optional default monitoring metrics/logs export spec, it can be overridden in the ModelMonitoringJob output spec. If not specified, a default Google Cloud Storage bucket will be created under your project.
    "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.
    },
  },
  "satisfiesPzi": True or False, # Output only. Reserved for future use.
  "satisfiesPzs": True or False, # Output only. Reserved for future use.
  "tabularObjective": { # Tabular monitoring objective. # Optional default tabular model 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
    },
  },
  "trainingDataset": { # Model monitoring data input spec. # Optional training dataset used to train the model. It can serve as a reference dataset to identify changes in production.
    "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",
      ],
    },
  },
  "updateTime": "A String", # Output only. Timestamp when this ModelMonitor was updated most recently.
}

  modelMonitorId: string, Optional. The ID to use for the Model Monitor, which will become the final component of the model monitor resource name. The maximum length is 63 characters, and valid characters are `/^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$/`.
  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.
  },
}

delete(name, force=None, x__xgafv=None)

Deletes a ModelMonitor.

Args:
  name: string, Required. The name of the ModelMonitor resource to be deleted. Format: `projects/{project}/locations/{location}/modelMonitords/{model_monitor}` (required)
  force: boolean, Optional. Force delete the model monitor with schedules.
  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 ModelMonitor.

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

Returns:
  An object of the form:

    { # Vertex AI Model Monitoring Service serves as a central hub for the analysis and visualization of data quality and performance related to models. ModelMonitor stands as a top level resource for overseeing your model monitoring tasks.
  "createTime": "A String", # Output only. Timestamp when this ModelMonitor was created.
  "displayName": "A String", # The display name of the ModelMonitor. The name can be up to 128 characters long and can consist of any UTF-8.
  "explanationSpec": { # Specification of Model explanation. # Optional model explanation spec. It is used for feature attribution monitoring.
    "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.
      },
    },
  },
  "modelMonitoringSchema": { # The Model Monitoring Schema definition. # Monitoring Schema is to specify the model's features, prediction outputs and ground truth properties. It is used to extract pertinent data from the dataset and to process features based on their properties. Make sure that the schema aligns with your dataset, if it does not, we will be unable to extract data from the dataset. It is required for most models, but optional for Vertex AI AutoML Tables unless the schem information is not available.
    "featureFields": [ # Feature names of the model. Vertex AI will try to match the features from your dataset as follows: * For 'csv' files, the header names are required, and we will extract the corresponding feature values when the header names align with the feature names. * For 'jsonl' files, we will extract the corresponding feature values if the key names match the feature names. Note: Nested features are not supported, so please ensure your features are flattened. Ensure the feature values are scalar or an array of scalars. * For 'bigquery' dataset, we will extract the corresponding feature values if the column names match the feature names. Note: The column type can be a scalar or an array of scalars. STRUCT or JSON types are not supported. You may use SQL queries to select or aggregate the relevant features from your original table. However, ensure that the 'schema' of the query results meets our requirements. * For the Vertex AI Endpoint Request Response Logging table or Vertex AI Batch Prediction Job results. If the instance_type is an array, ensure that the sequence in feature_fields matches the order of features in the prediction instance. We will match the feature with the array in the order specified in [feature_fields].
      { # Schema field definition.
        "dataType": "A String", # Supported data types are: `float` `integer` `boolean` `string` `categorical`
        "name": "A String", # Field name.
        "repeated": True or False, # Describes if the schema field is an array of given data type.
      },
    ],
    "groundTruthFields": [ # Target /ground truth names of the model.
      { # Schema field definition.
        "dataType": "A String", # Supported data types are: `float` `integer` `boolean` `string` `categorical`
        "name": "A String", # Field name.
        "repeated": True or False, # Describes if the schema field is an array of given data type.
      },
    ],
    "predictionFields": [ # Prediction output names of the model. The requirements are the same as the feature_fields. For AutoML Tables, the prediction output name presented in schema will be: `predicted_{target_column}`, the `target_column` is the one you specified when you train the model. For Prediction output drift analysis: * AutoML Classification, the distribution of the argmax label will be analyzed. * AutoML Regression, the distribution of the value will be analyzed.
      { # Schema field definition.
        "dataType": "A String", # Supported data types are: `float` `integer` `boolean` `string` `categorical`
        "name": "A String", # Field name.
        "repeated": True or False, # Describes if the schema field is an array of given data type.
      },
    ],
  },
  "modelMonitoringTarget": { # The monitoring target refers to the entity that is subject to analysis. e.g. Vertex AI Model version. # The entity that is subject to analysis. Currently only models in Vertex AI Model Registry are supported. If you want to analyze the model which is outside the Vertex AI, you could register a model in Vertex AI Model Registry using just a display name.
    "vertexModel": { # Model in Vertex AI Model Registry. # Model in Vertex AI Model Registry.
      "model": "A String", # Model resource name. Format: projects/{project}/locations/{location}/models/{model}.
      "modelVersionId": "A String", # Model version id.
    },
  },
  "name": "A String", # Immutable. Resource name of the ModelMonitor. Format: `projects/{project}/locations/{location}/modelMonitors/{model_monitor}`.
  "notificationSpec": { # Notification spec(email, notification channel) for model monitoring statistics/alerts. # Optional default notification spec, it can be overridden in the ModelMonitoringJob 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/`
      },
    ],
  },
  "outputSpec": { # Specification for the export destination of monitoring results, including metrics, logs, etc. # Optional default monitoring metrics/logs export spec, it can be overridden in the ModelMonitoringJob output spec. If not specified, a default Google Cloud Storage bucket will be created under your project.
    "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.
    },
  },
  "satisfiesPzi": True or False, # Output only. Reserved for future use.
  "satisfiesPzs": True or False, # Output only. Reserved for future use.
  "tabularObjective": { # Tabular monitoring objective. # Optional default tabular model 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
    },
  },
  "trainingDataset": { # Model monitoring data input spec. # Optional training dataset used to train the model. It can serve as a reference dataset to identify changes in production.
    "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",
      ],
    },
  },
  "updateTime": "A String", # Output only. Timestamp when this ModelMonitor was updated most recently.
}

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

Lists ModelMonitors in a Location.

Args:
  parent: string, Required. The resource name of the Location to list the ModelMonitors from. Format: `projects/{project}/locations/{location}` (required)
  filter: string, The standard list filter. More detail in [AIP-160](https://google.aip.dev/160).
  pageSize: integer, The standard list page size.
  pageToken: string, The standard list page token.
  readMask: string, Mask specifying which fields to read.
  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 ModelMonitoringService.ListModelMonitors
  "modelMonitors": [ # List of ModelMonitor in the requested page.
    { # Vertex AI Model Monitoring Service serves as a central hub for the analysis and visualization of data quality and performance related to models. ModelMonitor stands as a top level resource for overseeing your model monitoring tasks.
      "createTime": "A String", # Output only. Timestamp when this ModelMonitor was created.
      "displayName": "A String", # The display name of the ModelMonitor. The name can be up to 128 characters long and can consist of any UTF-8.
      "explanationSpec": { # Specification of Model explanation. # Optional model explanation spec. It is used for feature attribution monitoring.
        "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.
          },
        },
      },
      "modelMonitoringSchema": { # The Model Monitoring Schema definition. # Monitoring Schema is to specify the model's features, prediction outputs and ground truth properties. It is used to extract pertinent data from the dataset and to process features based on their properties. Make sure that the schema aligns with your dataset, if it does not, we will be unable to extract data from the dataset. It is required for most models, but optional for Vertex AI AutoML Tables unless the schem information is not available.
        "featureFields": [ # Feature names of the model. Vertex AI will try to match the features from your dataset as follows: * For 'csv' files, the header names are required, and we will extract the corresponding feature values when the header names align with the feature names. * For 'jsonl' files, we will extract the corresponding feature values if the key names match the feature names. Note: Nested features are not supported, so please ensure your features are flattened. Ensure the feature values are scalar or an array of scalars. * For 'bigquery' dataset, we will extract the corresponding feature values if the column names match the feature names. Note: The column type can be a scalar or an array of scalars. STRUCT or JSON types are not supported. You may use SQL queries to select or aggregate the relevant features from your original table. However, ensure that the 'schema' of the query results meets our requirements. * For the Vertex AI Endpoint Request Response Logging table or Vertex AI Batch Prediction Job results. If the instance_type is an array, ensure that the sequence in feature_fields matches the order of features in the prediction instance. We will match the feature with the array in the order specified in [feature_fields].
          { # Schema field definition.
            "dataType": "A String", # Supported data types are: `float` `integer` `boolean` `string` `categorical`
            "name": "A String", # Field name.
            "repeated": True or False, # Describes if the schema field is an array of given data type.
          },
        ],
        "groundTruthFields": [ # Target /ground truth names of the model.
          { # Schema field definition.
            "dataType": "A String", # Supported data types are: `float` `integer` `boolean` `string` `categorical`
            "name": "A String", # Field name.
            "repeated": True or False, # Describes if the schema field is an array of given data type.
          },
        ],
        "predictionFields": [ # Prediction output names of the model. The requirements are the same as the feature_fields. For AutoML Tables, the prediction output name presented in schema will be: `predicted_{target_column}`, the `target_column` is the one you specified when you train the model. For Prediction output drift analysis: * AutoML Classification, the distribution of the argmax label will be analyzed. * AutoML Regression, the distribution of the value will be analyzed.
          { # Schema field definition.
            "dataType": "A String", # Supported data types are: `float` `integer` `boolean` `string` `categorical`
            "name": "A String", # Field name.
            "repeated": True or False, # Describes if the schema field is an array of given data type.
          },
        ],
      },
      "modelMonitoringTarget": { # The monitoring target refers to the entity that is subject to analysis. e.g. Vertex AI Model version. # The entity that is subject to analysis. Currently only models in Vertex AI Model Registry are supported. If you want to analyze the model which is outside the Vertex AI, you could register a model in Vertex AI Model Registry using just a display name.
        "vertexModel": { # Model in Vertex AI Model Registry. # Model in Vertex AI Model Registry.
          "model": "A String", # Model resource name. Format: projects/{project}/locations/{location}/models/{model}.
          "modelVersionId": "A String", # Model version id.
        },
      },
      "name": "A String", # Immutable. Resource name of the ModelMonitor. Format: `projects/{project}/locations/{location}/modelMonitors/{model_monitor}`.
      "notificationSpec": { # Notification spec(email, notification channel) for model monitoring statistics/alerts. # Optional default notification spec, it can be overridden in the ModelMonitoringJob 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/`
          },
        ],
      },
      "outputSpec": { # Specification for the export destination of monitoring results, including metrics, logs, etc. # Optional default monitoring metrics/logs export spec, it can be overridden in the ModelMonitoringJob output spec. If not specified, a default Google Cloud Storage bucket will be created under your project.
        "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.
        },
      },
      "satisfiesPzi": True or False, # Output only. Reserved for future use.
      "satisfiesPzs": True or False, # Output only. Reserved for future use.
      "tabularObjective": { # Tabular monitoring objective. # Optional default tabular model 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
        },
      },
      "trainingDataset": { # Model monitoring data input spec. # Optional training dataset used to train the model. It can serve as a reference dataset to identify changes in production.
        "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",
          ],
        },
      },
      "updateTime": "A String", # Output only. Timestamp when this ModelMonitor was updated most recently.
    },
  ],
  "nextPageToken": "A String", # A token to retrieve the next page of results. Pass to ListModelMonitorsRequest.page_token to obtain that page.
}

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 a ModelMonitor.

Args:
  name: string, Immutable. Resource name of the ModelMonitor. Format: `projects/{project}/locations/{location}/modelMonitors/{model_monitor}`. (required)
  body: object, The request body.
    The object takes the form of:

{ # Vertex AI Model Monitoring Service serves as a central hub for the analysis and visualization of data quality and performance related to models. ModelMonitor stands as a top level resource for overseeing your model monitoring tasks.
  "createTime": "A String", # Output only. Timestamp when this ModelMonitor was created.
  "displayName": "A String", # The display name of the ModelMonitor. The name can be up to 128 characters long and can consist of any UTF-8.
  "explanationSpec": { # Specification of Model explanation. # Optional model explanation spec. It is used for feature attribution monitoring.
    "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.
      },
    },
  },
  "modelMonitoringSchema": { # The Model Monitoring Schema definition. # Monitoring Schema is to specify the model's features, prediction outputs and ground truth properties. It is used to extract pertinent data from the dataset and to process features based on their properties. Make sure that the schema aligns with your dataset, if it does not, we will be unable to extract data from the dataset. It is required for most models, but optional for Vertex AI AutoML Tables unless the schem information is not available.
    "featureFields": [ # Feature names of the model. Vertex AI will try to match the features from your dataset as follows: * For 'csv' files, the header names are required, and we will extract the corresponding feature values when the header names align with the feature names. * For 'jsonl' files, we will extract the corresponding feature values if the key names match the feature names. Note: Nested features are not supported, so please ensure your features are flattened. Ensure the feature values are scalar or an array of scalars. * For 'bigquery' dataset, we will extract the corresponding feature values if the column names match the feature names. Note: The column type can be a scalar or an array of scalars. STRUCT or JSON types are not supported. You may use SQL queries to select or aggregate the relevant features from your original table. However, ensure that the 'schema' of the query results meets our requirements. * For the Vertex AI Endpoint Request Response Logging table or Vertex AI Batch Prediction Job results. If the instance_type is an array, ensure that the sequence in feature_fields matches the order of features in the prediction instance. We will match the feature with the array in the order specified in [feature_fields].
      { # Schema field definition.
        "dataType": "A String", # Supported data types are: `float` `integer` `boolean` `string` `categorical`
        "name": "A String", # Field name.
        "repeated": True or False, # Describes if the schema field is an array of given data type.
      },
    ],
    "groundTruthFields": [ # Target /ground truth names of the model.
      { # Schema field definition.
        "dataType": "A String", # Supported data types are: `float` `integer` `boolean` `string` `categorical`
        "name": "A String", # Field name.
        "repeated": True or False, # Describes if the schema field is an array of given data type.
      },
    ],
    "predictionFields": [ # Prediction output names of the model. The requirements are the same as the feature_fields. For AutoML Tables, the prediction output name presented in schema will be: `predicted_{target_column}`, the `target_column` is the one you specified when you train the model. For Prediction output drift analysis: * AutoML Classification, the distribution of the argmax label will be analyzed. * AutoML Regression, the distribution of the value will be analyzed.
      { # Schema field definition.
        "dataType": "A String", # Supported data types are: `float` `integer` `boolean` `string` `categorical`
        "name": "A String", # Field name.
        "repeated": True or False, # Describes if the schema field is an array of given data type.
      },
    ],
  },
  "modelMonitoringTarget": { # The monitoring target refers to the entity that is subject to analysis. e.g. Vertex AI Model version. # The entity that is subject to analysis. Currently only models in Vertex AI Model Registry are supported. If you want to analyze the model which is outside the Vertex AI, you could register a model in Vertex AI Model Registry using just a display name.
    "vertexModel": { # Model in Vertex AI Model Registry. # Model in Vertex AI Model Registry.
      "model": "A String", # Model resource name. Format: projects/{project}/locations/{location}/models/{model}.
      "modelVersionId": "A String", # Model version id.
    },
  },
  "name": "A String", # Immutable. Resource name of the ModelMonitor. Format: `projects/{project}/locations/{location}/modelMonitors/{model_monitor}`.
  "notificationSpec": { # Notification spec(email, notification channel) for model monitoring statistics/alerts. # Optional default notification spec, it can be overridden in the ModelMonitoringJob 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/`
      },
    ],
  },
  "outputSpec": { # Specification for the export destination of monitoring results, including metrics, logs, etc. # Optional default monitoring metrics/logs export spec, it can be overridden in the ModelMonitoringJob output spec. If not specified, a default Google Cloud Storage bucket will be created under your project.
    "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.
    },
  },
  "satisfiesPzi": True or False, # Output only. Reserved for future use.
  "satisfiesPzs": True or False, # Output only. Reserved for future use.
  "tabularObjective": { # Tabular monitoring objective. # Optional default tabular model 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
    },
  },
  "trainingDataset": { # Model monitoring data input spec. # Optional training dataset used to train the model. It can serve as a reference dataset to identify changes in production.
    "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",
      ],
    },
  },
  "updateTime": "A String", # Output only. Timestamp when this ModelMonitor was updated most recently.
}

  updateMask: string, Required. Mask specifying which fields to update.
  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.
  },
}

searchModelMonitoringAlerts(modelMonitor, body=None, x__xgafv=None)

Returns the Model Monitoring alerts.

Args:
  modelMonitor: string, Required. ModelMonitor resource name. Format: `projects/{project}/locations/{location}/modelMonitors/{model_monitor}` (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for ModelMonitoringService.SearchModelMonitoringAlerts.
  "alertTimeInterval": { # 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. # If non-empty, returns the alerts in this time interval.
    "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.
  },
  "modelMonitoringJob": "A String", # If non-empty, returns the alerts of this model monitoring job.
  "objectiveType": "A String", # If non-empty, returns the alerts of this objective type. Supported monitoring objectives: `raw-feature-drift` `prediction-output-drift` `feature-attribution`
  "pageSize": 42, # The standard list page size.
  "pageToken": "A String", # A page token received from a previous ModelMonitoringService.SearchModelMonitoringAlerts call.
  "statsName": "A String", # If non-empty, returns the alerts of this stats_name.
}

  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 ModelMonitoringService.SearchModelMonitoringAlerts.
  "modelMonitoringAlerts": [ # Alerts retrieved for the requested objectives. Sorted by alert time descendingly.
    { # Represents a single monitoring alert. This is currently used in the SearchModelMonitoringAlerts api, thus the alert wrapped in this message belongs to the resource asked in the request.
      "alertTime": "A String", # Alert creation time.
      "anomaly": { # Represents a single model monitoring anomaly. # Anomaly details.
        "algorithm": "A String", # Algorithm used to calculated the metrics, eg: jensen_shannon_divergence, l_infinity.
        "modelMonitoringJob": "A String", # Model monitoring job resource name.
        "tabularAnomaly": { # Tabular anomaly details. # Tabular anomaly.
          "anomaly": "", # Anomaly body.
          "anomalyUri": "A String", # Additional anomaly information. e.g. Google Cloud Storage uri.
          "condition": { # Monitoring alert triggered condition. # The alert condition associated with this anomaly.
            "threshold": 3.14, # A condition that compares a stats value against a threshold. Alert will be triggered if value above the threshold.
          },
          "summary": "A String", # Overview of this anomaly.
          "triggerTime": "A String", # The time the anomaly was triggered.
        },
      },
      "objectiveType": "A String", # One of the supported monitoring objectives: `raw-feature-drift` `prediction-output-drift` `feature-attribution`
      "statsName": "A String", # The stats name.
    },
  ],
  "nextPageToken": "A String", # The page token that can be used by the next ModelMonitoringService.SearchModelMonitoringAlerts call.
  "totalNumberAlerts": "A String", # The total number of alerts retrieved by the requested objectives.
}

searchModelMonitoringAlerts_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.
        

searchModelMonitoringStats(modelMonitor, body=None, x__xgafv=None)

Searches Model Monitoring Stats generated within a given time window.

Args:
  modelMonitor: string, Required. ModelMonitor resource name. Format: `projects/{project}/locations/{location}/modelMonitors/{model_monitor}` (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for ModelMonitoringService.SearchModelMonitoringStats.
  "pageSize": 42, # The standard list page size.
  "pageToken": "A String", # A page token received from a previous ModelMonitoringService.SearchModelMonitoringStats call.
  "statsFilter": { # Filter for searching ModelMonitoringStats. # Filter for search different stats.
    "tabularStatsFilter": { # Tabular statistics filter. # Tabular statistics filter.
      "algorithm": "A String", # Specify the algorithm type used for distance calculation, eg: jensen_shannon_divergence, l_infinity.
      "modelMonitoringJob": "A String", # From a particular monitoring job.
      "modelMonitoringSchedule": "A String", # From a particular monitoring schedule.
      "objectiveType": "A String", # One of the supported monitoring objectives: `raw-feature-drift` `prediction-output-drift` `feature-attribution`
      "statsName": "A String", # If not specified, will return all the stats_names.
    },
  },
  "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 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.
  },
}

  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 ModelMonitoringService.SearchModelMonitoringStats.
  "monitoringStats": [ # Stats retrieved for requested objectives.
    { # Represents the collection of statistics for a metric.
      "tabularStats": { # A collection of data points that describes the time-varying values of a tabular metric. # Generated tabular statistics.
        "dataPoints": [ # The data points of this time series. When listing time series, points are returned in reverse time order.
          { # Represents a single statistics data point.
            "algorithm": "A String", # Algorithm used to calculated the metrics, eg: jensen_shannon_divergence, l_infinity.
            "baselineStats": { # Typed value of the statistics. # Statistics from baseline dataset.
              "distributionValue": { # Summary statistics for a population of values. # Distribution.
                "distribution": "", # Predictive monitoring drift distribution in `tensorflow.metadata.v0.DatasetFeatureStatistics` format.
                "distributionDeviation": 3.14, # Distribution distance deviation from the current dataset's statistics to baseline dataset's statistics. * For categorical feature, the distribution distance is calculated by L-inifinity norm or Jensen–Shannon divergence. * For numerical feature, the distribution distance is calculated by Jensen–Shannon divergence.
              },
              "doubleValue": 3.14, # Double.
            },
            "createTime": "A String", # Statistics create time.
            "currentStats": { # Typed value of the statistics. # Statistics from current dataset.
              "distributionValue": { # Summary statistics for a population of values. # Distribution.
                "distribution": "", # Predictive monitoring drift distribution in `tensorflow.metadata.v0.DatasetFeatureStatistics` format.
                "distributionDeviation": 3.14, # Distribution distance deviation from the current dataset's statistics to baseline dataset's statistics. * For categorical feature, the distribution distance is calculated by L-inifinity norm or Jensen–Shannon divergence. * For numerical feature, the distribution distance is calculated by Jensen–Shannon divergence.
              },
              "doubleValue": 3.14, # Double.
            },
            "hasAnomaly": True or False, # Indicate if the statistics has anomaly.
            "modelMonitoringJob": "A String", # Model monitoring job resource name.
            "schedule": "A String", # Schedule resource name.
            "thresholdValue": 3.14, # Threshold value.
          },
        ],
        "objectiveType": "A String", # One of the supported monitoring objectives: `raw-feature-drift` `prediction-output-drift` `feature-attribution`
        "statsName": "A String", # The stats name.
      },
    },
  ],
  "nextPageToken": "A String", # The page token that can be used by the next ModelMonitoringService.SearchModelMonitoringStats call.
}

searchModelMonitoringStats_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.