|
104 | 104 | </script> |
105 | 105 |
|
106 | 106 | <script type="text/x-red" data-help-name="watson-assistant-v2"> |
107 | | - <p>This node ... |
108 | | - </p> |
109 | | - |
110 | | - <p><b>Usage</b></p> |
111 | | - <p>This node should be provided in input : </p> |
112 | | - <ul> |
113 | | - <li><code>msg.payload</code> : ... |
114 | | - </li> |
115 | | - </ul> |
116 | | - <p>On successful conversion this node will output : </p> |
117 | | - <ul> |
118 | | - <li><code>msg.payload</code> : ... </li> |
119 | | - </ul> |
| 107 | + <p>With the IBM Watson™ Assistant V2 service you can create cognitive agents |
| 108 | + – virtual agents that combine machine learning, |
| 109 | + natural language understanding, and integrated dialog scripting tools to |
| 110 | + provide outstanding customer engagements.</p> |
| 111 | + |
| 112 | + <p><b>Usage</b></p> |
| 113 | + <p>This node should be provided in input : </p> |
| 114 | + <ul> |
| 115 | + <li><code>msg.payload</code> : the message of the Assistant to analyse. Format: String </li> |
| 116 | + <li><code>msg.params.session_id</code> (optional): unique identifier for the conversation session. |
| 117 | + If this field is not provided then the node will generate a new session_id and |
| 118 | + return itt as part of the response. If the node is not used in multi-session mode, then |
| 119 | + a session_id need not be provided, to reset the session_id in single-session mode |
| 120 | + send a null value as the session_id. Format: String </li> |
| 121 | + <li><code>msg.params.assistant_id</code> : unique identifier of the assistant to be used. Could be also configured in the node. Format: String </li> |
| 122 | + <li><code>msg.params.timeout</code> (optional): The timeout period (in millisecond) for Watson request. Leave empty or set to 0 to disable. </li> |
| 123 | + <li><code>msg.params.alternate_intents</code> (optional) : whether to return more than one intent. Default is false. Set to true to return all matching intents. For example, return all intents when the confidence is not high to allow users to choose their intent.</li> |
| 124 | + <li><code>msg.params.entities</code> (optional) : see API documentation </li> |
| 125 | + <li><code>msg.params.intents</code> (optional) : see API documentation </li> |
| 126 | + <li><code>msg.params.return_context</code> (optional) : see API documentation </li> |
| 127 | + <li><code>msg.params.debug</code> (optional) : see API documentation </li> |
| 128 | + <li><code>msg.params.restart</code> (optional) : see API documentation </li> |
| 129 | + <li><code>msg.additional_context</code> (optional) : additional properties that will be added to the context object. Format: Object </li> |
| 130 | + <br/> |
| 131 | + <li><code>msg.params.username</code> : If provided will be used as the username credential for the Assistant service.</li> |
| 132 | + <li><code>msg.params.password</code> : If provided will be used as the password credential for the Assistant service.</li> |
| 133 | + <li><code>msg.params.apikey</code> : If provided will be used as the api key credential for the Assistant service.</li> |
| 134 | + <li><code>msg.params.endpoint</code> : If provided will be used as the url for the Assistant service.</li> |
| 135 | + <li><code>msg.params.version</code> : If provided will be used as the API version date for the Assistant service.</li> |
| 136 | + <li><code>msg.params.optout_learning</code> : Set to true to opt out of request logging. Check the <a href="https://console.bluemix.net/docs/services/watson/getting-started-logging.html#controlling-request-logging-for-watson-services" target="_blank">documentation</a> for details.</li> |
| 137 | + <li><code>msg.params.disable_ssl_verification</code> : Set to true to disable SSL verification. <b>Note that this has serious security implications - only do this if you really mean to!</b></li> |
| 138 | + </ul> |
| 139 | + <p>See <a href="https://cloud.ibm.com/apidocs/assistant-v2" target="_blank">Assistant V2 API documentation</a> for details.</p> |
| 140 | + <p>All Results will made available at <code>msg.payload</code> in JSON format. |
| 141 | + Check the <a href="https://cloud.ibm.com/apidocs/assistant-v2" |
| 142 | + target="_blank">documentation</a> for details.</p> |
| 143 | + |
| 144 | + <p><b>Important</b> : before using this node, a workspace must be created and configured using the Watson Assistant Tool available in IBM Cloud, in the Watson Assistant instance detail page.</p> |
| 145 | + <p><b>Documentation</b> |
| 146 | + <ul> |
| 147 | + <li><a href="https://console.bluemix.net/docs/services/assistant/index.html" target="_blank">Watson Assistant API documentation</a></li> |
| 148 | + <li><a href="https://watson-api-explorer.mybluemix.net/apis/assistant-v1" target="_blank">Watson API Explorer</a></li> |
| 149 | + <li><a href="https://console.bluemix.net/docs/services/assistant/getting-started.html" target="_blank">Getting started tutorial</a> |
| 150 | + <li><a href="https://github.com/watson-developer-cloud/node-red-bluemix-starter" target="_blank">Sample Flow in the Watson Node-RED Starter</a> |
| 151 | + </ul> |
| 152 | + |
120 | 153 |
|
121 | 154 | </script> |
122 | 155 |
|
|
0 commit comments