Interface AnnotateTextResponseOrBuilder (2.56.0)

public interface AnnotateTextResponseOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getCategories(int index)

public abstract ClassificationCategory getCategories(int index)

Categories identified in the input document.

repeated .google.cloud.language.v2.ClassificationCategory categories = 5;

Parameter
Name Description
index int
Returns
Type Description
ClassificationCategory

getCategoriesCount()

public abstract int getCategoriesCount()

Categories identified in the input document.

repeated .google.cloud.language.v2.ClassificationCategory categories = 5;

Returns
Type Description
int

getCategoriesList()

public abstract List<ClassificationCategory> getCategoriesList()

Categories identified in the input document.

repeated .google.cloud.language.v2.ClassificationCategory categories = 5;

Returns
Type Description
List<ClassificationCategory>

getCategoriesOrBuilder(int index)

public abstract ClassificationCategoryOrBuilder getCategoriesOrBuilder(int index)

Categories identified in the input document.

repeated .google.cloud.language.v2.ClassificationCategory categories = 5;

Parameter
Name Description
index int
Returns
Type Description
ClassificationCategoryOrBuilder

getCategoriesOrBuilderList()

public abstract List<? extends ClassificationCategoryOrBuilder> getCategoriesOrBuilderList()

Categories identified in the input document.

repeated .google.cloud.language.v2.ClassificationCategory categories = 5;

Returns
Type Description
List<? extends com.google.cloud.language.v2.ClassificationCategoryOrBuilder>

getDocumentSentiment()

public abstract Sentiment getDocumentSentiment()

The overall sentiment for the document. Populated if the user enables AnnotateTextRequest.Features.extract_document_sentiment.

.google.cloud.language.v2.Sentiment document_sentiment = 3;

Returns
Type Description
Sentiment

The documentSentiment.

getDocumentSentimentOrBuilder()

public abstract SentimentOrBuilder getDocumentSentimentOrBuilder()

The overall sentiment for the document. Populated if the user enables AnnotateTextRequest.Features.extract_document_sentiment.

.google.cloud.language.v2.Sentiment document_sentiment = 3;

Returns
Type Description
SentimentOrBuilder

getEntities(int index)

public abstract Entity getEntities(int index)

Entities, along with their semantic information, in the input document. Populated if the user enables AnnotateTextRequest.Features.extract_entities or AnnotateTextRequest.Features.extract_entity_sentiment.

repeated .google.cloud.language.v2.Entity entities = 2;

Parameter
Name Description
index int
Returns
Type Description
Entity

getEntitiesCount()

public abstract int getEntitiesCount()

Entities, along with their semantic information, in the input document. Populated if the user enables AnnotateTextRequest.Features.extract_entities or AnnotateTextRequest.Features.extract_entity_sentiment.

repeated .google.cloud.language.v2.Entity entities = 2;

Returns
Type Description
int

getEntitiesList()

public abstract List<Entity> getEntitiesList()

Entities, along with their semantic information, in the input document. Populated if the user enables AnnotateTextRequest.Features.extract_entities or AnnotateTextRequest.Features.extract_entity_sentiment.

repeated .google.cloud.language.v2.Entity entities = 2;

Returns
Type Description
List<Entity>

getEntitiesOrBuilder(int index)

public abstract EntityOrBuilder getEntitiesOrBuilder(int index)

Entities, along with their semantic information, in the input document. Populated if the user enables AnnotateTextRequest.Features.extract_entities or AnnotateTextRequest.Features.extract_entity_sentiment.

repeated .google.cloud.language.v2.Entity entities = 2;

Parameter
Name Description
index int
Returns
Type Description
EntityOrBuilder

getEntitiesOrBuilderList()

public abstract List<? extends EntityOrBuilder> getEntitiesOrBuilderList()

Entities, along with their semantic information, in the input document. Populated if the user enables AnnotateTextRequest.Features.extract_entities or AnnotateTextRequest.Features.extract_entity_sentiment.

repeated .google.cloud.language.v2.Entity entities = 2;

Returns
Type Description
List<? extends com.google.cloud.language.v2.EntityOrBuilder>

getLanguageCode()

public abstract String getLanguageCode()

The language of the text, which will be the same as the language specified in the request or, if not specified, the automatically-detected language. See [Document.language][] field for more details.

string language_code = 4;

Returns
Type Description
String

The languageCode.

getLanguageCodeBytes()

public abstract ByteString getLanguageCodeBytes()

The language of the text, which will be the same as the language specified in the request or, if not specified, the automatically-detected language. See [Document.language][] field for more details.

string language_code = 4;

Returns
Type Description
ByteString

The bytes for languageCode.

getLanguageSupported()

public abstract boolean getLanguageSupported()

Whether the language is officially supported by all requested features. The API may still return a response when the language is not supported, but it is on a best effort basis.

bool language_supported = 7;

Returns
Type Description
boolean

The languageSupported.

getModerationCategories(int index)

public abstract ClassificationCategory getModerationCategories(int index)

Harmful and sensitive categories identified in the input document.

repeated .google.cloud.language.v2.ClassificationCategory moderation_categories = 6;

Parameter
Name Description
index int
Returns
Type Description
ClassificationCategory

getModerationCategoriesCount()

public abstract int getModerationCategoriesCount()

Harmful and sensitive categories identified in the input document.

repeated .google.cloud.language.v2.ClassificationCategory moderation_categories = 6;

Returns
Type Description
int

getModerationCategoriesList()

public abstract List<ClassificationCategory> getModerationCategoriesList()

Harmful and sensitive categories identified in the input document.

repeated .google.cloud.language.v2.ClassificationCategory moderation_categories = 6;

Returns
Type Description
List<ClassificationCategory>

getModerationCategoriesOrBuilder(int index)

public abstract ClassificationCategoryOrBuilder getModerationCategoriesOrBuilder(int index)

Harmful and sensitive categories identified in the input document.

repeated .google.cloud.language.v2.ClassificationCategory moderation_categories = 6;

Parameter
Name Description
index int
Returns
Type Description
ClassificationCategoryOrBuilder

getModerationCategoriesOrBuilderList()

public abstract List<? extends ClassificationCategoryOrBuilder> getModerationCategoriesOrBuilderList()

Harmful and sensitive categories identified in the input document.

repeated .google.cloud.language.v2.ClassificationCategory moderation_categories = 6;

Returns
Type Description
List<? extends com.google.cloud.language.v2.ClassificationCategoryOrBuilder>

getSentences(int index)

public abstract Sentence getSentences(int index)

Sentences in the input document. Populated if the user enables AnnotateTextRequest.Features.extract_document_sentiment.

repeated .google.cloud.language.v2.Sentence sentences = 1;

Parameter
Name Description
index int
Returns
Type Description
Sentence

getSentencesCount()

public abstract int getSentencesCount()

Sentences in the input document. Populated if the user enables AnnotateTextRequest.Features.extract_document_sentiment.

repeated .google.cloud.language.v2.Sentence sentences = 1;

Returns
Type Description
int

getSentencesList()

public abstract List<Sentence> getSentencesList()

Sentences in the input document. Populated if the user enables AnnotateTextRequest.Features.extract_document_sentiment.

repeated .google.cloud.language.v2.Sentence sentences = 1;

Returns
Type Description
List<Sentence>

getSentencesOrBuilder(int index)

public abstract SentenceOrBuilder getSentencesOrBuilder(int index)

Sentences in the input document. Populated if the user enables AnnotateTextRequest.Features.extract_document_sentiment.

repeated .google.cloud.language.v2.Sentence sentences = 1;

Parameter
Name Description
index int
Returns
Type Description
SentenceOrBuilder

getSentencesOrBuilderList()

public abstract List<? extends SentenceOrBuilder> getSentencesOrBuilderList()

Sentences in the input document. Populated if the user enables AnnotateTextRequest.Features.extract_document_sentiment.

repeated .google.cloud.language.v2.Sentence sentences = 1;

Returns
Type Description
List<? extends com.google.cloud.language.v2.SentenceOrBuilder>

hasDocumentSentiment()

public abstract boolean hasDocumentSentiment()

The overall sentiment for the document. Populated if the user enables AnnotateTextRequest.Features.extract_document_sentiment.

.google.cloud.language.v2.Sentiment document_sentiment = 3;

Returns
Type Description
boolean

Whether the documentSentiment field is set.