ModelMonitoringInput

Model monitoring data input spec.

Fields
dataset Union type
Dataset source. The following is a list of mutually exclusive fields. At most one of the fields will be set in a response:
columnizedDataset object (ModelMonitoringDataset)

Columnized dataset.

batchPredictionOutput object (BatchPredictionOutput)

Agent Platform Batch prediction Job.

vertexEndpointLogs object (VertexEndpointLogs)

Agent Platform Endpoint request & response logging.

End of mutually exclusive fields.
time_spec Union type
Time specification for the dataset. The following is a list of mutually exclusive fields. At most one of the fields will be set in a response:
timeInterval object (Interval)

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

timeOffset object (TimeOffset)

The time offset setting for which results should be returned.

End of mutually exclusive fields.
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
timestampField string

The timestamp field. Usually for serving data.

data_location Union type
Choose one of supported data location for columnized dataset. The following is a list of mutually exclusive fields. At most one of the fields will be set in a response:
vertexDataset string

Resource name of the Agent Platform managed dataset.

gcsSource object (ModelMonitoringGcsSource)

Google Cloud Storage data source.

bigquerySource object (ModelMonitoringBigQuerySource)

BigQuery data source.

End of mutually exclusive fields.
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
gcsUri 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/wildcards.

format enum (DataFormat)

data format of the dataset.

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

DataFormat

Supported data format.

Enums
DATA_FORMAT_UNSPECIFIED data format unspecified, used when this field is unset.
CSV CSV files.
TF_RECORD TfRecord files
JSONL JsonL files.

ModelMonitoringBigQuerySource

Dataset spec for data sotred in BigQuery.

Fields
connection Union type
The following is a list of mutually exclusive fields. At most one of the fields will be set in a response:
tableUri 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.
query string

Standard SQL to be used instead of the tableUri.

End of mutually exclusive fields.
JSON representation 
{

  // connection
  "tableUri": string,
  "query": string
  // Union type
}

BatchPredictionOutput

data from Agent Platform Batch prediction job output.

Fields
batchPredictionJob string

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

JSON representation 
{
  "batchPredictionJob": string
}

VertexEndpointLogs

data from Agent Platform 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
offset 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 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.

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