com.ibm.watson.developer_cloud.dialog.v1

Class DialogService

java.lang.Object

com.ibm.watson.developer_cloud.service.WatsonService

com.ibm.watson.developer_cloud.dialog.v1.DialogService

public class DialogService
extends WatsonService

The IBM Watson Dialog service Dialogs enhances application by providing chitchat for topics outside of a corpus and for giving context to a user's questions. You can create various virtual agent (VA) applications. Users can have natural, free-flowing, and human-like conversations with VAs that answer questions, show personality, decide, provide guidance, and even perform tasks.

Version:

v1

See Also:

Dialog

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLIENT_ID The Constant CLIENT_ID.
static String	CONVERSATION_ID The Constant CONVERSATION_ID.
static String	DATE_FROM The Constant DATE_FROM.
static String	DATE_TO The Constant DATE_TO.
static String	DIALOG_ID The Constant DIALOG_ID.
static String	INPUT The Constant INPUT.
static String	LIMIT The Constant LIMIT.
static String	NAME_VALUES The Constant NAME_VALUES.
static String	OFFSET The Constant OFFSET.

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

VERSION

Constructor Summary

Constructors

Constructor and Description
DialogService() Instantiates a new Dialog service with the default URL.

Method Summary

Modifier and Type	Method and Description
Conversation	converse(Conversation conversation, String newMessage) Starts or continue conversations.
Conversation	converse(Map<String,Object> params) Deprecated. Use converse(Conversation, String)
Conversation	createConversation(String dialogId) Starts or continue conversations.
Dialog	createDialog(String name, File dialogFile) Creates a dialog.
void	deleteDialog(String dialogId) Deletes a dialog.
List<DialogContent>	getContent(String dialogId) Gets content for nodes.
List<ConversationData>	getConversationData(Map<String,Object> params) Returns chat session data dump for a given date rage.
List<Dialog>	getDialogs() Retrieves the list of Dialogs for the user.
Map<String,String>	getProfile(String dialogId, Integer clientId, String... names) Returns a list of name-value pars associated with a client id.
Dialog	updateDialog(String dialogId, File dialogFile) Updates a dialog.
void	updateProfile(String dialogId, Integer clientId, Map<String,String> profile) Updates a dialog profile with a profile.

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

configureHttpClient, execute, executeRequest, executeWithoutResponse, getApiKey, getEndPoint, getName, getToken, setApiKey, setAuthentication, setDefaultHeaders, setEndPoint, setUsernameAndPassword, toString

Methods inherited from class java.lang.Object

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

Field Detail

CLIENT_ID

public static final String CLIENT_ID

The Constant CLIENT_ID.

See Also:

Constant Field Values

CONVERSATION_ID

public static final String CONVERSATION_ID

The Constant CONVERSATION_ID.

See Also:

Constant Field Values

DATE_FROM

public static final String DATE_FROM

The Constant DATE_FROM.

See Also:

Constant Field Values

DATE_TO

public static final String DATE_TO

The Constant DATE_TO.

See Also:

Constant Field Values

DIALOG_ID

public static final String DIALOG_ID

The Constant DIALOG_ID.

See Also:

Constant Field Values

INPUT

public static final String INPUT

The Constant INPUT.

See Also:

Constant Field Values

LIMIT

public static final String LIMIT

The Constant LIMIT.

See Also:

Constant Field Values

NAME_VALUES

public static final String NAME_VALUES

The Constant NAME_VALUES.

See Also:

Constant Field Values

OFFSET

public static final String OFFSET

The Constant OFFSET.

See Also:

Constant Field Values

Constructor Detail

DialogService

public DialogService()

Instantiates a new Dialog service with the default URL.

Method Detail

converse

public Conversation converse(Conversation conversation,
                             String newMessage)

Starts or continue conversations.

Parameters:

conversation - the current conversation

newMessage - the new message

Returns:

the Conversation with the response

converse

public Conversation converse(Map<String,Object> params)

Deprecated. Use converse(Conversation, String)

Starts or continue conversations.

Parameters:

params - the params

Returns:

the Conversation with the response

createConversation

public Conversation createConversation(String dialogId)

Starts or continue conversations.

Parameters:

dialogId - the dialog identifier

Returns:

a new Conversation

createDialog

public Dialog createDialog(String name,
                           File dialogFile)

Creates a dialog.

Parameters:

name - The dialog name

dialogFile - The dialog file created by using the Dialog service Applet.

Returns:

The created dialog

See Also:

Dialog

deleteDialog

public void deleteDialog(String dialogId)

Deletes a dialog.

Parameters:

dialogId - The dialog identifier

See Also:

DialogService

getContent

public List<DialogContent> getContent(String dialogId)

Gets content for nodes.

Parameters:

dialogId - the dialog identifier

Returns:

The DialogContent for nodes

getConversationData

public List<ConversationData> getConversationData(Map<String,Object> params)

Returns chat session data dump for a given date rage.

Parameters:

params - the params

Returns:

A list of ConversationData

getDialogs

public List<Dialog> getDialogs()

Retrieves the list of Dialogs for the user.

Returns:

the Dialog list

getProfile

public Map<String,String> getProfile(String dialogId,
                                     Integer clientId,
                                     String... names)

Returns a list of name-value pars associated with a client id.

Parameters:

dialogId - The dialog identifier

clientId - the client id

names - the profile variables to return

Returns:

the created dialog

updateDialog

public Dialog updateDialog(String dialogId,
                           File dialogFile)

Updates a dialog.

Parameters:

dialogId - The dialog identifier

dialogFile - The dialog file

Returns:

the created dialog

See Also:

Dialog

updateProfile

public void updateProfile(String dialogId,
                          Integer clientId,
                          Map<String,String> profile)

Updates a dialog profile with a profile. Profile variables are case sensitive.

Parameters:

dialogId - The dialog identifier

clientId - the client id

profile - the profile variables