com.google.api.services.language.v2.model

Class EntityMention

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.language.v2.model.EntityMention

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class EntityMention
extends com.google.api.client.json.GenericJson

Represents a mention for an entity in the text. Currently, proper noun mentions are supported.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Cloud Natural Language API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
EntityMention()

Method Summary

Modifier and Type	Method and Description
EntityMention	clone()
Float	getProbability() Probability score associated with the entity.
Sentiment	getSentiment() For calls to AnalyzeEntitySentiment this field will contain the sentiment expressed for this mention of the entity in the provided document.
TextSpan	getText() The mention text.
String	getType() The type of the entity mention.
EntityMention	set(String fieldName, Object value)
EntityMention	setProbability(Float probability) Probability score associated with the entity.
EntityMention	setSentiment(Sentiment sentiment) For calls to AnalyzeEntitySentiment this field will contain the sentiment expressed for this mention of the entity in the provided document.
EntityMention	setText(TextSpan text) The mention text.
EntityMention	setType(String type) The type of the entity mention.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

EntityMention

public EntityMention()

Method Detail

getProbability

public Float getProbability()

Probability score associated with the entity. The score shows the probability of the entity mention being the entity type. The score is in (0, 1] range.

Returns:

value or null for none

setProbability

public EntityMention setProbability(Float probability)

Probability score associated with the entity. The score shows the probability of the entity mention being the entity type. The score is in (0, 1] range.

Parameters:

probability - probability or null for none

getSentiment

public Sentiment getSentiment()

For calls to AnalyzeEntitySentiment this field will contain the sentiment expressed for this mention of the entity in the provided document.

Returns:

value or null for none

setSentiment

public EntityMention setSentiment(Sentiment sentiment)

For calls to AnalyzeEntitySentiment this field will contain the sentiment expressed for this mention of the entity in the provided document.

Parameters:

sentiment - sentiment or null for none

getText

public TextSpan getText()

The mention text.

Returns:

value or null for none

setText

public EntityMention setText(TextSpan text)

The mention text.

Parameters:

text - text or null for none

getType

public String getType()

The type of the entity mention.

Returns:

value or null for none

setType

public EntityMention setType(String type)

The type of the entity mention.

Parameters:

type - type or null for none

set

public EntityMention set(String fieldName,
                         Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public EntityMention clone()

Overrides:

clone in class com.google.api.client.json.GenericJson