Class: Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1BatchPredictionJob

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

A job that uses a Model to produce predictions on multiple input instances. If predictions for significant portion of the instances fail, the job may finish without attempting predictions for all remaining instances.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudAiplatformV1beta1BatchPredictionJob

Returns a new instance of GoogleCloudAiplatformV1beta1BatchPredictionJob.



9565
9566
9567
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 9565

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

Instance Attribute Details

#completion_stats ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1CompletionStats

Success and error statistics of processing multiple entities (for example, DataItems or structured data rows) in batch. Corresponds to the JSON property completionStats

Returns:



9351
9352
9353
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 9351

def completion_stats
  @completion_stats
end

#create_time ⇒ String

Output only. Time when the BatchPredictionJob was created. Corresponds to the JSON property createTime

Returns:

  • (String) 


9356
9357
9358
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 9356

def create_time
  @create_time
end

#dedicated_resources ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1BatchDedicatedResources

A description of resources that are used for performing batch operations, are dedicated to a Model, and need manual configuration. Corresponds to the JSON property dedicatedResources

Returns:



9362
9363
9364
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 9362

def dedicated_resources
  @dedicated_resources
end

#disable_container_logging ⇒ Boolean Also known as: disable_container_logging?

For custom-trained Models and AutoML Tabular Models, the container of the DeployedModel instances will send stderr and stdout streams to Cloud Logging by default. Please note that the logs incur cost, which are subject to Cloud Logging pricing. User can disable container logging by setting this flag to true. Corresponds to the JSON property disableContainerLogging

Returns:

  • (Boolean) 


9371
9372
9373
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 9371

def disable_container_logging
  @disable_container_logging
end

#display_name ⇒ String

Required. The user-defined name of this BatchPredictionJob. Corresponds to the JSON property displayName

Returns:

  • (String) 


9377
9378
9379
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 9377

def display_name
  @display_name
end

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

Represents a customer-managed encryption key specification that can be applied to a Vertex AI resource. Corresponds to the JSON property encryptionSpec

Returns:



9383
9384
9385
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 9383

def encryption_spec
  @encryption_spec
end

#end_time ⇒ String

Output only. Time when the BatchPredictionJob entered any of the following states: JOB_STATE_SUCCEEDED, JOB_STATE_FAILED, JOB_STATE_CANCELLED. Corresponds to the JSON property endTime

Returns:

  • (String) 


9389
9390
9391
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 9389

def end_time
  @end_time
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:



9399
9400
9401
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 9399

def error
  @error
end

#explanation_spec ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ExplanationSpec

Specification of Model explanation. Corresponds to the JSON property explanationSpec

Returns:



9404
9405
9406
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 9404

def explanation_spec
  @explanation_spec
end

#generate_explanation ⇒ Boolean Also known as: generate_explanation?

Generate explanation with the batch prediction results. When set to true, the batch prediction output changes based on the predictions_format field of the BatchPredictionJob.output_config object: * bigquery: output includes a column named explanation. The value is a struct that conforms to the Explanation object. * jsonl: The JSON objects on each line include an additional entry keyed explanation. The value of the entry is a JSON object that conforms to the Explanation object. * csv: Generating explanations for CSV format is not supported. If this field is set to true, either the Model. explanation_spec or explanation_spec must be populated. Corresponds to the JSON property generateExplanation

Returns:

  • (Boolean) 


9417
9418
9419
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 9417

def generate_explanation
  @generate_explanation
end

#input_config ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1BatchPredictionJobInputConfig

Configures the input to BatchPredictionJob. See Model. supported_input_storage_formats for Model's supported input formats, and how instances should be expressed via any of them. Corresponds to the JSON property inputConfig

Returns:



9425
9426
9427
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 9425

def input_config
  @input_config
end

#instance_config ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1BatchPredictionJobInstanceConfig

Configuration defining how to transform batch prediction input instances to the instances that the Model accepts. Corresponds to the JSON property instanceConfig

Returns:



9431
9432
9433
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 9431

def instance_config
  @instance_config
end

#labels ⇒ Hash<String,String>

The labels with user-defined metadata to organize BatchPredictionJobs. 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>) 


9440
9441
9442
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 9440

def labels
  @labels
end

#manual_batch_tuning_parameters ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ManualBatchTuningParameters

Manual batch tuning parameters. Corresponds to the JSON property manualBatchTuningParameters

Returns:



9445
9446
9447
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 9445

def manual_batch_tuning_parameters
  @manual_batch_tuning_parameters
end

#model ⇒ String

The name of the Model resource that produces the predictions via this job, must share the same ancestor Location. Starting this job has no impact on any existing deployments of the Model and their resources. Exactly one of model, unmanaged_container_model, or endpoint must be set. The model resource name may contain version id or version alias to specify the version. Example: projects/project/locations/location/models/model@2 or projects/ project/locations/location/models/model@golden if no version is specified, the default version will be deployed. The model resource could also be a publisher model. Example: publishers/publisher/models/modelor ` projects/`project`/locations/`location`/publishers/`publisher`/models/`model Corresponds to the JSON property model

Returns:

  • (String) 


9459
9460
9461
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 9459

def model
  @model
end

#model_monitoring_config ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ModelMonitoringConfig

The model monitoring configuration used for Batch Prediction Job. Corresponds to the JSON property modelMonitoringConfig

Returns:



9464
9465
9466
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 9464

def model_monitoring_config
  @model_monitoring_config
end

#model_monitoring_stats_anomalies ⇒ Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ModelMonitoringStatsAnomalies>

Get batch prediction job monitoring statistics. Corresponds to the JSON property modelMonitoringStatsAnomalies

Returns:



9469
9470
9471
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 9469

def model_monitoring_stats_anomalies
  @model_monitoring_stats_anomalies
end

#model_monitoring_status ⇒ 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 modelMonitoringStatus

Returns:



9479
9480
9481
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 9479

def model_monitoring_status
  @model_monitoring_status
end

#model_parameters ⇒ Object

The parameters that govern the predictions. The schema of the parameters may be specified via the Model's PredictSchemata's parameters_schema_uri. Corresponds to the JSON property modelParameters

Returns:

  • (Object) 


9485
9486
9487
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 9485

def model_parameters
  @model_parameters
end

#model_version_id ⇒ String

Output only. The version ID of the Model that produces the predictions via this job. Corresponds to the JSON property modelVersionId

Returns:

  • (String) 


9491
9492
9493
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 9491

def model_version_id
  @model_version_id
end

#name ⇒ String

Output only. Resource name of the BatchPredictionJob. Corresponds to the JSON property name

Returns:

  • (String) 


9496
9497
9498
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 9496

def name
  @name
end

#output_config ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1BatchPredictionJobOutputConfig

Configures the output of BatchPredictionJob. See Model. supported_output_storage_formats for supported output formats, and how predictions are expressed via any of them. Corresponds to the JSON property outputConfig

Returns:



9503
9504
9505
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 9503

def output_config
  @output_config
end

#output_info ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1BatchPredictionJobOutputInfo

Further describes this job's output. Supplements output_config. Corresponds to the JSON property outputInfo

Returns:



9508
9509
9510
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 9508

def output_info
  @output_info
end

#partial_failures ⇒ Array<Google::Apis::AiplatformV1beta1::GoogleRpcStatus>

Output only. Partial failures encountered. For example, single files that can' t be read. This field never exceeds 20 entries. Status details fields contain standard Google Cloud error details. Corresponds to the JSON property partialFailures

Returns:



9515
9516
9517
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 9515

def partial_failures
  @partial_failures
end

#resources_consumed ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ResourcesConsumed

Statistics information about resource consumption. Corresponds to the JSON property resourcesConsumed

Returns:



9520
9521
9522
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 9520

def resources_consumed
  @resources_consumed
end

#satisfies_pzi ⇒ Boolean Also known as: satisfies_pzi?

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

Returns:

  • (Boolean) 


9525
9526
9527
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 9525

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) 


9531
9532
9533
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 9531

def satisfies_pzs
  @satisfies_pzs
end

#service_account ⇒ String

The service account that the DeployedModel's container runs as. If not specified, a system generated one will be used, which has minimal permissions and the custom container, if used, may not have enough permission to access other Google Cloud resources. Users deploying the Model must have the iam. serviceAccounts.actAs permission on this service account. Corresponds to the JSON property serviceAccount

Returns:

  • (String) 


9541
9542
9543
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 9541

def 
  @service_account
end

#start_time ⇒ String

Output only. Time when the BatchPredictionJob for the first time entered the JOB_STATE_RUNNING state. Corresponds to the JSON property startTime

Returns:

  • (String) 


9547
9548
9549
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 9547

def start_time
  @start_time
end

#state ⇒ String

Output only. The detailed state of the job. Corresponds to the JSON property state

Returns:

  • (String) 


9552
9553
9554
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 9552

def state
  @state
end

#unmanaged_container_model ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1UnmanagedContainerModel

Contains model information necessary to perform batch prediction without requiring a full model import. Corresponds to the JSON property unmanagedContainerModel

Returns:



9558
9559
9560
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 9558

def unmanaged_container_model
  @unmanaged_container_model
end

#update_time ⇒ String

Output only. Time when the BatchPredictionJob was most recently updated. Corresponds to the JSON property updateTime

Returns:

  • (String) 


9563
9564
9565
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 9563

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



9570
9571
9572
9573
9574
9575
9576
9577
9578
9579
9580
9581
9582
9583
9584
9585
9586
9587
9588
9589
9590
9591
9592
9593
9594
9595
9596
9597
9598
9599
9600
9601
9602
9603
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 9570

def update!(**args)
  @completion_stats = args[:completion_stats] if args.key?(:completion_stats)
  @create_time = args[:create_time] if args.key?(:create_time)
  @dedicated_resources = args[:dedicated_resources] if args.key?(:dedicated_resources)
  @disable_container_logging = args[:disable_container_logging] if args.key?(:disable_container_logging)
  @display_name = args[:display_name] if args.key?(:display_name)
  @encryption_spec = args[:encryption_spec] if args.key?(:encryption_spec)
  @end_time = args[:end_time] if args.key?(:end_time)
  @error = args[:error] if args.key?(:error)
  @explanation_spec = args[:explanation_spec] if args.key?(:explanation_spec)
  @generate_explanation = args[:generate_explanation] if args.key?(:generate_explanation)
  @input_config = args[:input_config] if args.key?(:input_config)
  @instance_config = args[:instance_config] if args.key?(:instance_config)
  @labels = args[:labels] if args.key?(:labels)
  @manual_batch_tuning_parameters = args[:manual_batch_tuning_parameters] if args.key?(:manual_batch_tuning_parameters)
  @model = args[:model] if args.key?(:model)
  @model_monitoring_config = args[:model_monitoring_config] if args.key?(:model_monitoring_config)
  @model_monitoring_stats_anomalies = args[:model_monitoring_stats_anomalies] if args.key?(:model_monitoring_stats_anomalies)
  @model_monitoring_status = args[:model_monitoring_status] if args.key?(:model_monitoring_status)
  @model_parameters = args[:model_parameters] if args.key?(:model_parameters)
  @model_version_id = args[:model_version_id] if args.key?(:model_version_id)
  @name = args[:name] if args.key?(:name)
  @output_config = args[:output_config] if args.key?(:output_config)
  @output_info = args[:output_info] if args.key?(:output_info)
  @partial_failures = args[:partial_failures] if args.key?(:partial_failures)
  @resources_consumed = args[:resources_consumed] if args.key?(:resources_consumed)
  @satisfies_pzi = args[:satisfies_pzi] if args.key?(:satisfies_pzi)
  @satisfies_pzs = args[:satisfies_pzs] if args.key?(:satisfies_pzs)
  @service_account = args[:service_account] if args.key?(:service_account)
  @start_time = args[:start_time] if args.key?(:start_time)
  @state = args[:state] if args.key?(:state)
  @unmanaged_container_model = args[:unmanaged_container_model] if args.key?(:unmanaged_container_model)
  @update_time = args[:update_time] if args.key?(:update_time)
end