📄 Source: GoogleCloudAiplatformV1BatchPredictionJobOutputConfig.php
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Aiplatform;
class GoogleCloudAiplatformV1BatchPredictionJobOutputConfig extends \Google\Model
{
protected $bigqueryDestinationType = GoogleCloudAiplatformV1BigQueryDestination::class;
protected $bigqueryDestinationDataType = '';
protected $gcsDestinationType = GoogleCloudAiplatformV1GcsDestination::class;
protected $gcsDestinationDataType = '';
/**
* Required. The format in which Vertex AI gives the predictions, must be one
* of the Model's supported_output_storage_formats.
*
* @var string
*/
public $predictionsFormat;
protected $vertexMultimodalDatasetDestinationType = GoogleCloudAiplatformV1VertexMultimodalDatasetDestination::class;
protected $vertexMultimodalDatasetDestinationDataType = '';
/**
* 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__` where 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 and prediction 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 represented as a STRUCT, and containing only `code` and
* `message`.
*
* @param GoogleCloudAiplatformV1BigQueryDestination $bigqueryDestination
*/
public function setBigqueryDestination(GoogleCloudAiplatformV1BigQueryDestination $bigqueryDestination)
{
$this->bigqueryDestination = $bigqueryDestination;
}
/**
* @return GoogleCloudAiplatformV1BigQueryDestination
*/
public function getBigqueryDestination()
{
return $this->bigqueryDestination;
}
/**
* 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--`, where timestamp is in YYYY-MM-DDThh:mm:ss.sssZ ISO-8601
* format. Inside of it files `predictions_0001.`, `predictions_0002.`, ...,
* `predictions_N.` are created where `` depends on chosen predictions_format,
* and N may equal 0001 and depends on the total number of successfully
* predicted instances. If the Model has both instance and prediction schemata
* defined then each such file contains predictions as per the
* predictions_format. If prediction for any instance failed (partially or
* completely), then an additional `errors_0001.`, `errors_0002.`,...,
* `errors_N.` 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 containing only `code` and `message` fields.
*
* @param GoogleCloudAiplatformV1GcsDestination $gcsDestination
*/
public function setGcsDestination(GoogleCloudAiplatformV1GcsDestination $gcsDestination)
{
$this->gcsDestination = $gcsDestination;
}
/**
* @return GoogleCloudAiplatformV1GcsDestination
*/
public function getGcsDestination()
{
return $this->gcsDestination;
}
/**
* Required. The format in which Vertex AI gives the predictions, must be one
* of the Model's supported_output_storage_formats.
*
* @param string $predictionsFormat
*/
public function setPredictionsFormat($predictionsFormat)
{
$this->predictionsFormat = $predictionsFormat;
}
/**
* @return string
*/
public function getPredictionsFormat()
{
return $this->predictionsFormat;
}
/**
* The details for a Vertex Multimodal Dataset that will be created for the
* output.
*
* @param GoogleCloudAiplatformV1VertexMultimodalDatasetDestination $vertexMultimodalDatasetDestination
*/
public function setVertexMultimodalDatasetDestination(GoogleCloudAiplatformV1VertexMultimodalDatasetDestination $vertexMultimodalDatasetDestination)
{
$this->vertexMultimodalDatasetDestination = $vertexMultimodalDatasetDestination;
}
/**
* @return GoogleCloudAiplatformV1VertexMultimodalDatasetDestination
*/
public function getVertexMultimodalDatasetDestination()
{
return $this->vertexMultimodalDatasetDestination;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleCloudAiplatformV1BatchPredictionJobOutputConfig::class, 'Google_Service_Aiplatform_GoogleCloudAiplatformV1BatchPredictionJobOutputConfig');
← Back