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

Class GetDocumentCategoriesOptions

java.lang.Object

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

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

All Implemented Interfaces:

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

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

The getDocumentCategories options.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GetDocumentCategoriesOptions.Builder Builder.
static interface	GetDocumentCategoriesOptions.Category Select concepts belonging to disorders, drugs or genes.

Method Summary

Modifier and Type	Method and Description
java.lang.String	category() Gets the category.
java.lang.String	corpus() Gets the corpus.
java.lang.String	documentId() Gets the documentId.
java.lang.String	fields() Gets the fields.
java.lang.String	highlightTagBegin() Gets the highlightTagBegin.
java.lang.String	highlightTagEnd() Gets the highlightTagEnd.
java.lang.Long	limit() Gets the limit.
GetDocumentCategoriesOptions.Builder	newBuilder() New builder.
java.lang.Boolean	onlyNegatedConcepts() Gets the onlyNegatedConcepts.
java.util.List<java.lang.String>	types() Gets the types.

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 GetDocumentCategoriesOptions.Builder newBuilder()

New builder.

Returns:

a GetDocumentCategoriesOptions builder

corpus

public java.lang.String corpus()

Gets the corpus. Corpus name.

Returns:

the corpus

documentId

public java.lang.String documentId()

Gets the documentId. Document ID.

Returns:

the documentId

highlightTagBegin

public java.lang.String highlightTagBegin()

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

Returns:

the highlightTagBegin

highlightTagEnd

public java.lang.String highlightTagEnd()

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

Returns:

the highlightTagEnd

types

public java.util.List<java.lang.String> types()

Gets the types. Select concepts belonging to these semantic types to return. Semantic types for the corpus can be found using the /v1/corpora/{corpus}/types method.Defaults to 'all'.

Returns:

the types

category

public java.lang.String category()

Gets the category. Select concepts belonging to disorders, drugs or genes.

Returns:

the category

onlyNegatedConcepts

public java.lang.Boolean onlyNegatedConcepts()

Gets the onlyNegatedConcepts. Only return negated concepts?.

Returns:

the onlyNegatedConcepts

fields

public java.lang.String fields()

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

Returns:

the fields

limit

public java.lang.Long limit()

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

Returns:

the limit