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

Class GetSearchMatchesOptions

java.lang.Object

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

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

All Implemented Interfaces:

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

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

The getSearchMatches options.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GetSearchMatchesOptions.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.
String	documentId() Gets the documentId.
String	fields() Gets the fields.
Long	limit() Gets the limit.
Float	minScore() Gets the minScore.
GetSearchMatchesOptions.Builder	newBuilder() New builder.
List<String>	nluRelations() Gets the nluRelations.
String	relatedTagBegin() Gets the relatedTagBegin.
String	relatedTagEnd() Gets the relatedTagEnd.
String	searchTagBegin() Gets the searchTagBegin.
String	searchTagEnd() Gets the searchTagEnd.
List<String>	text() Gets the text.
List<String>	types() Gets the types.
List<String>	values() Gets the values.

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

New builder.

Returns:

a GetSearchMatchesOptions builder

corpus

public String corpus()

Gets the corpus. Corpus name.

Returns:

the corpus

documentId

public String documentId()

Gets the documentId. Document ID (e.g, 7014026).

Returns:

the documentId

minScore

public Float minScore()

Gets the minScore. Minimum score .0 to 1.0.

Returns:

the minScore

cuis

public List<String> cuis()

Gets the cuis. cui[,rank,[type]] - Example: "C0030567,10". The rank is an optional value from 0 to 10 (defalut is 10). Special rank values: 0=omit, 10=require. Related concepts can also be included by appending, '-PAR' (parents), '-CHD' (children), or '-SIB' (siblings) to the CUI (eg., to include all children of C0030567: 'C0030567-CHD')). The type may explicitly select a semanic type for a concept. If no type is specified, a default type is selected.

Returns:

the cuis

text

public List<String> text()

Gets the text. Case insensitive text searches.

Returns:

the text

types

public List<String> types()

Gets the types. Highlight all text spans matching these semantic types. Semantic types for the corpus can be found using the /v1/corpora/{corpus}/types method.

Returns:

the types

attributes

public List<String> attributes()

Gets the attributes. Highlight all text spans matching these attributes. An attribute may also specify a range value (e.g., age:years:65-100) or a string value (e.g., gender:female). The attribute may be qualified with one or more qualifiers (e.g., Treated,Severe>>diabetes) An attribute may target a specific CUI. (e.g., C0003864::disease).

Returns:

the attributes

values

public List<String> values()

Gets the values. Highlight all text spans matching these values. e.g., age:years:within:65-100 or gender:female a string value (e.g., gender:female).

Returns:

the values

nluRelations

public List<String> nluRelations()

Gets the nluRelations. Highlight all text spans matching these NLU relations. e.g., druggroup,treat,indication.

Returns:

the nluRelations

limit

public Long limit()

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

Returns:

the limit

searchTagBegin

public String searchTagBegin()

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

Returns:

the searchTagBegin

searchTagEnd

public String searchTagEnd()

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

Returns:

the searchTagEnd

relatedTagBegin

public String relatedTagBegin()

Gets the relatedTagBegin. HTML tag used to highlight related concepts found in the text.

Returns:

the relatedTagBegin

relatedTagEnd

public String relatedTagEnd()

Gets the relatedTagEnd. HTML tag used to highlight related concepts found in the text.

Returns:

the relatedTagEnd

fields

public String fields()

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

Returns:

the fields