From Bright Pattern Documentation
Jump to: navigation, search
(Undo revision 48599 by Tracy (talk))
Line 56: Line 56:
  
 
=== Name ===  
 
=== Name ===  
The unique name of this integration account (any). Because you can have multiple integration accounts of the same type, it is helpful to have a descriptive, memorable name.
+
The unique name of this integration account (any).
  
 
=== Type ===  
 
=== Type ===  
Line 62: Line 62:
  
 
=== Url ===  
 
=== Url ===  
The endpoint of your Watson Assistant bot instance (string).
+
The endpoint of your Watson Assistant Skill  in the following format: '''<Legacy v1 Workspace URL>?version=2017-05-26'''
  
'''Note that you must enter the Url in the following way for your bot to work properly!'''
+
For example:
  
The Url consists of these elements, strung together:
+
'''https://gateway.watsonplatform.net/assistant/api/v1/workspaces/12a3ab45-b12b-1234-12a3-12d34aebe56c/message?version=2017-05-26'''
* Endpoint: '''https://gateway.watsonplatform.net/assistant/api/v1/workspaces/'''
 
* Your workspace ID string (see below)
 
* '''/message?version=2017-05-26'''
 
  
For example:
+
# You can find the URL by going to ''Skills > your skill > Options > View API Details''.<br /><br />[[File:Watson-Skill-URL2-53.png|center|thumb|800px|IBM> Watson Skill > Options > View API Details]]<br /><br />
https://gateway.watsonplatform.net/assistant/api/v1/workspaces/085c97f9-44c3-403d-8aad-92e86d9379f8d/message?version=2017-05-26
+
# From the ''Skill Details'' page that opens, copy the '''Legacy v1 Workspace URL'''.<br /><br />[[File:Watson-Skill-API-Details-b-54.png|thumb|800px|center|Copy your Legacy v1 Workspace URL]]<br /><br />
 +
# Then append '''?version 2017-05-26''' to the end of the URL. For example:<br /><br />'''https://gateway.watsonplatform.net/assistant/api/v1/workspaces/46a4ab18-b13b-4306-83a0-57d83aebe56c/message?version=2017-05-26'''<br /><br />
 +
 
 +
Why do this?
 +
 
 +
Our integration accounts support requests to the V1 runtime API using the /message method, where user input is sent to Watson Assistant to get a response. We also support requests to the V2 runtime API using the /message method.
 +
 
 +
API requests require a version parameter that takes a date in the format ''version=YYYY-MM-DD''. Our integration uses /message ''version=2017-05-26''. Note that although the date of this version may not match the current version specified by IBM Cloud, this is the correct version to use for our integration because it is compatible with Bright Pattern applications.
 +
 
 +
When the version parameter is appended to the end of the URL property, the proper version will accompany every API request, every time the integrated Watson Assistant is used in Bright Pattern chat services.
  
 
=== Workspace ID ===  
 
=== Workspace ID ===  
The identifying number (string) of your Watson Assistant Workspace (i.e., instance).
+
The identifying number (string) of your Watson Assistant (Conversation) Skill (i.e., instance). Note that in IBM Watson, skills used to be called workspaces.
 +
 
 +
# To find this ID, go to ''Skills > your skill > Options > View API Details''.<br /><br />[[File:Watson-Skill-URL2-53.png|center|thumb|800px|IBM> Watson Skill > Options > View API Details]]<br /><br />
 +
# From the ''Skill Details'' page that opens, copy the '''Workspace ID'''.<br /><br />[[File:WatsonNew5b.png|thumb|800px|center|Copy your workspace ID]]
 +
 
  
=== API key ===  
+
=== API Key ===
The API key (string) used to authenticate the API.
+
The API Key (string) used to authenticate the service (e.g., “EEE-MTX13ZS1Ta4pD8qO4rmGP_SXR7HPB8IAAnPgTwKV”).
 +
 
 +
You can find the API Key by going to ''Skills > your skill > Options > View API Details''.<br /><br />[[File:Watson-Skill-URL2-53.png|center|thumb|800px|IBM> Watson Skill > Options > View API Details]]<br /><br />
 +
# From the ''Skill Details'' page that opens, copy the '''Api Key'''.<br /><br />[[File:WatsonNew5b.png|thumb|800px|center|Copy your API key]]
 +
 
 +
The API key is either auto-generated for you or created manually in IBM Cloud.
  
For example:
 
EEE-MTX13ZS1Ta4pD8qO4rmGP_SXR7HPB8IAAnPgTwKV
 
  
The API key is either auto-generated for you or created manually in IBM Cloud. To create a new key, go to IBM's website and navigate to ''IBM Cloud > Access (IAM) > IBM Cloud API Keys > Create an IBM Cloud API key''. Be sure to download it and save it because the API key will be shown only once.
+
==== How to Create a New Key ====
 +
# Go to IBM's website and navigate to ''IBM Cloud > Access (IAM) > IBM Cloud API Keys''.<br /><br />
 +
# Click '''Create an IBM Cloud API key'''.<br /><br />[[File:IBM-Cloud-API-Key1-53.PNG|thumb|800px|center|IBM Cloud API Keys]]<br /><br />
 +
# In '''Create API Key''' dialog, add name and description.<br /><br />[[File:IBM-Cloud-Create-Key2-53.PNG|thumb|450px|center|Create API Key]]<br /><br />
 +
# Download it and save it because the API key will be shown only once.<br /><br />[[File:IBM-Cloud-Key2-53.PNG|thumb|650px|center|Create API Key]]
  
 
=== Max API calls per day ===  
 
=== Max API calls per day ===  
Line 91: Line 108:
 
The maximum number of suggestions (e.g., 3) that can be delivered to the Agent Desktop during active chat interactions. Suggestions are the bot-generated replies that agents can select and use during chats.
 
The maximum number of suggestions (e.g., 3) that can be delivered to the Agent Desktop during active chat interactions. Suggestions are the bot-generated replies that agents can select and use during chats.
  
=== Test Connection ===
+
=== Test Connection ===  
Click to be sure Bright Pattern Contact Center can connect to your Watson Assistant (formerly Conversation.
+
Click to be sure Bright Pattern Contact Center can connect to your Watson Assistant.
 +
 
 +
If the credentials are invalid, go back to the Url property and make sure you’ve entered it exactly as explained. Test until you see the success dialog: "Account credentials appear to be valid."
 +
 
 +
Lastly, be sure to click '''Apply''' at the bottom of the screen to save your account properties.
  
  
 
== Watson Assistant (Conversation) Properties ==
 
== Watson Assistant (Conversation) Properties ==
Watson Assistant (Conversation) is the legacy version of IBM Watson Assistant.
+
Watson Assistant (Conversation) is the legacy version of IBM Watson Assistant that uses IBM's V1 runtime API and username/password authentication.
 +
 
 +
Previously, Watson Assistant was called Watson Conversation, and credentials for Watson Conversation included username and password. IBM has since renamed it Watson Assistant and changed its credentials from username/password to API key.
  
Previously, Watson Assistant was called Watson Conversation, and credentials for Watson Conversation included username and password. IBM has since renamed it Watson Assistant and changed its credentials from username and password to API key. For backwards compatibility, our integration accounts still work with either type of bot.
+
Note that according to IBM, username and password credentials will stop working on October 30, 2019, and all custom applications must be updated to use the IAM authentication method by then. You can learn more at [https://cloud.ibm.com/docs IBM Cloud Docs].
  
 
To integrate a legacy Watson Assistant (Conversation) bot, add a Watson Assistant (Conversation) account and edit the Properties of your bot instance as follows. This allows Bright Pattern to access your bot and use it in chat interactions.
 
To integrate a legacy Watson Assistant (Conversation) bot, add a Watson Assistant (Conversation) account and edit the Properties of your bot instance as follows. This allows Bright Pattern to access your bot and use it in chat interactions.
Line 109: Line 132:
  
 
=== Name ===  
 
=== Name ===  
The unique name of this integration account (any). Because you can have multiple integration accounts of the same type, it is helpful to have a descriptive, memorable name.
+
The unique name of this integration account (any).
  
 
=== Type ===  
 
=== Type ===  
Line 115: Line 138:
  
 
=== Url ===  
 
=== Url ===  
The endpoint of your Watson Assistant (Conversation) bot instance (string).
+
The endpoint of your Watson Assistant Skill  in the following format: '''<Legacy v1 Workspace URL>?version=2017-05-26'''
  
 
For example:
 
For example:
https://gateway.watsonplatform.net/assistant/api/v1/workspaces/085c97f9-44c3-403d-8aad-92e86d9379f8d/message?version=2017-05-26
 
  
=== Workspace ID ===
+
'''https://gateway.watsonplatform.net/assistant/api/v1/workspaces/12a3ab45-b12b-1234-12a3-12d34aebe56c/message?version=2017-05-26'''
The identifying number (string) of your Watson Assistant (Conversation) Workspace (i.e., instance).
 
  
 
=== Username ===   
 
=== Username ===   
The ''username'' (string) that is used to authenticate the Watson Assistant (Conversation) API. The username is provided in the service credentials for the service instance that you want to use.
+
The ''username'' (string) that is used to authenticate the Watson Assistant API. The username is provided in the service credentials for the service instance that you want to use.
 +
 
 +
If you do not know your username, you can set '''apikey''' as the username.
  
 
=== Password ===  
 
=== Password ===  
The ''password'' (string) used to authenticate the Watson Assistant (Conversation) API. The password is provided in the service credentials for the service instance that you want to use.
+
The ''password'' (string) used to authenticate the Watson Assistant API. The password is provided in the service credentials for the service instance that you want to use.
 +
 
 +
If you do not know your password, you can set your skill's API key.
  
 
=== Max API calls per day ===  
 
=== Max API calls per day ===  

Revision as of 23:50, 14 October 2019

Other languages:
English • ‎日本語
• 5.3 • 5.8

Bot / Chat Suggestions Engine Integration

Bot/chat suggestions engine integration accounts allow you to use third-party bots to automate chat conversations, provide self-service options, intelligently route customers to agents, and provide meaningful suggestions to an agent during active chat sessions.

This version of Bright Pattern Contact Center supports the following types of bot/chat integration: AWS Lex and Watson Assistant.

See How to Add a Bot/Chat Suggestions Engine Integration Account.


AWS Lex Properties

After you add an AWS Lex account, the Properties dialog will appear. In Properties, you enter the credentials of your Lex bot instance. This allows Bright Pattern to access your bot and use it in chat interactions.

For more information, see Tutorials for Admins, section Set up an AWS Lex Integration Account.


AWS Lex bot/chat suggestions engine integration account properties


Name

The unique name of this integration account (any). Because you can have multiple integration accounts of the same type, it is helpful to have a descriptive, memorable name.

Type

By default, the type is “AWS Lex” because you selected this type when adding the account.

User ID

Your AWS Account ID. Find it in AWS by going to My Account > Account Settings

Bot name

The bot name (e.g., “TripBooker”); note this may be different than an alias name. Find it in Amazon Lex > Bots (select the name of your bot) > Settings

Bot alias

The alias name (if any); you can add an alias now if you haven’t already

Access key

The access key ID (e.g., AKIAIOSFODNN7EXAMPLE).

You need to set up access key for AWS Identity and Access Management (IAM) service to get this. See Managing Access Keys for IAM Users and AWS Management Console.

Secret key

The secret access key (e.g., wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY)

Region

The region for your bot instance (e.g., “US West (Oregon)”)

Max API calls per day

The maximum number of calls that can be done each day. This limit is here to keep your account from being charged for additional calls beyond what is included in a free account.


Watson Assistant Properties

After you add a Watson Assistant account, the Properties dialog will appear. In Properties, you enter the credentials of your Watson Assistant bot instance. This allows Bright Pattern to access your bot and use it in chat interactions.

For more information, see Tutorials for Admins, section Set up a Watson Assistant Integration Account.


Watson Assistant bot/chat suggestions engine integration account properties


Name

The unique name of this integration account (any).

Type

By default, the type is “Watson Assistant” because you selected this type when adding the account.

Url

The endpoint of your Watson Assistant Skill in the following format: <Legacy v1 Workspace URL>?version=2017-05-26

For example:

https://gateway.watsonplatform.net/assistant/api/v1/workspaces/12a3ab45-b12b-1234-12a3-12d34aebe56c/message?version=2017-05-26

  1. You can find the URL by going to Skills > your skill > Options > View API Details.

    IBM> Watson Skill > Options > View API Details


  2. From the Skill Details page that opens, copy the Legacy v1 Workspace URL.

    Copy your Legacy v1 Workspace URL


  3. Then append ?version 2017-05-26 to the end of the URL. For example:

    https://gateway.watsonplatform.net/assistant/api/v1/workspaces/46a4ab18-b13b-4306-83a0-57d83aebe56c/message?version=2017-05-26

Why do this?

Our integration accounts support requests to the V1 runtime API using the /message method, where user input is sent to Watson Assistant to get a response. We also support requests to the V2 runtime API using the /message method.

API requests require a version parameter that takes a date in the format version=YYYY-MM-DD. Our integration uses /message version=2017-05-26. Note that although the date of this version may not match the current version specified by IBM Cloud, this is the correct version to use for our integration because it is compatible with Bright Pattern applications.

When the version parameter is appended to the end of the URL property, the proper version will accompany every API request, every time the integrated Watson Assistant is used in Bright Pattern chat services.

Workspace ID

The identifying number (string) of your Watson Assistant (Conversation) Skill (i.e., instance). Note that in IBM Watson, skills used to be called workspaces.

  1. To find this ID, go to Skills > your skill > Options > View API Details.

    IBM> Watson Skill > Options > View API Details


  2. From the Skill Details page that opens, copy the Workspace ID.

    Copy your workspace ID


API Key

The API Key (string) used to authenticate the service (e.g., “EEE-MTX13ZS1Ta4pD8qO4rmGP_SXR7HPB8IAAnPgTwKV”).

You can find the API Key by going to Skills > your skill > Options > View API Details.

IBM> Watson Skill > Options > View API Details



  1. From the Skill Details page that opens, copy the Api Key.

    Copy your API key

The API key is either auto-generated for you or created manually in IBM Cloud.


How to Create a New Key

  1. Go to IBM's website and navigate to IBM Cloud > Access (IAM) > IBM Cloud API Keys.

  2. Click Create an IBM Cloud API key.

    IBM Cloud API Keys


  3. In Create API Key dialog, add name and description.

    Create API Key


  4. Download it and save it because the API key will be shown only once.

    Create API Key

Max API calls per day

The maximum number of calls that can be done each day. This limit is here to keep your account from being charged for additional calls beyond the first 1,000 that are included in a free account.

Maximum suggestions

The maximum number of suggestions (e.g., 3) that can be delivered to the Agent Desktop during active chat interactions. Suggestions are the bot-generated replies that agents can select and use during chats.

Test Connection

Click to be sure Bright Pattern Contact Center can connect to your Watson Assistant.

If the credentials are invalid, go back to the Url property and make sure you’ve entered it exactly as explained. Test until you see the success dialog: "Account credentials appear to be valid."

Lastly, be sure to click Apply at the bottom of the screen to save your account properties.


Watson Assistant (Conversation) Properties

Watson Assistant (Conversation) is the legacy version of IBM Watson Assistant that uses IBM's V1 runtime API and username/password authentication.

Previously, Watson Assistant was called Watson Conversation, and credentials for Watson Conversation included username and password. IBM has since renamed it Watson Assistant and changed its credentials from username/password to API key.

Note that according to IBM, username and password credentials will stop working on October 30, 2019, and all custom applications must be updated to use the IAM authentication method by then. You can learn more at IBM Cloud Docs.

To integrate a legacy Watson Assistant (Conversation) bot, add a Watson Assistant (Conversation) account and edit the Properties of your bot instance as follows. This allows Bright Pattern to access your bot and use it in chat interactions.

For more information, see Tutorials for Admins, section Set up a Watson Assistant Integration Account.


Watson Assistant (Conversation) bot/chat suggestions engine integration account properties


Name

The unique name of this integration account (any).

Type

By default, the type is “Watson Conversation” because you selected this type when adding the account.

Url

The endpoint of your Watson Assistant Skill in the following format: <Legacy v1 Workspace URL>?version=2017-05-26

For example:

https://gateway.watsonplatform.net/assistant/api/v1/workspaces/12a3ab45-b12b-1234-12a3-12d34aebe56c/message?version=2017-05-26

Username

The username (string) that is used to authenticate the Watson Assistant API. The username is provided in the service credentials for the service instance that you want to use.

If you do not know your username, you can set apikey as the username.

Password

The password (string) used to authenticate the Watson Assistant API. The password is provided in the service credentials for the service instance that you want to use.

If you do not know your password, you can set your skill's API key.

Max API calls per day

The maximum number of calls that can be done each day. This limit is here to keep your account from being charged for additional calls beyond the first 1,000 that are included in a free account.

Maximum suggestions

The maximum number of suggestions (e.g., 3) that can be delivered to the Agent Desktop during active chat interactions. Suggestions are the bot-generated replies that agents can select and use during chats.

Test Connection

Click to be sure Bright Pattern Contact Center can connect to your Watson Assistant (Conversation).


Recommended Reading

For more information on bot integrations, see:


< Previous | Next >