| copyright | lastupdated | subcollection | ||
|---|---|---|---|---|
|
2020-08-19 |
assistant |
{:curl: .ph data-hd-programlang='curl'} {:javascript: .ph data-hd-programlang='javascript'} {:java: .ph data-hd-programlang='java'} {:python: .ph data-hd-programlang='python'} {:swift: data-hd-programlang='swift'} {:new_window: target="_blank"} {:external: target="_blank" .external} {:shortdesc: .shortdesc} {:screen: .screen} {:pre: .pre} {:codeblock: .codeblock} {:download: .download} {:deprecated: .deprecated} {:important: .important} {:note: .note} {:deprecated: .deprecated} {:important: .important} {:note: .note} {:tip: .tip}
{: #api-methods}
The following tables list the methods that are available using the {{site.data.keyword.conversationshort}} APIs.
{: #api-methods-runtime}
| Method | Description | API ver | Reference |
|---|---|---|---|
| Create a session | Create a new session. A session is used to send user input to a skill and receive responses. It also maintains the state of the conversation. | v2 | cURL{: external} node{: external} java{: external} python{: external} |
| Delete session | Deletes a session explicitly before it times out. | v2 | cURL{: external} node{: external} java{: external} python{: external} |
| Send user input to assistant (stateful) | Send user input to an assistant and receive a response, with conversation state (including context data) stored by Watson Assistant for the duration of the session. | v2 | cURL{: external} node{: external} java{: external} python{: external} |
| Send user input to assistant (stateless) | Send user input to an assistant and receive a response, with conversation state (including context data) managed by your application. | v2 | cURL{: external} node{: external} java{: external} python{: external} |
{: #api-methods-authoring}
| Method | Description | API ver | Reference |
|---|---|---|---|
| List workspaces | List the workspaces associated with a Watson Assistant service instance. | v1 | cURL{: external} node{: external} java{: external} python{: external} |
| Create workspace | Create a workspace based on component objects. You must provide workspace components defining the content of the new workspace. | v1 | cURL{: external} node{: external} java{: external} python{: external} |
| Get information about a workspace | Get information about a workspace, optionally including all workspace content. | v1 | cURL{: external} node{: external} java{: external} python{: external} |
| Update workspace | Update an existing workspace with new or modified data. You must provide component objects defining the content of the updated workspace. | v1 | cURL{: external} node{: external} java{: external} python{: external} |
| Delete workspace | Delete a workspace from the service instance. | v1 | cURL{: external} node{: external} java{: external} python{: external} |
| List intents | List the intents for a workspace. | v1 | cURL{: external} node{: external} java{: external} python{: external} |
| Create intent | Create a new intent. | v1 | cURL{: external} node{: external} java{: external} python{: external} |
| Get intent | Get information about an intent, optionally including all intent content. | v1 | cURL{: external} node{: external} java{: external} python{: external} |
| Update intent | Update an existing intent with new or modified data. You must provide component objects defining the content of the updated intent. | v1 | cURL{: external} node{: external} java{: external} python{: external} |
| Delete intent | Delete an intent from a workspace. | v1 | cURL{: external} node{: external} java{: external} python{: external} |
| List user input examples | List the user input examples for an intent, optionally including contextual entity mentions. | v1 | cURL{: external} node{: external} java{: external} python{: external} |
| Create user input example | Add a new user input example to an intent. | v1 | cURL{: external} node{: external} java{: external} python{: external} |
| Get user input example | Get information about a user input example. | v1 | cURL{: external} node{: external} java{: external} python{: external} |
| Update user input example | Update the text of a user input example. | v1 | cURL{: external} node{: external} java{: external} python{: external} |
| Delete user input example | Delete a user input example from an intent. | v1 | cURL{: external} node{: external} java{: external} python{: external} |
| List counterexamples | List the counterexamples for a workspace. Counterexamples are examples that have been marked as irrelevant input. | v1 | cURL{: external} node{: external} java{: external} python{: external} |
| Create counterexample | Add a new counterexample to a workspace. Counterexamples are examples that have been marked as irrelevant input. | v1 | cURL{: external} node{: external} java{: external} python{: external} |
| Get counterexample | Get information about a counterexample. Counterexamples are examples that have been marked as irrelevant input. | v1 | cURL{: external} node{: external} java{: external} python{: external} |
| Update counterexample | Update the text of a counterexample. Counterexamples are examples that have been marked as irrelevant input. | v1 | cURL{: external} node{: external} java{: external} python{: external} |
| Delete counterexample | Delete a counterexample from a workspace. Counterexamples are examples that have been marked as irrelevant input. | v1 | cURL{: external} node{: external} java{: external} python{: external} |
| List entities | List the entities for a workspace. | v1 | cURL{: external} node{: external} java{: external} python{: external} |
| Create entity | Create a new entity, or enable a system entity. | v1 | cURL{: external} node{: external} java{: external} python{: external} |
| Get entity | Get information about an entity, optionally including all entity content. | v1 | cURL{: external} node{: external} java{: external} python{: external} |
| Update entity | Update an existing entity with new or modified data. You must provide component objects defining the content of the updated entity. | v1 | cURL{: external} node{: external} java{: external} python{: external} |
| Delete entity | Delete an entity from a workspace, or disable a system entity. | v1 | cURL{: external} node{: external} java{: external} python{: external} |
| 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. | v1 | cURL{: external} node{: external} java{: external} python{: external} |
| List entity values | List the values for an entity. | v1 | cURL{: external} node{: external} java{: external} python{: external} |
| Add entity value | Create a new value for an entity. | v1 | cURL{: external} node{: external} java{: external} python{: external} |
| Get entity value | Get information about an entity value. | v1 | cURL{: external} node{: external} java{: external} python{: external} |
| 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. | v1 | cURL{: external} node{: external} java{: external} python{: external} |
| Delete entity value | Delete a value from an entity. | v1 | cURL{: external} node{: external} java{: external} python{: external} |
| List entity value synonyms | List the synonyms for an entity value. | v1 | cURL{: external} node{: external} java{: external} python{: external} |
| Add entity value synonym | Add a new synonym to an entity value. | v1 | cURL{: external} node{: external} java{: external} python{: external} |
| Get entity value synonym | Get information about a synonym of an entity value. | v1 | cURL{: external} node{: external} java{: external} python{: external} |
| Update entity value synonym | Update an existing entity value synonym with new text. | v1 | cURL{: external} node{: external} java{: external} python{: external} |
| Delete entity value synonym | Delete a synonym from an entity value. | v1 | cURL{: external} node{: external} java{: external} python{: external} |
| List dialog nodes | List the dialog nodes for a workspace. | v1 | cURL{: external} node{: external} java{: external} python{: external} |
| Create dialog node | Create a new dialog node. | v1 | cURL{: external} node{: external} java{: external} python{: external} |
| Get dialog node | Get information about a dialog node. | v1 | cURL{: external} node{: external} java{: external} python{: external} |
| Update dialog node | Update an existing dialog node with new or modified data. | v1 | cURL{: external} node{: external} java{: external} python{: external} |
| Delete dialog node | Delete a dialog node from a workspace. | v1 | cURL{: external} node{: external} java{: external} python{: external} |
| List log events in a workspace | List the events from the log of a specific workspace. | v1 | cURL{: external} node{: external} java{: external} python{: external} |
| List log events in all workspaces | List the events from the logs of all workspaces in the service instance. | v1 | cURL{: external} node{: external} java{: external} python{: external} |
| 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. | v1 | cURL{: external} node{: external} java{: external} python{: external} |