Class AnnotateTextRequest.Features (2.44.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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > AnnotateTextRequest.Features

Static Fields

CLASSIFICATION_MODEL_OPTIONS_FIELD_NUMBER

public static final int CLASSIFICATION_MODEL_OPTIONS_FIELD_NUMBER
Field Value
Type Description
int

CLASSIFY_TEXT_FIELD_NUMBER

public static final int CLASSIFY_TEXT_FIELD_NUMBER
Field Value
Type Description
int

EXTRACT_DOCUMENT_SENTIMENT_FIELD_NUMBER

public static final int EXTRACT_DOCUMENT_SENTIMENT_FIELD_NUMBER
Field Value
Type Description
int

EXTRACT_ENTITIES_FIELD_NUMBER

public static final int EXTRACT_ENTITIES_FIELD_NUMBER
Field Value
Type Description
int

EXTRACT_ENTITY_SENTIMENT_FIELD_NUMBER

public static final int EXTRACT_ENTITY_SENTIMENT_FIELD_NUMBER
Field Value
Type Description
int

EXTRACT_SYNTAX_FIELD_NUMBER

public static final int EXTRACT_SYNTAX_FIELD_NUMBER
Field Value
Type Description
int

MODERATE_TEXT_FIELD_NUMBER

public static final int MODERATE_TEXT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static AnnotateTextRequest.Features getDefaultInstance()
Returns
Type Description
AnnotateTextRequest.Features

getDescriptor()

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

newBuilder()

public static AnnotateTextRequest.Features.Builder newBuilder()
Returns
Type Description
AnnotateTextRequest.Features.Builder

newBuilder(AnnotateTextRequest.Features prototype)

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

parseDelimitedFrom(InputStream input)

public static AnnotateTextRequest.Features parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AnnotateTextRequest.Features
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static AnnotateTextRequest.Features parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
AnnotateTextRequest.Features
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static AnnotateTextRequest.Features parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
AnnotateTextRequest.Features
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static AnnotateTextRequest.Features parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AnnotateTextRequest.Features
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static AnnotateTextRequest.Features parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
AnnotateTextRequest.Features
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
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
Type Description
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
Type Description
ClassificationModelOptionsOrBuilder

getClassifyText()

public boolean getClassifyText()

Classify the full document into categories.

bool classify_text = 6;

Returns
Type Description
boolean

The classifyText.

getDefaultInstanceForType()

public AnnotateTextRequest.Features getDefaultInstanceForType()
Returns
Type Description
AnnotateTextRequest.Features

getExtractDocumentSentiment()

public boolean getExtractDocumentSentiment()

Extract document-level sentiment.

bool extract_document_sentiment = 3;

Returns
Type Description
boolean

The extractDocumentSentiment.

getExtractEntities()

public boolean getExtractEntities()

Extract entities.

bool extract_entities = 2;

Returns
Type Description
boolean

The extractEntities.

getExtractEntitySentiment()

public boolean getExtractEntitySentiment()

Extract entities and their associated sentiment.

bool extract_entity_sentiment = 4;

Returns
Type Description
boolean

The extractEntitySentiment.

getExtractSyntax()

public boolean getExtractSyntax()

Extract syntax information.

bool extract_syntax = 1;

Returns
Type Description
boolean

The extractSyntax.

getModerateText()

public boolean getModerateText()

Moderate the document for harmful and sensitive categories.

bool moderate_text = 11;

Returns
Type Description
boolean

The moderateText.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
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
Type Description
boolean

Whether the classificationModelOptions field is set.

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 AnnotateTextRequest.Features.Builder newBuilderForType()
Returns
Type Description
AnnotateTextRequest.Features.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public AnnotateTextRequest.Features.Builder toBuilder()
Returns
Type Description
AnnotateTextRequest.Features.Builder

writeTo(CodedOutputStream output)

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