Skip to content

Commit 5087d20

Browse files
sararobabcdefgs0324
authored andcommitted
chore: update bq destination docstring for bp job (googleapis#1495)
1 parent 39eb0b0 commit 5087d20

File tree

1 file changed

+21
-21
lines changed

1 file changed

+21
-21
lines changed

google/cloud/aiplatform/jobs.py

+21-21
Original file line numberDiff line numberDiff line change
@@ -438,27 +438,27 @@ def create(
438438
which as value has ```google.rpc.Status`` <Status>`__
439439
containing only ``code`` and ``message`` fields.
440440
bigquery_destination_prefix (Optional[str]):
441-
The BigQuery URI to a project or table, up to 2000 characters long.
442-
When only the project is specified, the Dataset and Table is created.
443-
When the full table reference is specified, the Dataset must exist and
444-
table must not exist. Accepted forms: ``bq://projectId`` or
445-
``bq://projectId.bqDatasetId`` or
446-
``bq://projectId.bqDatasetId.bqTableId``. If no Dataset is specified,
447-
a new one is created with the name
448-
``prediction_<model-display-name>_<job-create-time>``
449-
where the table name is made BigQuery-dataset-name compatible
450-
(for example, most special characters become underscores), and
451-
timestamp is in YYYY_MM_DDThh_mm_ss_sssZ "based on ISO-8601"
452-
format. In the dataset two tables will be created, ``predictions``,
453-
and ``errors``. If the Model has both ``instance`` and
454-
``prediction`` schemata defined then the tables have columns as
455-
follows: The ``predictions`` table contains instances for which
456-
the prediction succeeded, it has columns as per a concatenation
457-
of the Model's instance and prediction schemata. The ``errors``
458-
table contains rows for which the prediction has failed, it has
459-
instance columns, as per the instance schema, followed by a single
460-
"errors" column, which as values has ```google.rpc.Status`` <Status>`__
461-
represented as a STRUCT, and containing only ``code`` and ``message``.
441+
The BigQuery project or dataset location where the output is
442+
to be written to. If project is provided, a new dataset is
443+
created with name
444+
``prediction_<model-display-name>_<job-create-time>`` where
445+
is made BigQuery-dataset-name compatible (for example, most
446+
special characters become underscores), and timestamp is in
447+
YYYY_MM_DDThh_mm_ss_sssZ "based on ISO-8601" format. In the
448+
dataset two tables will be created, ``predictions``, and
449+
``errors``. If the Model has both
450+
[instance][google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri]
451+
and
452+
[prediction][google.cloud.aiplatform.v1.PredictSchemata.parameters_schema_uri]
453+
schemata defined then the tables have columns as follows:
454+
The ``predictions`` table contains instances for which the
455+
prediction succeeded, it has columns as per a concatenation
456+
of the Model's instance and prediction schemata. The
457+
``errors`` table contains rows for which the prediction has
458+
failed, it has instance columns, as per the instance schema,
459+
followed by a single "errors" column, which as values has
460+
[google.rpc.Status][google.rpc.Status] represented as a
461+
STRUCT, and containing only ``code`` and ``message``.
462462
model_parameters (Optional[Dict]):
463463
The parameters that govern the predictions. The schema of
464464
the parameters may be specified via the Model's `parameters_schema_uri`.

0 commit comments

Comments
 (0)