com.ibm.watson.assistant.v1

Class Assistant

java.lang.Object

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

com.ibm.watson.assistant.v1.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.

The Assistant v1 API provides authoring methods your application can use to create or update a workspace.

See Also:

Assistant

Field Summary

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

JSON_MIME_PATTERN, JSON_PATCH_MIME_PATTERN, PROPNAME_DISABLE_SSL, PROPNAME_URL

Constructor Summary

Constructors

Constructor and Description
Assistant(java.lang.String versionDate) Constructs a new `Assistant` client using the DEFAULT_SERVICE_NAME.
Assistant(java.lang.String versionDate, com.ibm.cloud.sdk.core.security.Authenticator authenticator) Constructs a new `Assistant` client with the DEFAULT_SERVICE_NAME and the specified Authenticator.
Assistant(java.lang.String versionDate, java.lang.String serviceName) Constructs a new `Assistant` client with the specified serviceName.
Assistant(java.lang.String versionDate, java.lang.String serviceName, com.ibm.cloud.sdk.core.security.Authenticator authenticator) Constructs a new `Assistant` client with the specified Authenticator and serviceName.

Method Summary

Methods

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

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

configureClient, configureHttpClient, configureService, createServiceCall, getAuthenticator, getClient, getEndPoint, getName, getServiceUrl, isJsonMimeType, isJsonPatchMimeType, processServiceCall, setAuthentication, setClient, setDefaultHeaders, setDefaultHeaders, setEndPoint, setServiceUrl, 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)

Constructs a new `Assistant` client using the DEFAULT_SERVICE_NAME.

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,
         com.ibm.cloud.sdk.core.security.Authenticator authenticator)

Constructs a new `Assistant` client with the DEFAULT_SERVICE_NAME and the specified Authenticator.

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.

authenticator - the Authenticator instance to be configured for this service

Assistant

public Assistant(java.lang.String versionDate,
         java.lang.String serviceName)

Constructs a new `Assistant` client with the specified serviceName.

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.

serviceName - The name of the service to configure.

Assistant

public Assistant(java.lang.String versionDate,
         java.lang.String serviceName,
         com.ibm.cloud.sdk.core.security.Authenticator authenticator)

Constructs a new `Assistant` client with the specified Authenticator and serviceName.

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.

serviceName - The name of the service to configure.

authenticator - the Authenticator instance to be configured for this service

Method Detail

message

public com.ibm.cloud.sdk.core.http.ServiceCall<MessageResponse> message(MessageOptions messageOptions)

Get response to user input.

Send user input to a workspace and receive a response.

**Important:** This method has been superseded by the new v2 runtime API. The v2 API offers significant advantages, including ease of deployment, automatic state management, versioning, and search capabilities. For more information, see the [documentation](https://cloud.ibm.com/docs/assistant?topic=assistant-api-overview).

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

listWorkspaces

public com.ibm.cloud.sdk.core.http.ServiceCall<WorkspaceCollection> listWorkspaces(ListWorkspacesOptions listWorkspacesOptions)

List workspaces.

List the workspaces associated with a Watson Assistant service instance.

This operation is limited to 500 requests per 30 minutes. For more information, see **Rate limiting**.

Parameters:

listWorkspacesOptions - the ListWorkspacesOptions containing the options for the call

Returns:

a ServiceCall with a response type of WorkspaceCollection

listWorkspaces

public com.ibm.cloud.sdk.core.http.ServiceCall<WorkspaceCollection> listWorkspaces()

List workspaces.

List the workspaces associated with a Watson Assistant service instance.

This operation is limited to 500 requests per 30 minutes. For more information, see **Rate limiting**.

Returns:

a ServiceCall with a response type of WorkspaceCollection

createWorkspace

public com.ibm.cloud.sdk.core.http.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.

This operation is limited to 30 requests per 30 minutes. For more information, see **Rate limiting**.

Parameters:

createWorkspaceOptions - the CreateWorkspaceOptions containing the options for the call

Returns:

a ServiceCall with a response type of Workspace

createWorkspace

public com.ibm.cloud.sdk.core.http.ServiceCall<Workspace> createWorkspace()

Create workspace.

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

This operation is limited to 30 requests per 30 minutes. For more information, see **Rate limiting**.

Returns:

a ServiceCall with a response type of Workspace

getWorkspace

public com.ibm.cloud.sdk.core.http.ServiceCall<Workspace> getWorkspace(GetWorkspaceOptions getWorkspaceOptions)

Get information about a workspace.

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

With **export**=`false`, this operation is limited to 6000 requests per 5 minutes. With **export**=`true`, the limit is 20 requests per 30 minutes. For more information, see **Rate limiting**.

Parameters:

getWorkspaceOptions - the GetWorkspaceOptions containing the options for the call

Returns:

a ServiceCall with a response type of Workspace

updateWorkspace

public com.ibm.cloud.sdk.core.http.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.

This operation is limited to 30 request per 30 minutes. For more information, see **Rate limiting**.

Parameters:

updateWorkspaceOptions - the UpdateWorkspaceOptions containing the options for the call

Returns:

a ServiceCall with a response type of Workspace

deleteWorkspace

public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> deleteWorkspace(DeleteWorkspaceOptions deleteWorkspaceOptions)

Delete workspace.

Delete a workspace from the service instance.

This operation is limited to 30 requests per 30 minutes. For more information, see **Rate limiting**.

Parameters:

deleteWorkspaceOptions - the DeleteWorkspaceOptions containing the options for the call

Returns:

a ServiceCall with a response type of Void

listIntents

public com.ibm.cloud.sdk.core.http.ServiceCall<IntentCollection> listIntents(ListIntentsOptions listIntentsOptions)

List intents.

List the intents for a workspace.

With **export**=`false`, this operation is limited to 2000 requests per 30 minutes. With **export**=`true`, the limit is 400 requests per 30 minutes. For more information, see **Rate limiting**.

Parameters:

listIntentsOptions - the ListIntentsOptions containing the options for the call

Returns:

a ServiceCall with a response type of IntentCollection

createIntent

public com.ibm.cloud.sdk.core.http.ServiceCall<Intent> createIntent(CreateIntentOptions createIntentOptions)

Create intent.

Create a new intent.

If you want to create multiple intents with a single API call, consider using the **[Update workspace](#update-workspace)** method instead.

This operation is limited to 2000 requests per 30 minutes. For more information, see **Rate limiting**.

Parameters:

createIntentOptions - the CreateIntentOptions containing the options for the call

Returns:

a ServiceCall with a response type of Intent

getIntent

public com.ibm.cloud.sdk.core.http.ServiceCall<Intent> getIntent(GetIntentOptions getIntentOptions)

Get intent.

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

With **export**=`false`, this operation is limited to 6000 requests per 5 minutes. With **export**=`true`, the limit is 400 requests per 30 minutes. For more information, see **Rate limiting**.

Parameters:

getIntentOptions - the GetIntentOptions containing the options for the call

Returns:

a ServiceCall with a response type of Intent

updateIntent

public com.ibm.cloud.sdk.core.http.ServiceCall<Intent> updateIntent(UpdateIntentOptions updateIntentOptions)

Update intent.

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

If you want to update multiple intents with a single API call, consider using the **[Update workspace](#update-workspace)** method instead.

This operation is limited to 2000 requests per 30 minutes. For more information, see **Rate limiting**.

Parameters:

updateIntentOptions - the UpdateIntentOptions containing the options for the call

Returns:

a ServiceCall with a response type of Intent

deleteIntent

public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> deleteIntent(DeleteIntentOptions deleteIntentOptions)

Delete intent.

Delete an intent from a workspace.

This operation is limited to 2000 requests per 30 minutes. For more information, see **Rate limiting**.

Parameters:

deleteIntentOptions - the DeleteIntentOptions containing the options for the call

Returns:

a ServiceCall with a response type of Void

listExamples

public com.ibm.cloud.sdk.core.http.ServiceCall<ExampleCollection> listExamples(ListExamplesOptions listExamplesOptions)

List user input examples.

List the user input examples for an intent, optionally including contextual entity mentions.

This operation is limited to 2500 requests per 30 minutes. For more information, see **Rate limiting**.

Parameters:

listExamplesOptions - the ListExamplesOptions containing the options for the call

Returns:

a ServiceCall with a response type of ExampleCollection

createExample

public com.ibm.cloud.sdk.core.http.ServiceCall<Example> createExample(CreateExampleOptions createExampleOptions)

Create user input example.

Add a new user input example to an intent.

If you want to add multiple examples with a single API call, consider using the **[Update intent](#update-intent)** method instead.

This operation is limited to 1000 requests per 30 minutes. For more information, see **Rate limiting**.

Parameters:

createExampleOptions - the CreateExampleOptions containing the options for the call

Returns:

a ServiceCall with a response type of Example

getExample

public com.ibm.cloud.sdk.core.http.ServiceCall<Example> getExample(GetExampleOptions getExampleOptions)

Get user input example.

Get information about a user input example.

This operation is limited to 6000 requests per 5 minutes. For more information, see **Rate limiting**.

Parameters:

getExampleOptions - the GetExampleOptions containing the options for the call

Returns:

a ServiceCall with a response type of Example

updateExample

public com.ibm.cloud.sdk.core.http.ServiceCall<Example> updateExample(UpdateExampleOptions updateExampleOptions)

Update user input example.

Update the text of a user input example.

If you want to update multiple examples with a single API call, consider using the **[Update intent](#update-intent)** method instead.

This operation is limited to 1000 requests per 30 minutes. For more information, see **Rate limiting**.

Parameters:

updateExampleOptions - the UpdateExampleOptions containing the options for the call

Returns:

a ServiceCall with a response type of Example

deleteExample

public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> deleteExample(DeleteExampleOptions deleteExampleOptions)

Delete user input example.

Delete a user input example from an intent.

This operation is limited to 1000 requests per 30 minutes. For more information, see **Rate limiting**.

Parameters:

deleteExampleOptions - the DeleteExampleOptions containing the options for the call

Returns:

a ServiceCall with a response type of Void

listCounterexamples

public com.ibm.cloud.sdk.core.http.ServiceCall<CounterexampleCollection> listCounterexamples(ListCounterexamplesOptions listCounterexamplesOptions)

List counterexamples.

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

This operation is limited to 2500 requests per 30 minutes. For more information, see **Rate limiting**.

Parameters:

listCounterexamplesOptions - the ListCounterexamplesOptions containing the options for the call

Returns:

a ServiceCall with a response type of CounterexampleCollection

createCounterexample

public com.ibm.cloud.sdk.core.http.ServiceCall<Counterexample> createCounterexample(CreateCounterexampleOptions createCounterexampleOptions)

Create counterexample.

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

If you want to add multiple counterexamples with a single API call, consider using the **[Update workspace](#update-workspace)** method instead.

This operation is limited to 1000 requests per 30 minutes. For more information, see **Rate limiting**.

Parameters:

createCounterexampleOptions - the CreateCounterexampleOptions containing the options for the call

Returns:

a ServiceCall with a response type of Counterexample

getCounterexample

public com.ibm.cloud.sdk.core.http.ServiceCall<Counterexample> getCounterexample(GetCounterexampleOptions getCounterexampleOptions)

Get counterexample.

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

This operation is limited to 6000 requests per 5 minutes. For more information, see **Rate limiting**.

Parameters:

getCounterexampleOptions - the GetCounterexampleOptions containing the options for the call

Returns:

a ServiceCall with a response type of Counterexample

updateCounterexample

public com.ibm.cloud.sdk.core.http.ServiceCall<Counterexample> updateCounterexample(UpdateCounterexampleOptions updateCounterexampleOptions)

Update counterexample.

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

If you want to update multiple counterexamples with a single API call, consider using the **[Update workspace](#update-workspace)** method instead.

This operation is limited to 1000 requests per 30 minutes. For more information, see **Rate limiting**.

Parameters:

updateCounterexampleOptions - the UpdateCounterexampleOptions containing the options for the call

Returns:

a ServiceCall with a response type of Counterexample

deleteCounterexample

public com.ibm.cloud.sdk.core.http.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.

This operation is limited to 1000 requests per 30 minutes. For more information, see **Rate limiting**.

Parameters:

deleteCounterexampleOptions - the DeleteCounterexampleOptions containing the options for the call

Returns:

a ServiceCall with a response type of Void

listEntities

public com.ibm.cloud.sdk.core.http.ServiceCall<EntityCollection> listEntities(ListEntitiesOptions listEntitiesOptions)

List entities.

List the entities for a workspace.

With **export**=`false`, this operation is limited to 1000 requests per 30 minutes. With **export**=`true`, the limit is 200 requests per 30 minutes. For more information, see **Rate limiting**.

Parameters:

listEntitiesOptions - the ListEntitiesOptions containing the options for the call

Returns:

a ServiceCall with a response type of EntityCollection

createEntity

public com.ibm.cloud.sdk.core.http.ServiceCall<Entity> createEntity(CreateEntityOptions createEntityOptions)

Create entity.

Create a new entity, or enable a system entity.

If you want to create multiple entities with a single API call, consider using the **[Update workspace](#update-workspace)** method instead.

This operation is limited to 1000 requests per 30 minutes. For more information, see **Rate limiting**.

Parameters:

createEntityOptions - the CreateEntityOptions containing the options for the call

Returns:

a ServiceCall with a response type of Entity

getEntity

public com.ibm.cloud.sdk.core.http.ServiceCall<Entity> getEntity(GetEntityOptions getEntityOptions)

Get entity.

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

With **export**=`false`, this operation is limited to 6000 requests per 5 minutes. With **export**=`true`, the limit is 200 requests per 30 minutes. For more information, see **Rate limiting**.

Parameters:

getEntityOptions - the GetEntityOptions containing the options for the call

Returns:

a ServiceCall with a response type of Entity

updateEntity

public com.ibm.cloud.sdk.core.http.ServiceCall<Entity> updateEntity(UpdateEntityOptions updateEntityOptions)

Update entity.

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

If you want to update multiple entities with a single API call, consider using the **[Update workspace](#update-workspace)** method instead.

This operation is limited to 1000 requests per 30 minutes. For more information, see **Rate limiting**.

Parameters:

updateEntityOptions - the UpdateEntityOptions containing the options for the call

Returns:

a ServiceCall with a response type of Entity

deleteEntity

public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> deleteEntity(DeleteEntityOptions deleteEntityOptions)

Delete entity.

Delete an entity from a workspace, or disable a system entity.

This operation is limited to 1000 requests per 30 minutes. For more information, see **Rate limiting**.

Parameters:

deleteEntityOptions - the DeleteEntityOptions containing the options for the call

Returns:

a ServiceCall with a response type of Void

listMentions

public com.ibm.cloud.sdk.core.http.ServiceCall<EntityMentionCollection> listMentions(ListMentionsOptions listMentionsOptions)

List entity mentions.

List mentions for a contextual entity. An entity mention is an occurrence of a contextual entity in the context of an intent user input example.

This operation is limited to 200 requests per 30 minutes. For more information, see **Rate limiting**.

Parameters:

listMentionsOptions - the ListMentionsOptions containing the options for the call

Returns:

a ServiceCall with a response type of EntityMentionCollection

listValues

public com.ibm.cloud.sdk.core.http.ServiceCall<ValueCollection> listValues(ListValuesOptions listValuesOptions)

List entity values.

List the values for an entity.

This operation is limited to 2500 requests per 30 minutes. For more information, see **Rate limiting**.

Parameters:

listValuesOptions - the ListValuesOptions containing the options for the call

Returns:

a ServiceCall with a response type of ValueCollection

createValue

public com.ibm.cloud.sdk.core.http.ServiceCall<Value> createValue(CreateValueOptions createValueOptions)

Create entity value.

Create a new value for an entity.

If you want to create multiple entity values with a single API call, consider using the **[Update entity](#update-entity)** method instead.

This operation is limited to 1000 requests per 30 minutes. For more information, see **Rate limiting**.

Parameters:

createValueOptions - the CreateValueOptions containing the options for the call

Returns:

a ServiceCall with a response type of Value

getValue

public com.ibm.cloud.sdk.core.http.ServiceCall<Value> getValue(GetValueOptions getValueOptions)

Get entity value.

Get information about an entity value.

This operation is limited to 6000 requests per 5 minutes. For more information, see **Rate limiting**.

Parameters:

getValueOptions - the GetValueOptions containing the options for the call

Returns:

a ServiceCall with a response type of Value

updateValue

public com.ibm.cloud.sdk.core.http.ServiceCall<Value> updateValue(UpdateValueOptions updateValueOptions)

Update entity value.

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

If you want to update multiple entity values with a single API call, consider using the **[Update entity](#update-entity)** method instead.

This operation is limited to 1000 requests per 30 minutes. For more information, see **Rate limiting**.

Parameters:

updateValueOptions - the UpdateValueOptions containing the options for the call

Returns:

a ServiceCall with a response type of Value

deleteValue

public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> deleteValue(DeleteValueOptions deleteValueOptions)

Delete entity value.

Delete a value from an entity.

This operation is limited to 1000 requests per 30 minutes. For more information, see **Rate limiting**.

Parameters:

deleteValueOptions - the DeleteValueOptions containing the options for the call

Returns:

a ServiceCall with a response type of Void

listSynonyms

public com.ibm.cloud.sdk.core.http.ServiceCall<SynonymCollection> listSynonyms(ListSynonymsOptions listSynonymsOptions)

List entity value synonyms.

List the synonyms for an entity value.

This operation is limited to 2500 requests per 30 minutes. For more information, see **Rate limiting**.

Parameters:

listSynonymsOptions - the ListSynonymsOptions containing the options for the call

Returns:

a ServiceCall with a response type of SynonymCollection

createSynonym

public com.ibm.cloud.sdk.core.http.ServiceCall<Synonym> createSynonym(CreateSynonymOptions createSynonymOptions)

Create entity value synonym.

Add a new synonym to an entity value.

If you want to create multiple synonyms with a single API call, consider using the **[Update entity](#update-entity)** or **[Update entity value](#update-entity-value)** method instead.

This operation is limited to 1000 requests per 30 minutes. For more information, see **Rate limiting**.

Parameters:

createSynonymOptions - the CreateSynonymOptions containing the options for the call

Returns:

a ServiceCall with a response type of Synonym

getSynonym

public com.ibm.cloud.sdk.core.http.ServiceCall<Synonym> getSynonym(GetSynonymOptions getSynonymOptions)

Get entity value synonym.

Get information about a synonym of an entity value.

This operation is limited to 6000 requests per 5 minutes. For more information, see **Rate limiting**.

Parameters:

getSynonymOptions - the GetSynonymOptions containing the options for the call

Returns:

a ServiceCall with a response type of Synonym

updateSynonym

public com.ibm.cloud.sdk.core.http.ServiceCall<Synonym> updateSynonym(UpdateSynonymOptions updateSynonymOptions)

Update entity value synonym.

Update an existing entity value synonym with new text.

If you want to update multiple synonyms with a single API call, consider using the **[Update entity](#update-entity)** or **[Update entity value](#update-entity-value)** method instead.

This operation is limited to 1000 requests per 30 minutes. For more information, see **Rate limiting**.

Parameters:

updateSynonymOptions - the UpdateSynonymOptions containing the options for the call

Returns:

a ServiceCall with a response type of Synonym

deleteSynonym

public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> deleteSynonym(DeleteSynonymOptions deleteSynonymOptions)

Delete entity value synonym.

Delete a synonym from an entity value.

This operation is limited to 1000 requests per 30 minutes. For more information, see **Rate limiting**.

Parameters:

deleteSynonymOptions - the DeleteSynonymOptions containing the options for the call

Returns:

a ServiceCall with a response type of Void

listDialogNodes

public com.ibm.cloud.sdk.core.http.ServiceCall<DialogNodeCollection> listDialogNodes(ListDialogNodesOptions listDialogNodesOptions)

List dialog nodes.

List the dialog nodes for a workspace.

This operation is limited to 2500 requests per 30 minutes. For more information, see **Rate limiting**.

Parameters:

listDialogNodesOptions - the ListDialogNodesOptions containing the options for the call

Returns:

a ServiceCall with a response type of DialogNodeCollection

createDialogNode

public com.ibm.cloud.sdk.core.http.ServiceCall<DialogNode> createDialogNode(CreateDialogNodeOptions createDialogNodeOptions)

Create dialog node.

Create a new dialog node.

If you want to create multiple dialog nodes with a single API call, consider using the **[Update workspace](#update-workspace)** method instead.

This operation is limited to 500 requests per 30 minutes. For more information, see **Rate limiting**.

Parameters:

createDialogNodeOptions - the CreateDialogNodeOptions containing the options for the call

Returns:

a ServiceCall with a response type of DialogNode

getDialogNode

public com.ibm.cloud.sdk.core.http.ServiceCall<DialogNode> getDialogNode(GetDialogNodeOptions getDialogNodeOptions)

Get dialog node.

Get information about a dialog node.

This operation is limited to 6000 requests per 5 minutes. For more information, see **Rate limiting**.

Parameters:

getDialogNodeOptions - the GetDialogNodeOptions containing the options for the call

Returns:

a ServiceCall with a response type of DialogNode

updateDialogNode

public com.ibm.cloud.sdk.core.http.ServiceCall<DialogNode> updateDialogNode(UpdateDialogNodeOptions updateDialogNodeOptions)

Update dialog node.

Update an existing dialog node with new or modified data.

If you want to update multiple dialog nodes with a single API call, consider using the **[Update workspace](#update-workspace)** method instead.

This operation is limited to 500 requests per 30 minutes. For more information, see **Rate limiting**.

Parameters:

updateDialogNodeOptions - the UpdateDialogNodeOptions containing the options for the call

Returns:

a ServiceCall with a response type of DialogNode

deleteDialogNode

public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> deleteDialogNode(DeleteDialogNodeOptions deleteDialogNodeOptions)

Delete dialog node.

Delete a dialog node from a workspace.

This operation is limited to 500 requests per 30 minutes. For more information, see **Rate limiting**.

Parameters:

deleteDialogNodeOptions - the DeleteDialogNodeOptions containing the options for the call

Returns:

a ServiceCall with a response type of Void

listLogs

public com.ibm.cloud.sdk.core.http.ServiceCall<LogCollection> listLogs(ListLogsOptions listLogsOptions)

List log events in a workspace.

List the events from the log of a specific workspace.

If **cursor** is not specified, this operation is limited to 40 requests per 30 minutes. If **cursor** is specified, the limit is 120 requests per minute. For more information, see **Rate limiting**.

Parameters:

listLogsOptions - the ListLogsOptions containing the options for the call

Returns:

a ServiceCall with a response type of LogCollection

listAllLogs

public com.ibm.cloud.sdk.core.http.ServiceCall<LogCollection> listAllLogs(ListAllLogsOptions listAllLogsOptions)

List log events in all workspaces.

List the events from the logs of all workspaces in the service instance.

If **cursor** is not specified, this operation is limited to 40 requests per 30 minutes. If **cursor** is specified, the limit is 120 requests per minute. For more information, see **Rate limiting**.

Parameters:

listAllLogsOptions - the ListAllLogsOptions containing the options for the call

Returns:

a ServiceCall with a response type of LogCollection

deleteUserData

public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> deleteUserData(DeleteUserDataOptions deleteUserDataOptions)

Delete labeled data.

Deletes all data associated with a specified customer ID. The method has no effect if no data is associated with the customer ID.

You associate a customer ID with data by passing the `X-Watson-Metadata` header with a request that passes data. For more information about personal data and customer IDs, see [Information security](https://cloud.ibm.com/docs/assistant?topic=assistant-information-security#information-security).

This operation is limited to 4 requests per minute. For more information, see **Rate limiting**.

Parameters:

deleteUserDataOptions - the DeleteUserDataOptions containing the options for the call

Returns:

a ServiceCall with a response type of Void