Method: modelMonitors.searchModelMonitoringAlerts

Full name: projects.locations.modelMonitors.searchModelMonitoringAlerts

Returns the Model Monitoring alerts.

Endpoint

post https://{service-endpoint}/v1beta1/{modelMonitor}:searchModelMonitoringAlerts

Where {service-endpoint} is one of the supported service endpoints.

Path parameters

modelMonitor string

Required. ModelMonitor resource name. Format: projects/{project}/locations/{location}/modelMonitors/{modelMonitor}

Request body

The request body contains data with the following structure:

Fields
modelMonitoringJob string

If non-empty, returns the alerts of this model monitoring job.

alertTimeInterval object (Interval)

If non-empty, returns the alerts in this time interval.

statsName string

If non-empty, returns the alerts of this statsName.

objectiveType string

If non-empty, returns the alerts of this objective type. Supported monitoring objectives: raw-feature-drift prediction-output-drift feature-attribution

pageSize integer

The standard list page size.

pageToken string

A page token received from a previous ModelMonitoringService.SearchModelMonitoringAlerts call.

Response body

Response message for ModelMonitoringService.SearchModelMonitoringAlerts.

If successful, the response body contains data with the following structure:

Fields
modelMonitoringAlerts[] object (ModelMonitoringAlert)

Alerts retrieved for the requested objectives. Sorted by alert time descendingly.

totalNumberAlerts string (int64 format)

The total number of alerts retrieved by the requested objectives.

nextPageToken string

The page token that can be used by the next ModelMonitoringService.SearchModelMonitoringAlerts call.

JSON representation 
{
  "modelMonitoringAlerts": [
    {
      object (ModelMonitoringAlert)
    }
  ],
  "totalNumberAlerts": string,
  "nextPageToken": string
}

ModelMonitoringAlert

Represents a single monitoring alert. This is currently used in the modelMonitors.searchModelMonitoringAlerts api, thus the alert wrapped in this message belongs to the resource asked in the request.

Fields
statsName string

The stats name.

objectiveType string

One of the supported monitoring objectives: raw-feature-drift prediction-output-drift feature-attribution

alertTime string (Timestamp format)

Alert creation time.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

anomaly object (ModelMonitoringAnomaly)

Anomaly details.

JSON representation 
{
  "statsName": string,
  "objectiveType": string,
  "alertTime": string,
  "anomaly": {
    object (ModelMonitoringAnomaly)
  }
}

ModelMonitoringAnomaly

Represents a single model monitoring anomaly.

Fields
modelMonitoringJob string

Model monitoring job resource name.

algorithm string

algorithm used to calculated the metrics, eg: jensen_shannon_divergence, l_infinity.

anomaly Union type
anomaly can be only one of the following:
tabularAnomaly object (TabularAnomaly)

Tabular anomaly.

JSON representation 
{
  "modelMonitoringJob": string,
  "algorithm": string,

  // anomaly
  "tabularAnomaly": {
    object (TabularAnomaly)
  }
  // Union type
}

TabularAnomaly

Tabular anomaly details.

Fields
anomalyUri string

Additional anomaly information. e.g. Google Cloud Storage uri.

summary string

Overview of this anomaly.

anomaly value (Value format)

Anomaly body.

triggerTime string (Timestamp format)

The time the anomaly was triggered.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

condition object (ModelMonitoringAlertCondition)

The alert condition associated with this anomaly.

JSON representation 
{
  "anomalyUri": string,
  "summary": string,
  "anomaly": value,
  "triggerTime": string,
  "condition": {
    object (ModelMonitoringAlertCondition)
  }
}