CategoriesOptions (IBM Watson Java SDK 9.3.0 API)

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 hierarchical taxonomy of the content. The top three categories are returned by default.

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

Nested Class Summary

Nested Classes

Modifier and Type Class Description

static class CategoriesOptions.Builder
Builder.

Method Summary

Modifier and Type	Method	Description
`Boolean`	`explanation()`	Gets the explanation.
`Long`	`limit()`	Gets the limit.
`String`	`model()`	Gets the model.
`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

getClass, notify, notifyAll, wait, wait, wait

Method Details
- newBuilder
  
  public CategoriesOptions.Builder newBuilder()
  
  New builder.
  
  Returns:
  
  a CategoriesOptions builder
- explanation
  
  public 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 Long limit()
  
  Gets the limit.
  Maximum number of categories to return.
  
  Returns:
  
  the limit
- model
  
  public String model()
  
  Gets the model.
  (Beta) Enter a [custom model](https://cloud.ibm.com/docs/natural-language-understanding?topic=natural-language-understanding-customizing) ID to override the standard categories model. **This is available only for English categories.**.
  
  Returns:
  
  the model