Class AssistantV1

Send multiple user inputs to a workspace in a single request and receive information about the intents and entities recognized in each input. This method is useful for testing and comparing the performance of different workspaces.

This method is available only with Enterprise with Data Isolation plans.

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 method instead.

Create a new dialog node.

If you want to create multiple dialog nodes with a single API call, consider using the Update workspace method instead.

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 method instead.

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 method instead.

Create a new intent.

If you want to create multiple intents with a single API call, consider using the Update workspace method instead.

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 or Update entity value method instead.

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 method instead.

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

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

Delete a dialog node from a workspace.

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

Delete a user input example from an intent.

Delete an intent from a workspace.

Delete a synonym from an entity value.

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.

Note: This operation is intended only for deleting data associated with a single specific customer, not for deleting data associated with multiple customers or for any other purpose. For more information, see Labeling and deleting data in Watson Assistant.

Delete a value from an entity.

Delete a workspace from the service instance.

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

Get information about a dialog node.

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

Get information about a user input example.

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

Get information about a synonym of an entity value.

Get information about an entity value.

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

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

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

List the dialog nodes for a workspace.

List the entities for a workspace.

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

List the intents for a workspace.

List the events from the log of a specific workspace.

This method requires Manager access.

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.

List the synonyms for an entity value.

List the values for an entity.

List the workspaces associated with a Watson Assistant service instance.

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.

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

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 method instead.

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 method instead.

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 method instead.

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 method instead.

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 or Update entity value method instead.

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 method instead.

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