Cloud AutoML V1beta1 Client - Class TablesAnnotation (1.5.4)

Reference documentation and code samples for the Cloud AutoML V1beta1 Client class TablesAnnotation.

Contains annotation details specific to Tables.

Generated from protobuf message google.cloud.automl.v1beta1.TablesAnnotation

Namespace

Google \ Cloud \ AutoMl \ V1beta1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ score float

Output only. A confidence estimate between 0.0 and 1.0, inclusive. A higher value means greater confidence in the returned value. For target_column_spec of FLOAT64 data type the score is not populated.

↳ prediction_interval Google\Cloud\AutoMl\V1beta1\DoubleRange

Output only. Only populated when target_column_spec has FLOAT64 data type. An interval in which the exactly correct target value has 95% chance to be in.

↳ value Google\Protobuf\Value

The predicted value of the row's target_column. The value depends on the column's DataType: * CATEGORY - the predicted (with the above confidence score) CATEGORY value. * FLOAT64 - the predicted (with above prediction_interval) FLOAT64 value.

↳ tables_model_column_info array<Google\Cloud\AutoMl\V1beta1\TablesModelColumnInfo>

Output only. Auxiliary information for each of the model's input_feature_column_specs with respect to this particular prediction. If no other fields than column_spec_name and column_display_name would be populated, then this whole field is not.

↳ baseline_score float

Output only. Stores the prediction score for the baseline example, which is defined as the example with all values set to their baseline values. This is used as part of the Sampled Shapley explanation of the model's prediction. This field is populated only when feature importance is requested. For regression models, this holds the baseline prediction for the baseline example. For classification models, this holds the baseline prediction for the baseline example for the argmax class.

getScore

Output only. A confidence estimate between 0.0 and 1.0, inclusive. A higher value means greater confidence in the returned value.

For target_column_spec of FLOAT64 data type the score is not populated.

Returns
TypeDescription
float

setScore

Output only. A confidence estimate between 0.0 and 1.0, inclusive. A higher value means greater confidence in the returned value.

For target_column_spec of FLOAT64 data type the score is not populated.

Parameter
NameDescription
var float
Returns
TypeDescription
$this

getPredictionInterval

Output only. Only populated when target_column_spec has FLOAT64 data type. An interval in which the exactly correct target value has 95% chance to be in.

Returns
TypeDescription
Google\Cloud\AutoMl\V1beta1\DoubleRange|null

hasPredictionInterval

clearPredictionInterval

setPredictionInterval

Output only. Only populated when target_column_spec has FLOAT64 data type. An interval in which the exactly correct target value has 95% chance to be in.

Parameter
NameDescription
var Google\Cloud\AutoMl\V1beta1\DoubleRange
Returns
TypeDescription
$this

getValue

The predicted value of the row's target_column.

The value depends on the column's DataType:

  • CATEGORY - the predicted (with the above confidence score) CATEGORY value.
  • FLOAT64 - the predicted (with above prediction_interval) FLOAT64 value.
Returns
TypeDescription
Google\Protobuf\Value|null

hasValue

clearValue

setValue

The predicted value of the row's target_column.

The value depends on the column's DataType:

  • CATEGORY - the predicted (with the above confidence score) CATEGORY value.
  • FLOAT64 - the predicted (with above prediction_interval) FLOAT64 value.
Parameter
NameDescription
var Google\Protobuf\Value
Returns
TypeDescription
$this

getTablesModelColumnInfo

Output only. Auxiliary information for each of the model's input_feature_column_specs with respect to this particular prediction.

If no other fields than column_spec_name and column_display_name would be populated, then this whole field is not.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setTablesModelColumnInfo

Output only. Auxiliary information for each of the model's input_feature_column_specs with respect to this particular prediction.

If no other fields than column_spec_name and column_display_name would be populated, then this whole field is not.

Parameter
NameDescription
var array<Google\Cloud\AutoMl\V1beta1\TablesModelColumnInfo>
Returns
TypeDescription
$this

getBaselineScore

Output only. Stores the prediction score for the baseline example, which is defined as the example with all values set to their baseline values.

This is used as part of the Sampled Shapley explanation of the model's prediction. This field is populated only when feature importance is requested. For regression models, this holds the baseline prediction for the baseline example. For classification models, this holds the baseline prediction for the baseline example for the argmax class.

Returns
TypeDescription
float

setBaselineScore

Output only. Stores the prediction score for the baseline example, which is defined as the example with all values set to their baseline values.

This is used as part of the Sampled Shapley explanation of the model's prediction. This field is populated only when feature importance is requested. For regression models, this holds the baseline prediction for the baseline example. For classification models, this holds the baseline prediction for the baseline example for the argmax class.

Parameter
NameDescription
var float
Returns
TypeDescription
$this