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

See Also:

Assistant

• Field Summary

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

    JSON_MIME_PATTERN, JSON_PATCH_MIME_PATTERN, PROPNAME_DISABLE_SSL, PROPNAME_URL

• Constructor Summary

  Constructors

  Constructor and Description
  Assistant (java.lang.String versionDate) Constructs a new `Assistant` client using the DEFAULT_SERVICE_NAME.
  Assistant (java.lang.String versionDate, com.ibm.cloud.sdk.core.security.Authenticator authenticator) Constructs a new `Assistant` client with the DEFAULT_SERVICE_NAME and the specified Authenticator.
  Assistant (java.lang.String versionDate, java.lang.String serviceName) Constructs a new `Assistant` client with the specified serviceName.
  Assistant (java.lang.String versionDate, java.lang.String serviceName, com.ibm.cloud.sdk.core.security.Authenticator authenticator) Constructs a new `Assistant` client with the specified Authenticator and serviceName.

• Method Summary

  Methods

  Modifier and Type	Method and Description
  com.ibm.cloud.sdk.core.http.ServiceCall<SessionResponse>	createSession (CreateSessionOptions createSessionOptions) Create a session.
  com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void>	deleteSession (DeleteSessionOptions deleteSessionOptions) Delete session.
  com.ibm.cloud.sdk.core.http.ServiceCall<MessageResponse>	message (MessageOptions messageOptions) Send user input to assistant (stateful).
  com.ibm.cloud.sdk.core.http.ServiceCall<MessageResponseStateless>	messageStateless (MessageStatelessOptions messageStatelessOptions) Send user input to assistant (stateless).

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

    configureClient, configureHttpClient, configureService, createServiceCall, getAuthenticator, getClient, getEndPoint, getName, getServiceUrl, isJsonMimeType, isJsonPatchMimeType, processServiceCall, setAuthentication, setClient, setDefaultHeaders, setDefaultHeaders, setEndPoint, setServiceUrl, toString

  • Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

• Constructor Detail

  • Assistant

    public Assistant(java.lang.String versionDate)

    Constructs a new `Assistant` client using the DEFAULT_SERVICE_NAME.

    Parameters:

    versionDate - The version date (yyyy-MM-dd) of the REST API to use. Specifying this value will keep your API calls from failing when the service introduces breaking changes.

  • Assistant

    public Assistant(java.lang.String versionDate,
     com.ibm.cloud.sdk.core.security.Authenticator authenticator)

    Constructs a new `Assistant` client with the DEFAULT_SERVICE_NAME and the specified Authenticator.

    Parameters:

    versionDate - The version date (yyyy-MM-dd) of the REST API to use. Specifying this value will keep your API calls from failing when the service introduces breaking changes.

    authenticator - the Authenticator instance to be configured for this service

  • Assistant

    public Assistant(java.lang.String versionDate,
     java.lang.String serviceName)

    Constructs a new `Assistant` client with the specified serviceName.

    Parameters:

    versionDate - The version date (yyyy-MM-dd) of the REST API to use. Specifying this value will keep your API calls from failing when the service introduces breaking changes.

    serviceName - The name of the service to configure.

  • Assistant

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

    Constructs a new `Assistant` client with the specified Authenticator and serviceName.

    Parameters:

    versionDate - The version date (yyyy-MM-dd) of the REST API to use. Specifying this value will keep your API calls from failing when the service introduces breaking changes.

    serviceName - The name of the service to configure.

    authenticator - the Authenticator instance to be configured for this service

• Method Detail

  • 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 response type of SessionResponse

  • deleteSession

    public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.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 response type of Void

  • message

    public com.ibm.cloud.sdk.core.http.ServiceCall<MessageResponse> 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 Watson Assistant for the duration of the session.

    There is no rate limit for this operation.

    Parameters:

    messageOptions - the MessageOptions containing the options for the call

    Returns:

    a ServiceCall with a response type of MessageResponse

  • messageStateless

    public com.ibm.cloud.sdk.core.http.ServiceCall<MessageResponseStateless> 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.

    There is no rate limit for this operation.

    Parameters:

    messageStatelessOptions - the MessageStatelessOptions containing the options for the call

    Returns:

    a ServiceCall with a response type of MessageResponseStateless