com.ibm.watson.developer_cloud.conversation.v1

Class Conversation

java.lang.Object

com.ibm.watson.developer_cloud.service.WatsonService

com.ibm.watson.developer_cloud.conversation.v1.Conversation

public class Conversation
extends WatsonService

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

See Also:

Conversation

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	VERSION_DATE_2016_07_11 The Constant VERSION_DATE_2016_07_11.
static java.lang.String	VERSION_DATE_2016_09_20 The Constant VERSION_DATE_2016_09_20.
static java.lang.String	VERSION_DATE_2017_02_03 The Constant VERSION_DATE_2017_02_03.
static java.lang.String	VERSION_DATE_2017_04_21 The Constant VERSION_DATE_2017_04_21.
static java.lang.String	VERSION_DATE_2017_05_26 The Constant VERSION_DATE_2017_05_26.

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

defaultHeaders, MESSAGE_CODE, MESSAGE_ERROR, skipAuthentication, VERSION

Constructor Summary

Constructors

Constructor and Description
Conversation(java.lang.String versionDate) Instantiates a new `Conversation`.
Conversation(java.lang.String versionDate, java.lang.String username, java.lang.String password) Instantiates a new `Conversation` with username and password.

Method Summary

Methods

Modifier and Type	Method and Description
ServiceCall<Counterexample>	createCounterexample(CreateCounterexampleOptions createCounterexampleOptions) Create counterexample.
ServiceCall<DialogNode>	createDialogNode(CreateDialogNodeOptions createDialogNodeOptions) Create dialog node.
ServiceCall<Entity>	createEntity(CreateEntityOptions createEntityOptions) Create entity.
ServiceCall<Example>	createExample(CreateExampleOptions createExampleOptions) Create user input example.
ServiceCall<Intent>	createIntent(CreateIntentOptions createIntentOptions) Create intent.
ServiceCall<Synonym>	createSynonym(CreateSynonymOptions createSynonymOptions) Add entity value synonym.
ServiceCall<Value>	createValue(CreateValueOptions createValueOptions) Add entity value.
ServiceCall<Workspace>	createWorkspace() Create workspace.
ServiceCall<Workspace>	createWorkspace(CreateWorkspaceOptions createWorkspaceOptions) Create workspace.
ServiceCall<java.lang.Void>	deleteCounterexample(DeleteCounterexampleOptions deleteCounterexampleOptions) Delete counterexample.
ServiceCall<java.lang.Void>	deleteDialogNode(DeleteDialogNodeOptions deleteDialogNodeOptions) Delete dialog node.
ServiceCall<java.lang.Void>	deleteEntity(DeleteEntityOptions deleteEntityOptions) Delete entity.
ServiceCall<java.lang.Void>	deleteExample(DeleteExampleOptions deleteExampleOptions) Delete user input example.
ServiceCall<java.lang.Void>	deleteIntent(DeleteIntentOptions deleteIntentOptions) Delete intent.
ServiceCall<java.lang.Void>	deleteSynonym(DeleteSynonymOptions deleteSynonymOptions) Delete entity value synonym.
ServiceCall<java.lang.Void>	deleteValue(DeleteValueOptions deleteValueOptions) Delete entity value.
ServiceCall<java.lang.Void>	deleteWorkspace(DeleteWorkspaceOptions deleteWorkspaceOptions) Delete workspace.
ServiceCall<Counterexample>	getCounterexample(GetCounterexampleOptions getCounterexampleOptions) Get counterexample.
ServiceCall<DialogNode>	getDialogNode(GetDialogNodeOptions getDialogNodeOptions) Get dialog node.
ServiceCall<EntityExport>	getEntity(GetEntityOptions getEntityOptions) Get entity.
ServiceCall<Example>	getExample(GetExampleOptions getExampleOptions) Get user input example.
ServiceCall<IntentExport>	getIntent(GetIntentOptions getIntentOptions) Get intent.
ServiceCall<Synonym>	getSynonym(GetSynonymOptions getSynonymOptions) Get entity value synonym.
ServiceCall<ValueExport>	getValue(GetValueOptions getValueOptions) Get entity value.
ServiceCall<WorkspaceExport>	getWorkspace(GetWorkspaceOptions getWorkspaceOptions) Get information about a workspace.
ServiceCall<LogCollection>	listAllLogs(ListAllLogsOptions listAllLogsOptions) List log events in all workspaces.
ServiceCall<CounterexampleCollection>	listCounterexamples(ListCounterexamplesOptions listCounterexamplesOptions) List counterexamples.
ServiceCall<DialogNodeCollection>	listDialogNodes(ListDialogNodesOptions listDialogNodesOptions) List dialog nodes.
ServiceCall<EntityCollection>	listEntities(ListEntitiesOptions listEntitiesOptions) List entities.
ServiceCall<ExampleCollection>	listExamples(ListExamplesOptions listExamplesOptions) List user input examples.
ServiceCall<IntentCollection>	listIntents(ListIntentsOptions listIntentsOptions) List intents.
ServiceCall<LogCollection>	listLogs(ListLogsOptions listLogsOptions) List log events in a workspace.
ServiceCall<SynonymCollection>	listSynonyms(ListSynonymsOptions listSynonymsOptions) List entity value synonyms.
ServiceCall<ValueCollection>	listValues(ListValuesOptions listValuesOptions) List entity values.
ServiceCall<WorkspaceCollection>	listWorkspaces() List workspaces.
ServiceCall<WorkspaceCollection>	listWorkspaces(ListWorkspacesOptions listWorkspacesOptions) List workspaces.
ServiceCall<MessageResponse>	message(MessageOptions messageOptions) Get a response to a user's input.
ServiceCall<Counterexample>	updateCounterexample(UpdateCounterexampleOptions updateCounterexampleOptions) Update counterexample.
ServiceCall<DialogNode>	updateDialogNode(UpdateDialogNodeOptions updateDialogNodeOptions) Update dialog node.
ServiceCall<Entity>	updateEntity(UpdateEntityOptions updateEntityOptions) Update entity.
ServiceCall<Example>	updateExample(UpdateExampleOptions updateExampleOptions) Update user input example.
ServiceCall<Intent>	updateIntent(UpdateIntentOptions updateIntentOptions) Update intent.
ServiceCall<Synonym>	updateSynonym(UpdateSynonymOptions updateSynonymOptions) Update entity value synonym.
ServiceCall<Value>	updateValue(UpdateValueOptions updateValueOptions) Update entity value.
ServiceCall<Workspace>	updateWorkspace(UpdateWorkspaceOptions updateWorkspaceOptions) Update workspace.

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

configureHttpClient, createServiceCall, getApiKey, getEndPoint, getName, getToken, processServiceCall, setApiKey, setAuthentication, setDefaultHeaders, setDefaultHeaders, setEndPoint, setSkipAuthentication, setUsernameAndPassword, toString

Methods inherited from class java.lang.Object

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

Field Detail

VERSION_DATE_2017_05_26

public static final java.lang.String VERSION_DATE_2017_05_26

The Constant VERSION_DATE_2017_05_26.

See Also:

Constant Field Values

VERSION_DATE_2017_04_21

public static final java.lang.String VERSION_DATE_2017_04_21

The Constant VERSION_DATE_2017_04_21.

See Also:

Constant Field Values

VERSION_DATE_2017_02_03

public static final java.lang.String VERSION_DATE_2017_02_03

The Constant VERSION_DATE_2017_02_03.

See Also:

Constant Field Values

VERSION_DATE_2016_09_20

public static final java.lang.String VERSION_DATE_2016_09_20

The Constant VERSION_DATE_2016_09_20.

See Also:

Constant Field Values

VERSION_DATE_2016_07_11

public static final java.lang.String VERSION_DATE_2016_07_11

The Constant VERSION_DATE_2016_07_11.

See Also:

Constant Field Values

Constructor Detail

Conversation

public Conversation(java.lang.String versionDate)

Instantiates a new `Conversation`.

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.

Conversation

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

Instantiates a new `Conversation` 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

Method Detail

createWorkspace

public ServiceCall<Workspace> createWorkspace(CreateWorkspaceOptions createWorkspaceOptions)

Create workspace. Create a workspace based on component objects. You must provide workspace components defining the content of the new workspace.

Parameters:

createWorkspaceOptions - the CreateWorkspaceOptions containing the options for the call

Returns:

a ServiceCall with a response type of Workspace

createWorkspace

public ServiceCall<Workspace> createWorkspace()

Create workspace. Create a workspace based on component objects. You must provide workspace components defining the content of the new workspace.

Returns:

a ServiceCall with a response type of Workspace

deleteWorkspace

public ServiceCall<java.lang.Void> deleteWorkspace(DeleteWorkspaceOptions deleteWorkspaceOptions)

Delete workspace. Delete a workspace from the service instance.

Parameters:

deleteWorkspaceOptions - the DeleteWorkspaceOptions containing the options for the call

Returns:

a ServiceCall with a response type of Void

getWorkspace

public ServiceCall<WorkspaceExport> getWorkspace(GetWorkspaceOptions getWorkspaceOptions)

Get information about a workspace. Get information about a workspace, optionally including all workspace content.

Parameters:

getWorkspaceOptions - the GetWorkspaceOptions containing the options for the call

Returns:

a ServiceCall with a response type of WorkspaceExport

listWorkspaces

public ServiceCall<WorkspaceCollection> listWorkspaces(ListWorkspacesOptions listWorkspacesOptions)

List workspaces. List the workspaces associated with a Conversation service instance.

Parameters:

listWorkspacesOptions - the ListWorkspacesOptions containing the options for the call

Returns:

a ServiceCall with a response type of WorkspaceCollection

listWorkspaces

public ServiceCall<WorkspaceCollection> listWorkspaces()

List workspaces. List the workspaces associated with a Conversation service instance.

Returns:

a ServiceCall with a response type of WorkspaceCollection

updateWorkspace

public ServiceCall<Workspace> updateWorkspace(UpdateWorkspaceOptions updateWorkspaceOptions)

Update workspace. Update an existing workspace with new or modified data. You must provide component objects defining the content of the updated workspace.

Parameters:

updateWorkspaceOptions - the UpdateWorkspaceOptions containing the options for the call

Returns:

a ServiceCall with a response type of Workspace

message

public ServiceCall<MessageResponse> message(MessageOptions messageOptions)

Get a response to a user's input.

Parameters:

messageOptions - the MessageOptions containing the options for the call

Returns:

a ServiceCall with a response type of MessageResponse

createIntent

public ServiceCall<Intent> createIntent(CreateIntentOptions createIntentOptions)

Create intent. Create a new intent.

Parameters:

createIntentOptions - the CreateIntentOptions containing the options for the call

Returns:

a ServiceCall with a response type of Intent

deleteIntent

public ServiceCall<java.lang.Void> deleteIntent(DeleteIntentOptions deleteIntentOptions)

Delete intent. Delete an intent from a workspace.

Parameters:

deleteIntentOptions - the DeleteIntentOptions containing the options for the call

Returns:

a ServiceCall with a response type of Void

getIntent

public ServiceCall<IntentExport> getIntent(GetIntentOptions getIntentOptions)

Get intent. Get information about an intent, optionally including all intent content.

Parameters:

getIntentOptions - the GetIntentOptions containing the options for the call

Returns:

a ServiceCall with a response type of IntentExport

listIntents

public ServiceCall<IntentCollection> listIntents(ListIntentsOptions listIntentsOptions)

List intents. List the intents for a workspace.

Parameters:

listIntentsOptions - the ListIntentsOptions containing the options for the call

Returns:

a ServiceCall with a response type of IntentCollection

updateIntent

public ServiceCall<Intent> updateIntent(UpdateIntentOptions updateIntentOptions)

Update intent. Update an existing intent with new or modified data. You must provide data defining the content of the updated intent.

Parameters:

updateIntentOptions - the UpdateIntentOptions containing the options for the call

Returns:

a ServiceCall with a response type of Intent

createExample

public ServiceCall<Example> createExample(CreateExampleOptions createExampleOptions)

Create user input example. Add a new user input example to an intent.

Parameters:

createExampleOptions - the CreateExampleOptions containing the options for the call

Returns:

a ServiceCall with a response type of Example

deleteExample

public ServiceCall<java.lang.Void> deleteExample(DeleteExampleOptions deleteExampleOptions)

Delete user input example. Delete a user input example from an intent.

Parameters:

deleteExampleOptions - the DeleteExampleOptions containing the options for the call

Returns:

a ServiceCall with a response type of Void

getExample

public ServiceCall<Example> getExample(GetExampleOptions getExampleOptions)

Get user input example. Get information about a user input example.

Parameters:

getExampleOptions - the GetExampleOptions containing the options for the call

Returns:

a ServiceCall with a response type of Example

listExamples

public ServiceCall<ExampleCollection> listExamples(ListExamplesOptions listExamplesOptions)

List user input examples. List the user input examples for an intent.

Parameters:

listExamplesOptions - the ListExamplesOptions containing the options for the call

Returns:

a ServiceCall with a response type of ExampleCollection

updateExample

public ServiceCall<Example> updateExample(UpdateExampleOptions updateExampleOptions)

Update user input example. Update the text of a user input example.

Parameters:

updateExampleOptions - the UpdateExampleOptions containing the options for the call

Returns:

a ServiceCall with a response type of Example

createEntity

public ServiceCall<Entity> createEntity(CreateEntityOptions createEntityOptions)

Create entity. Create a new entity.

Parameters:

createEntityOptions - the CreateEntityOptions containing the options for the call

Returns:

a ServiceCall with a response type of Entity

deleteEntity

public ServiceCall<java.lang.Void> deleteEntity(DeleteEntityOptions deleteEntityOptions)

Delete entity. Delete an entity from a workspace.

Parameters:

deleteEntityOptions - the DeleteEntityOptions containing the options for the call

Returns:

a ServiceCall with a response type of Void

getEntity

public ServiceCall<EntityExport> getEntity(GetEntityOptions getEntityOptions)

Get entity. Get information about an entity, optionally including all entity content.

Parameters:

getEntityOptions - the GetEntityOptions containing the options for the call

Returns:

a ServiceCall with a response type of EntityExport

listEntities

public ServiceCall<EntityCollection> listEntities(ListEntitiesOptions listEntitiesOptions)

List entities. List the entities for a workspace.

Parameters:

listEntitiesOptions - the ListEntitiesOptions containing the options for the call

Returns:

a ServiceCall with a response type of EntityCollection

updateEntity

public ServiceCall<Entity> updateEntity(UpdateEntityOptions updateEntityOptions)

Update entity. Update an existing entity with new or modified data.

Parameters:

updateEntityOptions - the UpdateEntityOptions containing the options for the call

Returns:

a ServiceCall with a response type of Entity

createValue

public ServiceCall<Value> createValue(CreateValueOptions createValueOptions)

Add entity value. Create a new value for an entity.

Parameters:

createValueOptions - the CreateValueOptions containing the options for the call

Returns:

a ServiceCall with a response type of Value

deleteValue

public ServiceCall<java.lang.Void> deleteValue(DeleteValueOptions deleteValueOptions)

Delete entity value. Delete a value for an entity.

Parameters:

deleteValueOptions - the DeleteValueOptions containing the options for the call

Returns:

a ServiceCall with a response type of Void

getValue

public ServiceCall<ValueExport> getValue(GetValueOptions getValueOptions)

Get entity value. Get information about an entity value.

Parameters:

getValueOptions - the GetValueOptions containing the options for the call

Returns:

a ServiceCall with a response type of ValueExport

listValues

public ServiceCall<ValueCollection> listValues(ListValuesOptions listValuesOptions)

List entity values. List the values for an entity.

Parameters:

listValuesOptions - the ListValuesOptions containing the options for the call

Returns:

a ServiceCall with a response type of ValueCollection

updateValue

public ServiceCall<Value> updateValue(UpdateValueOptions updateValueOptions)

Update entity value. Update the content of a value for an entity.

Parameters:

updateValueOptions - the UpdateValueOptions containing the options for the call

Returns:

a ServiceCall with a response type of Value

createSynonym

public ServiceCall<Synonym> createSynonym(CreateSynonymOptions createSynonymOptions)

Add entity value synonym. Add a new synonym to an entity value.

Parameters:

createSynonymOptions - the CreateSynonymOptions containing the options for the call

Returns:

a ServiceCall with a response type of Synonym

deleteSynonym

public ServiceCall<java.lang.Void> deleteSynonym(DeleteSynonymOptions deleteSynonymOptions)

Delete entity value synonym. Delete a synonym for an entity value.

Parameters:

deleteSynonymOptions - the DeleteSynonymOptions containing the options for the call

Returns:

a ServiceCall with a response type of Void

getSynonym

public ServiceCall<Synonym> getSynonym(GetSynonymOptions getSynonymOptions)

Get entity value synonym. Get information about a synonym for an entity value.

Parameters:

getSynonymOptions - the GetSynonymOptions containing the options for the call

Returns:

a ServiceCall with a response type of Synonym

listSynonyms

public ServiceCall<SynonymCollection> listSynonyms(ListSynonymsOptions listSynonymsOptions)

List entity value synonyms. List the synonyms for an entity value.

Parameters:

listSynonymsOptions - the ListSynonymsOptions containing the options for the call

Returns:

a ServiceCall with a response type of SynonymCollection

updateSynonym

public ServiceCall<Synonym> updateSynonym(UpdateSynonymOptions updateSynonymOptions)

Update entity value synonym. Update the information about a synonym for an entity value.

Parameters:

updateSynonymOptions - the UpdateSynonymOptions containing the options for the call

Returns:

a ServiceCall with a response type of Synonym

createDialogNode

public ServiceCall<DialogNode> createDialogNode(CreateDialogNodeOptions createDialogNodeOptions)

Create dialog node. Create a dialog node.

Parameters:

createDialogNodeOptions - the CreateDialogNodeOptions containing the options for the call

Returns:

a ServiceCall with a response type of DialogNode

deleteDialogNode

public ServiceCall<java.lang.Void> deleteDialogNode(DeleteDialogNodeOptions deleteDialogNodeOptions)

Delete dialog node. Delete a dialog node from the workspace.

Parameters:

deleteDialogNodeOptions - the DeleteDialogNodeOptions containing the options for the call

Returns:

a ServiceCall with a response type of Void

getDialogNode

public ServiceCall<DialogNode> getDialogNode(GetDialogNodeOptions getDialogNodeOptions)

Get dialog node. Get information about a dialog node.

Parameters:

getDialogNodeOptions - the GetDialogNodeOptions containing the options for the call

Returns:

a ServiceCall with a response type of DialogNode

listDialogNodes

public ServiceCall<DialogNodeCollection> listDialogNodes(ListDialogNodesOptions listDialogNodesOptions)

List dialog nodes. List the dialog nodes in the workspace.

Parameters:

listDialogNodesOptions - the ListDialogNodesOptions containing the options for the call

Returns:

a ServiceCall with a response type of DialogNodeCollection

updateDialogNode

public ServiceCall<DialogNode> updateDialogNode(UpdateDialogNodeOptions updateDialogNodeOptions)

Update dialog node. Update information for a dialog node.

Parameters:

updateDialogNodeOptions - the UpdateDialogNodeOptions containing the options for the call

Returns:

a ServiceCall with a response type of DialogNode

listAllLogs

public ServiceCall<LogCollection> listAllLogs(ListAllLogsOptions listAllLogsOptions)

List log events in all workspaces. List log events in all workspaces in the service instance.

Parameters:

listAllLogsOptions - the ListAllLogsOptions containing the options for the call

Returns:

a ServiceCall with a response type of LogCollection

listLogs

public ServiceCall<LogCollection> listLogs(ListLogsOptions listLogsOptions)

List log events in a workspace. List log events in a specific workspace.

Parameters:

listLogsOptions - the ListLogsOptions containing the options for the call

Returns:

a ServiceCall with a response type of LogCollection

createCounterexample

public ServiceCall<Counterexample> createCounterexample(CreateCounterexampleOptions createCounterexampleOptions)

Create counterexample. Add a new counterexample to a workspace. Counterexamples are examples that have been marked as irrelevant input.

Parameters:

createCounterexampleOptions - the CreateCounterexampleOptions containing the options for the call

Returns:

a ServiceCall with a response type of Counterexample

deleteCounterexample

public ServiceCall<java.lang.Void> deleteCounterexample(DeleteCounterexampleOptions deleteCounterexampleOptions)

Delete counterexample. Delete a counterexample from a workspace. Counterexamples are examples that have been marked as irrelevant input.

Parameters:

deleteCounterexampleOptions - the DeleteCounterexampleOptions containing the options for the call

Returns:

a ServiceCall with a response type of Void

getCounterexample

public ServiceCall<Counterexample> getCounterexample(GetCounterexampleOptions getCounterexampleOptions)

Get counterexample. Get information about a counterexample. Counterexamples are examples that have been marked as irrelevant input.

Parameters:

getCounterexampleOptions - the GetCounterexampleOptions containing the options for the call

Returns:

a ServiceCall with a response type of Counterexample

listCounterexamples

public ServiceCall<CounterexampleCollection> listCounterexamples(ListCounterexamplesOptions listCounterexamplesOptions)

List counterexamples. List the counterexamples for a workspace. Counterexamples are examples that have been marked as irrelevant input.

Parameters:

listCounterexamplesOptions - the ListCounterexamplesOptions containing the options for the call

Returns:

a ServiceCall with a response type of CounterexampleCollection

updateCounterexample

public ServiceCall<Counterexample> updateCounterexample(UpdateCounterexampleOptions updateCounterexampleOptions)

Update counterexample. Update the text of a counterexample. Counterexamples are examples that have been marked as irrelevant input.

Parameters:

updateCounterexampleOptions - the UpdateCounterexampleOptions containing the options for the call

Returns:

a ServiceCall with a response type of Counterexample