ModelMonitoringInput

Model monitoring data input spec.

Fields
datasetUnion type
Dataset source.dataset can be only one of the following:
columnizedDatasetobject (ModelMonitoringDataset)

Columnized dataset.

batchPredictionOutputobject (BatchPredictionOutput)

Vertex AI Batch prediction Job.

vertexEndpointLogsobject (VertexEndpointLogs)

Vertex AI Endpoint request & response logging.

time_specUnion type
Time specification for the dataset.time_spec can be only one of the following:
timeIntervalobject (Interval)

The time interval (pair of startTime and endTime) for which results should be returned.

timeOffsetobject (TimeOffset)

The time offset setting for which results should be returned.

JSON representation
{// dataset"columnizedDataset":{object (ModelMonitoringDataset)},"batchPredictionOutput":{object (BatchPredictionOutput)},"vertexEndpointLogs":{object (VertexEndpointLogs)}// Union type// time_spec"timeInterval":{object (Interval)},"timeOffset":{object (TimeOffset)}// Union type}

ModelMonitoringDataset

Input dataset spec.

Fields
timestampFieldstring

The timestamp field. Usually for serving data.

data_locationUnion type
Choose one of supported data location for columnized dataset.data_location can be only one of the following:
vertexDatasetstring

Resource name of the Vertex AI managed dataset.

gcsSourceobject (ModelMonitoringGcsSource)

Google Cloud Storage data source.

bigquerySourceobject (ModelMonitoringBigQuerySource)

BigQuery data source.

JSON representation
{"timestampField":string,// data_location"vertexDataset":string,"gcsSource":{object (ModelMonitoringGcsSource)},"bigquerySource":{object (ModelMonitoringBigQuerySource)}// Union type}

ModelMonitoringGcsSource

Dataset spec for data stored in Google Cloud Storage.

Fields
gcsUristring

Google Cloud Storage URI to the input file(s). May contain wildcards. For more information on wildcards, seehttps://cloud.google.com/storage/docs/wildcards.

formatenum (DataFormat)

data format of the dataset.

JSON representation
{"gcsUri":string,"format":enum (DataFormat)}

DataFormat

Supported data format.

Enums
DATA_FORMAT_UNSPECIFIEDdata format unspecified, used when this field is unset.
CSVCSV files.
TF_RECORDTfRecord files
JSONLJsonL files.

ModelMonitoringBigQuerySource

Dataset spec for data sotred in BigQuery.

Fields
connectionUnion type
connection can be only one of the following:
tableUristring

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

Standard SQL to be used instead of thetableUri.

JSON representation
{// connection"tableUri":string,"query":string// Union type}

BatchPredictionOutput

data from Vertex AI Batch prediction job output.

Fields
batchPredictionJobstring

Vertex AI Batch prediction job resource name. The job must match the model version specified in [ModelMonitor].[modelMonitoringTarget].

JSON representation
{"batchPredictionJob":string}

VertexEndpointLogs

data from Vertex AI Endpoint request response logging.

Fields
endpoints[]string

List of endpoint resource names. The endpoints must enable the logging with the [Endpoint].[requestResponseLoggingConfig], and must contain the deployed model corresponding to the model version specified in [ModelMonitor].[modelMonitoringTarget].

JSON representation
{"endpoints":[string]}

TimeOffset

time offset setting.

Fields
offsetstring

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

windowstring

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

JSON representation
{"offset":string,"window":string}

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-06-27 UTC.