Class AnnotateTextRequest.Features (2.42.0)

public static final class AnnotateTextRequest.Features extends GeneratedMessageV3 implements AnnotateTextRequest.FeaturesOrBuilder

All available features for sentiment, syntax, and semantic analysis. Setting each one to true will enable that specific analysis for the input.

Protobuf type google.cloud.language.v1.AnnotateTextRequest.Features

Static Fields

CLASSIFICATION_MODEL_OPTIONS_FIELD_NUMBER

public static final int CLASSIFICATION_MODEL_OPTIONS_FIELD_NUMBER
Field Value
TypeDescription
int

CLASSIFY_TEXT_FIELD_NUMBER

public static final int CLASSIFY_TEXT_FIELD_NUMBER
Field Value
TypeDescription
int

EXTRACT_DOCUMENT_SENTIMENT_FIELD_NUMBER

public static final int EXTRACT_DOCUMENT_SENTIMENT_FIELD_NUMBER
Field Value
TypeDescription
int

EXTRACT_ENTITIES_FIELD_NUMBER

public static final int EXTRACT_ENTITIES_FIELD_NUMBER
Field Value
TypeDescription
int

EXTRACT_ENTITY_SENTIMENT_FIELD_NUMBER

public static final int EXTRACT_ENTITY_SENTIMENT_FIELD_NUMBER
Field Value
TypeDescription
int

EXTRACT_SYNTAX_FIELD_NUMBER

public static final int EXTRACT_SYNTAX_FIELD_NUMBER
Field Value
TypeDescription
int

MODERATE_TEXT_FIELD_NUMBER

public static final int MODERATE_TEXT_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static AnnotateTextRequest.Features getDefaultInstance()
Returns
TypeDescription
AnnotateTextRequest.Features

getDescriptor()

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

newBuilder()

public static AnnotateTextRequest.Features.Builder newBuilder()
Returns
TypeDescription
AnnotateTextRequest.Features.Builder

newBuilder(AnnotateTextRequest.Features prototype)

public static AnnotateTextRequest.Features.Builder newBuilder(AnnotateTextRequest.Features prototype)
Parameter
NameDescription
prototypeAnnotateTextRequest.Features
Returns
TypeDescription
AnnotateTextRequest.Features.Builder

parseDelimitedFrom(InputStream input)

public static AnnotateTextRequest.Features parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
AnnotateTextRequest.Features
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static AnnotateTextRequest.Features parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
AnnotateTextRequest.Features
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static AnnotateTextRequest.Features parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
AnnotateTextRequest.Features
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static AnnotateTextRequest.Features parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
AnnotateTextRequest.Features
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static AnnotateTextRequest.Features parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
AnnotateTextRequest.Features
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<AnnotateTextRequest.Features> parser()
Returns
TypeDescription
Parser<Features>

Methods

equals(Object obj)

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

getClassificationModelOptions()

public ClassificationModelOptions getClassificationModelOptions()

The model options to use for classification. Defaults to v1 options if not specified. Only used if classify_text is set to true.

.google.cloud.language.v1.ClassificationModelOptions classification_model_options = 10;

Returns
TypeDescription
ClassificationModelOptions

The classificationModelOptions.

getClassificationModelOptionsOrBuilder()

public ClassificationModelOptionsOrBuilder getClassificationModelOptionsOrBuilder()

The model options to use for classification. Defaults to v1 options if not specified. Only used if classify_text is set to true.

.google.cloud.language.v1.ClassificationModelOptions classification_model_options = 10;

Returns
TypeDescription
ClassificationModelOptionsOrBuilder

getClassifyText()

public boolean getClassifyText()

Classify the full document into categories.

bool classify_text = 6;

Returns
TypeDescription
boolean

The classifyText.

getDefaultInstanceForType()

public AnnotateTextRequest.Features getDefaultInstanceForType()
Returns
TypeDescription
AnnotateTextRequest.Features

getExtractDocumentSentiment()

public boolean getExtractDocumentSentiment()

Extract document-level sentiment.

bool extract_document_sentiment = 3;

Returns
TypeDescription
boolean

The extractDocumentSentiment.

getExtractEntities()

public boolean getExtractEntities()

Extract entities.

bool extract_entities = 2;

Returns
TypeDescription
boolean

The extractEntities.

getExtractEntitySentiment()

public boolean getExtractEntitySentiment()

Extract entities and their associated sentiment.

bool extract_entity_sentiment = 4;

Returns
TypeDescription
boolean

The extractEntitySentiment.

getExtractSyntax()

public boolean getExtractSyntax()

Extract syntax information.

bool extract_syntax = 1;

Returns
TypeDescription
boolean

The extractSyntax.

getModerateText()

public boolean getModerateText()

Moderate the document for harmful and sensitive categories.

bool moderate_text = 11;

Returns
TypeDescription
boolean

The moderateText.

getParserForType()

public Parser<AnnotateTextRequest.Features> getParserForType()
Returns
TypeDescription
Parser<Features>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hasClassificationModelOptions()

public boolean hasClassificationModelOptions()

The model options to use for classification. Defaults to v1 options if not specified. Only used if classify_text is set to true.

.google.cloud.language.v1.ClassificationModelOptions classification_model_options = 10;

Returns
TypeDescription
boolean

Whether the classificationModelOptions 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 AnnotateTextRequest.Features.Builder newBuilderForType()
Returns
TypeDescription
AnnotateTextRequest.Features.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public AnnotateTextRequest.Features.Builder toBuilder()
Returns
TypeDescription
AnnotateTextRequest.Features.Builder

writeTo(CodedOutputStream output)

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