REST Resource: projects.locations.instances.predictionResults

Resource: PredictionResult

PredictionResult is the result of using a model to create predictions.

JSON representation
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },
  "state": enum (State),
  "dataset": string,
  "model": string,
  "endTime": string,
  "predictionPeriods": integer,
  "outputs": {
    object (Outputs)
  },
  "lineOfBusiness": enum (LineOfBusiness)
}
Fields
name

string

Output only. The resource name of the PredictionResult. format: "/projects/{project_num}/locations/{location}/instances/{instance}/predictionResults/{predictionResult}"

createTime

string (Timestamp format)

Output only. The timestamp of creation of this resource.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

updateTime

string (Timestamp format)

Output only. The timestamp of the most recent update of this resource.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

labels

map (key: string, value: string)

Labels

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

state

enum (State)

Output only. State of the PredictionResult (creating, active, deleting, etc.)

dataset

string

Required. The resource name of the Dataset to do predictions on Format: "/projects/{project_num}/locations/{location}/instances/{instance}/dataset/{datasetId}"

model

string

Required. The resource name of the Model to use to use to make predictions Format: "/projects/{project_num}/locations/{location}/instances/{instance}/models/{model}"

endTime

string (Timestamp format)

Required. Specifies the latest time from which data is used to generate features for predictions. This time should be no later than the end of the dateRange of the dataset.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

predictionPeriods

integer

The number of consecutive months to produce predictions for, ending with the last full month prior to endTime according to the dataset's timezone.

outputs

object (Outputs)

Required. Where to write the output of the predictions.

lineOfBusiness

enum (LineOfBusiness)

Output only. The line of business (Retail/Commercial) this prediction is for. Determined by Model, cannot be set by user.

State

The possible states of a resource.

Enums
STATE_UNSPECIFIED State is unspecified, should not occur.
CREATING The resource has not finished being created.
ACTIVE The resource is active/ready to be used.
UPDATING The resource is in the process of being updated.
DELETING The resource is in the process of being deleted.

Outputs

Outputs is a list of places where the operation will write results.

JSON representation
{
  "predictionDestination": {
    object (BigQueryDestination)
  },
  "explainabilityDestination": {
    object (BigQueryDestination)
  }
}
Fields
predictionDestination

object (BigQueryDestination)

Required. The location to output the predictions.

explainabilityDestination

object (BigQueryDestination)

The location to output explainability information. If not specified no explainability data will be output.

BigQueryDestination

BigQueryDestination is a wrapper for BigQuery output information.

JSON representation
{
  "tableUri": string,
  "writeDisposition": enum (WriteDisposition)
}
Fields
tableUri

string

Optional. BigQuery URI to a table, must be of the form bq://projectId.bqDatasetId.tableId. Note that the BigQuery dataset must already exist. VPC-SC restrictions apply.

writeDisposition

enum (WriteDisposition)

Required. Whether to overwrite or not destination table. By default the table won't be overwritten and an error will be returned if the table exists and contains data.

WriteDisposition

WriteDisposition controls the behavior when the destination table already exists.

Enums
WRITE_DISPOSITION_UNSPECIFIED Default behavior is the same as WRITE_EMPTY.
WRITE_EMPTY If the table already exists and contains data, an error is returned.
WRITE_TRUNCATE If the table already exists, the data will be overwritten.

Methods

create

Create a PredictionResult.

delete

Deletes a PredictionResult.

exportMetadata

Export governance information for PredictionResult resource.

get

Gets a PredictionResult.

list

List PredictionResults.

patch

Updates the parameters of a single PredictionResult.