Class TextSentimentAnnotation (2.42.0)

public final class TextSentimentAnnotation extends GeneratedMessageV3 implements TextSentimentAnnotationOrBuilder

Contains annotation details specific to text sentiment.

Protobuf type google.cloud.automl.v1.TextSentimentAnnotation

Static Fields

SENTIMENT_FIELD_NUMBER

public static final int SENTIMENT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static TextSentimentAnnotation getDefaultInstance()
Returns
Type Description
TextSentimentAnnotation

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static TextSentimentAnnotation.Builder newBuilder()
Returns
Type Description
TextSentimentAnnotation.Builder

newBuilder(TextSentimentAnnotation prototype)

public static TextSentimentAnnotation.Builder newBuilder(TextSentimentAnnotation prototype)
Parameter
Name Description
prototype TextSentimentAnnotation
Returns
Type Description
TextSentimentAnnotation.Builder

parseDelimitedFrom(InputStream input)

public static TextSentimentAnnotation parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
TextSentimentAnnotation
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TextSentimentAnnotation parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TextSentimentAnnotation
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static TextSentimentAnnotation parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
TextSentimentAnnotation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static TextSentimentAnnotation parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TextSentimentAnnotation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static TextSentimentAnnotation parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
TextSentimentAnnotation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static TextSentimentAnnotation parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TextSentimentAnnotation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static TextSentimentAnnotation parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
TextSentimentAnnotation
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static TextSentimentAnnotation parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TextSentimentAnnotation
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static TextSentimentAnnotation parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
TextSentimentAnnotation
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TextSentimentAnnotation parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TextSentimentAnnotation
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static TextSentimentAnnotation parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
TextSentimentAnnotation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static TextSentimentAnnotation parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TextSentimentAnnotation
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<TextSentimentAnnotation> parser()
Returns
Type Description
Parser<TextSentimentAnnotation>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public TextSentimentAnnotation getDefaultInstanceForType()
Returns
Type Description
TextSentimentAnnotation

getParserForType()

public Parser<TextSentimentAnnotation> getParserForType()
Returns
Type Description
Parser<TextSentimentAnnotation>
Overrides

getSentiment()

public int getSentiment()

Output only. The sentiment with the semantic, as given to the AutoMl.ImportData when populating the dataset from which the model used for the prediction had been trained. The sentiment values are between 0 and Dataset.text_sentiment_dataset_metadata.sentiment_max (inclusive), with higher value meaning more positive sentiment. They are completely relative, i.e. 0 means least positive sentiment and sentiment_max means the most positive from the sentiments present in the train data. Therefore e.g. if train data had only negative sentiment, then sentiment_max, would be still negative (although least negative). The sentiment shouldn't be confused with "score" or "magnitude" from the previous Natural Language Sentiment Analysis API.

int32 sentiment = 1;

Returns
Type Description
int

The sentiment.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public TextSentimentAnnotation.Builder newBuilderForType()
Returns
Type Description
TextSentimentAnnotation.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected TextSentimentAnnotation.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
TextSentimentAnnotation.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public TextSentimentAnnotation.Builder toBuilder()
Returns
Type Description
TextSentimentAnnotation.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException