JavaScript is disabled on your browser.
Skip navigation links
com.ibm.watson.assistant.v2

Class Assistant


  • public class Assistant
extends com.ibm.cloud.sdk.core.service.BaseService
    The IBM® watsonx™ Assistant service combines machine learning, natural language understanding, and an integrated dialog editor to create conversation flows between your apps and your users.

    The Assistant v2 API provides runtime methods your client application can use to send user input to an assistant and receive a response.

    You need a paid Plus plan or higher to use the watsonx Assistant v2 API.

    API Version: 2.0 See: https://cloud.ibm.com/docs/assistant

    • Field Detail

      • DEFAULT_SERVICE_NAME

        public static final String DEFAULT_SERVICE_NAME
        Default service name used when configuring the `Assistant` client.
        See Also:
        Constant Field Values

    • Constructor Detail

      • Assistant

        public Assistant(String version)
        Constructs an instance of the `Assistant` client. The default service name is used to configure the client instance.
        Parameters:
        version - Release date of the API version you want to use. Specify dates in YYYY-MM-DD format. The current version is `2024年08月25日`.

      • Assistant

        public Assistant(String version,
 com.ibm.cloud.sdk.core.security.Authenticator authenticator)
        Constructs an instance of the `Assistant` client. The default service name and specified authenticator are used to configure the client instance.
        Parameters:
        version - Release date of the API version you want to use. Specify dates in YYYY-MM-DD format. The current version is `2024年08月25日`.
        authenticator - the Authenticator instance to be configured for this client

      • Assistant

        public Assistant(String version,
 String serviceName)
        Constructs an instance of the `Assistant` client. The specified service name is used to configure the client instance.
        Parameters:
        version - Release date of the API version you want to use. Specify dates in YYYY-MM-DD format. The current version is `2024年08月25日`.
        serviceName - the service name to be used when configuring the client instance

      • Assistant

        public Assistant(String version,
 String serviceName,
 com.ibm.cloud.sdk.core.security.Authenticator authenticator)
        Constructs an instance of the `Assistant` client. The specified service name and authenticator are used to configure the client instance.
        Parameters:
        version - Release date of the API version you want to use. Specify dates in YYYY-MM-DD format. The current version is `2024年08月25日`.
        serviceName - the service name to be used when configuring the client instance
        authenticator - the Authenticator instance to be configured for this client

    • Method Detail

      • getVersion

        public String getVersion()
        Gets the version.

        Release date of the API version you want to use. Specify dates in YYYY-MM-DD format. The current version is `2024年08月25日`.

        Returns:
        the version

      • setVersion

        public void setVersion(String version)
        Sets the version.
        Parameters:
        version - the new version

      • createProvider

        public com.ibm.cloud.sdk.core.http.ServiceCall<ProviderResponse> createProvider(CreateProviderOptions createProviderOptions)
        Create a conversational skill provider.

        Create a new conversational skill provider.

        Parameters:
        createProviderOptions - the CreateProviderOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type ProviderResponse

      • listProviders

        public com.ibm.cloud.sdk.core.http.ServiceCall<ProviderCollection> listProviders(ListProvidersOptions listProvidersOptions)
        List conversational skill providers.

        List the conversational skill providers associated with a Watson Assistant service instance.

        Parameters:
        listProvidersOptions - the ListProvidersOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type ProviderCollection

      • listProviders

        public com.ibm.cloud.sdk.core.http.ServiceCall<ProviderCollection> listProviders()
        List conversational skill providers.

        List the conversational skill providers associated with a Watson Assistant service instance.

        Returns:
        a ServiceCall with a result of type ProviderCollection

      • updateProvider

        public com.ibm.cloud.sdk.core.http.ServiceCall<ProviderResponse> updateProvider(UpdateProviderOptions updateProviderOptions)
        Update a conversational skill provider.

        Update a new conversational skill provider.

        Parameters:
        updateProviderOptions - the UpdateProviderOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type ProviderResponse

      • createAssistant

        public com.ibm.cloud.sdk.core.http.ServiceCall<AssistantData> createAssistant()
        Create an assistant.

        Create a new assistant.

        Returns:
        a ServiceCall with a result of type AssistantData

      • listAssistants

        public com.ibm.cloud.sdk.core.http.ServiceCall<AssistantCollection> listAssistants()
        List assistants.

        List the assistants associated with a watsonx Assistant service instance.

        Returns:
        a ServiceCall with a result of type AssistantCollection

      • deleteAssistant

        public com.ibm.cloud.sdk.core.http.ServiceCall<Void> deleteAssistant(DeleteAssistantOptions deleteAssistantOptions)
        Delete assistant.

        Delete an assistant.

        Parameters:
        deleteAssistantOptions - the DeleteAssistantOptions containing the options for the call
        Returns:
        a ServiceCall with a void result

      • createSession

        public com.ibm.cloud.sdk.core.http.ServiceCall<SessionResponse> createSession(CreateSessionOptions createSessionOptions)
        Create a session.

        Create a new session. A session is used to send user input to a skill and receive responses. It also maintains the state of the conversation. A session persists until it is deleted, or until it times out because of inactivity. (For more information, see the [documentation](https://cloud.ibm.com/docs/assistant?topic=assistant-assistant-settings).).

        Parameters:
        createSessionOptions - the CreateSessionOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type SessionResponse

      • deleteSession

        public com.ibm.cloud.sdk.core.http.ServiceCall<Void> deleteSession(DeleteSessionOptions deleteSessionOptions)
        Delete session.

        Deletes a session explicitly before it times out. (For more information about the session inactivity timeout, see the [documentation](https://cloud.ibm.com/docs/assistant?topic=assistant-assistant-settings)).

        Parameters:
        deleteSessionOptions - the DeleteSessionOptions containing the options for the call
        Returns:
        a ServiceCall with a void result

      • message

        public com.ibm.cloud.sdk.core.http.ServiceCall<StatefulMessageResponse> message(MessageOptions messageOptions)
        Send user input to assistant (stateful).

        Send user input to an assistant and receive a response, with conversation state (including context data) stored by watsonx Assistant for the duration of the session.

        Parameters:
        messageOptions - the MessageOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type StatefulMessageResponse

      • messageStateless

        public com.ibm.cloud.sdk.core.http.ServiceCall<StatelessMessageResponse> messageStateless(MessageStatelessOptions messageStatelessOptions)
        Send user input to assistant (stateless).

        Send user input to an assistant and receive a response, with conversation state (including context data) managed by your application.

        Parameters:
        messageStatelessOptions - the MessageStatelessOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type StatelessMessageResponse

      • messageStream

        public com.ibm.cloud.sdk.core.http.ServiceCall<InputStream> messageStream(MessageStreamOptions messageStreamOptions)
        Send user input to assistant (stateful).

        Send user input to an assistant and receive a streamed response, with conversation state (including context data) stored by watsonx Assistant for the duration of the session.

        Parameters:
        messageStreamOptions - the MessageStreamOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type InputStream

      • messageStreamStateless

        public com.ibm.cloud.sdk.core.http.ServiceCall<InputStream> messageStreamStateless(MessageStreamStatelessOptions messageStreamStatelessOptions)
        Send user input to assistant (stateless).

        Send user input to an assistant and receive a response, with conversation state (including context data) managed by your application.

        Parameters:
        messageStreamStatelessOptions - the MessageStreamStatelessOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type InputStream

      • bulkClassify

        public com.ibm.cloud.sdk.core.http.ServiceCall<BulkClassifyResponse> bulkClassify(BulkClassifyOptions bulkClassifyOptions)
        Identify intents and entities in multiple user utterances.

        Send multiple user inputs to a dialog skill in a single request and receive information about the intents and entities recognized in each input. This method is useful for testing and comparing the performance of different skills or skill versions.

        This method is available only with Enterprise with Data Isolation plans.

        Parameters:
        bulkClassifyOptions - the BulkClassifyOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type BulkClassifyResponse

      • listLogs

        public com.ibm.cloud.sdk.core.http.ServiceCall<LogCollection> listLogs(ListLogsOptions listLogsOptions)
        List log events for an assistant.

        List the events from the log of an assistant.

        This method requires Manager access.

        **Note:** If you use the **cursor** parameter to retrieve results one page at a time, subsequent requests must be no more than 5 minutes apart. Any returned value for the **cursor** parameter becomes invalid after 5 minutes. For more information about using pagination, see [Pagination](#pagination).

        Parameters:
        listLogsOptions - the ListLogsOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type LogCollection

      • deleteUserData

        public com.ibm.cloud.sdk.core.http.ServiceCall<Void> deleteUserData(DeleteUserDataOptions deleteUserDataOptions)
        Delete labeled data.

        Deletes all data associated with a specified customer ID. The method has no effect if no data is associated with the customer ID.

        You associate a customer ID with data by passing the `X-Watson-Metadata` header with a request that passes data. For more information about personal data and customer IDs, see [Information security](https://cloud.ibm.com/docs/assistant?topic=assistant-information-security#information-security).

        **Note:** This operation is intended only for deleting data associated with a single specific customer, not for deleting data associated with multiple customers or for any other purpose. For more information, see [Labeling and deleting data in watsonx Assistant](https://cloud.ibm.com/docs/assistant?topic=assistant-information-security#information-security-gdpr-wa).

        Parameters:
        deleteUserDataOptions - the DeleteUserDataOptions containing the options for the call
        Returns:
        a ServiceCall with a void result

      • getEnvironment

        public com.ibm.cloud.sdk.core.http.ServiceCall<Environment> getEnvironment(GetEnvironmentOptions getEnvironmentOptions)
        Get environment.

        Get information about an environment. For more information about environments, see [Environments](https://cloud.ibm.com/docs/watson-assistant?topic=watson-assistant-publish-overview#environments).

        Parameters:
        getEnvironmentOptions - the GetEnvironmentOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type Environment

      • updateEnvironment

        public com.ibm.cloud.sdk.core.http.ServiceCall<Environment> updateEnvironment(UpdateEnvironmentOptions updateEnvironmentOptions)
        Update environment.

        Update an environment with new or modified data. For more information about environments, see [Environments](https://cloud.ibm.com/docs/watson-assistant?topic=watson-assistant-publish-overview#environments).

        Parameters:
        updateEnvironmentOptions - the UpdateEnvironmentOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type Environment

      • createRelease

        public com.ibm.cloud.sdk.core.http.ServiceCall<Release> createRelease(CreateReleaseOptions createReleaseOptions)
        Create release.

        Create a new release using the current content of the dialog and action skills in the draft environment. (In the watsonx Assistant user interface, a release is called a *version*.).

        Parameters:
        createReleaseOptions - the CreateReleaseOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type Release

      • listReleases

        public com.ibm.cloud.sdk.core.http.ServiceCall<ReleaseCollection> listReleases(ListReleasesOptions listReleasesOptions)
        List releases.

        List the releases associated with an assistant. (In the watsonx Assistant user interface, a release is called a *version*.).

        Parameters:
        listReleasesOptions - the ListReleasesOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type ReleaseCollection

      • getRelease

        public com.ibm.cloud.sdk.core.http.ServiceCall<Release> getRelease(GetReleaseOptions getReleaseOptions)
        Get release.

        Get information about a release.

        Release data is not available until publishing of the release completes. If publishing is still in progress, you can continue to poll by calling the same request again and checking the value of the **status** property. When processing has completed, the request returns the release data.

        Parameters:
        getReleaseOptions - the GetReleaseOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type Release

      • deleteRelease

        public com.ibm.cloud.sdk.core.http.ServiceCall<Void> deleteRelease(DeleteReleaseOptions deleteReleaseOptions)
        Delete release.

        Delete a release. (In the watsonx Assistant user interface, a release is called a *version*.).

        Parameters:
        deleteReleaseOptions - the DeleteReleaseOptions containing the options for the call
        Returns:
        a ServiceCall with a void result

      • deployRelease

        public com.ibm.cloud.sdk.core.http.ServiceCall<Environment> deployRelease(DeployReleaseOptions deployReleaseOptions)
        Deploy release.

        Update the environment with the content of the release. All snapshots saved as part of the release become active in the environment.

        Parameters:
        deployReleaseOptions - the DeployReleaseOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type Environment

      • createReleaseExport

        public com.ibm.cloud.sdk.core.http.ServiceCall<CreateReleaseExportWithStatusErrors> createReleaseExport(CreateReleaseExportOptions createReleaseExportOptions)
        Create release export.

        Initiate an asynchronous process which will create a downloadable Zip file artifact (/package) for an assistant release. This artifact will contain Action and/or Dialog skills that are part of the release. The Dialog skill will only be included in the event that coexistence is enabled on the assistant. The expected workflow with the use of Release Export endpoint is to first initiate the creation of the artifact with the POST endpoint and then poll the GET endpoint to retrieve the artifact. Once the artifact has been created, it will last for the duration (/scope) of the release.

        Parameters:
        createReleaseExportOptions - the CreateReleaseExportOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type CreateReleaseExportWithStatusErrors

      • downloadReleaseExport

        public com.ibm.cloud.sdk.core.http.ServiceCall<CreateReleaseExportWithStatusErrors> downloadReleaseExport(DownloadReleaseExportOptions downloadReleaseExportOptions)
        Get release export.

        A dual function endpoint to either retrieve the Zip file artifact that is associated with an assistant release or, retrieve the status of the artifact's creation. It is assumed that the artifact creation was already initiated prior to calling this endpoint. In the event that the artifact is not yet created and ready for download, this endpoint can be used to poll the system until the creation is completed or has failed. On the other hand, if the artifact is created, this endpoint will return the Zip file artifact as an octet stream. Once the artifact has been created, it will last for the duration (/scope) of the release. <br /><br /> When you will have downloaded the Zip file artifact, you have one of three ways to import it into an assistant's draft environment. These are as follows. <br /><ol><li>Import the zip package in Tooling via <var>"Assistant Settings" -> "Download/Upload files" -> "Upload" -> "Assistant only"</var>.</li><li>Import the zip package via "Create release import" endpoint using the APIs.</li><li>Extract the contents of the Zip file artifact and individually import the skill JSONs via skill update endpoints.</li></ol>.

        Parameters:
        downloadReleaseExportOptions - the DownloadReleaseExportOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type CreateReleaseExportWithStatusErrors

      • downloadReleaseExportAsStream

        public com.ibm.cloud.sdk.core.http.ServiceCall<InputStream> downloadReleaseExportAsStream(DownloadReleaseExportOptions downloadReleaseExportOptions)
        Get release export as stream.

        A dual function endpoint to either retrieve the Zip file artifact that is associated with an assistant release or, retrieve the status of the artifact's creation. It is assumed that the artifact creation was already initiated prior to calling this endpoint. In the event that the artifact is not yet created and ready for download, this endpoint can be used to poll the system until the creation is completed or has failed. On the other hand, if the artifact is created, this endpoint will return the Zip file artifact as an octet stream. Once the artifact has been created, it will last for the duration (/scope) of the release. <br /><br /> When you will have downloaded the Zip file artifact, you have one of three ways to import it into an assistant's draft environment. These are as follows. <br /><ol><li>Import the zip package in Tooling via <var>"Assistant Settings" -> "Download/Upload files" -> "Upload" -> "Assistant only"</var>.</li><li>Import the zip package via "Create release import" endpoint using the APIs.</li><li>Extract the contents of the Zip file artifact and individually import the skill JSONs via skill update endpoints.</li></ol>.

        Parameters:
        downloadReleaseExportOptions - the DownloadReleaseExportOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type InputStream

      • createReleaseImport

        public com.ibm.cloud.sdk.core.http.ServiceCall<CreateAssistantReleaseImportResponse> createReleaseImport(CreateReleaseImportOptions createReleaseImportOptions)
        Create release import.

        Import a previously exported assistant release Zip file artifact (/package) into an assistant. This endpoint creates (/initiates) an asynchronous task (/job) in the background which will import the artifact contents into the draft environment of the assistant on which this endpoint is called. Specifically, the asynchronous operation will override the action and/or dialog skills in the assistant. It will be worth noting that when the artifact that is provided to this endpoint is from an assistant release which has coexistence enabled (i.e., it has both action and dialog skills), the import process will automatically enable coexistence, if not already enabled, on the assistant into which said artifact is being uploaded to. On the other hand, if the artifact package being imported only has action skill in it, the import asynchronous process will only override the draft environment's action skill, regardless of whether coexistence is enabled on the assistant into which the package is being imported. Lastly, the system will only run one asynchronous import at a time on an assistant. As such, consecutive imports will override previous import's updates to the skills in the draft environment. Once created, you may poll the completion of the import via the "Get release import Status" endpoint.

        Parameters:
        createReleaseImportOptions - the CreateReleaseImportOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type CreateAssistantReleaseImportResponse

      • getSkill

        public com.ibm.cloud.sdk.core.http.ServiceCall<Skill> getSkill(GetSkillOptions getSkillOptions)
        Get skill.

        Get information about a skill.

        Parameters:
        getSkillOptions - the GetSkillOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type Skill

      • updateSkill

        public com.ibm.cloud.sdk.core.http.ServiceCall<Skill> updateSkill(UpdateSkillOptions updateSkillOptions)
        Update skill.

        Update a skill with new or modified data.

        **Note:** The update is performed asynchronously; you can see the status of the update by calling the **Get skill** method and checking the value of the **status** property.

        Parameters:
        updateSkillOptions - the UpdateSkillOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type Skill

      • exportSkills

        public com.ibm.cloud.sdk.core.http.ServiceCall<SkillsExport> exportSkills(ExportSkillsOptions exportSkillsOptions)
        Export skills.

        Asynchronously export the action skill and dialog skill (if enabled) for the assistant. Use this method to save all skill data from the draft environment so that you can import it to a different assistant using the **Import skills** method. Use `assistant_id` instead of `environment_id` to call this endpoint.

        A successful call to this method only initiates an asynchronous export. The exported JSON data is not available until processing completes.

        After the initial request is submitted, you can poll the status of the operation by calling the same request again and checking the value of the **status** property. If an error occurs (indicated by a **status** value of `Failed`), the `status_description` property provides more information about the error, and the `status_errors` property contains an array of error messages that caused the failure.

        When processing has completed, the request returns the exported JSON data. Remember that the usual rate limits apply.

        Parameters:
        exportSkillsOptions - the ExportSkillsOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type SkillsExport

      • importSkills

        public com.ibm.cloud.sdk.core.http.ServiceCall<SkillsAsyncRequestStatus> importSkills(ImportSkillsOptions importSkillsOptions)
        Import skills.

        Asynchronously import skills into an existing assistant from a previously exported file. This method only imports assistants into a draft environment. Use `assistant_id` instead of `environment_id` to call this endpoint.

        The request body for this method should contain the response data that was received from a previous call to the **Export skills** method, without modification.

        A successful call to this method initiates an asynchronous import. The updated skills belonging to the assistant are not available until processing completes. To check the status of the asynchronous import operation, use the **Get status of skills import** method.

        Parameters:
        importSkillsOptions - the ImportSkillsOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type SkillsAsyncRequestStatus
Skip navigation links
IBM Corporation

Copyright © 2025 IBM Cloud. All rights reserved.

AltStyle によって変換されたページ (->オリジナル) /