com.ibm.watson.developer_cloud.assistant.v2

Class Assistant

java.lang.Object

com.ibm.watson.developer_cloud.service.WatsonService

com.ibm.watson.developer_cloud.assistant.v2.Assistant

public class Assistant
extends WatsonService

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

See Also:

Assistant

Field Summary

Fields inherited from class com.ibm.watson.developer_cloud.service.WatsonService

defaultHeaders, JSON_MIME_PATTERN, JSON_PATCH_MIME_PATTERN, MESSAGE_CODE, MESSAGE_ERROR, skipAuthentication, VERSION

Constructor Summary

Constructors

Constructor and Description
Assistant(java.lang.String versionDate) Instantiates a new `Assistant`.
Assistant(java.lang.String versionDate, IamOptions iamOptions) Instantiates a new `Assistant` with IAM.
Assistant(java.lang.String versionDate, java.lang.String username, java.lang.String password) Instantiates a new `Assistant` with username and password.

Method Summary

Methods

Modifier and Type	Method and Description
ServiceCall<SessionResponse>	createSession(CreateSessionOptions createSessionOptions) Create a session.
ServiceCall<java.lang.Void>	deleteSession(DeleteSessionOptions deleteSessionOptions) Delete session.
ServiceCall<MessageResponse>	message(MessageOptions messageOptions) Send user input to assistant.

Methods inherited from class com.ibm.watson.developer_cloud.service.WatsonService

configureClient, configureHttpClient, createServiceCall, getApiKey, getEndPoint, getName, getPassword, getToken, getUsername, isJsonMimeType, isJsonPatchMimeType, isTokenManagerSet, processServiceCall, setApiKey, setAuthentication, 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

public Assistant(java.lang.String versionDate)

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

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

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,
         IamOptions iamOptions)

Instantiates a new `Assistant` with IAM. Note that if the access token is specified in the iamOptions, you accept responsibility for managing the access token yourself. You must set a new access token before this one expires or after receiving a 401 error from the service. Failing to do so will result in authentication errors after this token expires.

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.

iamOptions - the options for authenticating through IAM

Method Detail

createSession

public 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 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 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