Class TextSentimentAnnotation (2.17.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
TypeDescription
int

Static Methods

getDefaultInstance()

public static TextSentimentAnnotation getDefaultInstance()
Returns
TypeDescription
TextSentimentAnnotation

getDescriptor()

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

newBuilder()

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

newBuilder(TextSentimentAnnotation prototype)

public static TextSentimentAnnotation.Builder newBuilder(TextSentimentAnnotation prototype)
Parameter
NameDescription
prototypeTextSentimentAnnotation
Returns
TypeDescription
TextSentimentAnnotation.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public TextSentimentAnnotation getDefaultInstanceForType()
Returns
TypeDescription
TextSentimentAnnotation

getParserForType()

public Parser<TextSentimentAnnotation> getParserForType()
Returns
TypeDescription
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
TypeDescription
int

The sentiment.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

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 TextSentimentAnnotation.Builder newBuilderForType()
Returns
TypeDescription
TextSentimentAnnotation.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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