com.ibm.watson.natural_language_understanding.v1.model

Class CategoriesOptions

java.lang.Object

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

com.ibm.watson.natural_language_understanding.v1.model.CategoriesOptions

All Implemented Interfaces:

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

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

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.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.Boolean	explanation
protected java.lang.Long	limit
protected java.lang.String	model Deprecated.

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Boolean	explanation() Gets the explanation.
java.lang.Long	limit() Gets the limit.
java.lang.String	model() Deprecated. the model parameter is no longer supported by the Natural Language Understanding service and will be removed in the next major release
CategoriesOptions.Builder	newBuilder() New builder.

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

explanation

protected java.lang.Boolean explanation

limit

protected java.lang.Long limit

model

@Deprecated
protected java.lang.String model

Deprecated.

Constructor Detail

CategoriesOptions

protected CategoriesOptions(CategoriesOptions.Builder builder)

Method Detail

newBuilder

public CategoriesOptions.Builder newBuilder()

New builder.

Returns:

a CategoriesOptions builder

explanation

public java.lang.Boolean explanation()

Gets the explanation.

Set this to `true` to return explanations for each categorization. **This is available only for English categories.**.

Returns:

the explanation

limit

public java.lang.Long limit()

Gets the limit.

Maximum number of categories to return.

Returns:

the limit

model

public java.lang.String model()

Deprecated. the model parameter is no longer supported by the Natural Language Understanding service and will be removed in the next major release

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 categories model.

The custom categories experimental feature will be retired on 19 December 2019. On that date, deployed custom categories models will no longer be accessible in Natural Language Understanding. The feature will be removed from Knowledge Studio on an earlier date. Custom categories models will no longer be accessible in Knowledge Studio on 17 December 2019.

Returns:

the model