Class GoogleCloudAiplatformV1BatchPredictionJob

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.

Inheritance
object
GoogleCloudAiplatformV1BatchPredictionJob
Implements
Inherited Members
Namespace: Google.Apis.Aiplatform.v1.Data
Assembly: Google.Apis.Aiplatform.v1.dll
Syntax
public class GoogleCloudAiplatformV1BatchPredictionJob : IDirectResponseSchema

Properties

CompletionStats

Output only. Statistics on completed and failed prediction instances.

Declaration
[JsonProperty("completionStats")]
public virtual GoogleCloudAiplatformV1CompletionStats CompletionStats { get; set; }
Property Value
Type Description
GoogleCloudAiplatformV1CompletionStats

CreateTime

object representation of CreateTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use CreateTimeDateTimeOffset instead.")]
public virtual object CreateTime { get; set; }
Property Value
Type Description
object

CreateTimeDateTimeOffset

DateTimeOffset representation of CreateTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? CreateTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

CreateTimeRaw

Output only. Time when the BatchPredictionJob was created.

Declaration
[JsonProperty("createTime")]
public virtual string CreateTimeRaw { get; set; }
Property Value
Type Description
string

DedicatedResources

The config of resources used by the Model during the batch prediction. If the Model supports DEDICATED_RESOURCES this config may be provided (and the job will use these resources), if the Model doesn't support AUTOMATIC_RESOURCES, this config must be provided.

Declaration
[JsonProperty("dedicatedResources")]
public virtual GoogleCloudAiplatformV1BatchDedicatedResources DedicatedResources { get; set; }
Property Value
Type Description
GoogleCloudAiplatformV1BatchDedicatedResources

DisableContainerLogging

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.

Declaration
[JsonProperty("disableContainerLogging")]
public virtual bool? DisableContainerLogging { get; set; }
Property Value
Type Description
bool?

DisplayName

Required. The user-defined name of this BatchPredictionJob.

Declaration
[JsonProperty("displayName")]
public virtual string DisplayName { get; set; }
Property Value
Type Description
string

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

EncryptionSpec

Customer-managed encryption key options for a BatchPredictionJob. If this is set, then all resources created by the BatchPredictionJob will be encrypted with the provided encryption key.

Declaration
[JsonProperty("encryptionSpec")]
public virtual GoogleCloudAiplatformV1EncryptionSpec EncryptionSpec { get; set; }
Property Value
Type Description
GoogleCloudAiplatformV1EncryptionSpec

EndTime

object representation of EndTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use EndTimeDateTimeOffset instead.")]
public virtual object EndTime { get; set; }
Property Value
Type Description
object

EndTimeDateTimeOffset

DateTimeOffset representation of EndTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? EndTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

EndTimeRaw

Output only. Time when the BatchPredictionJob entered any of the following states: JOB_STATE_SUCCEEDED, JOB_STATE_FAILED, JOB_STATE_CANCELLED.

Declaration
[JsonProperty("endTime")]
public virtual string EndTimeRaw { get; set; }
Property Value
Type Description
string

Error

Output only. Only populated when the job's state is JOB_STATE_FAILED or JOB_STATE_CANCELLED.

Declaration
[JsonProperty("error")]
public virtual GoogleRpcStatus Error { get; set; }
Property Value
Type Description
GoogleRpcStatus

ExplanationSpec

Explanation configuration for this BatchPredictionJob. Can be specified only if generate_explanation is set to true. This value overrides the value of Model.explanation_spec. All fields of explanation_spec are optional in the request. If a field of the explanation_spec object is not populated, the corresponding field of the Model.explanation_spec object is inherited.

Declaration
[JsonProperty("explanationSpec")]
public virtual GoogleCloudAiplatformV1ExplanationSpec ExplanationSpec { get; set; }
Property Value
Type Description
GoogleCloudAiplatformV1ExplanationSpec

GenerateExplanation

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.

Declaration
[JsonProperty("generateExplanation")]
public virtual bool? GenerateExplanation { get; set; }
Property Value
Type Description
bool?

InputConfig

Required. Input configuration of the instances on which predictions are performed. The schema of any single instance may be specified via the Model's PredictSchemata's instance_schema_uri.

Declaration
[JsonProperty("inputConfig")]
public virtual GoogleCloudAiplatformV1BatchPredictionJobInputConfig InputConfig { get; set; }
Property Value
Type Description
GoogleCloudAiplatformV1BatchPredictionJobInputConfig

InstanceConfig

Configuration for how to convert batch prediction input instances to the prediction instances that are sent to the Model.

Declaration
[JsonProperty("instanceConfig")]
public virtual GoogleCloudAiplatformV1BatchPredictionJobInstanceConfig InstanceConfig { get; set; }
Property Value
Type Description
GoogleCloudAiplatformV1BatchPredictionJobInstanceConfig

Labels

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.

Declaration
[JsonProperty("labels")]
public virtual IDictionary<string, string> Labels { get; set; }
Property Value
Type Description
IDictionary<string, string>

ManualBatchTuningParameters

Immutable. Parameters configuring the batch behavior. Currently only applicable when dedicated_resources are used (in other cases Vertex AI does the tuning itself).

Declaration
[JsonProperty("manualBatchTuningParameters")]
public virtual GoogleCloudAiplatformV1ManualBatchTuningParameters ManualBatchTuningParameters { get; set; }
Property Value
Type Description
GoogleCloudAiplatformV1ManualBatchTuningParameters

Model

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/{model} or projects/{project}/locations/{location}/publishers/{publisher}/models/{model}

Declaration
[JsonProperty("model")]
public virtual string Model { get; set; }
Property Value
Type Description
string

ModelParameters

The parameters that govern the predictions. The schema of the parameters may be specified via the Model's PredictSchemata's parameters_schema_uri.

Declaration
[JsonProperty("modelParameters")]
public virtual object ModelParameters { get; set; }
Property Value
Type Description
object

ModelVersionId

Output only. The version ID of the Model that produces the predictions via this job.

Declaration
[JsonProperty("modelVersionId")]
public virtual string ModelVersionId { get; set; }
Property Value
Type Description
string

Name

Output only. Resource name of the BatchPredictionJob.

Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type Description
string

OutputConfig

Required. The Configuration specifying where output predictions should be written. The schema of any single prediction may be specified as a concatenation of Model's PredictSchemata's instance_schema_uri and prediction_schema_uri.

Declaration
[JsonProperty("outputConfig")]
public virtual GoogleCloudAiplatformV1BatchPredictionJobOutputConfig OutputConfig { get; set; }
Property Value
Type Description
GoogleCloudAiplatformV1BatchPredictionJobOutputConfig

OutputInfo

Output only. Information further describing the output of this job.

Declaration
[JsonProperty("outputInfo")]
public virtual GoogleCloudAiplatformV1BatchPredictionJobOutputInfo OutputInfo { get; set; }
Property Value
Type Description
GoogleCloudAiplatformV1BatchPredictionJobOutputInfo

PartialFailures

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.

Declaration
[JsonProperty("partialFailures")]
public virtual IList<GoogleRpcStatus> PartialFailures { get; set; }
Property Value
Type Description
IList<GoogleRpcStatus>

ResourcesConsumed

Output only. Information about resources that had been consumed by this job. Provided in real time at best effort basis, as well as a final value once the job completes. Note: This field currently may be not populated for batch predictions that use AutoML Models.

Declaration
[JsonProperty("resourcesConsumed")]
public virtual GoogleCloudAiplatformV1ResourcesConsumed ResourcesConsumed { get; set; }
Property Value
Type Description
GoogleCloudAiplatformV1ResourcesConsumed

SatisfiesPzi

Output only. Reserved for future use.

Declaration
[JsonProperty("satisfiesPzi")]
public virtual bool? SatisfiesPzi { get; set; }
Property Value
Type Description
bool?

SatisfiesPzs

Output only. Reserved for future use.

Declaration
[JsonProperty("satisfiesPzs")]
public virtual bool? SatisfiesPzs { get; set; }
Property Value
Type Description
bool?

ServiceAccount

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.

Declaration
[JsonProperty("serviceAccount")]
public virtual string ServiceAccount { get; set; }
Property Value
Type Description
string

StartTime

object representation of StartTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use StartTimeDateTimeOffset instead.")]
public virtual object StartTime { get; set; }
Property Value
Type Description
object

StartTimeDateTimeOffset

DateTimeOffset representation of StartTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? StartTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

StartTimeRaw

Output only. Time when the BatchPredictionJob for the first time entered the JOB_STATE_RUNNING state.

Declaration
[JsonProperty("startTime")]
public virtual string StartTimeRaw { get; set; }
Property Value
Type Description
string

State

Output only. The detailed state of the job.

Declaration
[JsonProperty("state")]
public virtual string State { get; set; }
Property Value
Type Description
string

UnmanagedContainerModel

Contains model information necessary to perform batch prediction without requiring uploading to model registry. Exactly one of model and unmanaged_container_model must be set.

Declaration
[JsonProperty("unmanagedContainerModel")]
public virtual GoogleCloudAiplatformV1UnmanagedContainerModel UnmanagedContainerModel { get; set; }
Property Value
Type Description
GoogleCloudAiplatformV1UnmanagedContainerModel

UpdateTime

object representation of UpdateTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use UpdateTimeDateTimeOffset instead.")]
public virtual object UpdateTime { get; set; }
Property Value
Type Description
object

UpdateTimeDateTimeOffset

DateTimeOffset representation of UpdateTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? UpdateTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

UpdateTimeRaw

Output only. Time when the BatchPredictionJob was most recently updated.

Declaration
[JsonProperty("updateTime")]
public virtual string UpdateTimeRaw { get; set; }
Property Value
Type Description
string

Implements