com.ibm.watson.assistant.v2

Class Assistant

java.lang.Object

com.ibm.cloud.sdk.core.service.BaseService

com.ibm.watson.assistant.v2.Assistant

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

The IBM Watson™ Assistant service combines machine learning, natural language understanding, and an integrated dialog editor to create conversation flows between your apps and your users.

See Also:

Assistant

Field Summary

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

JSON_MIME_PATTERN, JSON_PATCH_MIME_PATTERN

Constructor Summary

Constructors

Constructor and Description
Assistant(java.lang.String versionDate) Deprecated. Use Assistant(String versionDate, AuthenticatorConfig authenticatorConfig) instead
Assistant(java.lang.String versionDate, com.ibm.cloud.sdk.core.security.AuthenticatorConfig authenticatorConfig) Instantiates a new `Assistant` with the specified authentication configuration.
Assistant(java.lang.String versionDate, java.lang.String username, java.lang.String password) Deprecated. Use Assistant(String versionDate, AuthenticatorConfig authenticatorConfig) instead

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.

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

configureClient, configureHttpClient, createServiceCall, getApiKey, getAuthenticator, getClient, getEndPoint, getName, getPassword, getUsername, isJsonMimeType, isJsonPatchMimeType, isSkipAuthentication, isTokenManagerSet, processServiceCall, setApiKey, setAuthentication, setAuthenticator, setClient, setDefaultHeaders, setDefaultHeaders, setEndPoint, setIamCredentials, setSkipAuthentication, setUsernameAndPassword, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

Assistant

@Deprecated
public Assistant(java.lang.String versionDate)

Deprecated. Use Assistant(String versionDate, AuthenticatorConfig authenticatorConfig) instead

Instantiates a new `Assistant`.

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

@Deprecated
public Assistant(java.lang.String versionDate,
                    java.lang.String username,
                    java.lang.String password)

Deprecated. Use Assistant(String versionDate, AuthenticatorConfig authenticatorConfig) instead

Instantiates a new `Assistant` with username and password.

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.

username - the username

password - the password

Assistant

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

Instantiates a new `Assistant` with the specified authentication configuration.

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.

authenticatorConfig - the authentication configuration 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.

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.

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. Send user input to an assistant and receive a response. 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