Class TablesAnnotation (2.11.0)

public final class TablesAnnotation extends GeneratedMessageV3 implements TablesAnnotationOrBuilder

Contains annotation details specific to Tables.

Protobuf type google.cloud.automl.v1beta1.TablesAnnotation

Static Fields

BASELINE_SCORE_FIELD_NUMBER

public static final int BASELINE_SCORE_FIELD_NUMBER
Field Value
TypeDescription
int

PREDICTION_INTERVAL_FIELD_NUMBER

public static final int PREDICTION_INTERVAL_FIELD_NUMBER
Field Value
TypeDescription
int

SCORE_FIELD_NUMBER

public static final int SCORE_FIELD_NUMBER
Field Value
TypeDescription
int

TABLES_MODEL_COLUMN_INFO_FIELD_NUMBER

public static final int TABLES_MODEL_COLUMN_INFO_FIELD_NUMBER
Field Value
TypeDescription
int

VALUE_FIELD_NUMBER

public static final int VALUE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static TablesAnnotation getDefaultInstance()
Returns
TypeDescription
TablesAnnotation

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static TablesAnnotation.Builder newBuilder()
Returns
TypeDescription
TablesAnnotation.Builder

newBuilder(TablesAnnotation prototype)

public static TablesAnnotation.Builder newBuilder(TablesAnnotation prototype)
Parameter
NameDescription
prototypeTablesAnnotation
Returns
TypeDescription
TablesAnnotation.Builder

parseDelimitedFrom(InputStream input)

public static TablesAnnotation parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
TablesAnnotation
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TablesAnnotation parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TablesAnnotation
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static TablesAnnotation parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
TablesAnnotation
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static TablesAnnotation parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TablesAnnotation
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static TablesAnnotation parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
TablesAnnotation
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static TablesAnnotation parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TablesAnnotation
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static TablesAnnotation parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
TablesAnnotation
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static TablesAnnotation parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TablesAnnotation
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static TablesAnnotation parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
TablesAnnotation
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TablesAnnotation parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TablesAnnotation
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static TablesAnnotation parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
TablesAnnotation
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static TablesAnnotation parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TablesAnnotation
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<TablesAnnotation> parser()
Returns
TypeDescription
Parser<TablesAnnotation>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getBaselineScore()

public float 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.

float baseline_score = 5;

Returns
TypeDescription
float

The baselineScore.

getDefaultInstanceForType()

public TablesAnnotation getDefaultInstanceForType()
Returns
TypeDescription
TablesAnnotation

getParserForType()

public Parser<TablesAnnotation> getParserForType()
Returns
TypeDescription
Parser<TablesAnnotation>
Overrides

getPredictionInterval()

public DoubleRange 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.

.google.cloud.automl.v1beta1.DoubleRange prediction_interval = 4;

Returns
TypeDescription
DoubleRange

The predictionInterval.

getPredictionIntervalOrBuilder()

public DoubleRangeOrBuilder getPredictionIntervalOrBuilder()

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.

.google.cloud.automl.v1beta1.DoubleRange prediction_interval = 4;

Returns
TypeDescription
DoubleRangeOrBuilder

getScore()

public float 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.

float score = 1;

Returns
TypeDescription
float

The score.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getTablesModelColumnInfo(int index)

public TablesModelColumnInfo getTablesModelColumnInfo(int index)

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.

repeated .google.cloud.automl.v1beta1.TablesModelColumnInfo tables_model_column_info = 3;

Parameter
NameDescription
indexint
Returns
TypeDescription
TablesModelColumnInfo

getTablesModelColumnInfoCount()

public int getTablesModelColumnInfoCount()

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.

repeated .google.cloud.automl.v1beta1.TablesModelColumnInfo tables_model_column_info = 3;

Returns
TypeDescription
int

getTablesModelColumnInfoList()

public List<TablesModelColumnInfo> getTablesModelColumnInfoList()

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.

repeated .google.cloud.automl.v1beta1.TablesModelColumnInfo tables_model_column_info = 3;

Returns
TypeDescription
List<TablesModelColumnInfo>

getTablesModelColumnInfoOrBuilder(int index)

public TablesModelColumnInfoOrBuilder getTablesModelColumnInfoOrBuilder(int index)

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.

repeated .google.cloud.automl.v1beta1.TablesModelColumnInfo tables_model_column_info = 3;

Parameter
NameDescription
indexint
Returns
TypeDescription
TablesModelColumnInfoOrBuilder

getTablesModelColumnInfoOrBuilderList()

public List<? extends TablesModelColumnInfoOrBuilder> getTablesModelColumnInfoOrBuilderList()

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.

repeated .google.cloud.automl.v1beta1.TablesModelColumnInfo tables_model_column_info = 3;

Returns
TypeDescription
List<? extends com.google.cloud.automl.v1beta1.TablesModelColumnInfoOrBuilder>

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

getValue()

public Value 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.

.google.protobuf.Value value = 2;

Returns
TypeDescription
Value

The value.

getValueOrBuilder()

public ValueOrBuilder getValueOrBuilder()

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.

.google.protobuf.Value value = 2;

Returns
TypeDescription
ValueOrBuilder

hasPredictionInterval()

public boolean hasPredictionInterval()

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.

.google.cloud.automl.v1beta1.DoubleRange prediction_interval = 4;

Returns
TypeDescription
boolean

Whether the predictionInterval field is set.

hasValue()

public boolean hasValue()

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.

.google.protobuf.Value value = 2;

Returns
TypeDescription
boolean

Whether the value field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public TablesAnnotation.Builder newBuilderForType()
Returns
TypeDescription
TablesAnnotation.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected TablesAnnotation.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
TablesAnnotation.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public TablesAnnotation.Builder toBuilder()
Returns
TypeDescription
TablesAnnotation.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException