Package com.google.cloud.automl.v1beta1

Class TablesAnnotation

  • All Implemented Interfaces:
    TablesAnnotationOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class TablesAnnotation
extends com.google.protobuf.GeneratedMessageV3
implements TablesAnnotationOrBuilder
     Contains annotation details specific to Tables.
    Protobuf type google.cloud.automl.v1beta1.TablesAnnotation
    See Also:
    Serialized Form

    • Field Detail

      • PREDICTION_INTERVAL_FIELD_NUMBER

        public static final int PREDICTION_INTERVAL_FIELD_NUMBER
        See Also:
        Constant Field Values

      • TABLES_MODEL_COLUMN_INFO_FIELD_NUMBER

        public static final int TABLES_MODEL_COLUMN_INFO_FIELD_NUMBER
        See Also:
        Constant Field Values

      • BASELINE_SCORE_FIELD_NUMBER

        public static final int BASELINE_SCORE_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • 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][google.cloud.automl.v1beta1.TablesModelMetadata.target_column_spec]
 of FLOAT64 data type the score is not populated.
        float score = 1;
        Specified by:
        getScore in interface TablesAnnotationOrBuilder
        Returns:
        The score.

      • hasPredictionInterval

        public boolean hasPredictionInterval()
         Output only. Only populated when

 [target_column_spec][google.cloud.automl.v1beta1.TablesModelMetadata.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;
        Specified by:
        hasPredictionInterval in interface TablesAnnotationOrBuilder
        Returns:
        Whether the predictionInterval field is set.

      • getPredictionInterval

        public DoubleRange getPredictionInterval()
         Output only. Only populated when

 [target_column_spec][google.cloud.automl.v1beta1.TablesModelMetadata.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;
        Specified by:
        getPredictionInterval in interface TablesAnnotationOrBuilder
        Returns:
        The predictionInterval.

      • getPredictionIntervalOrBuilder

        public DoubleRangeOrBuilder getPredictionIntervalOrBuilder()
         Output only. Only populated when

 [target_column_spec][google.cloud.automl.v1beta1.TablesModelMetadata.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;
        Specified by:
        getPredictionIntervalOrBuilder in interface TablesAnnotationOrBuilder

      • hasValue

        public boolean hasValue()
         The predicted value of the row's

 [target_column][google.cloud.automl.v1beta1.TablesModelMetadata.target_column_spec].
 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;
        Specified by:
        hasValue in interface TablesAnnotationOrBuilder
        Returns:
        Whether the value field is set.

      • getValue

        public com.google.protobuf.Value getValue()
         The predicted value of the row's

 [target_column][google.cloud.automl.v1beta1.TablesModelMetadata.target_column_spec].
 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;
        Specified by:
        getValue in interface TablesAnnotationOrBuilder
        Returns:
        The value.

      • getValueOrBuilder

        public com.google.protobuf.ValueOrBuilder getValueOrBuilder()
         The predicted value of the row's

 [target_column][google.cloud.automl.v1beta1.TablesModelMetadata.target_column_spec].
 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;
        Specified by:
        getValueOrBuilder in interface TablesAnnotationOrBuilder

      • getTablesModelColumnInfoList

        public List<TablesModelColumnInfo> getTablesModelColumnInfoList()
         Output only. Auxiliary information for each of the model's

 [input_feature_column_specs][google.cloud.automl.v1beta1.TablesModelMetadata.input_feature_column_specs]
 with respect to this particular prediction.
 If no other fields than

 [column_spec_name][google.cloud.automl.v1beta1.TablesModelColumnInfo.column_spec_name]
 and

 [column_display_name][google.cloud.automl.v1beta1.TablesModelColumnInfo.column_display_name]
 would be populated, then this whole field is not.
        repeated .google.cloud.automl.v1beta1.TablesModelColumnInfo tables_model_column_info = 3;
        Specified by:
        getTablesModelColumnInfoList in interface TablesAnnotationOrBuilder

      • getTablesModelColumnInfoOrBuilderList

        public List<? extends TablesModelColumnInfoOrBuilder> getTablesModelColumnInfoOrBuilderList()
         Output only. Auxiliary information for each of the model's

 [input_feature_column_specs][google.cloud.automl.v1beta1.TablesModelMetadata.input_feature_column_specs]
 with respect to this particular prediction.
 If no other fields than

 [column_spec_name][google.cloud.automl.v1beta1.TablesModelColumnInfo.column_spec_name]
 and

 [column_display_name][google.cloud.automl.v1beta1.TablesModelColumnInfo.column_display_name]
 would be populated, then this whole field is not.
        repeated .google.cloud.automl.v1beta1.TablesModelColumnInfo tables_model_column_info = 3;
        Specified by:
        getTablesModelColumnInfoOrBuilderList in interface TablesAnnotationOrBuilder

      • getTablesModelColumnInfoCount

        public int getTablesModelColumnInfoCount()
         Output only. Auxiliary information for each of the model's

 [input_feature_column_specs][google.cloud.automl.v1beta1.TablesModelMetadata.input_feature_column_specs]
 with respect to this particular prediction.
 If no other fields than

 [column_spec_name][google.cloud.automl.v1beta1.TablesModelColumnInfo.column_spec_name]
 and

 [column_display_name][google.cloud.automl.v1beta1.TablesModelColumnInfo.column_display_name]
 would be populated, then this whole field is not.
        repeated .google.cloud.automl.v1beta1.TablesModelColumnInfo tables_model_column_info = 3;
        Specified by:
        getTablesModelColumnInfoCount in interface TablesAnnotationOrBuilder

      • getTablesModelColumnInfo

        public TablesModelColumnInfo getTablesModelColumnInfo​(int index)
         Output only. Auxiliary information for each of the model's

 [input_feature_column_specs][google.cloud.automl.v1beta1.TablesModelMetadata.input_feature_column_specs]
 with respect to this particular prediction.
 If no other fields than

 [column_spec_name][google.cloud.automl.v1beta1.TablesModelColumnInfo.column_spec_name]
 and

 [column_display_name][google.cloud.automl.v1beta1.TablesModelColumnInfo.column_display_name]
 would be populated, then this whole field is not.
        repeated .google.cloud.automl.v1beta1.TablesModelColumnInfo tables_model_column_info = 3;
        Specified by:
        getTablesModelColumnInfo in interface TablesAnnotationOrBuilder

      • getTablesModelColumnInfoOrBuilder

        public TablesModelColumnInfoOrBuilder getTablesModelColumnInfoOrBuilder​(int index)
         Output only. Auxiliary information for each of the model's

 [input_feature_column_specs][google.cloud.automl.v1beta1.TablesModelMetadata.input_feature_column_specs]
 with respect to this particular prediction.
 If no other fields than

 [column_spec_name][google.cloud.automl.v1beta1.TablesModelColumnInfo.column_spec_name]
 and

 [column_display_name][google.cloud.automl.v1beta1.TablesModelColumnInfo.column_display_name]
 would be populated, then this whole field is not.
        repeated .google.cloud.automl.v1beta1.TablesModelColumnInfo tables_model_column_info = 3;
        Specified by:
        getTablesModelColumnInfoOrBuilder in interface TablesAnnotationOrBuilder

      • 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;
        Specified by:
        getBaselineScore in interface TablesAnnotationOrBuilder
        Returns:
        The baselineScore.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static TablesAnnotation parseFrom​(ByteBuffer data)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static TablesAnnotation parseFrom​(ByteBuffer data,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static TablesAnnotation parseFrom​(com.google.protobuf.ByteString data)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static TablesAnnotation parseFrom​(com.google.protobuf.ByteString data,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static TablesAnnotation parseFrom​(byte[] data)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static TablesAnnotation parseFrom​(byte[] data,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static TablesAnnotation parseFrom​(com.google.protobuf.CodedInputStream input,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws IOException
        Throws:
        IOException

      • newBuilderForType

        public TablesAnnotation.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public TablesAnnotation.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected TablesAnnotation.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<TablesAnnotation> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public TablesAnnotation getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder