Class: Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ModelDeploymentMonitoringJob

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/aiplatform_v1beta1/classes.rb,
lib/google/apis/aiplatform_v1beta1/representations.rb,
lib/google/apis/aiplatform_v1beta1/representations.rb

Overview

Represents a job that runs periodically to monitor the deployed models in an endpoint. It will analyze the logged training & prediction data to detect any abnormal behaviors.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudAiplatformV1beta1ModelDeploymentMonitoringJob

Returns a new instance of GoogleCloudAiplatformV1beta1ModelDeploymentMonitoringJob.



18411
18412
18413
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 18411

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#analysis_instance_schema_uri ⇒ String

YAML schema file uri describing the format of a single instance that you want Tensorflow Data Validation (TFDV) to analyze. If this field is empty, all the feature data types are inferred from predict_instance_schema_uri, meaning that TFDV will use the data in the exact format(data type) as prediction request/ response. If there are any data type differences between predict instance and TFDV instance, this field can be used to override the schema. For models trained with Vertex AI, this field must be set as all the fields in predict instance formatted as string. Corresponds to the JSON property analysisInstanceSchemaUri

Returns:

  • (String) 


18254
18255
18256
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 18254

def analysis_instance_schema_uri
  @analysis_instance_schema_uri
end

#bigquery_tables ⇒ Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ModelDeploymentMonitoringBigQueryTable>

Output only. The created bigquery tables for the job under customer project. Customer could do their own query & analysis. There could be 4 log tables in maximum: 1. Training data logging predict request/response 2. Serving data logging predict request/response Corresponds to the JSON property bigqueryTables

Returns:



18262
18263
18264
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 18262

def bigquery_tables
  @bigquery_tables
end

#create_time ⇒ String

Output only. Timestamp when this ModelDeploymentMonitoringJob was created. Corresponds to the JSON property createTime

Returns:

  • (String) 


18267
18268
18269
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 18267

def create_time
  @create_time
end

#display_name ⇒ String

Required. The user-defined name of the ModelDeploymentMonitoringJob. The name can be up to 128 characters long and can consist of any UTF-8 characters. Display name of a ModelDeploymentMonitoringJob. Corresponds to the JSON property displayName

Returns:

  • (String) 


18274
18275
18276
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 18274

def display_name
  @display_name
end

#enable_monitoring_pipeline_logs ⇒ Boolean Also known as: enable_monitoring_pipeline_logs?

If true, the scheduled monitoring pipeline logs are sent to Google Cloud Logging, including pipeline status and anomalies detected. Please note the logs incur cost, which are subject to Cloud Logging pricing. Corresponds to the JSON property enableMonitoringPipelineLogs

Returns:

  • (Boolean) 


18282
18283
18284
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 18282

def enable_monitoring_pipeline_logs
  @enable_monitoring_pipeline_logs
end

#encryption_spec ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EncryptionSpec

Represents a customer-managed encryption key spec that can be applied to a top- level resource. Corresponds to the JSON property encryptionSpec

Returns:



18289
18290
18291
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 18289

def encryption_spec
  @encryption_spec
end

#endpoint ⇒ String

Required. Endpoint resource name. Format: projects/project/locations/ location/endpoints/endpoint` Corresponds to the JSON propertyendpoint`

Returns:

  • (String) 


18295
18296
18297
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 18295

def endpoint
  @endpoint
end

#error ⇒ Google::Apis::AiplatformV1beta1::GoogleRpcStatus

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide. Corresponds to the JSON property error

Returns:



18305
18306
18307
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 18305

def error
  @error
end

#labels ⇒ Hash<String,String>

The labels with user-defined metadata to organize your ModelDeploymentMonitoringJob. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


18314
18315
18316
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 18314

def labels
  @labels
end

#latest_monitoring_pipeline_metadata ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ModelDeploymentMonitoringJobLatestMonitoringPipelineMetadata

All metadata of most recent monitoring pipelines. Corresponds to the JSON property latestMonitoringPipelineMetadata

Returns:



18319
18320
18321
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 18319

def latest_monitoring_pipeline_metadata
  @latest_monitoring_pipeline_metadata
end

#log_ttl ⇒ String

The TTL of BigQuery tables in user projects which stores logs. A day is the basic unit of the TTL and we take the ceil of TTL/86400(a day). e.g. second: 3600 indicates ttl = 1 day. Corresponds to the JSON property logTtl

Returns:

  • (String) 


18326
18327
18328
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 18326

def log_ttl
  @log_ttl
end

#logging_sampling_strategy ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1SamplingStrategy

Sampling Strategy for logging, can be for both training and prediction dataset. Corresponds to the JSON property loggingSamplingStrategy

Returns:



18331
18332
18333
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 18331

def logging_sampling_strategy
  @logging_sampling_strategy
end

#model_deployment_monitoring_objective_configs ⇒ Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ModelDeploymentMonitoringObjectiveConfig>

Required. The config for monitoring objectives. This is a per DeployedModel config. Each DeployedModel needs to be configured separately. Corresponds to the JSON property modelDeploymentMonitoringObjectiveConfigs

Returns:



18337
18338
18339
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 18337

def model_deployment_monitoring_objective_configs
  @model_deployment_monitoring_objective_configs
end

#model_deployment_monitoring_schedule_config ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ModelDeploymentMonitoringScheduleConfig

The config for scheduling monitoring job. Corresponds to the JSON property modelDeploymentMonitoringScheduleConfig

Returns:



18342
18343
18344
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 18342

def model_deployment_monitoring_schedule_config
  @model_deployment_monitoring_schedule_config
end

#model_monitoring_alert_config ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ModelMonitoringAlertConfig

The alert config for model monitoring. Corresponds to the JSON property modelMonitoringAlertConfig

Returns:



18347
18348
18349
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 18347

def model_monitoring_alert_config
  @model_monitoring_alert_config
end

#name ⇒ String

Output only. Resource name of a ModelDeploymentMonitoringJob. Corresponds to the JSON property name

Returns:

  • (String) 


18352
18353
18354
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 18352

def name
  @name
end

#next_schedule_time ⇒ String

Output only. Timestamp when this monitoring pipeline will be scheduled to run for the next round. Corresponds to the JSON property nextScheduleTime

Returns:

  • (String) 


18358
18359
18360
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 18358

def next_schedule_time
  @next_schedule_time
end

#predict_instance_schema_uri ⇒ String

YAML schema file uri describing the format of a single instance, which are given to format this Endpoint's prediction (and explanation). If not set, we will generate predict schema from collected predict requests. Corresponds to the JSON property predictInstanceSchemaUri

Returns:

  • (String) 


18365
18366
18367
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 18365

def predict_instance_schema_uri
  @predict_instance_schema_uri
end

#sample_predict_instance ⇒ Object

Sample Predict instance, same format as PredictRequest.instances, this can be set as a replacement of ModelDeploymentMonitoringJob. predict_instance_schema_uri. If not set, we will generate predict schema from collected predict requests. Corresponds to the JSON property samplePredictInstance

Returns:

  • (Object) 


18373
18374
18375
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 18373

def sample_predict_instance
  @sample_predict_instance
end

#satisfies_pzi ⇒ Boolean Also known as: satisfies_pzi?

Output only. Reserved for future use. Corresponds to the JSON property satisfiesPzi

Returns:

  • (Boolean) 


18378
18379
18380
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 18378

def satisfies_pzi
  @satisfies_pzi
end

#satisfies_pzs ⇒ Boolean Also known as: satisfies_pzs?

Output only. Reserved for future use. Corresponds to the JSON property satisfiesPzs

Returns:

  • (Boolean) 


18384
18385
18386
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 18384

def satisfies_pzs
  @satisfies_pzs
end

#schedule_state ⇒ String

Output only. Schedule state when the monitoring job is in Running state. Corresponds to the JSON property scheduleState

Returns:

  • (String) 


18390
18391
18392
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 18390

def schedule_state
  @schedule_state
end

#state ⇒ String

Output only. The detailed state of the monitoring job. When the job is still creating, the state will be 'PENDING'. Once the job is successfully created, the state will be 'RUNNING'. Pause the job, the state will be 'PAUSED'. Resume the job, the state will return to 'RUNNING'. Corresponds to the JSON property state

Returns:

  • (String) 


18398
18399
18400
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 18398

def state
  @state
end

#stats_anomalies_base_directory ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GcsDestination

The Google Cloud Storage location where the output is to be written to. Corresponds to the JSON property statsAnomaliesBaseDirectory

Returns:



18403
18404
18405
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 18403

def stats_anomalies_base_directory
  @stats_anomalies_base_directory
end

#update_time ⇒ String

Output only. Timestamp when this ModelDeploymentMonitoringJob was updated most recently. Corresponds to the JSON property updateTime

Returns:

  • (String) 


18409
18410
18411
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 18409

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



18416
18417
18418
18419
18420
18421
18422
18423
18424
18425
18426
18427
18428
18429
18430
18431
18432
18433
18434
18435
18436
18437
18438
18439
18440
18441
18442
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 18416

def update!(**args)
  @analysis_instance_schema_uri = args[:analysis_instance_schema_uri] if args.key?(:analysis_instance_schema_uri)
  @bigquery_tables = args[:bigquery_tables] if args.key?(:bigquery_tables)
  @create_time = args[:create_time] if args.key?(:create_time)
  @display_name = args[:display_name] if args.key?(:display_name)
  @enable_monitoring_pipeline_logs = args[:enable_monitoring_pipeline_logs] if args.key?(:enable_monitoring_pipeline_logs)
  @encryption_spec = args[:encryption_spec] if args.key?(:encryption_spec)
  @endpoint = args[:endpoint] if args.key?(:endpoint)
  @error = args[:error] if args.key?(:error)
  @labels = args[:labels] if args.key?(:labels)
  @latest_monitoring_pipeline_metadata = args[:latest_monitoring_pipeline_metadata] if args.key?(:latest_monitoring_pipeline_metadata)
  @log_ttl = args[:log_ttl] if args.key?(:log_ttl)
  @logging_sampling_strategy = args[:logging_sampling_strategy] if args.key?(:logging_sampling_strategy)
  @model_deployment_monitoring_objective_configs = args[:model_deployment_monitoring_objective_configs] if args.key?(:model_deployment_monitoring_objective_configs)
  @model_deployment_monitoring_schedule_config = args[:model_deployment_monitoring_schedule_config] if args.key?(:model_deployment_monitoring_schedule_config)
  @model_monitoring_alert_config = args[:model_monitoring_alert_config] if args.key?(:model_monitoring_alert_config)
  @name = args[:name] if args.key?(:name)
  @next_schedule_time = args[:next_schedule_time] if args.key?(:next_schedule_time)
  @predict_instance_schema_uri = args[:predict_instance_schema_uri] if args.key?(:predict_instance_schema_uri)
  @sample_predict_instance = args[:sample_predict_instance] if args.key?(:sample_predict_instance)
  @satisfies_pzi = args[:satisfies_pzi] if args.key?(:satisfies_pzi)
  @satisfies_pzs = args[:satisfies_pzs] if args.key?(:satisfies_pzs)
  @schedule_state = args[:schedule_state] if args.key?(:schedule_state)
  @state = args[:state] if args.key?(:state)
  @stats_anomalies_base_directory = args[:stats_anomalies_base_directory] if args.key?(:stats_anomalies_base_directory)
  @update_time = args[:update_time] if args.key?(:update_time)
end