public sealed class BatchPredictionJob.Types.OutputConfig : IMessage<BatchPredictionJob.Types.OutputConfig>, IEquatable<BatchPredictionJob.Types.OutputConfig>, IDeepCloneable<BatchPredictionJob.Types.OutputConfig>, IBufferMessage, IMessageReference documentation and code samples for the Cloud AI Platform v1beta1 API class BatchPredictionJob.Types.OutputConfig.
Configures the output of [BatchPredictionJob][google.cloud.aiplatform.v1beta1.BatchPredictionJob]. See [Model.supported_output_storage_formats][google.cloud.aiplatform.v1beta1.Model.supported_output_storage_formats] for supported output formats, and how predictions are expressed via any of them.
Implements
IMessageBatchPredictionJobTypesOutputConfig, IEquatableBatchPredictionJobTypesOutputConfig, IDeepCloneableBatchPredictionJobTypesOutputConfig, IBufferMessage, IMessageNamespace
Google.Cloud.AIPlatform.V1Beta1Assembly
Google.Cloud.AIPlatform.V1Beta1.dll
Constructors
OutputConfig()
public OutputConfig()OutputConfig(OutputConfig)
public OutputConfig(BatchPredictionJob.Types.OutputConfig other)| Parameter | |
|---|---|
| Name | Description |
other |
BatchPredictionJobTypesOutputConfig |
Properties
BigqueryDestination
public BigQueryDestination BigqueryDestination { get; set; }The BigQuery project or dataset location where the output is to be
written to. If project is provided, a new dataset is created with name
prediction_<model-display-name>_<job-create-time>
where <model-display-name> is made
BigQuery-dataset-name compatible (for example, most special characters
become underscores), and timestamp is in
YYYY_MM_DDThh_mm_ss_sssZ "based on ISO-8601" format. In the dataset
two tables will be created, predictions, and errors.
If the Model has both
[instance][google.cloud.aiplatform.v1beta1.PredictSchemata.instance_schema_uri]
and
[prediction][google.cloud.aiplatform.v1beta1.PredictSchemata.parameters_schema_uri]
schemata defined then the tables have columns as follows: The
predictions table contains instances for which the prediction
succeeded, it has columns as per a concatenation of the Model's
instance and prediction schemata. The errors table contains rows for
which the prediction has failed, it has instance columns, as per the
instance schema, followed by a single "errors" column, which as values
has [google.rpc.Status][google.rpc.Status]
represented as a STRUCT, and containing only code and message.
| Property Value | |
|---|---|
| Type | Description |
BigQueryDestination |
|
DestinationCase
public BatchPredictionJob.Types.OutputConfig.DestinationOneofCase DestinationCase { get; }| Property Value | |
|---|---|
| Type | Description |
BatchPredictionJobTypesOutputConfigDestinationOneofCase |
|
GcsDestination
public GcsDestination GcsDestination { get; set; }The Cloud Storage location of the directory where the output is
to be written to. In the given directory a new directory is created.
Its name is prediction-<model-display-name>-<job-create-time>,
where timestamp is in YYYY-MM-DDThh:mm:ss.sssZ ISO-8601 format.
Inside of it files predictions_0001.<extension>,
predictions_0002.<extension>, ..., predictions_N.<extension>
are created where <extension> depends on chosen
[predictions_format][google.cloud.aiplatform.v1beta1.BatchPredictionJob.OutputConfig.predictions_format],
and N may equal 0001 and depends on the total number of successfully
predicted instances. If the Model has both
[instance][google.cloud.aiplatform.v1beta1.PredictSchemata.instance_schema_uri]
and
[prediction][google.cloud.aiplatform.v1beta1.PredictSchemata.parameters_schema_uri]
schemata defined then each such file contains predictions as per the
[predictions_format][google.cloud.aiplatform.v1beta1.BatchPredictionJob.OutputConfig.predictions_format].
If prediction for any instance failed (partially or completely), then
an additional errors_0001.<extension>, errors_0002.<extension>,...,
errors_N.<extension> files are created (N depends on total number
of failed predictions). These files contain the failed instances,
as per their schema, followed by an additional error field which as
value has [google.rpc.Status][google.rpc.Status]
containing only code and message fields.
| Property Value | |
|---|---|
| Type | Description |
GcsDestination |
|
PredictionsFormat
public string PredictionsFormat { get; set; }Required. The format in which Vertex AI gives the predictions, must be one of the [Model's][google.cloud.aiplatform.v1beta1.BatchPredictionJob.model] [supported_output_storage_formats][google.cloud.aiplatform.v1beta1.Model.supported_output_storage_formats].
| Property Value | |
|---|---|
| Type | Description |
string |
|