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
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
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 |
↳ 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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
var |
float
|
| Returns | |
|---|---|
| Type | Description |
$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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
var |
Google\Cloud\AutoMl\V1beta1\DoubleRange
|
| Returns | |
|---|---|
| Type | Description |
$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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Value
|
| Returns | |
|---|---|
| Type | Description |
$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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\AutoMl\V1beta1\TablesModelColumnInfo>
|
| Returns | |
|---|---|
| Type | Description |
$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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
var |
float
|
| Returns | |
|---|---|
| Type | Description |
$this | |