Skip to content

Latest commit

 

History

History
executable file
·
94 lines (83 loc) · 23.5 KB

api-methods.md

File metadata and controls

executable file
·
94 lines (83 loc) · 23.5 KB
copyright lastupdated subcollection
years
2015, 2019
2019-01-31
assistant

{:curl: #curl .ph data-hd-programlang='curl'} {:javascript: #javascript .ph data-hd-programlang='javascript'} {:java: #java .ph data-hd-programlang='java'} {:python: #python .ph data-hd-programlang='python'} {:swift: data-hd-programlang='swift'} {:new_window: target="_blank"} {: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 summary

{: #api-methods}

The following tables list the methods that are available using the {{site.data.keyword.conversationshort}} APIs.

Runtime methods

{: #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{: new_window} node{: new_window} java{: new_window} python{: new_window}
Delete session Deletes a session explicitly before it times out. v2 cURL{: new_window} node{: new_window} java{: new_window} python{: new_window}
Send user input to assistant Send user input to an assistant and receive a response. v2 cURL{: new_window} node{: new_window} java{: new_window} python{: new_window}
Get response to user input Send user input to a workspace and receive a response. v1 cURL{: new_window} node{: new_window} java{: new_window} python{: new_window}

Authoring methods

{: #api-methods-authoring}

Method Description API ver Reference
List workspaces List the workspaces associated with a Watson Assistant service instance. v1 cURL{: new_window} node{: new_window} java{: new_window} python{: new_window}
Create workspace Create a workspace based on component objects. You must provide workspace components defining the content of the new workspace. v1 cURL{: new_window} node{: new_window} java{: new_window} python{: new_window}
Get information about a workspace Get information about a workspace, optionally including all workspace content. v1 cURL{: new_window} node{: new_window} java{: new_window} python{: new_window}
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{: new_window} node{: new_window} java{: new_window} python{: new_window}
Delete workspace Delete a workspace from the service instance. v1 cURL{: new_window} node{: new_window} java{: new_window} python{: new_window}
List intents List the intents for a workspace. v1 cURL{: new_window} node{: new_window} java{: new_window} python{: new_window}
Create intent Create a new intent. v1 cURL{: new_window} node{: new_window} java{: new_window} python{: new_window}
Get intent Get information about an intent, optionally including all intent content. v1 cURL{: new_window} node{: new_window} java{: new_window} python{: new_window}
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{: new_window} node{: new_window} java{: new_window} python{: new_window}
Delete intent Delete an intent from a workspace. v1 cURL{: new_window} node{: new_window} java{: new_window} python{: new_window}
List user input examples List the user input examples for an intent, optionally including contextual entity mentions. v1 cURL{: new_window} node{: new_window} java{: new_window} python{: new_window}
Create user input example Add a new user input example to an intent. v1 cURL{: new_window} node{: new_window} java{: new_window} python{: new_window}
Get user input example Get information about a user input example. v1 cURL{: new_window} node{: new_window} java{: new_window} python{: new_window}
Update user input example Update the text of a user input example. v1 cURL{: new_window} node{: new_window} java{: new_window} python{: new_window}
Delete user input example Delete a user input example from an intent. v1 cURL{: new_window} node{: new_window} java{: new_window} python{: new_window}
List counterexamples List the counterexamples for a workspace. Counterexamples are examples that have been marked as irrelevant input. v1 cURL{: new_window} node{: new_window} java{: new_window} python{: new_window}
Create counterexample Add a new counterexample to a workspace. Counterexamples are examples that have been marked as irrelevant input. v1 cURL{: new_window} node{: new_window} java{: new_window} python{: new_window}
Get counterexample Get information about a counterexample. Counterexamples are examples that have been marked as irrelevant input. v1 cURL{: new_window} node{: new_window} java{: new_window} python{: new_window}
Update counterexample Update the text of a counterexample. Counterexamples are examples that have been marked as irrelevant input. v1 cURL{: new_window} node{: new_window} java{: new_window} python{: new_window}
Delete counterexample Delete a counterexample from a workspace. Counterexamples are examples that have been marked as irrelevant input. v1 cURL{: new_window} node{: new_window} java{: new_window} python{: new_window}
List entities List the entities for a workspace. v1 cURL{: new_window} node{: new_window} java{: new_window} python{: new_window}
Create entity Create a new entity, or enable a system entity. v1 cURL{: new_window} node{: new_window} java{: new_window} python{: new_window}
Get entity Get information about an entity, optionally including all entity content. v1 cURL{: new_window} node{: new_window} java{: new_window} python{: new_window}
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{: new_window} node{: new_window} java{: new_window} python{: new_window}
Delete entity Delete an entity from a workspace, or disable a system entity. v1 cURL{: new_window} node{: new_window} java{: new_window} python{: new_window}
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{: new_window} node{: new_window} java{: new_window} python{: new_window}
List entity values List the values for an entity. v1 cURL{: new_window} node{: new_window} java{: new_window} python{: new_window}
Add entity value Create a new value for an entity. v1 cURL{: new_window} node{: new_window} java{: new_window} python{: new_window}
Get entity value Get information about an entity value. v1 cURL{: new_window} node{: new_window} java{: new_window} python{: new_window}
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{: new_window} node{: new_window} java{: new_window} python{: new_window}
Delete entity value Delete a value from an entity. v1 cURL{: new_window} node{: new_window} java{: new_window} python{: new_window}
List entity value synonyms List the synonyms for an entity value. v1 cURL{: new_window} node{: new_window} java{: new_window} python{: new_window}
Add entity value synonym Add a new synonym to an entity value. v1 cURL{: new_window} node{: new_window} java{: new_window} python{: new_window}
Get entity value synonym Get information about a synonym of an entity value. v1 cURL{: new_window} node{: new_window} java{: new_window} python{: new_window}
Update entity value synonym Update an existing entity value synonym with new text. v1 cURL{: new_window} node{: new_window} java{: new_window} python{: new_window}
Delete entity value synonym Delete a synonym from an entity value. v1 cURL{: new_window} node{: new_window} java{: new_window} python{: new_window}
List dialog nodes List the dialog nodes for a workspace. v1 cURL{: new_window} node{: new_window} java{: new_window} python{: new_window}
Create dialog node Create a new dialog node. v1 cURL{: new_window} node{: new_window} java{: new_window} python{: new_window}
Get dialog node Get information about a dialog node. v1 cURL{: new_window} node{: new_window} java{: new_window} python{: new_window}
Update dialog node Update an existing dialog node with new or modified data. v1 cURL{: new_window} node{: new_window} java{: new_window} python{: new_window}
Delete dialog node Delete a dialog node from a workspace. v1 cURL{: new_window} node{: new_window} java{: new_window} python{: new_window}
List log events in a workspace List the events from the log of a specific workspace. v1 cURL{: new_window} node{: new_window} java{: new_window} python{: new_window}
List log events in all workspaces List the events from the logs of all workspaces in the service instance. v1 cURL{: new_window} node{: new_window} java{: new_window} python{: new_window}
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{: new_window} node{: new_window} java{: new_window} python{: new_window}