From Bright Pattern Documentation
Jump to: navigation, search
(Marked this version for translation)
Line 59: Line 59:
  
 
<!--T:19-->
 
<!--T:19-->
[[File:Watson-Assistant-1-53.PNG|450px|thumbnail|center|Watson Assistant bot/chat suggestions engine integration account properties]]
+
[[File:Watson-Assistant-Properties2-5399.PNG|800px|thumbnail|center|Watson Assistant bot/chat suggestions engine integration account properties]]
  
  
 
=== Name ===  <!--T:20-->
 
=== Name ===  <!--T:20-->
The unique name of this integration account (any).
+
The name of this integration account.
  
 
=== Type ===  <!--T:21-->
 
=== Type ===  <!--T:21-->
Line 69: Line 69:
  
 
=== Url ===  <!--T:22-->
 
=== Url ===  <!--T:22-->
The endpoint of your Watson Assistant Skill in the following format: '''<Legacy v1 Workspace URL>?version=2017-05-26'''
+
The API endpoint of your Watson Assistant Skill (note that in IBM Watson Assistant Skill Details, this URL is called “Legacy v1 workspace URL”).
  
 
<!--T:23-->
 
<!--T:23-->
Line 75: Line 75:
  
 
<!--T:24-->
 
<!--T:24-->
'''https://gateway.watsonplatform.net/assistant/api/v1/workspaces/12a3ab45-b12b-1234-12a3-12d34aebe56c/message?version=2017-05-26'''
+
'''https://gateway.watsonplatform.net/assistant/api/v1/workspaces/12c3a41e-ad2e-341c-12d3-412341ffdffd/message'''
  
 
<!--T:25-->
 
<!--T:25-->
# 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 />
+
You can find the URL by going to ''Skills > your skill > Options''. Click '''View API Details''' and then you will see the skill details and service credentials, and you can copy the URL.
# 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 />
 
  
<!--T:26-->
+
=== Skill ID ===  <!--T:26-->
Why do this?
+
The identifying number (string) of your Watson Assistant Skill (i.e., instance). Note that in IBM Watson, skills used to be called workspaces.
  
 
<!--T:27-->
 
<!--T:27-->
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.
+
To find this ID, go to ''Skills > your skill > Options'' and click '''View API Details'''.
  
<!--T:28-->
+
=== API Key === <!--T:28-->
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.
+
The API Key (string) used to authenticate the service (e.g., “EEE-MTX13ZS1Ta4pD8qO4rmGP_SXR7HPB8IAAnPgTwKV”).
  
 
<!--T:29-->
 
<!--T:29-->
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.
+
You can find the API Key by going to ''Skills > your skill > Options'' and clicking '''View API Details'''. The API key is either auto-generated for you or created manually in IBM Cloud, in ''Access (IAM) > IBM Cloud API keys''.
 
 
=== Workspace ID ===  <!--T:30-->
 
The identifying number (string) of your Watson Assistant (Conversation) Skill (i.e., instance). Note that in IBM Watson, skills used to be called workspaces.
 
 
 
<!--T:31-->
 
# 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 === <!--T:32-->
 
The API Key (string) used to authenticate the service (e.g., “EEE-MTX13ZS1Ta4pD8qO4rmGP_SXR7HPB8IAAnPgTwKV”).
 
  
<!--T:33-->
+
=== Max API calls per day ===  <!--T:30-->
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]]
 
 
 
<!--T:34-->
 
The API key is either auto-generated for you or created manually in IBM Cloud.
 
 
 
 
 
==== How to Create a New Key ==== <!--T:35-->
 
# 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 ===  <!--T:36-->
 
 
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.
 
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 ===  <!--T:37-->
+
=== Maximum suggestions ===  <!--T:31-->
 
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 ===  <!--T:38-->
+
=== Test Connection ===  <!--T:32-->
 
Click to be sure Bright Pattern Contact Center can connect to your Watson Assistant.
 
Click to be sure Bright Pattern Contact Center can connect to your Watson Assistant.
  
<!--T:39-->
+
<!--T:33-->
 
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."
 
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."
  
<!--T:40-->
+
<!--T:34-->
 
Lastly, be sure to click '''Apply''' at the bottom of the screen to save your account properties.
 
Lastly, be sure to click '''Apply''' at the bottom of the screen to save your account properties.
  
  
== Watson Assistant (Conversation) Properties == <!--T:41-->
+
== Watson Assistant (Legacy) Properties == <!--T:35-->
Watson Assistant (Conversation) is the legacy version of IBM Watson Assistant that uses IBM's V1 runtime API and username/password authentication.
+
Watson Assistant (Legacy) is the legacy version of IBM Watson Assistant that uses IBM's V1 runtime API and username/password authentication.
  
<!--T:42-->
+
<!--T:36-->
 
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/password to API key.
  
<!--T:43-->
+
<!--T:37-->
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 Conversation bot, add a Watson Assistant (Legacy) 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.
  
<!--T:44-->
+
<!--T:38-->
 
For more information, see ''Tutorials for Admins'', section [[Tutorials-for-admins/SetupaWatsonAssistantIntegrationAccount | Set up a Watson Assistant Integration Account]].
 
For more information, see ''Tutorials for Admins'', section [[Tutorials-for-admins/SetupaWatsonAssistantIntegrationAccount | Set up a Watson Assistant Integration Account]].
  
  
<!--T:45-->
+
<!--T:39-->
[[File:Watson-Conversation-Properties-53.PNG|450px|thumbnail|center|Watson Assistant (Conversation) bot/chat suggestions engine integration account properties]]
+
[[File:Watson-Conversation-Properties3-5399.PNG|800px|thumbnail|center|Watson Assistant (Conversation) bot/chat suggestions engine integration account properties]]
  
  
=== Name ===  <!--T:46-->
+
=== Name ===  <!--T:40-->
The unique name of this integration account (any).
+
The name of this integration account.
  
=== Type ===  <!--T:47-->
+
=== Type ===  <!--T:41-->
By default, the type is “Watson Conversation” because you selected this type when adding the account.
+
By default, the type is “Watson Assistant (Legacy)” because you selected this type when adding the account.
  
=== Url ===  <!--T:48-->
+
=== Url ===  <!--T:42-->
The endpoint of your Watson Assistant Skill in the following format: '''<Legacy v1 Workspace URL>?version=2017-05-26'''
+
The Legacy v1 Workspace URL of your Watson Assistant Skill.
  
<!--T:49-->
+
<!--T:43-->
 
For example:
 
For example:
  
<!--T:50-->
+
<!--T:44-->
'''https://gateway.watsonplatform.net/assistant/api/v1/workspaces/12a3ab45-b12b-1234-12a3-12d34aebe56c/message?version=2017-05-26'''
+
'''https://api.us-south.assistant.watson.cloud.ibm.com/instances/c1f234f5-1d23-4e51-23af-4cef51b2b345/v1/workspaces/012b31f4-51c2-345d-1aad-23e45d123f4d/message'''
 +
 
 +
<!--T:45-->
 +
To find this ID, go to ''IBM Watson Assistant > Skills'', and click '''View API details'''.
 +
 
 +
<!--T:46-->
 +
Please note that earlier versions of Bright Pattern Contact Center (earlier than version 5.3.21) required the URL to be in the format “<Legacy v1 Workspace URL>?version=2017-05-26”. Now, “version=2017-05-26” is added by default (so you do not have to append the version to the URL manually). You have the option to use another version from the list recommended by IBM.
  
=== Workspace ID === <!--T:51-->
+
=== Skill ID === <!--T:47-->
 
The identifying number (string) of your Watson Assistant (Conversation) Skill (i.e., instance). Note that in IBM Watson, skills used to be called workspaces.
 
The identifying number (string) of your Watson Assistant (Conversation) Skill (i.e., instance). Note that in IBM Watson, skills used to be called workspaces.
  
<!--T:52-->
+
<!--T:48-->
# To find this ID, go to ''IBM Watson Assistant > Skills'', click on the desired skill’s '''Actions''' button, and select '''View API details'''.<br /><br />[[File:Skills-View-API-53.PNG|thumb|800px|center|IBM Watson Assistant > Skills]]<br /><br />
+
To find this ID, go to ''IBM Watson Assistant > Skills'', and click '''View API details'''.
# On the page that opens, copy your '''workspace ID'''.<br /><br />[[File:Watson-Legacy-Skillsb.png|thumb|800px|center|Copy your workspace ID]]
 
  
=== Username ===  <!--T:53-->
+
=== Username ===  <!--T:49-->
 
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.
 
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.
  
<!--T:54-->
+
<!--T:50-->
 
If you do not know your username, you can set '''apikey''' as the username.
 
If you do not know your username, you can set '''apikey''' as the username.
  
=== Password ===  <!--T:55-->
+
=== Password ===  <!--T:51-->
 
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.
 
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.
  
<!--T:56-->
+
<!--T:52-->
 
If you do not know your password, you can set your skill's API key.
 
If you do not know your password, you can set your skill's API key.
  
=== Max API calls per day ===  <!--T:57-->
+
=== Max API calls per day ===  <!--T:53-->
 
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.
 
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 ===  <!--T:58-->
+
=== Maximum suggestions ===  <!--T:54-->
 
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 === <!--T:59-->
+
=== Test Connection === <!--T:55-->
Click to be sure Bright Pattern Contact Center can connect to your Watson Assistant (Conversation).
+
Click to be sure Bright Pattern Contact Center can connect to your Watson Assistant (Legacy).
  
  
== Recommended Reading == <!--T:60-->
+
== Recommended Reading == <!--T:56-->
 
For more information on bot integrations, see:
 
For more information on bot integrations, see:
 
* [[5.3:Tutorials-for-admins/HowtoCreateWatsonAssistant |  How to Create a Watson Assistant]]
 
* [[5.3:Tutorials-for-admins/HowtoCreateWatsonAssistant |  How to Create a Watson Assistant]]
  
<!--T:61-->
+
<!--T:57-->
 
* [[5.3:Contact-center-administrator-guide/HowtoIntegrateBotswithChat | How to Integrate Bots with Chat]]
 
* [[5.3:Contact-center-administrator-guide/HowtoIntegrateBotswithChat | How to Integrate Bots with Chat]]
  
<!--T:62-->
+
<!--T:58-->
 
* [[Tutorials-for-admins/SetupaWatsonAssistantIntegrationAccount | Set up a Watson Assistant Integration Account]]
 
* [[Tutorials-for-admins/SetupaWatsonAssistantIntegrationAccount | Set up a Watson Assistant Integration Account]]
  

Revision as of 20:04, 11 January 2021

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 name of this integration account.

Type

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

Url

The API endpoint of your Watson Assistant Skill (note that in IBM Watson Assistant Skill Details, this URL is called “Legacy v1 workspace URL”).

For example:

https://gateway.watsonplatform.net/assistant/api/v1/workspaces/12c3a41e-ad2e-341c-12d3-412341ffdffd/message

You can find the URL by going to Skills > your skill > Options. Click View API Details and then you will see the skill details and service credentials, and you can copy the URL.

Skill ID

The identifying number (string) of your Watson Assistant 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 and click View API Details.

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 and clicking View API Details. The API key is either auto-generated for you or created manually in IBM Cloud, in Access (IAM) > IBM Cloud API keys.

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 (Legacy) Properties

Watson Assistant (Legacy) 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.

To integrate a legacy Watson Conversation bot, add a Watson Assistant (Legacy) 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 name of this integration account.

Type

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

Url

The Legacy v1 Workspace URL of your Watson Assistant Skill.

For example:

https://api.us-south.assistant.watson.cloud.ibm.com/instances/c1f234f5-1d23-4e51-23af-4cef51b2b345/v1/workspaces/012b31f4-51c2-345d-1aad-23e45d123f4d/message

To find this ID, go to IBM Watson Assistant > Skills, and click View API details.

Please note that earlier versions of Bright Pattern Contact Center (earlier than version 5.3.21) required the URL to be in the format “<Legacy v1 Workspace URL>?version=2017-05-26”. Now, “version=2017-05-26” is added by default (so you do not have to append the version to the URL manually). You have the option to use another version from the list recommended by IBM.

Skill 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.

To find this ID, go to IBM Watson Assistant > Skills, and click View API details.

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 (Legacy).


Recommended Reading

For more information on bot integrations, see:


< Previous | Next >