Package com.merative.acd.v1

Class 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

    • 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 Map<String, AcdProfile>

      • 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 Map<String, AcdProfile>

      • 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 <b>POST /v1/analyze</b> API. A profile contains annotator configuration information that will be applied to the annotators specified in the annotator flow.<p>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.
        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 <b>POST /v1/analyze</b> API. A profile contains annotator configuration information that will be applied to the annotators specified in the annotator flow.<p>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.
        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 Map<String, AcdFlow>

      • 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 Map<String, AcdFlow>

      • 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 <b>POST /v1/analyze</b> API. A flow definition contains a list one or more annotators, and optionally can include annotator configuration, a flow ID, and/or flow sequence.<p>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.
        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 <b>POST /v1/analyze</b> API. A flow definition contains a list one or more annotators, and optionally can include annotator configuration, a flow ID, and/or flow sequence.<p>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.
        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

      • analyze

        public com.ibm.cloud.sdk.core.http.ServiceCall<ContainerGroup> analyze​(AnalyzeOptions analyzeOptions)
        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.
        Parameters:
        analyzeOptions - the AnalyzeOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type ContainerGroup

      • analyzeWithFlow

        public com.ibm.cloud.sdk.core.http.ServiceCall<ContainerGroup> analyzeWithFlow​(AnalyzeWithFlowOptions analyzeWithFlowOptions)
        Detect entities and relations from unstructured data using 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
        Parameters:
        analyzeWithFlowOptions - the AnalyzeWithFlowOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type ContainerGroup

      • analyze

        public ContainerGroup analyze​(java.lang.String text,
                              Flow flow)
        Method to analyze text with a provided annotator flow definition.
        Parameters:
        text - data to be analyzed
        flow - Flow analytics to apply to the text
        Returns:
        the ContainerGroup discovered cognitive entities

      • analyzeInclResponseDetails

        public com.ibm.cloud.sdk.core.http.Response<ContainerGroup> analyzeInclResponseDetails​(java.lang.String text,
                                                                                       Flow flow)
        Method to analyze text using a provided annotator flow definition.
        Parameters:
        text - data to be analyzed
        flow - Flow annotator flow definition
        Returns:
        the Response with a result of type ContainerGroup

      • analyze

        public ContainerGroup analyze​(java.lang.String text,
                              Flow flow,
                              boolean returnAnalyzedText)
        Method to analyze text using a provided annotator flow definition.
        Parameters:
        text - data to be analyzed
        flow - Flow annotator flow definition
        returnAnalyzedText - if true, analyzed text is included in response
        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 using a provided annotator flow definition.
        Parameters:
        text - data to be analyzed
        flow - Flow annotator flow definition
        returnAnalyzedText - if true, analyzed text is included in response
        Returns:
        the Response with a result of type ContainerGroup

      • analyzeDebug

        public com.ibm.cloud.sdk.core.http.Response<ContainerGroup> analyzeDebug​(java.lang.String text,
                                                                         Flow flow,
                                                                         boolean returnAnalyzedText,
                                                                         boolean debug)
        Method to analyze text using a provided annotator flow definition.
        Parameters:
        text - data to be analyzed
        flow - Flow annotator flow definition
        returnAnalyzedText - if true, analyzed text is included in response
        debug - analyze debug flag
        Returns:
        the Response with a result of type ContainerGroup

      • analyzeWithFlow

        public ContainerGroup analyzeWithFlow​(java.lang.String flowId,
                                      java.lang.String text)
        Method to analyze text with a persisted annotator flow.
        Parameters:
        flowId - identifier of persisted annotator 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 a persisted annotator flow.
        Parameters:
        flowId - identifier of persisted annotator flow to apply to the text
        text - data to be analyzed
        Returns:
        the Response with a result of type ContainerGroup

      • analyzeWithFlow

        public ContainerGroup analyzeWithFlow​(java.lang.String flowId,
                                      java.lang.String text,
                                      boolean returnAnalyzedText)
        Method to analyze text with a persisted annotator flow.
        Parameters:
        flowId - identifier of persisted annotator flow to apply to the text
        text - data to be analyzed
        returnAnalyzedText - if true, analyzed text is included in response
        Returns:
        the ContainerGroup

      • analyzeWithFlowDebug

        public ContainerGroup analyzeWithFlowDebug​(java.lang.String flowId,
                                           java.lang.String text,
                                           boolean returnAnalyzedText,
                                           boolean debug)
        Method to analyze text with a persisted annotator flow with analyze debug flag enabled.
        Parameters:
        flowId - identifier of persisted annotator flow to apply to the text
        text - data to be analyzed
        returnAnalyzedText - if true, analyzed text is included in response
        debug - turn on analyze debug flag
        Returns:
        the 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 a persisted annotator flow.
        Parameters:
        flowId - identifier of persisted annotator flow to apply to the text
        text - data to be analyzed
        returnAnalyzedText - if true, analyzed text is included in response
        Returns:
        the Response with a result of type ContainerGroup

      • analyzeWithFlow

        public ContainerGroup analyzeWithFlow​(java.lang.String flowId,
                                      UnstructuredContainer unstructuredContainer)
        Method to analyze text with a persisted annotator flow.
        Parameters:
        flowId - identifier of persisted annotator flow to apply to the text
        unstructuredContainer - UnstructuredContainer text to analyze and discovered cognitive entities
        Returns:
        the ContainerGroup

      • analyzeWithFlow

        public ContainerGroup analyzeWithFlow​(java.lang.String flowId,
                                      UnstructuredContainer unstructuredContainer,
                                      boolean returnAnalyzedText)
        Method to analyze text with a persisted annotator flow.
        Parameters:
        flowId - identifier of persisted annotator flow to apply to the text
        unstructuredContainer - UnstructuredContainer text to analyze and discovered cognitive entities
        returnAnalyzedText - if true, analyzed text is included in response
        Returns:
        the ContainerGroup discovered cognitive entities

      • analyzeWithFlowInclResponseDetails

        public com.ibm.cloud.sdk.core.http.Response<ContainerGroup> analyzeWithFlowInclResponseDetails​(java.lang.String flowId,
                                                                                               UnstructuredContainer unstructuredContainer)
        Method to analyze text with a persisted annotator flow.
        Parameters:
        flowId - identifier of persisted annotator flow to apply to the text
        unstructuredContainer - UnstructuredContainer text to analyze and discovered cognitive entities
        Returns:
        the Response with a result of type ContainerGroup

      • analyzeWithFlowInclResponseDetails

        public com.ibm.cloud.sdk.core.http.Response<ContainerGroup> analyzeWithFlowInclResponseDetails​(java.lang.String flowId,
                                                                                               UnstructuredContainer unstructuredContainer,
                                                                                               boolean returnAnalyzedText)
        Method to analyze text with a persisted annotator flow.
        Parameters:
        flowId - identifier of persisted annotator flow to apply to the text
        unstructuredContainer - UnstructuredContainer text to analyze and discovered cognitive entities
        returnAnalyzedText - if true, analyzed text is included in response
        Returns:
        the Response with a result of type ContainerGroup

      • analyzeWithFlowDebug

        public com.ibm.cloud.sdk.core.http.Response<ContainerGroup> analyzeWithFlowDebug​(java.lang.String flowId,
                                                                                 UnstructuredContainer unstructuredContainer,
                                                                                 boolean returnAnalyzedText,
                                                                                 boolean debug)
        Method to analyze text with a persisted annotator flow with analyze debug flag enabled.
        Parameters:
        flowId - identifier of persisted annotator flow to apply to the text
        unstructuredContainer - UnstructuredContainer text to analyze and discovered cognitive entities
        returnAnalyzedText - if true, analyzed text is included in response
        debug - analyze debug flag enabled
        Returns:
        the Response with a result of type 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 annotators 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 result of type Map<String, ServiceApiBean>

      • 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 annotators can be leveraged within a single request to the service.
        Returns:
        a ServiceCall with a result of type Map<String, ServiceApiBean>

      • getAnnotatorsById

        public com.ibm.cloud.sdk.core.http.ServiceCall<ServiceApiBean> 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 ServiceApiBean 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 cartridge deployment statuses. 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 AcdCartridgesList

      • 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 AcdCartridgesList

      • 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()
        Update an existing 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

      • 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