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.



2586
2587
2588
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 2586

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:



2384
2385
2386
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 2384

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) 


2389
2390
2391
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 2389

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:



2395
2396
2397
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 2395

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) 


2404
2405
2406
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 2404

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) 


2410
2411
2412
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 2410

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



2416
2417
2418
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 2416

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) 


2422
2423
2424
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 2422

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:



2432
2433
2434
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 2432

def error
  @error
end

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

Specification of Model explanation. Corresponds to the JSON property explanationSpec

Returns:



2437
2438
2439
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 2437

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) 


2450
2451
2452
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 2450

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:



2458
2459
2460
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 2458

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:



2464
2465
2466
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 2464

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>) 


2473
2474
2475
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 2473

def labels
  @labels
end

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

Manual batch tuning parameters. Corresponds to the JSON property manualBatchTuningParameters

Returns:



2478
2479
2480
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 2478

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 and unmanaged_container_model 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) 


2492
2493
2494
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 2492

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:



2497
2498
2499
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 2497

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:



2502
2503
2504
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 2502

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:



2512
2513
2514
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 2512

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) 


2518
2519
2520
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 2518

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) 


2524
2525
2526
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 2524

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) 


2529
2530
2531
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 2529

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:



2536
2537
2538
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 2536

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:



2541
2542
2543
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 2541

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:



2548
2549
2550
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 2548

def partial_failures
  @partial_failures
end

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

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

Returns:



2553
2554
2555
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 2553

def resources_consumed
  @resources_consumed
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) 


2562
2563
2564
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 2562

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) 


2568
2569
2570
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 2568

def start_time
  @start_time
end

#state ⇒ String

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

Returns:

  • (String) 


2573
2574
2575
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 2573

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:



2579
2580
2581
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 2579

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) 


2584
2585
2586
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 2584

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 2591

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)
  @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