Try Gemini 1.5 Pro, our most advanced multimodal model in Vertex AI, and see what you can build with a 1M token context window. Try Gemini 1.5 Pro, our most advanced multimodal model in Vertex AI, and see what you can build with a 1M token context window.

Method: projects.locations.modelDeploymentMonitoringJobs.searchModelDeploymentMonitoringStatsAnomalies

Searches Model Monitoring Statistics generated within a given time window.

HTTP request

POST https://{service-endpoint}/v1beta1/{modelDeploymentMonitoringJob}:searchModelDeploymentMonitoringStatsAnomalies

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

Path parameters

Parameters

Parameters
`modelDeploymentMonitoringJob`	`string` Required. ModelDeploymentMonitoring Job resource name. Format: `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJob}`

modelDeploymentMonitoringJob

string

Required. ModelDeploymentMonitoring Job resource name. Format: projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJob}

Request body

The request body contains data with the following structure:

JSON representation
{ "deployedModelId": string, "featureDisplayName": string, "objectives": [ { object (`StatsAnomaliesObjective`) } ], "pageSize": integer, "pageToken": string, "startTime": string, "endTime": string }

Fields
`deployedModelId`	`string` Required. The DeployedModel ID of the [ModelDeploymentMonitoringObjectiveConfig.deployed_model_id].
`featureDisplayName`	`string` The feature display name. If specified, only return the stats belonging to this feature. Format: `ModelMonitoringStatsAnomalies.FeatureHistoricStatsAnomalies.feature_display_name`, example: "user_destination".
`objectives[]`	`object (StatsAnomaliesObjective)` Required. Objectives of the stats to retrieve.
`pageSize`	`integer` The standard list page size.
`pageToken`	`string` A page token received from a previous `JobService.SearchModelDeploymentMonitoringStatsAnomalies` call.
`startTime`	`string (Timestamp format)` The earliest timestamp of stats being generated. If not set, indicates fetching stats till the earliest possible one. 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"`.
`endTime`	`string (Timestamp format)` The latest timestamp of stats being generated. If not set, indicates feching stats till the latest possible one. 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"`.

Response body

Response message for JobService.SearchModelDeploymentMonitoringStatsAnomalies.

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

JSON representation
{ "monitoringStats": [ { object (`ModelMonitoringStatsAnomalies`) } ], "nextPageToken": string }

Fields

Fields
`monitoringStats[]`	`object (ModelMonitoringStatsAnomalies)` Stats retrieved for requested objectives. There are at most 1000 `ModelMonitoringStatsAnomalies.FeatureHistoricStatsAnomalies.prediction_stats` in the response.
`nextPageToken`	`string` The page token that can be used by the next `JobService.SearchModelDeploymentMonitoringStatsAnomalies` call.

monitoringStats[]

object (ModelMonitoringStatsAnomalies)

Stats retrieved for requested objectives. There are at most 1000 ModelMonitoringStatsAnomalies.FeatureHistoricStatsAnomalies.prediction_stats in the response.

nextPageToken

string

The page token that can be used by the next JobService.SearchModelDeploymentMonitoringStatsAnomalies call.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the modelDeploymentMonitoringJob resource:

aiplatform.modelDeploymentMonitoringJobs.searchStatsAnomalies

For more information, see the IAM documentation.

StatsAnomaliesObjective

Stats requested for specific objective.

JSON representation
{ "type": enum (`ModelDeploymentMonitoringObjectiveType`), "topFeatureCount": integer }

Fields

Fields
`type`	`enum (ModelDeploymentMonitoringObjectiveType)`
`topFeatureCount`	`integer` If set, all attribution scores between `SearchModelDeploymentMonitoringStatsAnomaliesRequest.start_time` and `SearchModelDeploymentMonitoringStatsAnomaliesRequest.end_time` are fetched, and page token doesn't take effect in this case. Only used to retrieve attribution score for the top Features which has the highest attribution score in the latest monitoring run.

type

enum (ModelDeploymentMonitoringObjectiveType)

topFeatureCount

integer

If set, all attribution scores between SearchModelDeploymentMonitoringStatsAnomaliesRequest.start_time and SearchModelDeploymentMonitoringStatsAnomaliesRequest.end_time are fetched, and page token doesn't take effect in this case. Only used to retrieve attribution score for the top Features which has the highest attribution score in the latest monitoring run.