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

Class GetConceptsOptions

java.lang.Object

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

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

All Implemented Interfaces:

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

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

The getConcepts options.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
List<String>	attributes() Gets the attributes.
String	corpus() Gets the corpus.
List<String>	cuis() Gets the cuis.
Long	limit() Gets the limit.
GetConceptsOptions.Builder	newBuilder() New builder.
List<String>	preferredNames() Gets the preferredNames.
String	sort() Gets the sort.
List<String>	surfaceForms() Gets the surfaceForms.
Boolean	verbose() Gets the verbose.

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

New builder.

Returns:

a GetConceptsOptions builder

corpus

public String corpus()

Gets the corpus. Corpus name.

Returns:

the corpus

cuis

public List<String> cuis()

Gets the cuis. Select concepts with the specified CUIs. Each cui is assumed to be from UMLS unless an ontology is explicitly specified using the syntax [ontology:]cui, e.g., 'concepts:C0018787'.

Returns:

the cuis

preferredNames

public List<String> preferredNames()

Gets the preferredNames. Select concepts with the specified preferred names. Each preferred name is assumed to be from UMLS unless an ontology is explicitly specified using the syntax [ontology:::]preferred_name, e.g., 'concepts:::HEART'.

Returns:

the preferredNames

surfaceForms

public List<String> surfaceForms()

Gets the surfaceForms. Select all concepts having these surface forms. The match is case insensitive. Each surface form is matched against UMLS unless an ontology is explicitly specified using the syntax [ontology:::]surface_form, e.g., 'concepts:::heart attack'.

Returns:

the surfaceForms

attributes

public List<String> attributes()

Gets the attributes. Select all concepts having these attributes. The match is case insensitive.

Returns:

the attributes

verbose

public Boolean verbose()

Gets the verbose. Verbose output. Default is false.

Returns:

the verbose

sort

public String sort()

Gets the sort. Sort by hitCount (in document count). Set to ascending order (_sort=+hitCount) or descending order (_sort=-hitCount).

Returns:

the sort

limit

public Long limit()

Gets the limit. Number of possible concepts to return. Default is 250.

Returns:

the limit