Software Development Kits

Annotator for Clinical Data has software development kits (SDKs) for interacting with the ACD service REST APIs. Depending on your chosen language that you use to develop applications to take advantage of the functionality provided by ACD, both a Java and Python version of the SDK are available to you. See below for more SDK details.

Alternatively, curl can be used to directly call the Annotator for Clinical Data REST APIs. See the examples in the exported PDF documentation for curl.

To authenticate to Annotator for Clinical Data Container Edition, you pass a bearer token in the credentials. If you have provided secure access to your ACD service instance via the OpenShift OAuth service (see Managing Access to ACD), you will use the token that you created on the service account as your bearer token. For access to an unsecured ACD service instance, the bearer token used for the credentials can be a dummy token.

Annotator for Clinical Data SDKs in GitHub

Find details about installing and using the SDKs.

Java SDK
- See examples provided in the API Reference for Java. See also the Java SDK javadoc.
Python SDK
- See examples provided in the API Reference for Python.

Examples

In the following examples, replace:

{version} is the ACD service API version, e.g. 2022-06-01
{url} is either:
- OAuth proxy route URL if secured access, e.g. https://<proxy_route_name>-<proxy_namespace>.apps.yourserver.com/services/clinical_data_annotator/api
- Direct route URL if unsecured, e.g. https://<route_name>-<acd_namespace>.apps.yourserver.com/services/clinical_data_annotator/api
{token} is either:
- bearer token of OAuth proxy route, e.g. edJhb......M1g
- dummy token, e.g. dummy

Java SDK

Authentication

import com.ibm.cloud.sdk.core.security.BearerTokenAuthenticator;
import com.merative.acd.v1.AnnotatorForClinicalData;

AnnotatorForClinicalData acdService = new AnnotatorForClinicalData({version},
                "AnnotatorForClinicalData", new BearerTokenAuthenticator({token}));
acdService.setServiceUrl({url});

Authentication and Disabling SSL Verification (not recommended)

import com.ibm.cloud.sdk.core.security.BearerTokenAuthenticator;
import com.merative.acd.v1.AnnotatorForClinicalData;
import com.ibm.cloud.sdk.core.http.HttpConfigOptions;

AnnotatorForClinicalData acdService = new AnnotatorForClinicalData({version},
                                "AnnotatorForClinicalData", new BearerTokenAuthenticator({token}));
acdService.setServiceUrl({url});
HttpConfigOptions options = new HttpConfigOptions.Builder().disableSslVerification(true).build();
acdService.configureClient(options);

Python SDK

Authentication

from ibm_cloud_sdk_core.authenticators import BearerTokenAuthenticator
import acd_sdk.annotator_for_clinical_data as acd

acd_service = acd.AnnotatorForClinicalDataV1(
    authenticator=BearerTokenAuthenticator(bearer_token={token}),
    version={version}
    )
acd_service.set_service_url({url})

Authentication and Disabling SSL Verification (not recommended)

from ibm_cloud_sdk_core.authenticators import BearerTokenAuthenticator
import acd_sdk.annotator_for_clinical_data as acd

acd_service = acd.AnnotatorForClinicalDataV1(
    authenticator=BearerTokenAuthenticator(bearer_token={token}),
    version={version}
    )
acd_service.set_service_url({url})
acd_service.set_disable_ssl_verification(True)

Using ACD: Getting Started

Using ACD: Custom Resource APIs