com.ibm.watson.natural_language_understanding.v1.model

Class Features

java.lang.Object

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

com.ibm.watson.natural_language_understanding.v1.model.Features

All Implemented Interfaces:

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

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

Analysis features and options.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
protected CategoriesOptions	categories
protected ConceptsOptions	concepts
protected EmotionOptions	emotion
protected EntitiesOptions	entities
protected KeywordsOptions	keywords
protected MetadataOptions	metadata
protected RelationsOptions	relations
protected SemanticRolesOptions	semanticRoles
protected SentimentOptions	sentiment
protected SyntaxOptions	syntax

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Features(Features.Builder builder)

Method Summary

Methods

Modifier and Type	Method and Description
CategoriesOptions	categories() Gets the categories.
ConceptsOptions	concepts() Gets the concepts.
EmotionOptions	emotion() Gets the emotion.
EntitiesOptions	entities() Gets the entities.
KeywordsOptions	keywords() Gets the keywords.
MetadataOptions	metadata() Gets the metadata.
Features.Builder	newBuilder() New builder.
RelationsOptions	relations() Gets the relations.
SemanticRolesOptions	semanticRoles() Gets the semanticRoles.
SentimentOptions	sentiment() Gets the sentiment.
SyntaxOptions	syntax() Gets the syntax.

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

equals, hashCode, toString

Methods inherited from class java.lang.Object

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

Field Detail

concepts

protected ConceptsOptions concepts

emotion

protected EmotionOptions emotion

entities

protected EntitiesOptions entities

keywords

protected KeywordsOptions keywords

metadata

protected MetadataOptions metadata

relations

protected RelationsOptions relations

semanticRoles

@SerializedName(value="semantic_roles")
protected SemanticRolesOptions semanticRoles

sentiment

protected SentimentOptions sentiment

categories

protected CategoriesOptions categories

syntax

protected SyntaxOptions syntax

Constructor Detail

Features

protected Features(Features.Builder builder)

Method Detail

newBuilder

public Features.Builder newBuilder()

New builder.

Returns:

a Features builder

concepts

public ConceptsOptions concepts()

Gets the concepts.

Returns high-level concepts in the content. For example, a research paper about deep learning might return the concept, "Artificial Intelligence" although the term is not mentioned.

Supported languages: English, French, German, Italian, Japanese, Korean, Portuguese, Spanish.

Returns:

the concepts

emotion

public EmotionOptions emotion()

Gets the emotion.

Detects anger, disgust, fear, joy, or sadness that is conveyed in the content or by the context around target phrases specified in the targets parameter. You can analyze emotion for detected entities with `entities.emotion` and for keywords with `keywords.emotion`.

Supported languages: English.

Returns:

the emotion

entities

public EntitiesOptions entities()

Gets the entities.

Identifies people, cities, organizations, and other entities in the content. 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.

Returns:

the entities

keywords

public KeywordsOptions keywords()

Gets the keywords.

Returns important keywords in the content.

Supported languages: English, French, German, Italian, Japanese, Korean, Portuguese, Russian, Spanish, Swedish.

Returns:

the keywords

metadata

public MetadataOptions metadata()

Gets the metadata.

Returns information from the document, including author name, title, RSS/ATOM feeds, prominent page image, and publication date. Supports URL and HTML input types only.

Returns:

the metadata

relations

public RelationsOptions relations()

Gets the relations.

Recognizes when two entities are related and identifies the type of relation. For example, an `awardedTo` relation might connect the entities "Nobel Prize" and "Albert Einstein". See [Relation types](https://cloud.ibm.com/docs/natural-language-understanding?topic=natural-language-understanding-relations).

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

Returns:

the relations

semanticRoles

public SemanticRolesOptions semanticRoles()

Gets the semanticRoles.

Parses sentences into subject, action, and object form.

Supported languages: English, German, Japanese, Korean, Spanish.

Returns:

the semanticRoles

sentiment

public SentimentOptions sentiment()

Gets the sentiment.

Analyzes the general sentiment of your content or the sentiment toward specific target phrases. You can analyze sentiment for detected entities with `entities.sentiment` and for keywords with `keywords.sentiment`.

Supported languages: Arabic, English, French, German, Italian, Japanese, Korean, Portuguese, Russian, Spanish.

Returns:

the sentiment

categories

public CategoriesOptions categories()

Gets the categories.

Returns a five-level taxonomy of the content. The top three categories are returned.

Supported languages: Arabic, English, French, German, Italian, Japanese, Korean, Portuguese, Spanish.

Returns:

the categories

syntax

public SyntaxOptions syntax()

Gets the syntax.

Returns tokens and sentences from the input text.

Returns:

the syntax