AnnotatorForClinicalData (IBM Watson Health Cognitive Services Java SDK 1.4.2 API)

java.lang.Object
- com.ibm.cloud.sdk.core.service.BaseService
- - com.ibm.watson.health.acd.v1.AnnotatorForClinicalData

```
public class AnnotatorForClinicalData
extends com.ibm.cloud.sdk.core.service.BaseService
```
Natural Language Processing (NLP) service featuring a set of medical domain annotators for use in detecting entities and medical concepts from unstructured data. Multiple annotators may be invoked from a single request.

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`
`static java.lang.String`	`RETURN_ANALYZED_TEXT`
`static java.lang.String`	`VERSION`

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
`AnnotatorForClinicalData(java.lang.String version, java.lang.String serviceName, com.ibm.cloud.sdk.core.security.Authenticator authenticator)` Constructs an instance of the `AnnotatorForClinicalDataAcd` client.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`com.ibm.cloud.sdk.core.http.ServiceCall<ContainerGroup>`	`analyze(AnalyzeOptions analyzeOptions)` Derive entities and relations from unstructured data.
`ContainerGroup`	`analyze(java.lang.String text, Flow flow)` Method to analyze text with a manually defined annotator flow.
`ContainerGroup`	`analyze(java.lang.String text, Flow flow, boolean returnAnalyzedText)` Method to analyze text with a manually defined annotator flow.
`com.ibm.cloud.sdk.core.http.Response<ContainerGroup>`	`analyzeInclResponseDetails(java.lang.String text, Flow flow)` Method to analyze text with a manually defined annotator flow.
`com.ibm.cloud.sdk.core.http.Response<ContainerGroup>`	`analyzeInclResponseDetails(java.lang.String text, Flow flow, boolean returnAnalyzedText)` Method to analyze text with a manually defined annotator flow.
`com.ibm.cloud.sdk.core.http.ServiceCall<ContainerGroup>`	`analyzeWithFlow(AnalyzeWithFlowOptions analyzeWithFlowOptions)` analyze with a persisted flow.
`ContainerGroup`	`analyzeWithFlow(java.lang.String flowId, java.lang.String text)` Method to analyze text with an existing annotator flow.
`ContainerGroup`	`analyzeWithFlow(java.lang.String flowId, java.lang.String text, boolean returnAnalyzedText)` Method to analyze text with an existing annotator flow.
`ContainerGroup`	`analyzeWithFlow(java.lang.String flowId, UnstructuredContainer unstructuredContainer)` Method to analyze text with an existing annotator flow.
`ContainerGroup`	`analyzeWithFlow(java.lang.String flowId, UnstructuredContainer unstructuredContainer, boolean returnAnalyzedText)` Method to analyze text with an existing annotator flow.
`com.ibm.cloud.sdk.core.http.Response<ContainerGroup>`	`analyzeWithFlowInclResponseDetails(java.lang.String flowId, java.lang.String text)` Method to analyze text with an existing annotator flow.
`com.ibm.cloud.sdk.core.http.Response<ContainerGroup>`	`analyzeWithFlowInclResponseDetails(java.lang.String flowId, java.lang.String text, boolean returnAnalyzedText)` Method to analyze text with an existing annotator flow.
`com.ibm.cloud.sdk.core.http.Response<ContainerGroup>`	`analyzeWithFlowInclResponseDetails(java.lang.String flowId, UnstructuredContainer unstructuredContainer)` Method to analyze text with an existing annotator flow.
`com.ibm.cloud.sdk.core.http.Response<ContainerGroup>`	`analyzeWithFlowInclResponseDetails(java.lang.String flowId, UnstructuredContainer unstructuredContainer, boolean returnAnalyzedText)` Method to analyze text with an existing annotator flow.
`com.ibm.cloud.sdk.core.http.ServiceCall<AcdCartridgesList>`	`cartridgesGet()` Get list of available deployment status.
`com.ibm.cloud.sdk.core.http.ServiceCall<AcdCartridgesList>`	`cartridgesGet(CartridgesGetOptions cartridgesGetOptions)` Get list of available deployment status.
`com.ibm.cloud.sdk.core.http.ServiceCall<AcdCartridges>`	`cartridgesGetId(CartridgesGetIdOptions cartridgesGetIdOptions)` Get details of a specific deployment.
`com.ibm.cloud.sdk.core.http.ServiceCall<DeployCartridgeResponse>`	`cartridgesPostMultipart()` Create a cartridge deployment.
`com.ibm.cloud.sdk.core.http.ServiceCall<DeployCartridgeResponse>`	`cartridgesPostMultipart(CartridgesPostMultipartOptions cartridgesPostMultipartOptions)` Create a cartridge deployment.
`com.ibm.cloud.sdk.core.http.ServiceCall<DeployCartridgeResponse>`	`cartridgesPutMultipart()` Create a cartridge deployment.
`com.ibm.cloud.sdk.core.http.ServiceCall<DeployCartridgeResponse>`	`cartridgesPutMultipart(CartridgesPutMultipartOptions cartridgesPutMultipartOptions)` Create a cartridge deployment.
`com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void>`	`createFlows()` Persist a new flow definition.
`com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void>`	`createFlows(CreateFlowsOptions createFlowsOptions)` Persist a new flow definition.
`com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void>`	`createProfile()` Persist a new profile.
`com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void>`	`createProfile(CreateProfileOptions createProfileOptions)` Persist a new profile.
`com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void>`	`deleteFlows(DeleteFlowsOptions deleteFlowsOptions)` Delete a persisted flow.
`com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void>`	`deleteProfile(DeleteProfileOptions deleteProfileOptions)` Delete a persisted profile.
`com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void>`	`deleteUserSpecificArtifacts()` Delete tenant specific artifacts.
`com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void>`	`deleteUserSpecificArtifacts(DeleteUserSpecificArtifactsOptions deleteUserSpecificArtifactsOptions)` Delete tenant specific artifacts.
`com.ibm.cloud.sdk.core.http.ServiceCall<DeployCartridgeResponse>`	`deployCartridge()` Deploy a cartridge.
`com.ibm.cloud.sdk.core.http.ServiceCall<DeployCartridgeResponse>`	`deployCartridge(DeployCartridgeOptions deployCartridgeOptions)` Deploy a cartridge.
`com.ibm.cloud.sdk.core.http.ServiceCall<java.util.Map<java.lang.String,ServiceApiBean>>`	`getAnnotators()` Get list of available annotators.
`com.ibm.cloud.sdk.core.http.ServiceCall<java.util.Map<java.lang.String,ServiceApiBean>>`	`getAnnotators(GetAnnotatorsOptions getAnnotatorsOptions)` Get list of available annotators.
`com.ibm.cloud.sdk.core.http.ServiceCall<Annotator>`	`getAnnotatorsById(GetAnnotatorsByIdOptions getAnnotatorsByIdOptions)` Get details of a specific annotator.
`com.ibm.cloud.sdk.core.http.ServiceCall<java.util.Map<java.lang.String,AcdFlow>>`	`getFlows()` Get list of available persisted flows.
`com.ibm.cloud.sdk.core.http.ServiceCall<java.util.Map<java.lang.String,AcdFlow>>`	`getFlows(GetFlowsOptions getFlowsOptions)` Get list of available persisted flows.
`com.ibm.cloud.sdk.core.http.ServiceCall<AcdFlow>`	`getFlowsById(GetFlowsByIdOptions getFlowsByIdOptions)` Get details of a specific flow.
`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<AcdProfile>`	`getProfile(GetProfileOptions getProfileOptions)` Get details of a specific profile.
`com.ibm.cloud.sdk.core.http.ServiceCall<java.util.Map<java.lang.String,AcdProfile>>`	`getProfiles()` Get list of available persisted profiles.
`com.ibm.cloud.sdk.core.http.ServiceCall<java.util.Map<java.lang.String,AcdProfile>>`	`getProfiles(GetProfilesOptions getProfilesOptions)` Get list of available persisted profiles.
`java.lang.String`	`getVersion()` Gets the version.
`static AnnotatorForClinicalData`	`newInstance(java.lang.String version)` Class method which constructs an instance of the `AnnotatorForClinicalDataAcd` client.
`static AnnotatorForClinicalData`	`newInstance(java.lang.String version, java.lang.String serviceName)` Class method which constructs an instance of the `AnnotatorForClinicalDataAcd` client.
`com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void>`	`runPipeline()` Detect entities and relations from unstructured data.
`com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void>`	`runPipeline(RunPipelineOptions runPipelineOptions)` Detect entities & relations from unstructured data.
`com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void>`	`runPipelineWithFlow(RunPipelineWithFlowOptions runPipelineWithFlowOptions)` analyze with a pre-specified flow.
`void`	`setVersion(java.lang.String version)` Sets the version.
`com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void>`	`updateFlows(UpdateFlowsOptions updateFlowsOptions)` Update a persisted flow definition.
`com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void>`	`updateProfile(UpdateProfileOptions updateProfileOptions)` Update a persisted profile definition.

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
 - RETURN_ANALYZED_TEXT
```
public static final java.lang.String RETURN_ANALYZED_TEXT
```
 See Also:
 
 Constant Field Values
 - VERSION
```
public static final java.lang.String VERSION
```
 See Also:
 
 Constant Field Values
- Constructor Detail
 - AnnotatorForClinicalData
```
public AnnotatorForClinicalData(java.lang.String version,
 java.lang.String serviceName,
 com.ibm.cloud.sdk.core.security.Authenticator authenticator)
```
 Constructs an instance of the `AnnotatorForClinicalDataAcd` 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 AnnotatorForClinicalData newInstance(java.lang.String version)
```
 Class method which constructs an instance of the `AnnotatorForClinicalDataAcd` 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 `AnnotatorForClinicalDataAcd` client using external configuration
 - newInstance
```
public static AnnotatorForClinicalData newInstance(java.lang.String version,
 java.lang.String serviceName)
```
 Class method which constructs an instance of the `AnnotatorForClinicalDataAcd` 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 `AnnotatorForClinicalDataAcd` 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
 - getProfiles
```
public com.ibm.cloud.sdk.core.http.ServiceCall<java.util.Map<java.lang.String,AcdProfile>> getProfiles(GetProfilesOptions getProfilesOptions)
```
 Get list of available persisted profiles. Returns a summary including ID and description of the available persisted profiles.
 
 Parameters:
 
 getProfilesOptions - the GetProfilesOptions containing the options for the call
 
 Returns:
 
 a ServiceCall with a result of type ListStringWrapper
 - getProfiles
```
public com.ibm.cloud.sdk.core.http.ServiceCall<java.util.Map<java.lang.String,AcdProfile>> getProfiles()
```
 Get list of available persisted profiles. Returns a summary including ID and description of the available persisted profiles.
 
 Returns:
 
 a ServiceCall with a result of type ListStringWrapper
 - createProfile
```
public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> createProfile(CreateProfileOptions createProfileOptions)
```
 Persist a new profile. This API persists a new profile. A profile is identified by an ID. This ID can optionally be specified as part of the request body when invoking POST /v1/analyze API. A profile contains annotator configuration information that will be applied to the annotators specified in the annotator flow.If a caller would choose to have the ID of the new profile generated on their behalf, then in the request body the "id" field of the profile definition should be an empty string (""). The auto-generated ID would be a normalized form of the "name" field from the profile definition.Sample Profile #1 A profile definition that configures the 'concept_detection' annotator to use the UMLS umls.latest library. <pre>{ "id": "acd_profile_cd_umls_latest", "name": "Profile for the latest Concept Detection UMLS Library", "description": "Provides configurations for running Concept Detection with the latest UMLS library", "annotators": [ { "name": "concept_detection", "parameters": { "libraries": ["umls.latest"] } } ] }</pre>Sample Profile #2 A profile definition that configures the 'concept_detection' annotator to exclude any annotations where the semantic type does not equal 'neop'. <pre>{ "id": "acd_profile_cd_neop_only", "name": "Profile for Concept Detection neop Semantic Type", "description": "Concept Detection configuration fitler to exclude annotations where semantic type does not equal 'neop'.", "annotators": [ { "name": "concept_detection", "configurations": [ { "filter": { "target": "unstructured.data.concepts", "condition": { "type": "match", "field": "semanticType", "values": [ "neop" ], "not": false, "caseInsensitive": false, "operator": "equals" } } } ] } ] }</pre>.
 
 Parameters:
 
 createProfileOptions - the CreateProfileOptions containing the options for the call
 
 Returns:
 
 a ServiceCall with a void result
 - createProfile
```
public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> createProfile()
```
 Persist a new profile. This API persists a new profile. A profile is identified by an ID. This ID can optionally be specified as part of the request body when invoking POST /v1/analyze API. A profile contains annotator configuration information that will be applied to the annotators specified in the annotator flow.If a caller would choose to have the ID of the new profile generated on their behalf, then in the request body the "id" field of the profile definition should be an empty string (""). The auto-generated ID would be a normalized form of the "name" field from the profile definition.Sample Profile #1 A profile definition that configures the 'concept_detection' annotator to use the UMLS umls.latest library. <pre>{ "id": "acd_profile_cd_umls_latest", "name": "Profile for the latest Concept Detection UMLS Library", "description": "Provides configurations for running Concept Detection with the latest UMLS library", "annotators": [ { "name": "concept_detection", "parameters": { "libraries": ["umls.latest"] } } ] }</pre>Sample Profile #2 A profile definition that configures the 'concept_detection' annotator to exclude any annotations where the semantic type does not equal 'neop'. <pre>{ "id": "acd_profile_cd_neop_only", "name": "Profile for Concept Detection neop Semantic Type", "description": "Concept Detection configuration fitler to exclude annotations where semantic type does not equal 'neop'.", "annotators": [ { "name": "concept_detection", "configurations": [ { "filter": { "target": "unstructured.data.concepts", "condition": { "type": "match", "field": "semanticType", "values": [ "neop" ], "not": false, "caseInsensitive": false, "operator": "equals" } } } ] } ] }</pre>.
 
 Returns:
 
 a ServiceCall with a void result
 - getProfile
```
public com.ibm.cloud.sdk.core.http.ServiceCall<AcdProfile> getProfile(GetProfileOptions getProfileOptions)
```
 Get details of a specific profile. Using the specified profile ID, retrieves the profile definition.
 
 Parameters:
 
 getProfileOptions - the GetProfileOptions containing the options for the call
 
 Returns:
 
 a ServiceCall with a result of type AcdProfile
 - updateProfile
```
public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> updateProfile(UpdateProfileOptions updateProfileOptions)
```
 Update a persisted profile definition. Using the specified Profile ID, updates the profile definition. This is a complete replacement of the existing profile definition using the JSON object provided in the request body.
 
 Parameters:
 
 updateProfileOptions - the UpdateProfileOptions containing the options for the call
 
 Returns:
 
 a ServiceCall with a void result
 - deleteProfile
```
public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> deleteProfile(DeleteProfileOptions deleteProfileOptions)
```
 Delete a persisted profile. Using the specified profile ID, deletes the profile from the list of persisted profiles.
 
 Parameters:
 
 deleteProfileOptions - the DeleteProfileOptions containing the options for the call
 
 Returns:
 
 a ServiceCall with a void result
 - getFlows
```
public com.ibm.cloud.sdk.core.http.ServiceCall<java.util.Map<java.lang.String,AcdFlow>> getFlows(GetFlowsOptions getFlowsOptions)
```
 Get list of available persisted flows. Returns a summary including ID and description of the available persisted flows.
 
 Parameters:
 
 getFlowsOptions - the GetFlowsOptions containing the options for the call
 
 Returns:
 
 a ServiceCall with a result of type ListStringWrapper
 - getFlows
```
public com.ibm.cloud.sdk.core.http.ServiceCall<java.util.Map<java.lang.String,AcdFlow>> getFlows()
```
 Get list of available persisted flows. Returns a summary including ID and description of the available persisted flows.
 
 Returns:
 
 a ServiceCall with a result of type ListStringWrapper
 - createFlows
```
public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> createFlows(CreateFlowsOptions createFlowsOptions)
```
 Persist a new flow definition. This API persists a new flow. A flow is identified by an ID. This ID can optionally be specified as part of the request body when invoking POST /v1/analyze API. A flow definition contains a list one or more annotators, and optionally can include annotator configuration, a flow ID, and/or flow sequence.If a caller would choose to have the ID of the new flow generated on their behalf, then in the request body the "id" field of the flow definition should be an empty string (""). The auto-generated ID would be a normalized form of the "name" field from the flow definition.Sample Flow #1 A flow definition that includes two annotators. <pre>{ "id": "flow_simple", "name": "flow simple", "description": "A simple flow with two annotators", "annotatorFlows": [ { "flow": { "elements": [ { "annotator": { "name": "concept_detection" } }, { "annotator": { "name": "symptom_disease" } } ], "async": false } } ] }</pre>Sample Flow #2 A flow definition that includes the 'concept_detection' annotator and configuration details for the 'concept_detection' annotator. <pre>{ "id": "flow_concept_detection_exclude_non_neop", "name": "flow concept detection exclude non neop", "description": "A flow excluding detected concepts that do not have 'neop' semantic type", "annotatorFlows": [ { "flow": { "elements": [ { "annotator": { "name": "concept_detection", "configurations": [ { "filter": { "target": "unstructured.data.concepts", "condition": { "type": "match", "field": "semanticType", "values": [ "neop" ], "not": false, "caseInsensitive": false, "operator": "equals" } } } ] } } ], "async": false } } ] }</pre>.
 
 Parameters:
 
 createFlowsOptions - the CreateFlowsOptions containing the options for the call
 
 Returns:
 
 a ServiceCall with a void result
 - createFlows
```
public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> createFlows()
```
 Persist a new flow definition. This API persists a new flow. A flow is identified by an ID. This ID can optionally be specified as part of the request body when invoking POST /v1/analyze API. A flow definition contains a list one or more annotators, and optionally can include annotator configuration, a flow ID, and/or flow sequence.If a caller would choose to have the ID of the new flow generated on their behalf, then in the request body the "id" field of the flow definition should be an empty string (""). The auto-generated ID would be a normalized form of the "name" field from the flow definition.Sample Flow #1 A flow definition that includes two annotators. <pre>{ "id": "flow_simple", "name": "flow simple", "description": "A simple flow with two annotators", "annotatorFlows": [ { "flow": { "elements": [ { "annotator": { "name": "concept_detection" } }, { "annotator": { "name": "symptom_disease" } } ], "async": false } } ] }</pre>Sample Flow #2 A flow definition that includes the 'concept_detection' annotator and configuration details for the 'concept_detection' annotator. <pre>{ "id": "flow_concept_detection_exclude_non_neop", "name": "flow concept detection exclude non neop", "description": "A flow excluding detected concepts that do not have 'neop' semantic type", "annotatorFlows": [ { "flow": { "elements": [ { "annotator": { "name": "concept_detection", "configurations": [ { "filter": { "target": "unstructured.data.concepts", "condition": { "type": "match", "field": "semanticType", "values": [ "neop" ], "not": false, "caseInsensitive": false, "operator": "equals" } } } ] } } ], "async": false } } ] }</pre>.
 
 Returns:
 
 a ServiceCall with a void result
 - getFlowsById
```
public com.ibm.cloud.sdk.core.http.ServiceCall<AcdFlow> getFlowsById(GetFlowsByIdOptions getFlowsByIdOptions)
```
 Get details of a specific flow. Using the specified Flow ID, retrieves the flow definition.
 
 Parameters:
 
 getFlowsByIdOptions - the GetFlowsByIdOptions containing the options for the call
 
 Returns:
 
 a ServiceCall with a result of type AcdFlow
 - updateFlows
```
public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> updateFlows(UpdateFlowsOptions updateFlowsOptions)
```
 Update a persisted flow definition. Using the specified Flow ID, updates the persisted flow definition. This is a complete replacement of the existing flow definition using the JSON object provided in the request body.
 
 Parameters:
 
 updateFlowsOptions - the UpdateFlowsOptions containing the options for the call
 
 Returns:
 
 a ServiceCall with a void result
 - deleteFlows
```
public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> deleteFlows(DeleteFlowsOptions deleteFlowsOptions)
```
 Delete a persisted flow. Using the specified Flow ID, deletes the flow from the list of persisted flows.
 
 Parameters:
 
 deleteFlowsOptions - the DeleteFlowsOptions containing the options for the call
 
 Returns:
 
 a ServiceCall with a void result
 - runPipeline
```
public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> runPipeline(RunPipelineOptions runPipelineOptions)
```
 Detect entities & relations from unstructured data. This API accepts a JSON request model featuring both the unstructured data to be analyzed as well as the desired annotator flow.Annotator Chaining Sample request invoking both the concept_detection and symptom_disease annotators asynchronously. This sample request references configurations via a profile id. Profiles define configurations that can be referenced within a request. Profile is optional. A default profile is used if no profile id is available in the annotator flow. The default profile contains the parameters for the concept detection and the attribute detection. An empty profile can be used if absolutely no parameters are attached to any annotators. See <a href=".." target="_blank">documentation</a> for more information. <pre>{ "annotatorFlows": [ { "profile" : "default_profile_v1.0", "flow": { "elements": [ { "annotator": { "name": "concept_detection" } }, { "annotator": { "name": "symptom_disease" } } ], "async": false } } ], "unstructured": [ { "text": "Patient has lung cancer, but did not smoke. She may consider chemotherapy as part of a treatment plan." } ] } </pre>Annotation Filtering Sample request invoking concept_detection with a filter defined to exclude any annotations detected from concept_detection where the semanticType field does not equal "neop".<pre>{ "annotatorFlows": [ { "flow": { "elements": [ { "annotator": { "name": "concept_detection", "configurations": [ { "filter": { "target": "unstructured.data.concepts", "condition": { "type": "match", "field": "semanticType", "values": [ "neop" ], "not": false, "caseInsensitive": false, "operator": "equals" } } } ] } } ], "async": false } } ], "unstructured": [ { "text": "Patient has lung cancer, but did not smoke. She may consider chemotherapy as part of a treatment plan." } ] } </pre>Annotators that support annotation filtering: allergy, bathing_assistance, cancer, concept_detection, dressing_assistance, eating_assistance, ejection_fraction, lab_value, medication, named_entities, procedure, seeing_assistance, smoking, symptom_disease, toileting_assistance, walking_assistance.<hr/>Annotation Augmentation Sample request invoking the cancer annotator and providing a whitelist entry for a new custom surface form: "lungcancer".<pre>{ "annotatorFlows": [ { "flow": { "elements": [ { "annotator": { "name": "cancer", "configurations": [ { "whitelist": { "name": "cancer", "entries": [ { "surfaceForms": [ "lungcancer" ], "features": { "normalizedName": "lung cancer", "hccCode": "9", "icd10Code": "C34.9", "ccsCode": "19", "icd9Code": "162.9", "conceptId": "93880001" } } ] } } ] } } ], "async": false } } ], "unstructured": [ { "text": "The patient was diagnosed with lungcancer, on Dec 23, 2011." } ] } </pre>Annotators that support annotation augmentation: allergy, bathing_assistance, cancer, dressing_assistance, eating_assistance, ejection_fraction, lab_value, medication, named_entities, procedure, seeing_assistance, smoking, symptom_disease, toileting_assistance, walking_assistance. .
 
 Parameters:
 
 runPipelineOptions - the RunPipelineOptions containing the options for the call
 
 Returns:
 
 a ServiceCall with a void result
 - runPipeline
```
public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> runPipeline()
```
 Detect entities and relations from unstructured data. This API accepts a JSON request model featuring both the unstructured data to be analyzed as well as the desired annotator flow.Annotator Chaining Sample request invoking both the concept_detection and symptom_disease annotators asynchronously. This sample request references configurations via a profile id. Profiles define configurations that can be referenced within a request. Profile is optional. A default profile is used if no profile id is available in the annotator flow. The default profile contains the parameters for the concept detection and the attribute detection. An empty profile can be used if absolutely no parameters are attached to any annotators. See <a href=".." target="_blank">documentation</a> for more information. <pre>{ "annotatorFlows": [ { "profile" : "default_profile_v1.0", "flow": { "elements": [ { "annotator": { "name": "concept_detection" } }, { "annotator": { "name": "symptom_disease" } } ], "async": false } } ], "unstructured": [ { "text": "Patient has lung cancer, but did not smoke. She may consider chemotherapy as part of a treatment plan." } ] } </pre>Annotation Filtering Sample request invoking concept_detection with a filter defined to exclude any annotations detected from concept_detection where the semanticType field does not equal "neop".<pre>{ "annotatorFlows": [ { "flow": { "elements": [ { "annotator": { "name": "concept_detection", "configurations": [ { "filter": { "target": "unstructured.data.concepts", "condition": { "type": "match", "field": "semanticType", "values": [ "neop" ], "not": false, "caseInsensitive": false, "operator": "equals" } } } ] } } ], "async": false } } ], "unstructured": [ { "text": "Patient has lung cancer, but did not smoke. She may consider chemotherapy as part of a treatment plan." } ] } </pre>Annotators that support annotation filtering: allergy, bathing_assistance, cancer, concept_detection, dressing_assistance, eating_assistance, ejection_fraction, lab_value, medication, named_entities, procedure, seeing_assistance, smoking, symptom_disease, toileting_assistance, walking_assistance.<hr/>Annotation Augmentation Sample request invoking the cancer annotator and providing a whitelist entry for a new custom surface form: "lungcancer".<pre>{ "annotatorFlows": [ { "flow": { "elements": [ { "annotator": { "name": "cancer", "configurations": [ { "whitelist": { "name": "cancer", "entries": [ { "surfaceForms": [ "lungcancer" ], "features": { "normalizedName": "lung cancer", "hccCode": "9", "icd10Code": "C34.9", "ccsCode": "19", "icd9Code": "162.9", "conceptId": "93880001" } } ] } } ] } } ], "async": false } } ], "unstructured": [ { "text": "The patient was diagnosed with lungcancer, on Dec 23, 2011." } ] } </pre>Annotators that support annotation augmentation: allergy, bathing_assistance, cancer, dressing_assistance, eating_assistance, ejection_fraction, lab_value, medication, named_entities, procedure, seeing_assistance, smoking, symptom_disease, toileting_assistance, walking_assistance. .
 
 Returns:
 
 a ServiceCall with a void result
 - runPipelineWithFlow
```
public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> runPipelineWithFlow(RunPipelineWithFlowOptions runPipelineWithFlowOptions)
```
 analyze with a pre-specified flow. This API accepts a flow identifier as well as a <emph>TEXT</emph> or a <emph>JSON</emph> request model featuring the unstructured text to be analyzed. JSON request model with unstructured text <pre>{ "unstructured": [ { "text": "Patient has lung cancer, but did not smoke. She may consider chemotherapy as part of a treatment plan." } ] } </pre>JSON request model with existing annotations <pre>{ "unstructured": [ { "text": "Patient will not start on cisplatin 80mg on 1/1/2018. Patient is also diabetic.", "data": { "concepts": [ { "cui": "C0030705", "preferredName": "Patients", "semanticType": "podg", "source": "umls", "sourceVersion": "2017AA", "type": "umls.PatientOrDisabledGroup", "begin": 0, "end": 7, "coveredText": "Patient" } ] } } ] } </pre>.
 
 Parameters:
 
 runPipelineWithFlowOptions - the RunPipelineWithFlowOptions containing the options for the call
 
 Returns:
 
 a ServiceCall with a void result
 - analyze
```
public com.ibm.cloud.sdk.core.http.ServiceCall<ContainerGroup> analyze(AnalyzeOptions analyzeOptions)
```
 Derive entities and relations from unstructured data. This API accepts a JSON request model featuring both the unstructured data to be analyzed as well as the desired annotator flow. Annotator Chaining Sample request invoking both the concept_detection and symptom_disease annotators asynchronously. { "annotatorFlows": [ { "flow": { "elements": [ { "annotator": { "name": "concept_detection" } }, { "annotator": { "name": "symptom_disease" } } ], "async": true } } ], "unstructured\": [ { "text": "Patient has lung cancer, but did not smoke. She may consider chemotherapy as part of a treatment plan." } ] } Annotation Filtering Sample request invoking concept_detection with a filter defined to exclude any annotations derived from concept_detection where the semanticType field does not equal "neop". { "annotatorFlows": {"flow": {"elements": [{"annotator": {"name": "concept_detection", "configurations": [ {"filter": {"target": "unstructured.data.concepts","condition": { "type": "match", "field": "semanticType", "values": ["neop"], "not": false, "caseInsensitive": false, "operator": "equals" } }}]}}], "async": false }}], unstructured": [{"text": "Patient has lung cancer, but did not smoke. She may consider chemotherapy as part of a treatment plan."} ]}Annotators that support annotation filtering: allergy, bathing_assistance, cancer, concept_detection, dressing_assistance, eating_assistance, ejection_fraction, lab_value, medication, named_entities, procedure, seeing_assistance, smoking, symptom_disease, toileting_assistance, walking_assistance. Annotation Augmentation Sample request invoking the cancer annotator and providing a whitelist entry for a new custom surface form: "lungcancer". {"annotatorFlows": [{"flow": {"elements": [ { "annotator": {"name": "cancer", "configurations": [{"whitelist": {"name": "cancer","entries": [ {"surfaceForms": ["lungcancer"],"features": {"normalizedName": "lung cancer", "hccCode": "9", "icd10Code": "C34.9", "ccsCode": "19", "icd9Code": "162.9", "conceptId": "93880001" } }]}}]}}], "async": false}}], "unstructured": [{"text": "The patient was diagnosed with lungcancer, on Dec 23, 2011." }]} Annotators that support annotation augmentation: allergy, bathing_assistance, cancer, dressing_assistance, eating_assistance, ejection_fraction, lab_value, medication, named_entities, procedure, seeing_assistance, smoking, symptom_disease, toileting_assistance, walking_assistance. .
 
 Parameters:
 
 analyzeOptions - the AnalyzeOptions containing the options for the call
 
 Returns:
 
 the service call
 - analyzeWithFlow
```
public com.ibm.cloud.sdk.core.http.ServiceCall<ContainerGroup> analyzeWithFlow(AnalyzeWithFlowOptions analyzeWithFlowOptions)
```
 analyze with a persisted flow. This API accepts a flow identifier as well as a TEXT or a JSON request model featuring the unstructured text to be analyzed. JSON request model with unstructured text { "unstructured": [ {"text": "Patient has lung cancer, but did not smoke. She may consider chemotherapy as part of a treatment plan." } ]} JSON request model with existing annotations {"unstructured": [{"text": "Patient will not start on cisplatin 80mg on 1/1/2018. Patient is also diabetic.", "data": {"concepts": [{"cui": "C0030705", "preferredName": "Patients", "semanticType": "podg", "source": "umls", "sourceVersion": "2017AA", "type": "umls.PatientOrDisabledGroup", "begin": 0, "end": 7, "coveredText": "Patient"}]}}]} .
 
 Parameters:
 
 analyzeWithFlowOptions - the AnalyzeWithFlowOptions containing the options for the call
 
 Returns:
 
 the service call
 - analyze
```
public ContainerGroup analyze(java.lang.String text,
 Flow flow)
```
 Method to analyze text with a manually defined annotator flow.
 
 Parameters:
 
 text - data to be analyzed
 
 flow - Flow analytics to apply to the text
 
 Returns:
 
 the ContainerGroup discovered cogntive artifacts
 - analyzeInclResponseDetails
```
public com.ibm.cloud.sdk.core.http.Response<ContainerGroup> analyzeInclResponseDetails(java.lang.String text,
 Flow flow)
```
 Method to analyze text with a manually defined annotator flow.
 
 Parameters:
 
 text - data to be analyzed
 
 flow - Flow analytics to apply to the text
 
 Returns:
 
 the response with ContainerGroup
 - analyze
```
public ContainerGroup analyze(java.lang.String text,
 Flow flow,
 boolean returnAnalyzedText)
```
 Method to analyze text with a manually defined annotator flow.
 
 Parameters:
 
 text - data to be analyzed
 
 flow - analytics to appply to the text Flow
 
 returnAnalyzedText - where to return the submitted data
 
 Returns:
 
 the ContainerGroup
 - analyzeInclResponseDetails
```
public com.ibm.cloud.sdk.core.http.Response<ContainerGroup> analyzeInclResponseDetails(java.lang.String text,
 Flow flow,
 boolean returnAnalyzedText)
```
 Method to analyze text with a manually defined annotator flow.
 
 Parameters:
 
 text - data to be analyzed
 
 flow - analytics to appply to the text Flow
 
 returnAnalyzedText - where to return the submitted data
 
 Returns:
 
 the resopnse with result representing ContainerGroup
 - analyzeWithFlow
```
public ContainerGroup analyzeWithFlow(java.lang.String flowId,
 java.lang.String text)
```
 Method to analyze text with an existing annotator flow.
 
 Parameters:
 
 flowId - identifier of existing analytic flow to apply to the text
 
 text - data to be analyzed
 
 Returns:
 
 the ContainerGroup
 - analyzeWithFlowInclResponseDetails
```
public com.ibm.cloud.sdk.core.http.Response<ContainerGroup> analyzeWithFlowInclResponseDetails(java.lang.String flowId,
 java.lang.String text)
```
 Method to analyze text with an existing annotator flow.
 
 Parameters:
 
 flowId - identifier of existing analytic flow to apply to the text
 
 text - data to be analyzed
 
 Returns:
 
 the resopnse with result representing ContainerGroup
 - analyzeWithFlow
```
public ContainerGroup analyzeWithFlow(java.lang.String flowId,
 java.lang.String text,
 boolean returnAnalyzedText)
```
 Method to analyze text with an existing annotator flow.
 
 Parameters:
 
 flowId - identifier of existing analytic flow to apply to the text
 
 text - data to be analyzed
 
 returnAnalyzedText - where to return the submitted data
 
 Returns:
 
 the resopnse with result representing ContainerGroup
 - analyzeWithFlowInclResponseDetails
```
public com.ibm.cloud.sdk.core.http.Response<ContainerGroup> analyzeWithFlowInclResponseDetails(java.lang.String flowId,
 java.lang.String text,
 boolean returnAnalyzedText)
```
 Method to analyze text with an existing annotator flow.
 
 Parameters:
 
 flowId - identifier of existing analytic flow to apply to the text
 
 text - data to be analyzed
 
 returnAnalyzedText - where to return the submitted data
 
 Returns:
 
 the resopnse with result representing ContainerGroup
 - analyzeWithFlow
```
public ContainerGroup analyzeWithFlow(java.lang.String flowId,
 UnstructuredContainer unstructuredContainer)
```
 Method to analyze text with an existing annotator flow.
 
 Parameters:
 
 flowId - identifier of existing analytic flow to apply to the text
 
 unstructuredContainer - UnstructuredContainer discovered cogntive artifacts
 
 Returns:
 
 the ContainerGroup
 - analyzeWithFlowInclResponseDetails
```
public com.ibm.cloud.sdk.core.http.Response<ContainerGroup> analyzeWithFlowInclResponseDetails(java.lang.String flowId,
 UnstructuredContainer unstructuredContainer)
```
 Method to analyze text with an existing annotator flow.
 
 Parameters:
 
 flowId - identifier of existing analytic flow to apply to the text
 
 unstructuredContainer - UnstructuredContainer discovered cogntive artifacts
 
 Returns:
 
 the resopnse with result representing ContainerGroup
 - analyzeWithFlow
```
public ContainerGroup analyzeWithFlow(java.lang.String flowId,
 UnstructuredContainer unstructuredContainer,
 boolean returnAnalyzedText)
```
 Method to analyze text with an existing annotator flow.
 
 Parameters:
 
 flowId - identifier of existing analytic flow to apply to the text
 
 unstructuredContainer - UnstructuredContainer
 
 returnAnalyzedText - where to return the submitted data
 
 Returns:
 
 the ContainerGroup discovered cogntive artifacts
 - analyzeWithFlowInclResponseDetails
```
public com.ibm.cloud.sdk.core.http.Response<ContainerGroup> analyzeWithFlowInclResponseDetails(java.lang.String flowId,
 UnstructuredContainer unstructuredContainer,
 boolean returnAnalyzedText)
```
 Method to analyze text with an existing annotator flow.
 
 Parameters:
 
 flowId - identifier of existing analytic flow to apply to the text
 
 unstructuredContainer - UnstructuredContainer
 
 returnAnalyzedText - where to return the submitted data
 
 Returns:
 
 the resopnse with result representing ContainerGroup
 - getAnnotators
```
public com.ibm.cloud.sdk.core.http.ServiceCall<java.util.Map<java.lang.String,ServiceApiBean>> getAnnotators(GetAnnotatorsOptions getAnnotatorsOptions)
```
 Get list of available annotators. Get list of available annotators that can be leveraged to detect information from unstructured data. One or more annnotators can be leveraged within a single request to the service.
 
 Parameters:
 
 getAnnotatorsOptions - the GetAnnotatorsOptions containing the options for the call
 
 Returns:
 
 a ServiceCall with a void result
 - getAnnotators
```
public com.ibm.cloud.sdk.core.http.ServiceCall<java.util.Map<java.lang.String,ServiceApiBean>> getAnnotators()
```
 Get list of available annotators. Get list of available annotators that can be leveraged to detect information from unstructured data. One or more annnotators can be leveraged within a single request to the service.
 
 Returns:
 
 a ServiceCall with a void result
 - getAnnotatorsById
```
public com.ibm.cloud.sdk.core.http.ServiceCall<Annotator> getAnnotatorsById(GetAnnotatorsByIdOptions getAnnotatorsByIdOptions)
```
 Get details of a specific annotator. Get details of an annotator that can be used to detect information from unstructured data.
 
 Parameters:
 
 getAnnotatorsByIdOptions - the GetAnnotatorsByIdOptions containing the options for the call
 
 Returns:
 
 a ServiceCall with a void result
 - deleteUserSpecificArtifacts
```
public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> deleteUserSpecificArtifacts(DeleteUserSpecificArtifactsOptions deleteUserSpecificArtifactsOptions)
```
 Delete tenant specific artifacts. Delete tenant specific artifacts.
 
 Parameters:
 
 deleteUserSpecificArtifactsOptions - the DeleteUserSpecificArtifactsOptions containing the options for the call
 
 Returns:
 
 a ServiceCall with a void result
 - deleteUserSpecificArtifacts
```
public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> deleteUserSpecificArtifacts()
```
 Delete tenant specific artifacts. Delete tenant specific artifacts.
 
 Returns:
 
 a ServiceCall with a void result
 - cartridgesGet
```
public com.ibm.cloud.sdk.core.http.ServiceCall<AcdCartridgesList> cartridgesGet(CartridgesGetOptions cartridgesGetOptions)
```
 Get list of available deployment status. Returns a summary including ID and status of the available deployments.
 
 Parameters:
 
 cartridgesGetOptions - the CartridgesGetOptions containing the options for the call
 
 Returns:
 
 a ServiceCall with a result of type ListStringWrapper
 - cartridgesGet
```
public com.ibm.cloud.sdk.core.http.ServiceCall<AcdCartridgesList> cartridgesGet()
```
 Get list of available deployment status. Returns a summary including ID and status of the available deployments.
 
 Returns:
 
 a ServiceCall with a result of type ListStringWrapper
 - cartridgesPostMultipart
```
public com.ibm.cloud.sdk.core.http.ServiceCall<DeployCartridgeResponse> cartridgesPostMultipart(CartridgesPostMultipartOptions cartridgesPostMultipartOptions)
```
 Create a cartridge deployment. Create a cartridge deployment from a cartridge archive file.
 
 Parameters:
 
 cartridgesPostMultipartOptions - the CartridgesPostMultipartOptions containing the options for the call
 
 Returns:
 
 a ServiceCall with a result of type DeployCartridgeResponse
 - cartridgesPostMultipart
```
public com.ibm.cloud.sdk.core.http.ServiceCall<DeployCartridgeResponse> cartridgesPostMultipart()
```
 Create a cartridge deployment. Create a cartridge deployment from a cartridge archive file.
 
 Returns:
 
 a ServiceCall with a result of type DeployCartridgeResponse
 - cartridgesPutMultipart
```
public com.ibm.cloud.sdk.core.http.ServiceCall<DeployCartridgeResponse> cartridgesPutMultipart(CartridgesPutMultipartOptions cartridgesPutMultipartOptions)
```
 Create a cartridge deployment. Update a cartridge deployment from a cartridge archive file.
 
 Parameters:
 
 cartridgesPutMultipartOptions - the CartridgesPutMultipartOptions containing the options for the call
 
 Returns:
 
 a ServiceCall with a result of type DeployCartridgeResponse
 - cartridgesPutMultipart
```
public com.ibm.cloud.sdk.core.http.ServiceCall<DeployCartridgeResponse> cartridgesPutMultipart()
```
 Create a cartridge deployment. Update a cartridge deployment from a cartridge archive file.
 
 Returns:
 
 a ServiceCall with a result of type DeployCartridgeResponse
 - cartridgesGetId
```
public com.ibm.cloud.sdk.core.http.ServiceCall<AcdCartridges> cartridgesGetId(CartridgesGetIdOptions cartridgesGetIdOptions)
```
 Get details of a specific deployment. Using the specified Catridge ID, retrieves the deployment status.
 
 Parameters:
 
 cartridgesGetIdOptions - the CartridgesGetIdOptions containing the options for the call
 
 Returns:
 
 a ServiceCall with a result of type AcdCartridges
 - deployCartridge
```
public com.ibm.cloud.sdk.core.http.ServiceCall<DeployCartridgeResponse> deployCartridge(DeployCartridgeOptions deployCartridgeOptions)
```
 Deploy a cartridge. Deploy a cartridge from a cartridge archive file.
 
 Parameters:
 
 deployCartridgeOptions - the DeployCartridgeOptions containing the options for the call
 
 Returns:
 
 a ServiceCall with a result of type DeployCartridgeResponse
 - deployCartridge
```
public com.ibm.cloud.sdk.core.http.ServiceCall<DeployCartridgeResponse> deployCartridge()
```
 Deploy a cartridge. Deploy a cartridge from a cartridge archive file.
 
 Returns:
 
 a ServiceCall with a result of type DeployCartridgeResponse
 - 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

Class AnnotatorForClinicalData

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_SERVICE_NAME

DEFAULT_SERVICE_URL

RETURN_ANALYZED_TEXT

VERSION

Constructor Detail

AnnotatorForClinicalData

Method Detail

newInstance

newInstance

getVersion

setVersion

getProfiles

getProfiles

createProfile

createProfile

getProfile

updateProfile

deleteProfile

getFlows

getFlows

createFlows

createFlows

getFlowsById

updateFlows

deleteFlows

runPipeline

runPipeline

runPipelineWithFlow

analyze

analyzeWithFlow

analyze

analyzeInclResponseDetails

analyze

analyzeInclResponseDetails

analyzeWithFlow

analyzeWithFlowInclResponseDetails

analyzeWithFlow

analyzeWithFlowInclResponseDetails

analyzeWithFlow

analyzeWithFlowInclResponseDetails

analyzeWithFlow

analyzeWithFlowInclResponseDetails

getAnnotators

getAnnotators

getAnnotatorsById

deleteUserSpecificArtifacts

deleteUserSpecificArtifacts

cartridgesGet

cartridgesGet

cartridgesPostMultipart

cartridgesPostMultipart

cartridgesPutMultipart

cartridgesPutMultipart

cartridgesGetId

deployCartridge

deployCartridge

getHealthCheckStatus

getHealthCheckStatus