com.ibm.watson.health.iml.v1

Class InsightsForMedicalLiteratureService

java.lang.Object

com.ibm.cloud.sdk.core.service.BaseService

com.ibm.watson.health.iml.v1.InsightsForMedicalLiteratureService

public class InsightsForMedicalLiteratureService
extends com.ibm.cloud.sdk.core.service.BaseService

For more information see the <a href='../../documentation' target='_blank'>extended documentation</a>.<p>Try the <a href='../../application'>Insights for Medical Literature demo application</a>.<h3>Service Overview</h3>The Insights for Medical Literature service provides APIs that enable you to derive insights from a corpus of medical documents. For example, the <a href='https://www.nlm.nih.gov/bsd/pmresources.html' target='_blank'>MEDLINE&reg;</a> corpus contains more than 26 million references to medical journal articles. An unstructured medical document corpus is ingested by IBM, enriched with the Unified Medical Language System (<a href='https://www.nlm.nih.gov/research/umls/' target='_blank'>UMLS&reg;</a>) and stored as structured data in an IBM managed database. The UMLS enrichment enables a concept based search, in addition to a conventional text search. Other unique features include concept matching, concept relationships, identifying co-occurring concepts and identifying disorders, drugs, genes and other medical terms mentioned in a medical document.<h3>National Library of Medicine&reg; (NLM&reg;) License</h3>The MEDLINE corpus is imported from <a href='https://www.nlm.nih.gov/databases/journal.html' target='_blank'>MEDLINE&reg;/PubMed&reg;</a>, a database of the U.S. National Library of Medicine. <P><P>The MEDLINE corpus is periodically updated to contain new and/or maintained records, and remove deleted records, at least once every thirty (30) days. The MEDLINE corpus may be updated on a weekly basis.<P><P>NLM represents that its data were formulated with a reasonable standard of care. Except for this representation, NLM makes no representation or warranties, expressed or implied. This includes, but is not limited to, any implied warranty of merchantability or fitness for a particular purpose, with respect to the NLM data, and NLM specifically disclaims any such warranties and representations.<P><P>All complete or parts of U.S. National Library of Medicine (NLM) records that are redistributed or retransmitted must be identified as being derived from NLM data.<h3>API Overview</h3>The APIs are grouped into these categories:<UL><LI><B>Concepts</B> : Concept information</LI><P>Concept information includes a concept unique identifier (CUI), preferred name, alternative name (other surface forms), semantic group (category), semantic types, counts (hits, parents, children, siblings...) and, related concepts. <LI><B>Corpora</B> : Corpora information</LI><P>You can retrieve a list of corpus names. For each corpus a unique list of semantic groups and semantic types is provided. <LI><B>Documents</B> : Document information</LI><P>These APIs enable full text documents and document annotations to be retreived. Concepts mentioned in a medical document may also be categorized by semantic groups and types. The best matching search concepts can also be identified in a medical document.<LI><B>Search</B> : Concept search</LI><P>These APIs perform typeahead concept searches, ranked document searches, and cohesive and co-occurring concept searches. A search targets a single medical document corpus.<LI><B>Status</B> : Check the status of this service</LI></UL><h3>Terminology</h3><UL><LI><B>Concept Unique Identifier (cui)</B></LI>A UMLS CUI identifies a concept, and is specified as a path or query parameter to select a specific concept. A CUI always begins with an uppercase letter 'C' followed by seven decimal digits (e.g., C0446516).<LI><B>Document Identifiter</B></LI>A document ID uniquely identifies a document in a corpus, and is specified as a path or query parameter to select a specific medical document.<LI><B>Hit count</B></LI>A hit count specifies the number of times a specific concept is mentioned in a corpus.<LI><B>Preferred Name (pn)</B></LI>A preferred name is the common name for a concept. A concept may also have other surface forms or alternative names.<LI><B>Semantic Group (group)</B></LI>A semantic group aggregates multiple semantic types, and is specified as a path or query parameter to filter or select concepts belonging to the same semantic group (e.g., Disorders or ChemicalsAndDrugs).<LI><B>Semantic Type (type)</B></LI>A semantic type is a camelcase string derived from a UMLS semantic type (e.g., ClinicalDrug or DiseaseOrSyndrome). It is specified as a path or query parameter to filter or select concepts belonging to the same category (semantic type).<LI><B>Surface form</B></LI>A surface form is an alternative name for a concept. The surface forms identify text spans in a medical document, and the identified text spans are annotated with the matching CUI, preferred name and semantic type.</UL><h3>Typical Document Search Flow</h3><p>1. <b>GET /v1/corpora</b> - Get list of all available corpus names<p>2. <b>GET /v1/corpora/corpus_name/search/typeahead</b> - Use typeahead to select search concepts<p>3. <b>GET /v1/corpora/corpus_name/search/cooccurring_concepts</b> - Find additional co-occurring search concepts<p>4. <b>GET /v1/corpora/corpus_name/concepts/{cui}/matching_concepts</b> - Find additional matching search concepts<p>5. <b>GET /v1/corpora/corpus_name/concepts/{cui}/related_concepts</b> - Find additional related search concepts<p>6. <b>GET /v1/corpora/corpus_name/search/ranked_documents</b> - Search for ranked documents matching search concepts<p>7. <b>GET /v1/corpora/corpus_name/documents/{document_id}/search_matches</b> - Highlight matching search concepts in a ranked documents<p>8. <b>GET /v1/corpora/corpus_name/documents/{document_id}/categories</b> - Highlight diseases, drugs and genes in a ranked document.

Version:

v1

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_SERVICE_NAME
static java.lang.String	DEFAULT_SERVICE_URL

Fields inherited from class com.ibm.cloud.sdk.core.service.BaseService

PROPNAME_DISABLE_SSL, PROPNAME_ENABLE_GZIP, PROPNAME_ENABLE_RETRIES, PROPNAME_MAX_RETRIES, PROPNAME_RETRY_INTERVAL, PROPNAME_URL

Constructor Summary

Constructors

Constructor and Description
InsightsForMedicalLiteratureService(java.lang.String version, java.lang.String serviceName, com.ibm.cloud.sdk.core.security.Authenticator authenticator) Constructs an instance of the `InsightsForMedicalLiteratureService` client.

Method Summary

Modifier and Type	Method and Description
com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void>	addArtifact(AddArtifactOptions addArtifactOptions) Add cartridge artifact.
com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void>	addCorpusDocument(AddCorpusDocumentOptions addCorpusDocumentOptions) Define enrichment document.
com.ibm.cloud.sdk.core.http.ServiceCall<CorporaConfig>	deleteCorpusSchema(DeleteCorpusSchemaOptions deleteCorpusSchemaOptions) Delete a corpus.
com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void>	enableCorpusSearchTracking() Toggle Search Activity Tracking.
com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void>	enableCorpusSearchTracking(EnableCorpusSearchTrackingOptions enableCorpusSearchTrackingOptions) Toggle Search Activity Tracking.
com.ibm.cloud.sdk.core.http.ServiceCall<ConceptListModel>	getConcepts(GetConceptsOptions getConceptsOptions) Retrieves information for concepts mentioned in this corpus.
com.ibm.cloud.sdk.core.http.ServiceCall<CorporaConfig>	getCorporaConfig() Retrieves the available corpus names and configuration.
com.ibm.cloud.sdk.core.http.ServiceCall<CorporaConfig>	getCorporaConfig(GetCorporaConfigOptions getCorporaConfigOptions) Retrieves the available corpus names and configuration.
com.ibm.cloud.sdk.core.http.ServiceCall<CorporaConfig>	getCorpusConfig(GetCorpusConfigOptions getCorpusConfigOptions) Retrieves the corpus configuration.
com.ibm.cloud.sdk.core.http.ServiceCall<ConceptInfoModel>	getCuiInfo(GetCuiInfoOptions getCuiInfoOptions) Retrieve information for a concept.
com.ibm.cloud.sdk.core.http.ServiceCall<AnnotationsModel>	getDocumentAnnotations(GetDocumentAnnotationsOptions getDocumentAnnotationsOptions) Retrieves annotations for a document.
com.ibm.cloud.sdk.core.http.ServiceCall<CategoriesModel>	getDocumentCategories(GetDocumentCategoriesOptions getDocumentCategoriesOptions) Categorizes concepts in a document.
com.ibm.cloud.sdk.core.http.ServiceCall<GetDocumentInfoResponse>	getDocumentInfo(GetDocumentInfoOptions getDocumentInfoOptions) Retrieves the external ID, title, abstract and text for a document.
com.ibm.cloud.sdk.core.http.ServiceCall<CategoriesModel>	getDocumentMultipleCategories(GetDocumentMultipleCategoriesOptions getDocumentMultipleCategoriesOptions) Categorizes concepts in a document.
com.ibm.cloud.sdk.core.http.ServiceCall<CorpusInfoModel>	getDocuments(GetDocumentsOptions getDocumentsOptions) Retrieves information about the documents in this corpus.
com.ibm.cloud.sdk.core.http.ServiceCall<MetadataModel>	getFields(GetFieldsOptions getFieldsOptions) Retrieves a list of metadata fields defined in the corpus.
com.ibm.cloud.sdk.core.http.ServiceCall<ServiceStatus>	getHealthCheckStatus() Determine if service is running correctly.
com.ibm.cloud.sdk.core.http.ServiceCall<ServiceStatus>	getHealthCheckStatus(GetHealthCheckStatusOptions getHealthCheckStatusOptions) Determine if service is running correctly.
com.ibm.cloud.sdk.core.http.ServiceCall<HitCount>	getHitCount(GetHitCountOptions getHitCountOptions) Retrieves a count of the number of times a concept is mentioned in the corpus.
com.ibm.cloud.sdk.core.http.ServiceCall<RelatedConceptsModel>	getRelatedConcepts(GetRelatedConceptsOptions getRelatedConceptsOptions) Retrieve concepts related to a concept.
com.ibm.cloud.sdk.core.http.ServiceCall<SearchMatchesModel>	getSearchMatches(GetSearchMatchesOptions getSearchMatchesOptions) Finds concepts in a document matching a set of search concepts.
com.ibm.cloud.sdk.core.http.ServiceCall<ServiceStatus>	getServiceStatus() Get status of service.
com.ibm.cloud.sdk.core.http.ServiceCall<ServiceStatus>	getServiceStatus(GetServiceStatusOptions getServiceStatusOptions) Get status of service.
com.ibm.cloud.sdk.core.http.ServiceCall<ConceptListModel>	getSimilarConcepts(GetSimilarConceptsOptions getSimilarConceptsOptions) Find similar concepts.
com.ibm.cloud.sdk.core.http.ServiceCall<StatisticsModel>	getStatistics(GetStatisticsOptions getStatisticsOptions) Retrieves statistics for a corpus.
java.lang.String	getVersion() Gets the version.
com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void>	monitorCorpus(MonitorCorpusOptions monitorCorpusOptions) Enable monitoring for a custom instance.
static InsightsForMedicalLiteratureService	newInstance(java.lang.String version) Class method which constructs an instance of the `InsightsForMedicalLiteratureService` client.
static InsightsForMedicalLiteratureService	newInstance(java.lang.String version, java.lang.String serviceName) Class method which constructs an instance of the `InsightsForMedicalLiteratureService` client.
com.ibm.cloud.sdk.core.http.ServiceCall<SearchModel>	search(SearchOptions searchOptions) Search for concepts, documents, and authors.
com.ibm.cloud.sdk.core.http.ServiceCall<CorporaConfig>	setCorpusConfig() Define service repository.
com.ibm.cloud.sdk.core.http.ServiceCall<CorporaConfig>	setCorpusConfig(SetCorpusConfigOptions setCorpusConfigOptions) Define service repository.
com.ibm.cloud.sdk.core.http.ServiceCall<CorporaConfig>	setCorpusSchema() Define service repository data model.
com.ibm.cloud.sdk.core.http.ServiceCall<CorporaConfig>	setCorpusSchema(SetCorpusSchemaOptions setCorpusSchemaOptions) Define service repository data model.
void	setVersion(java.lang.String version) Sets the version.
com.ibm.cloud.sdk.core.http.ServiceCall<CommonDataModel>	tokenize(TokenizeOptions tokenizeOptions) Tokenize the input text into concepts.
com.ibm.cloud.sdk.core.http.ServiceCall<ConceptListModel>	typeahead(TypeaheadOptions typeaheadOptions) Find concepts matching the specified query string.

Methods inherited from class com.ibm.cloud.sdk.core.service.BaseService

configureClient, configureService, constructServiceUrl, constructServiceURL, disableRetries, enableGzipCompression, enableRetries, getAuthenticator, getClient, getEndPoint, getName, getServiceUrl, isJsonMimeType, isJsonPatchMimeType, setClient, setDefaultHeaders, setEndPoint, setServiceUrl, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_SERVICE_NAME

public static final java.lang.String DEFAULT_SERVICE_NAME

See Also:

Constant Field Values

DEFAULT_SERVICE_URL

public static final java.lang.String DEFAULT_SERVICE_URL

See Also:

Constant Field Values

Constructor Detail

InsightsForMedicalLiteratureService

public InsightsForMedicalLiteratureService(java.lang.String version,
                                           java.lang.String serviceName,
                                           com.ibm.cloud.sdk.core.security.Authenticator authenticator)

Constructs an instance of the `InsightsForMedicalLiteratureService` client. The specified service name and authenticator are used to configure the client instance.

Parameters:

version - The release date of the version of the API you want to use. Specify dates in YYYY-MM-DD format.

serviceName - the service name to be used when configuring the client instance

authenticator - the Authenticator instance to be configured for this client

Method Detail

newInstance

public static InsightsForMedicalLiteratureService newInstance(java.lang.String version)

Class method which constructs an instance of the `InsightsForMedicalLiteratureService` client. The default service name is used to configure the client instance.

Parameters:

version - The release date of the version of the API you want to use. Specify dates in YYYY-MM-DD format.

Returns:

an instance of the `InsightsForMedicalLiteratureService` client using external configuration

newInstance

public static InsightsForMedicalLiteratureService newInstance(java.lang.String version,
                                                              java.lang.String serviceName)

Class method which constructs an instance of the `InsightsForMedicalLiteratureService` client. The specified service name is used to configure the client instance.

Parameters:

version - The release date of the version of the API you want to use. Specify dates in YYYY-MM-DD format.

serviceName - the service name to be used when configuring the client instance

Returns:

an instance of the `InsightsForMedicalLiteratureService` client using external configuration

getVersion

public java.lang.String getVersion()

Gets the version. The release date of the version of the API you want to use. Specify dates in YYYY-MM-DD format.

Returns:

the version

setVersion

public void setVersion(java.lang.String version)

Sets the version.

Parameters:

version - the new version

getDocuments

public com.ibm.cloud.sdk.core.http.ServiceCall<CorpusInfoModel> getDocuments(GetDocumentsOptions getDocumentsOptions)

Retrieves information about the documents in this corpus. The response returns the following information: <ul><li>number of documents in the corpus</li><li>corpus provider</li></ul>.

Parameters:

getDocumentsOptions - the GetDocumentsOptions containing the options for the call

Returns:

a ServiceCall with a result of type CorpusModel

addCorpusDocument

public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> addCorpusDocument(AddCorpusDocumentOptions addCorpusDocumentOptions)

Define enrichment document. The response returns whether the document was properly added to the corpus. <P>This API should be used for adding a document to a custom corpus.<P>Example POST body:<pre>{ "acdUrl" : "acdApiKeyl" : "flowId" : "document" : { "doc_id" : "field[n]" : "value" } "otherAnnotators" : [ "{ "annotatorUrl "annotatorApiKey "containerName "} ] } </pre>.

Parameters:

addCorpusDocumentOptions - the AddCorpusDocumentOptions containing the options for the call

Returns:

a ServiceCall with a void result

getDocumentInfo

public com.ibm.cloud.sdk.core.http.ServiceCall<GetDocumentInfoResponse> getDocumentInfo(GetDocumentInfoOptions getDocumentInfoOptions)

Retrieves the external ID, title, abstract and text for a document. The response may return the following fields:<ul><li>external ID (e.g., PubMed ID)</li><li>title</li><li>abstract</li><li>body</li><li>pdfUrl</li><li>referenceUrl</li><li>other metadata</li></ul>Note, some documents may not have an abstract, or only the abstract may be available without the body text.

Parameters:

getDocumentInfoOptions - the GetDocumentInfoOptions containing the options for the call

Returns:

a ServiceCall with a result of type GetDocumentInfoResponse

getDocumentAnnotations

public com.ibm.cloud.sdk.core.http.ServiceCall<AnnotationsModel> getDocumentAnnotations(GetDocumentAnnotationsOptions getDocumentAnnotationsOptions)

Retrieves annotations for a document. The response returns a list of all the annotations contained in the document.

Parameters:

getDocumentAnnotationsOptions - the GetDocumentAnnotationsOptions containing the options for the call

Returns:

a ServiceCall with a void result

getDocumentCategories

public com.ibm.cloud.sdk.core.http.ServiceCall<CategoriesModel> getDocumentCategories(GetDocumentCategoriesOptions getDocumentCategoriesOptions)

Categorizes concepts in a document. The response returns a categorized list of text passages in a document. The sentences are grouped by concept with the matching concepts highlighted.

Parameters:

getDocumentCategoriesOptions - the GetDocumentCategoriesOptions containing the options for the call

Returns:

a ServiceCall with a result of type CategoriesModel

getDocumentMultipleCategories

public com.ibm.cloud.sdk.core.http.ServiceCall<CategoriesModel> getDocumentMultipleCategories(GetDocumentMultipleCategoriesOptions getDocumentMultipleCategoriesOptions)

Categorizes concepts in a document. The response returns multiple categorized lists of text passages in a document. The sentences are grouped by concept with the matching concepts highlighted.<P>This API should be used to batch multiple categories in a single request to improve performance.<P>Example POST body:<pre>{ categories: [ { name : 'disorders', category : 'disorders' }, { name : 'drugs', category : 'drugs' }, { name : 'genes', category : 'genes' }, { name : 'negated', category : 'negated' }, { name : 'finding',' types : ['Finding'] }, ] } </pre>.

Parameters:

getDocumentMultipleCategoriesOptions - the GetDocumentMultipleCategoriesOptions containing the options for the call

Returns:

a ServiceCall with a result of type CategoriesModel

getSearchMatches

public com.ibm.cloud.sdk.core.http.ServiceCall<SearchMatchesModel> getSearchMatches(GetSearchMatchesOptions getSearchMatchesOptions)

Finds concepts in a document matching a set of search concepts. Returns matching concepts and text passages. The sentences containing each concept are returned with the concept highlighted. <p>Extended annotations provide additional details for each discrete search match detected in the document. An iml-annotation-id attribute is added to each highlight tag which allows an application to easily show the annotation details when hovering over a text span. The iml-annotation-id may also be used to color code the text spans. The ibm_annotation-id is used as a key for the returned annotations. <p>For example, a search match on the concept "Breast Carcinoma" will have a class name "iml-breast-carcinoma" inserted in the highlight tag, and the returned annotations['umls-breast_carcinoma-hypothetical'] JSON field will contain the detailed annotation data: <pre>{ "cui": "C0678222" "hypothetical": true "preferredName": "Breast Carcinoma" "semanticType": "umls.NeoplasticProcess" "source": "umls" "type": "umls.NeoplasticProcess" } </pre>.

Parameters:

getSearchMatchesOptions - the GetSearchMatchesOptions containing the options for the call

Returns:

a ServiceCall with a result of type SearchMatchesModel

getCorporaConfig

public com.ibm.cloud.sdk.core.http.ServiceCall<CorporaConfig> getCorporaConfig(GetCorporaConfigOptions getCorporaConfigOptions)

Retrieves the available corpus names and configuration. The response returns an array of available corpus names and optionally includes detailed configuation parameters.

Parameters:

getCorporaConfigOptions - the GetCorporaConfigOptions containing the options for the call

Returns:

a ServiceCall with a result of type CorporaConfig

getCorporaConfig

public com.ibm.cloud.sdk.core.http.ServiceCall<CorporaConfig> getCorporaConfig()

Retrieves the available corpus names and configuration. The response returns an array of available corpus names and optionally includes detailed configuation parameters.

Returns:

a ServiceCall with a result of type CorporaConfig

setCorpusSchema

public com.ibm.cloud.sdk.core.http.ServiceCall<CorporaConfig> setCorpusSchema(SetCorpusSchemaOptions setCorpusSchemaOptions)

Define service repository data model. The response returns whether the instance schema was properly created. <P>This API should be used for defining a custom corpus schema.<P>Example POST body:<pre>{ corpusName : 'string' "enrichmentTargets" : [ { "contentField": 'string', "enrichmentField : 'string' } ], "metadataFields" : [ { "fieldName": 'string', "fieldType : 'string' } ], "referenceIndices" : { "dictionaryIndex" : "my_umls", "attributeIndex" : "my_attributes", "meshIndex" : "my_mesh", } } </pre>.

Parameters:

setCorpusSchemaOptions - the SetCorpusSchemaOptions containing the options for the call

Returns:

a ServiceCall with a result of type CorporaConfig

setCorpusSchema

public com.ibm.cloud.sdk.core.http.ServiceCall<CorporaConfig> setCorpusSchema()

Define service repository data model. The response returns whether the instance schema was properly created. <P>This API should be used for defining a custom corpus schema.<P>Example POST body:<pre>{ corpusName : 'string' "enrichmentTargets" : [ { "contentField": 'string', "enrichmentField : 'string' } ], "metadataFields" : [ { "fieldName": 'string', "fieldType : 'string' } ], "referenceIndices" : { "dictionaryIndex" : "my_umls", "attributeIndex" : "my_attributes", "meshIndex" : "my_mesh", } } </pre>.

Returns:

a ServiceCall with a result of type CorporaConfig

deleteCorpusSchema

public com.ibm.cloud.sdk.core.http.ServiceCall<CorporaConfig> deleteCorpusSchema(DeleteCorpusSchemaOptions deleteCorpusSchemaOptions)

Delete a corpus. The response returns whether the instance schema was properly deleted.

Parameters:

deleteCorpusSchemaOptions - the DeleteCorpusSchemaOptions containing the options for the call

Returns:

a ServiceCall with a result of type CorporaConfig

setCorpusConfig

public com.ibm.cloud.sdk.core.http.ServiceCall<CorporaConfig> setCorpusConfig(SetCorpusConfigOptions setCorpusConfigOptions)

Define service repository. The response returns whether the service successfully connected to the specified repository. <P>This API should be used for providing a custom enriched corpus.<P>Example POST body:<pre>{ userName : 'string', password : 'string' repositoryUri : 'uri' } </pre>.

Parameters:

setCorpusConfigOptions - the SetCorpusConfigOptions containing the options for the call

Returns:

a ServiceCall with a result of type CorporaConfig

setCorpusConfig

public com.ibm.cloud.sdk.core.http.ServiceCall<CorporaConfig> setCorpusConfig()

Define service repository. The response returns whether the service successfully connected to the specified repository. <P>This API should be used for providing a custom enriched corpus.<P>Example POST body:<pre>{ userName : 'string', password : 'string' repositoryUri : 'uri' } </pre>.

Returns:

a ServiceCall with a result of type CorporaConfig

monitorCorpus

public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> monitorCorpus(MonitorCorpusOptions monitorCorpusOptions)

Enable monitoring for a custom instance. This API is meant to be used for IBM Cloud automated monitoring of custom plan instances. A service api-key with read only role can be submitted to enable monitoring.

Parameters:

monitorCorpusOptions - the MonitorCorpusOptions containing the options for the call

Returns:

a ServiceCall with a void result

enableCorpusSearchTracking

public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> enableCorpusSearchTracking(EnableCorpusSearchTrackingOptions enableCorpusSearchTrackingOptions)

Toggle Search Activity Tracking. The response returns whether the tracking was enabled or disabled.

Parameters:

enableCorpusSearchTrackingOptions - the EnableCorpusSearchTrackingOptions containing the options for the call

Returns:

a ServiceCall with a void result

enableCorpusSearchTracking

public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> enableCorpusSearchTracking()

Toggle Search Activity Tracking. The response returns whether the tracking was enabled or disabled.

Returns:

a ServiceCall with a void result

getCorpusConfig

public com.ibm.cloud.sdk.core.http.ServiceCall<CorporaConfig> getCorpusConfig(GetCorpusConfigOptions getCorpusConfigOptions)

Retrieves the corpus configuration. The response returns the corpus configuration.

Parameters:

getCorpusConfigOptions - the GetCorpusConfigOptions containing the options for the call

Returns:

a ServiceCall with a result of type CorporaConfig

getStatistics

public com.ibm.cloud.sdk.core.http.ServiceCall<StatisticsModel> getStatistics(GetStatisticsOptions getStatisticsOptions)

Retrieves statistics for a corpus. The response returns internal statistics for the corpus.

Parameters:

getStatisticsOptions - the GetStatisticsOptions containing the options for the call

Returns:

a ServiceCall with a result of type StatisticsModel

getServiceStatus

public com.ibm.cloud.sdk.core.http.ServiceCall<ServiceStatus> getServiceStatus(GetServiceStatusOptions getServiceStatusOptions)

Get status of service.

Parameters:

getServiceStatusOptions - the GetServiceStatusOptions containing the options for the call

Returns:

a ServiceCall with a result of type ServiceStatus

getServiceStatus

public com.ibm.cloud.sdk.core.http.ServiceCall<ServiceStatus> getServiceStatus()

Get status of service.

Returns:

a ServiceCall with a result of type ServiceStatus

getHealthCheckStatus

public com.ibm.cloud.sdk.core.http.ServiceCall<ServiceStatus> getHealthCheckStatus(GetHealthCheckStatusOptions getHealthCheckStatusOptions)

Determine if service is running correctly. This resource differs from /status in that it will will always return a 500 error if the service state is not OK. This makes it simpler for service front ends (such as Datapower) to detect a failed service.

Parameters:

getHealthCheckStatusOptions - the GetHealthCheckStatusOptions containing the options for the call

Returns:

a ServiceCall with a result of type ServiceStatus

getHealthCheckStatus

public com.ibm.cloud.sdk.core.http.ServiceCall<ServiceStatus> getHealthCheckStatus()

Determine if service is running correctly. This resource differs from /status in that it will will always return a 500 error if the service state is not OK. This makes it simpler for service front ends (such as Datapower) to detect a failed service.

Returns:

a ServiceCall with a result of type ServiceStatus

search

public com.ibm.cloud.sdk.core.http.ServiceCall<SearchModel> search(SearchOptions searchOptions)

Search for concepts, documents, and authors. Features include:<ul><li>Concept search</li><li>Keyword search</li><li>Attributes search</li><li>Attributes typeahead</li><li>Regular expressions</li><li>Find passages</li><li>Selecting authors</li><li>Selecting providers</li><li>Date ranges: publish date</li><li>Pagination</li><li>Aggregation: authors, concepts, and documents</li><li>Document date histogram</li></ul>.

Parameters:

searchOptions - the SearchOptions containing the options for the call

Returns:

a ServiceCall with a result of type SearchModel

getFields

public com.ibm.cloud.sdk.core.http.ServiceCall<MetadataModel> getFields(GetFieldsOptions getFieldsOptions)

Retrieves a list of metadata fields defined in the corpus. The response returns a list of metadata field names that can be used by the POST search API.

Parameters:

getFieldsOptions - the GetFieldsOptions containing the options for the call

Returns:

a ServiceCall with a result of type MetadataModel

typeahead

public com.ibm.cloud.sdk.core.http.ServiceCall<ConceptListModel> typeahead(TypeaheadOptions typeaheadOptions)

Find concepts matching the specified query string. Searches concepts mentioned in the corpus looking for matches on the query string field. The comparison is not case sensitive. The main use of this method is to build query boxes that offer auto-complete, to allow users to select valid concepts.

Parameters:

typeaheadOptions - the TypeaheadOptions containing the options for the call

Returns:

a ServiceCall with a result of type ConceptListModel

getConcepts

public com.ibm.cloud.sdk.core.http.ServiceCall<ConceptListModel> getConcepts(GetConceptsOptions getConceptsOptions)

Retrieves information for concepts mentioned in this corpus. The response returns concepts mentioned in this corpus. The returned concepts may be selected by CUI, preferred name, suface forms and attribute name. All selected concepts are returned.

Parameters:

getConceptsOptions - the GetConceptsOptions containing the options for the call

Returns:

a ServiceCall with a result of type ConceptListModel

addArtifact

public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> addArtifact(AddArtifactOptions addArtifactOptions)

Add cartridge artifact.

Parameters:

addArtifactOptions - the AddArtifactOptions containing the options for the call

Returns:

a ServiceCall with a void result

getCuiInfo

public com.ibm.cloud.sdk.core.http.ServiceCall<ConceptInfoModel> getCuiInfo(GetCuiInfoOptions getCuiInfoOptions)

Retrieve information for a concept. The followning fields may be retrieved: <ul><li>Preferred name</li><li>Semantic types</li><li>Surface forms - Ontology Dictionary names for this concept</li><li>Definition - Concept definition (if available)</li><li>Related Concepts info</li></ul><P>The default is to return all fields. Individual fields may be selected using the '_fields' query parameter.

Parameters:

getCuiInfoOptions - the GetCuiInfoOptions containing the options for the call

Returns:

a ServiceCall with a result of type ConceptInfoModel

getHitCount

public com.ibm.cloud.sdk.core.http.ServiceCall<HitCount> getHitCount(GetHitCountOptions getHitCountOptions)

Retrieves a count of the number of times a concept is mentioned in the corpus. The response returns the number of times a concept is mentioned (hit count) in the corpus.

Parameters:

getHitCountOptions - the GetHitCountOptions containing the options for the call

Returns:

a ServiceCall with a result of type HitCount

getRelatedConcepts

public com.ibm.cloud.sdk.core.http.ServiceCall<RelatedConceptsModel> getRelatedConcepts(GetRelatedConceptsOptions getRelatedConceptsOptions)

Retrieve concepts related to a concept. Returns a list of related concepts mentioned in the specified corpus. The following relationships are suppored: <ul><li><b>children</b> child concepts</li><li><b>parents</b> parent concepts</li><li><b>siblings</b> sibling concepts</li><li><b>synonyms</b> synonym concepts</li><li><b>qualified by</b> qualified by concepts</li><li><b>broader</b> broader concepts</li><li><b>narrower</b> narrower concepts</li><li><b>other</b> other than synonyms, narrower or broader</li><li><b>related</b> related and posibly synonymous concepts</li></ul><p>If the corpus path parameter can be set to 'umls' to look up relationship in the entire UMLS dictionary. Otherwise, an actual corpus name may be specified to limit the output to only those concepts mentioned in a specific corpus.

Parameters:

getRelatedConceptsOptions - the GetRelatedConceptsOptions containing the options for the call

Returns:

a ServiceCall with a result of type RelatedConceptsModel

getSimilarConcepts

public com.ibm.cloud.sdk.core.http.ServiceCall<ConceptListModel> getSimilarConcepts(GetSimilarConceptsOptions getSimilarConceptsOptions)

Find similar concepts. The response returns a list of similar concepts. All ontologies defined in the corpora are searched. Similarity is determined by checking for overlapping surface forms. The results are sorted in descending order by hit count.

Parameters:

getSimilarConceptsOptions - the GetSimilarConceptsOptions containing the options for the call

Returns:

a ServiceCall with a result of type ConceptListModel

tokenize

public com.ibm.cloud.sdk.core.http.ServiceCall<CommonDataModel> tokenize(TokenizeOptions tokenizeOptions)

Tokenize the input text into concepts. The response returns a list of tokenized concepts for the specified ontologies.

Parameters:

tokenizeOptions - the TokenizeOptions containing the options for the call

Returns:

a ServiceCall with a result of type CommonDataModel