public sealed class BatchPredictionJob : IMessage<BatchPredictionJob>, IEquatable<BatchPredictionJob>, IDeepCloneable<BatchPredictionJob>, IBufferMessage, IMessageReference documentation and code samples for the Cloud AI Platform v1 API class BatchPredictionJob.
A job that uses a [Model][google.cloud.aiplatform.v1.BatchPredictionJob.model] to produce predictions on multiple [input instances][google.cloud.aiplatform.v1.BatchPredictionJob.input_config]. If predictions for significant portion of the instances fail, the job may finish without attempting predictions for all remaining instances.
Implements
IMessageBatchPredictionJob, IEquatableBatchPredictionJob, IDeepCloneableBatchPredictionJob, IBufferMessage, IMessageNamespace
Google.Cloud.AIPlatform.V1Assembly
Google.Cloud.AIPlatform.V1.dll
Constructors
BatchPredictionJob()
public BatchPredictionJob()BatchPredictionJob(BatchPredictionJob)
public BatchPredictionJob(BatchPredictionJob other)| Parameter | |
|---|---|
| Name | Description |
other | BatchPredictionJob |
Properties
BatchPredictionJobName
public BatchPredictionJobName BatchPredictionJobName { get; set; }BatchPredictionJobName-typed view over the Name resource name property.
| Property Value | |
|---|---|
| Type | Description |
BatchPredictionJobName | |
CompletionStats
public CompletionStats CompletionStats { get; set; }Output only. Statistics on completed and failed prediction instances.
| Property Value | |
|---|---|
| Type | Description |
CompletionStats | |
CreateTime
public Timestamp CreateTime { get; set; }Output only. Time when the BatchPredictionJob was created.
| Property Value | |
|---|---|
| Type | Description |
Timestamp | |
DedicatedResources
public BatchDedicatedResources DedicatedResources { get; set; }The config of resources used by the Model during the batch prediction. If the Model [supports][google.cloud.aiplatform.v1.Model.supported_deployment_resources_types] 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.
| Property Value | |
|---|---|
| Type | Description |
BatchDedicatedResources | |
DisableContainerLogging
public bool DisableContainerLogging { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
bool | |
DisplayName
public string DisplayName { get; set; }Required. The user-defined name of this BatchPredictionJob.
| Property Value | |
|---|---|
| Type | Description |
string | |
EncryptionSpec
public EncryptionSpec EncryptionSpec { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
EncryptionSpec | |
EndTime
public Timestamp EndTime { get; set; }Output only. Time when the BatchPredictionJob entered any of the following
states: JOB_STATE_SUCCEEDED, JOB_STATE_FAILED, JOB_STATE_CANCELLED.
| Property Value | |
|---|---|
| Type | Description |
Timestamp | |
Error
public Status Error { get; set; }Output only. Only populated when the job's state is JOB_STATE_FAILED or JOB_STATE_CANCELLED.
| Property Value | |
|---|---|
| Type | Description |
Status | |
ExplanationSpec
public ExplanationSpec ExplanationSpec { get; set; }Explanation configuration for this BatchPredictionJob. Can be
specified only if
[generate_explanation][google.cloud.aiplatform.v1.BatchPredictionJob.generate_explanation]
is set to true.
This value overrides the value of [Model.explanation_spec][google.cloud.aiplatform.v1.Model.explanation_spec]. All fields of [explanation_spec][google.cloud.aiplatform.v1.BatchPredictionJob.explanation_spec] are optional in the request. If a field of the [explanation_spec][google.cloud.aiplatform.v1.BatchPredictionJob.explanation_spec] object is not populated, the corresponding field of the [Model.explanation_spec][google.cloud.aiplatform.v1.Model.explanation_spec] object is inherited.
| Property Value | |
|---|---|
| Type | Description |
ExplanationSpec | |
GenerateExplanation
public bool GenerateExplanation { get; set; }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][google.cloud.aiplatform.v1.BatchPredictionJob.output_config]
object:
bigquery: output includes a column namedexplanation. The value is a struct that conforms to the [Explanation][google.cloud.aiplatform.v1.Explanation] object.jsonl: The JSON objects on each line include an additional entry keyedexplanation. The value of the entry is a JSON object that conforms to the [Explanation][google.cloud.aiplatform.v1.Explanation] object.csv: Generating explanations for CSV format is not supported.
If this field is set to true, either the [Model.explanation_spec][google.cloud.aiplatform.v1.Model.explanation_spec] or [explanation_spec][google.cloud.aiplatform.v1.BatchPredictionJob.explanation_spec] must be populated.
| Property Value | |
|---|---|
| Type | Description |
bool | |
InputConfig
public BatchPredictionJob.Types.InputConfig InputConfig { get; set; }Required. Input configuration of the instances on which predictions are performed. The schema of any single instance may be specified via the [Model's][google.cloud.aiplatform.v1.BatchPredictionJob.model] [PredictSchemata's][google.cloud.aiplatform.v1.Model.predict_schemata] [instance_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri].
| Property Value | |
|---|---|
| Type | Description |
BatchPredictionJobTypesInputConfig | |
InstanceConfig
public BatchPredictionJob.Types.InstanceConfig InstanceConfig { get; set; }Configuration for how to convert batch prediction input instances to the prediction instances that are sent to the Model.
| Property Value | |
|---|---|
| Type | Description |
BatchPredictionJobTypesInstanceConfig | |
Labels
public MapField<string, string> Labels { get; }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.
| Property Value | |
|---|---|
| Type | Description |
MapFieldstringstring | |
ManualBatchTuningParameters
public ManualBatchTuningParameters ManualBatchTuningParameters { get; set; }Immutable. Parameters configuring the batch behavior. Currently only applicable when [dedicated_resources][google.cloud.aiplatform.v1.BatchPredictionJob.dedicated_resources] are used (in other cases Vertex AI does the tuning itself).
| Property Value | |
|---|---|
| Type | Description |
ManualBatchTuningParameters | |
Model
public string Model { get; set; }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}
| Property Value | |
|---|---|
| Type | Description |
string | |
ModelAsModelName
public ModelName ModelAsModelName { get; set; }| Property Value | |
|---|---|
| Type | Description |
ModelName | |
ModelParameters
public Value ModelParameters { get; set; }The parameters that govern the predictions. The schema of the parameters may be specified via the [Model's][google.cloud.aiplatform.v1.BatchPredictionJob.model] [PredictSchemata's][google.cloud.aiplatform.v1.Model.predict_schemata] [parameters_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.parameters_schema_uri].
| Property Value | |
|---|---|
| Type | Description |
Value | |
ModelVersionId
public string ModelVersionId { get; set; }Output only. The version ID of the Model that produces the predictions via this job.
| Property Value | |
|---|---|
| Type | Description |
string | |
Name
public string Name { get; set; }Output only. Resource name of the BatchPredictionJob.
| Property Value | |
|---|---|
| Type | Description |
string | |
OutputConfig
public BatchPredictionJob.Types.OutputConfig OutputConfig { get; set; }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][google.cloud.aiplatform.v1.BatchPredictionJob.model] [PredictSchemata's][google.cloud.aiplatform.v1.Model.predict_schemata] [instance_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri] and [prediction_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.prediction_schema_uri].
| Property Value | |
|---|---|
| Type | Description |
BatchPredictionJobTypesOutputConfig | |
OutputInfo
public BatchPredictionJob.Types.OutputInfo OutputInfo { get; set; }Output only. Information further describing the output of this job.
| Property Value | |
|---|---|
| Type | Description |
BatchPredictionJobTypesOutputInfo | |
PartialFailures
public RepeatedField<Status> PartialFailures { get; }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.
| Property Value | |
|---|---|
| Type | Description |
RepeatedFieldStatus | |
ResourcesConsumed
public ResourcesConsumed ResourcesConsumed { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
ResourcesConsumed | |
ServiceAccount
public string ServiceAccount { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
string | |
StartTime
public Timestamp StartTime { get; set; }Output only. Time when the BatchPredictionJob for the first time entered
the JOB_STATE_RUNNING state.
| Property Value | |
|---|---|
| Type | Description |
Timestamp | |
State
public JobState State { get; set; }Output only. The detailed state of the job.
| Property Value | |
|---|---|
| Type | Description |
JobState | |
UnmanagedContainerModel
public UnmanagedContainerModel UnmanagedContainerModel { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
UnmanagedContainerModel | |
UpdateTime
public Timestamp UpdateTime { get; set; }Output only. Time when the BatchPredictionJob was most recently updated.
| Property Value | |
|---|---|
| Type | Description |
Timestamp | |