Try Gemini 1.5 models, our newest multimodal models in Vertex AI, and see what you can build with a 1M token context window. Try Gemini 1.5 models, our newest multimodal models in Vertex AI, and see what you can build with a 1M token context window.

Method: projects.locations.modelMonitors.searchModelMonitoringAlerts

Returns the Model Monitoring alerts.

HTTP request

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

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

Path parameters

Parameters

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

modelMonitor

string

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

Request body

The request body contains data with the following structure:

JSON representation
{ "modelMonitoringJob": string, "alertTimeInterval": { object (`Interval`) }, "statsName": string, "objectiveType": string, "pageSize": integer, "pageToken": string }

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:

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

Fields

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.

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.

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

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.

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

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. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: `"2014-10-02T15:01:23Z"` and `"2014-10-02T15:01:23.045123456Z"`.
`anomaly`	`object (ModelMonitoringAnomaly)` Anomaly details.

ModelMonitoringAnomaly

Represents a single model monitoring anomaly.

JSON representation

JSON representation
{ "modelMonitoringJob": string, "algorithm": string, // Union field `anomaly` can be only one of the following: "tabularAnomaly": { object (`TabularAnomaly`) } // End of list of possible types for union field `anomaly`. }

{
  "modelMonitoringJob": string,
  "algorithm": string,

  // Union field anomaly can be only one of the following:
  "tabularAnomaly": {
    object (TabularAnomaly)
  }
  // End of list of possible types for union field anomaly.
}

Fields
`modelMonitoringJob`	`string` Model monitoring job resource name.
`algorithm`	`string` Algorithm used to calculated the metrics, eg: jensen_shannon_divergence, l_infinity.
Union field `anomaly`. `anomaly` can be only one of the following:
`tabularAnomaly`	`object (TabularAnomaly)` Tabular anomaly.

TabularAnomaly

Tabular anomaly details.

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

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. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: `"2014-10-02T15:01:23Z"` and `"2014-10-02T15:01:23.045123456Z"`.
`condition`	`object (ModelMonitoringAlertCondition)` The alert condition associated with this anomaly.