From Bright Pattern Documentation
Jump to: navigation, search
(Marked this version for translation)
 
(18 intermediate revisions by 3 users not shown)
Line 1: Line 1:
<translate>= Bot / Chat Suggestions Engine Integration =
+
<translate>= Bot / Chat Suggestions Engine Integration = <!--T:1-->
 
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.
 
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: Alterra, AWS Lex, Watson Assistant.
+
<!--T:2-->
 +
This version of Bright Pattern Contact Center supports the following types of bot/chat integration: AWS Lex and Watson Assistant.
  
 +
<!--T:3-->
 
See [[Tutorials-for-admins/HowtoAddBotChatSuggestionsEngine |  How to Add a Bot/Chat Suggestions Engine Integration Account]].
 
See [[Tutorials-for-admins/HowtoAddBotChatSuggestionsEngine |  How to Add a Bot/Chat Suggestions Engine Integration Account]].
  
  
== Alterra Properties ==
+
== AWS Lex Properties == <!--T:4-->
Bright Pattern integrates with Alterra.ai's Answer Bot and NLP Engine. To set up your integration account, you will need to plug your Alterra credentials into the integration account properties (see the following descriptions).
+
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.
  
 +
<!--T:5-->
 +
For more information, see ''Tutorials for Admins'', section [[Tutorials-for-admins/AI/SetupanAWSLexIntegrationAccount | Set up an AWS Lex Integration Account]].
  
[[File:Alterra-Properties-53.PNG|450px|thumbnail|center|Alterra bot/chat suggestions engine integration account properties]]
 
  
 +
<!--T:6-->
 +
[[File:Lex-8.PNG|450px|thumbnail|center|AWS Lex bot/chat suggestions engine integration account properties]]
  
=== Name ===
+
 
 +
=== Name === <!--T:7-->
 
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). Because you can have multiple integration accounts of the same type, it is helpful to have a descriptive, memorable name.
  
=== Type ===  
+
=== Type === <!--T:8-->
By default, the type is “Alterra” because you selected this type when adding the account.
+
By default, the type is “AWS Lex” because you selected this type when adding the account.
 +
 
 +
=== User ID === <!--T:9-->
 +
Your AWS Account ID. Find it in AWS by going to ''My Account > Account Settings''
 +
 
 +
=== Bot name === <!--T:10-->
 +
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 === <!--T:11-->
 +
The alias name (if any); you can add an alias now if you haven’t already
 +
 
 +
=== Access key === <!--T:12-->
 +
The access key ID (e.g., AKIAIOSFODNN7EXAMPLE).
 +
 
 +
<!--T:13-->
 +
You need to set up access key for AWS Identity and Access Management (IAM) service to get this. See [https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html Managing Access Keys for IAM Users] and [https://console.aws.amazon.com/iam/ AWS Management Console].
 +
 
 +
=== Secret key === <!--T:14-->
 +
The secret access key (e.g., wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY)
 +
 
 +
=== Region === <!--T:15-->
 +
The region for your bot instance (e.g., “US West (Oregon)”)
 +
 
 +
=== Max API calls per day === <!--T:16-->
 +
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 == <!--T:17-->
 +
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.
 +
 
 +
<!--T:18-->
 +
For more information, see ''Tutorials for Admins'', section [[Tutorials-for-admins/SetupaWatsonAssistantIntegrationAccount | Set up a Watson Assistant Integration Account]].
 +
 
 +
 
 +
<!--T:19-->
 +
[[File:Watson-Assistant-Properties2-5399.PNG|800px|thumbnail|center|Watson Assistant bot/chat suggestions engine integration account properties]]
 +
 
 +
 
 +
=== Name === <!--T:20-->
 +
The name of this integration account.
 +
 
 +
=== Type === <!--T:21-->
 +
By default, the type is “Watson Assistant” because you selected this type when adding the account.
 +
 
 +
=== Url === <!--T:22-->
 +
The API endpoint of your Watson Assistant Skill (note that in IBM Watson Assistant Skill Details, this URL is called “Legacy v1 workspace URL” or the "Assistant URL").
 +
 
 +
<!--T:23-->
 +
For example:
 +
 
 +
<!--T:24-->
 +
'''https://gateway.watsonplatform.net/assistant/api/v1/workspaces/12c3a41e-ad2e-341c-12d3-412341ffdffd/message'''
 +
 
 +
<!--T:25-->
 +
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.
  
=== Url ===  
+
=== Skill ID === <!--T:26-->
The endpoint of your Alterra instance. The default ''Url'' value is ''https://next.alterra.ai/api/faq/v1/''.
+
The identifying number (string) of your Watson Assistant Skill (i.e., instance). Note that in IBM Watson, skills used to be called workspaces.
  
=== Method ===
+
<!--T:27-->
The HTTP method. The default is POST.
+
To find this ID, go to ''Skills > your skill > Options'' and click '''View API Details'''.
  
=== API key ===
+
=== API Key === <!--T:28-->
The API key (string) required to access the service. There is no default value.
+
The API Key (string) used to authenticate the service (e.g., “EEE-MTX13ZS1Ta4pD8qO4rmGP_SXR7HPB8IAAnPgTwKV”).
  
You can find your API key in your Alterra account, in ''Settings > My Account''.
+
<!--T:29-->
 +
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''.
  
=== Maximum suggestions ===  
+
=== Max API calls per day === <!--T:30-->
''Maximum suggestions'' is the maximum number of suggestions (e.g., 1, 2, or 3) that can be delivered to the Agent Desktop for the agent to select and use in chat replies.
+
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.
  
=== Test connection ===
+
=== Maximum suggestions === <!--T:31-->
Click to be sure Bright Pattern Contact Center can connect to your Alterra instance.
+
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.
  
If the credentials are invalid, go back to the Url property and API key and make sure you’ve entered them correctly. Test until you see the success dialog: "Account credentials appear to be valid."
+
=== Test Connection === <!--T:32-->
 +
Click to be sure Bright Pattern Contact Center can connect to your Watson Assistant.
  
Click '''Apply''' at the bottom of the screen to save your account properties.
+
<!--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."
  
 +
<!--T:34-->
 +
Lastly, be sure to click '''Apply''' at the bottom of the screen to save your account properties.
  
== Watson Assistant Properties ==
 
Bright Pattern integrates with IBM Watson Assistant instances on IBM Cloud. To set up your integration account, you will need to plug in your IBM Watson credentials to the integration account properties (see the following descriptions).
 
  
For more information on Watson Assistant, see [[5.3:Tutorials-for-admins/HowtoCreateWatsonAssistant |  How to Create a Watson Assistant]] and [[5.3:Contact-center-administrator-guide/HowtoIntegrateBotswithChat | How to Integrate Bots with Chat]]
+
== Watson Assistant (Legacy) Properties == <!--T:35-->
 +
Watson Assistant (Legacy) is the legacy version of IBM Watson Assistant that uses IBM's V1 runtime API and username/password authentication.
  
 +
<!--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.
  
[[File:Watson-Conversation-Properties-50.png|450px|thumbnail|center|Watson Conversation bot/chat suggestions engine integration account properties]]
+
<!--T:37-->
 +
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:38-->
 +
For more information, see ''Tutorials for Admins'', section [[Tutorials-for-admins/SetupaWatsonAssistantIntegrationAccount | Set up a Watson Assistant Integration Account]].
  
=== 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 ===
+
<!--T:39-->
By default, the type is “Watson Conversation” because you selected this type when adding the account.
+
[[File:Watson-Conversation-Properties3-5399.PNG|800px|thumbnail|center|Watson Assistant (Conversation) bot/chat suggestions engine integration account properties]]
  
=== Url ===
 
The endpoint of your Watson Assistant (string). Note that you must enter the Url in the following way for your bot to work properly.
 
  
The Url consists of:
+
=== Name === <!--T:40-->
'''https://gateway.watsonplatform.net/assistant/api''' + '''/v1/workspaces/''' + '''your workspace ID''' (see below) + '''/message?version=2017-05-26'''
+
The name of this integration account.
  
For example:
+
=== Type === <!--T:41-->
https://gateway.watsonplatform.net/assistant/api/v1/workspaces/085c97f9-44c3-403d-8aad-92e86d9379f8d/message?version=2017-05-26
+
By default, the type is “Watson Assistant (Legacy)” because you selected this type when adding the account.
  
=== Workspace ID ===  
+
=== Url === <!--T:42-->
The identifying number (string) of your Watson Assistant Workspace (i.e., instance).
+
The Legacy v1 Workspace URL of your Watson Assistant Skill.
  
To find this ID, go to ''IBM Watson Assistant > Workspaces'', click on the desired workspace’s '''Actions''' button, and select '''View details'''.
+
<!--T:43-->
 +
For example:
  
 +
<!--T:44-->
 +
'''https://api.us-south.assistant.watson.cloud.ibm.com/instances/c1f234f5-1d23-4e51-23af-4cef51b2b345/v1/workspaces/012b31f4-51c2-345d-1aad-23e45d123f4d/message'''
  
[[File:ChatWat7.PNG|thumb|800px|center|IBM Watson Assistant > Workspaces]]
+
<!--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.
  
Copy your workspace ID from there.
+
=== 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.
  
 +
<!--T:48-->
 +
To find this ID, go to ''IBM Watson Assistant > Skills'', and click '''View API details'''.
  
[[File:ChatWat8.PNG|thumb|800px|center|Copy your workspace ID]]
+
=== 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.
  
 +
<!--T:50-->
 +
If you do not know your username, you can set '''apikey''' as the username.
  
=== Username ===
+
=== Password === <!--T:51-->
The ''username'' (string) that is used to authenticate the Watson Conversation API. The username 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.
  
=== Password ===
+
<!--T:52-->
The ''password'' (string) used to authenticate the Watson Conversation 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 === <!--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 ===  
+
=== 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 ===
+
=== Test Connection === <!--T:55-->
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 (Legacy).
 +
 
  
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."
+
== Recommended Reading == <!--T:56-->
 +
For more information on bot integrations, see:
 +
* [[5.3:Tutorials-for-admins/HowtoCreateWatsonAssistant |  How to Create a Watson Assistant]]
  
Click '''Apply''' at the bottom of the screen to save your account properties.
+
<!--T:57-->
 +
* [[5.3:Contact-center-administrator-guide/HowtoIntegrateBotswithChat | How to Integrate Bots with Chat]]
  
 +
<!--T:58-->
 +
* [[Tutorials-for-admins/SetupaWatsonAssistantIntegrationAccount | Set up a Watson Assistant Integration Account]]
  
  
  
 
</translate>
 
</translate>

Latest revision as of 23:19, 8 September 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” or the "Assistant 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 >