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

Author:

German Attanasio Ruiz (germanatt@us.ibm.com)

See Also:

Dialog

Field Summary

Fields

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

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(Map<String,Object> params) Starts or continue conversations.
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.
List<NameValue>	getProfile(String dialogId, Integer clientId) Returns a list of name-value pars associated with a client id.
String	toString()
Dialog	updateDialog(String dialogId, File dialogFile) Updates a dialog.
void	updateProfile(String dialogId, Integer clientId, List<NameValue> nameValues) Updates a dialog profile with a list of NaveValue properties.

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

execute, executeWithoutResponse, getApiKey, getDefaultContentType, getDefaultRequestParams, getEndPoint, getGson, getHttpClient, getThreadSafeClient, setApiKey, setEndPoint, setUsernameAndPassword

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

See Also:

Constant Field Values

CONVERSATION_ID

public static final String CONVERSATION_ID

See Also:

Constant Field Values

DIALOG_ID

public static final String DIALOG_ID

See Also:

Constant Field Values

INPUT

public static final String INPUT

See Also:

Constant Field Values

DATE_FROM

public static final String DATE_FROM

See Also:

Constant Field Values

DATE_TO

public static final String DATE_TO

See Also:

Constant Field Values

LIMIT

public static final String LIMIT

See Also:

Constant Field Values

OFFSET

public static final String OFFSET

See Also:

Constant Field Values

NAME_VALUES

public static final String NAME_VALUES

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(Map<String,Object> params)

Starts or continue conversations.

Parameters:

dialog_id - Dialog identifier

client_id - A client id number generated by the Dialog service. If not specified a new client id will be issued.

conversation_id - the conversation id. If not specified, a new conversation will be started.

input - the user input message

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

getDialogs

public List<Dialog> getDialogs()

Retrieves the list of Dialogs for the user.

Returns:

the Dialog list

getProfile

public List<NameValue> getProfile(String dialogId,
                                  Integer clientId)

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

Parameters:

dialogId - The dialog identifier

clientId - the client id

Returns:

the created dialog

See Also:

NameValue

getConversationData

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

Returns chat session data dump for a given date rage.

Parameters:

dialog_id - the dialog identifier

date_from - Date from where to start the data dump

date_to - Date to where to end the data dump

offset - the offset from where to return conversations

limit - the number of conversations to return

Returns:

A list of ConversationData

toString

public String toString()

Overrides:

toString in class WatsonService

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,
                          List<NameValue> nameValues)

Updates a dialog profile with a list of NaveValue properties. If clientId is not specified a new clientId is generated. Profile variables are case sensitive.

Parameters:

dialogId - The dialog identifier

clientId - the client identifier

nameValues - The name value list to update

See Also:

Dialog