com.ibm.watson.natural_language_understanding.v1.model

Class EntitiesResult

java.lang.Object

com.ibm.cloud.sdk.core.service.model.GenericModel

com.ibm.watson.natural_language_understanding.v1.model.EntitiesResult

All Implemented Interfaces:

com.ibm.cloud.sdk.core.service.model.ObjectModel

public class EntitiesResult
extends com.ibm.cloud.sdk.core.service.model.GenericModel

The important people, places, geopolitical entities and other types of entities in your content.

Method Summary

Modifier and Type	Method and Description
Double	getConfidence() Gets the confidence.
Long	getCount() Gets the count.
DisambiguationResult	getDisambiguation() Gets the disambiguation.
EmotionScores	getEmotion() Gets the emotion.
List<EntityMention>	getMentions() Gets the mentions.
Double	getRelevance() Gets the relevance.
FeatureSentimentResults	getSentiment() Gets the sentiment.
String	getText() Gets the text.
String	getType() Gets the type.

Methods inherited from class com.ibm.cloud.sdk.core.service.model.GenericModel

equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

getType

public String getType()

Gets the type.

Entity type.

Returns:

the type

getText

public String getText()

Gets the text.

The name of the entity.

Returns:

the text

getRelevance

public Double getRelevance()

Gets the relevance.

Relevance score from 0 to 1. Higher values indicate greater relevance.

Returns:

the relevance

getConfidence

public Double getConfidence()

Gets the confidence.

Confidence in the entity identification from 0 to 1. Higher values indicate higher confidence. In standard entities requests, confidence is returned only for English text. All entities requests that use custom models return the confidence score.

Returns:

the confidence

getMentions

public List<EntityMention> getMentions()

Gets the mentions.

Entity mentions and locations.

Returns:

the mentions

getCount

public Long getCount()

Gets the count.

How many times the entity was mentioned in the text.

Returns:

the count

getEmotion

public EmotionScores getEmotion()

Gets the emotion.

Emotion analysis results for the entity, enabled with the `emotion` option.

Returns:

the emotion

getSentiment

public FeatureSentimentResults getSentiment()

Gets the sentiment.

Sentiment analysis results for the entity, enabled with the `sentiment` option.

Returns:

the sentiment

getDisambiguation

public DisambiguationResult getDisambiguation()

Gets the disambiguation.

Disambiguation information for the entity.

Returns:

the disambiguation