com.ibm.watson.natural_language_understanding.v1.model

Class EntitiesOptions

java.lang.Object

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

com.ibm.watson.natural_language_understanding.v1.model.EntitiesOptions

All Implemented Interfaces:

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

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

Identifies people, cities, organizations, and other entities in the content. For more information, see [Entity types and subtypes](https://cloud.ibm.com/docs/natural-language-understanding?topic=natural-language-understanding-entity-types).

Supported languages: English, French, German, Italian, Japanese, Korean, Portuguese, Russian, Spanish, Swedish. Arabic, Chinese, and Dutch are supported only through custom models.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EntitiesOptions.Builder Builder.

Method Summary

Modifier and Type	Method and Description
Boolean	emotion() Gets the emotion.
Long	limit() Gets the limit.
Boolean	mentions() Gets the mentions.
String	model() Gets the model.
EntitiesOptions.Builder	newBuilder() New builder.
Boolean	sentiment() Gets the sentiment.

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

newBuilder

public EntitiesOptions.Builder newBuilder()

New builder.

Returns:

a EntitiesOptions builder

limit

public Long limit()

Gets the limit.

Maximum number of entities to return.

Returns:

the limit

mentions

public Boolean mentions()

Gets the mentions.

Set this to `true` to return locations of entity mentions.

Returns:

the mentions

model

public String model()

Gets the model.

Enter a [custom model](https://cloud.ibm.com/docs/natural-language-understanding?topic=natural-language-understanding-customizing) ID to override the standard entity detection model.

Returns:

the model

sentiment

public Boolean sentiment()

Gets the sentiment.

Set this to `true` to return sentiment information for detected entities.

Returns:

the sentiment

emotion

public Boolean emotion()

Gets the emotion.

Set this to `true` to analyze emotion for detected keywords.

Returns:

the emotion