com.ibm.watson.health.iml.v1.model

Class GetDocumentMultipleCategoriesOptions

java.lang.Object

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

com.ibm.watson.health.iml.v1.model.GetDocumentMultipleCategoriesOptions

All Implemented Interfaces:

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

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

The getDocumentMultipleCategories options.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
List<Category>	categories() Gets the categories.
String	corpus() Gets the corpus.
String	documentId() Gets the documentId.
String	fields() Gets the fields.
String	highlightTagBegin() Gets the highlightTagBegin.
String	highlightTagEnd() Gets the highlightTagEnd.
Long	limit() Gets the limit.
GetDocumentMultipleCategoriesOptions.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 Detail

newBuilder

public GetDocumentMultipleCategoriesOptions.Builder newBuilder()

New builder.

Returns:

a GetDocumentMultipleCategoriesOptions builder

corpus

public String corpus()

Gets the corpus. Corpus name.

Returns:

the corpus

documentId

public String documentId()

Gets the documentId. Document ID.

Returns:

the documentId

categories

public List<Category> categories()

Gets the categories. Annotation categories.

Returns:

the categories

highlightTagBegin

public String highlightTagBegin()

Gets the highlightTagBegin. HTML tag used to highlight concepts found in the text. Default is '&ltb&gt'.

Returns:

the highlightTagBegin

highlightTagEnd

public String highlightTagEnd()

Gets the highlightTagEnd. HTML tag used to highlight concepts found in the text. Default is '&lt/b&gt'.

Returns:

the highlightTagEnd

fields

public String fields()

Gets the fields. Comma separated list of fields to return: passages, annotations, highlightedTitle, highlightedAbstract, highlightedBody, highlightedSections.

Returns:

the fields

limit

public Long limit()

Gets the limit. Limit the number of passages per search concept (1 to 250). Default is 50.

Returns:

the limit