imported>Sergem |
(Updated via BpDeleteTranslateTags script) |
||
| Line 1: | Line 1: | ||
| − | + | ||
| − | = Set up a Watson Assistant (Conversation) Integration Account = | + | = Set up a Watson Assistant (Conversation) Integration Account = |
Integrations with IBM Watson Assistant (formerly Conversation) are enabled through [[Contact-center-administrator-guide/IntegrationAccounts | integration accounts]], which store the credentials of third-party services so that Bright Pattern Contact Center can access and work with them. | Integrations with IBM Watson Assistant (formerly Conversation) are enabled through [[Contact-center-administrator-guide/IntegrationAccounts | integration accounts]], which store the credentials of third-party services so that Bright Pattern Contact Center can access and work with them. | ||
| − | |||
Bright Pattern integrates with both IBM Watson Assistant (Conversation) (legacy version) and IBM Watson Assistant (latest version). | Bright Pattern integrates with both IBM Watson Assistant (Conversation) (legacy version) and IBM Watson Assistant (latest version). | ||
| − | |||
In this article, you will learn how to set up your Watson Assistant (Conversation) integration account and edit its properties. | In this article, you will learn how to set up your Watson Assistant (Conversation) integration account and edit its properties. | ||
| − | == Procedure == | + | == Procedure == |
=== Step 1: Add integration account === | === Step 1: Add integration account === | ||
[[Tutorials-for-admins/HowtoAddBotChatSuggestionsEngine | Add a bot/chat suggestions engine integration account]], and select type '''Watson Assistant (Conversation)'''. | [[Tutorials-for-admins/HowtoAddBotChatSuggestionsEngine | Add a bot/chat suggestions engine integration account]], and select type '''Watson Assistant (Conversation)'''. | ||
| − | === Step 2: Edit properties === | + | === Step 2: Edit properties === |
In the Properties dialog, enter the credentials of your IBM Watson Assistant (Conversation) bot instance as follows. This allows Bright Pattern to access your bot and use it in chat interactions. | In the Properties dialog, enter the credentials of your IBM Watson Assistant (Conversation) bot instance as follows. This allows Bright Pattern to access your bot and use it in chat interactions. | ||
| − | |||
[[File:Watson-Conversation-Properties-53.PNG|450px|thumbnail|center|Watson Assistant (Conversation) bot/chat suggestions engine integration account properties]] | [[File:Watson-Conversation-Properties-53.PNG|450px|thumbnail|center|Watson Assistant (Conversation) bot/chat suggestions engine integration account properties]] | ||
| − | ==== Name ==== | + | ==== Name ==== |
The unique name of this integration account (any). | The unique name of this integration account (any). | ||
| − | ==== Type ==== | + | ==== Type ==== |
By default, the type is “Watson Assistant (Conversation)” because you selected this type when adding the account. | By default, the type is “Watson Assistant (Conversation)” because you selected this type when adding the account. | ||
| − | ==== Url ==== | + | ==== Url ==== |
The endpoint of your Watson Assistant Skill in the following format: '''<Legacy v1 Workspace URL>?version=2017-05-26''' | 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/12a3ab45-b12b-1234-12a3-12d34aebe56c/message?version=2017-05-26''' | '''https://gateway.watsonplatform.net/assistant/api/v1/workspaces/12a3ab45-b12b-1234-12a3-12d34aebe56c/message?version=2017-05-26''' | ||
| − | |||
# To find the Legacy v1 Workspace URL, go to ''IBM Watson Assistant (Conversation) > Skills'', click on the desired skill’s '''Actions''' button, and select '''View API details'''.<br /><br />[[File:Watson-Assistant-Skills1-53.PNG|thumb|800px|center|IBM Watson Assistant > Skills]]<br /><br /> | # To find the Legacy v1 Workspace URL, go to ''IBM Watson Assistant (Conversation) > Skills'', click on the desired skill’s '''Actions''' button, and select '''View API details'''.<br /><br />[[File:Watson-Assistant-Skills1-53.PNG|thumb|800px|center|IBM Watson Assistant > Skills]]<br /><br /> | ||
# On the page that opens, copy your '''Legacy v1 Workspace URL'''.<br /><br />[[File:WatsonNew5b.png|thumb|800px|center|Copy your Legacy v1 Workspace URL]] | # On the page that opens, copy your '''Legacy v1 Workspace URL'''.<br /><br />[[File:WatsonNew5b.png|thumb|800px|center|Copy your Legacy v1 Workspace URL]] | ||
| − | ==== Workspace ID ==== | + | ==== 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. | 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'', 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'', 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 /> | ||
# On the page that opens, copy your '''workspace ID'''.<br /><br />[[File:Watson-Legacy-Skillsb.png|thumb|800px|center|Copy your workspace ID]] | # On the page that opens, copy your '''workspace ID'''.<br /><br />[[File:Watson-Legacy-Skillsb.png|thumb|800px|center|Copy your workspace ID]] | ||
| − | ==== Username ==== | + | ==== Username ==== |
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 ''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. | ||
| − | ==== Password ==== | + | ==== Password ==== |
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. | 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. | ||
| − | ==== Max API calls per day ==== | + | ==== 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. | 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 ==== |
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 (Conversation). | Click to be sure Bright Pattern Contact Center can connect to your Watson Assistant (Conversation). | ||
| − | |||
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." | ||
| − | === Step 3: Save properties === | + | === Step 3: Save properties === |
Click '''Apply''' at the bottom of the screen to save your account properties. Your Watson Assistant (Conversation) integration configuration is now complete. | Click '''Apply''' at the bottom of the screen to save your account properties. Your Watson Assistant (Conversation) integration configuration is now complete. | ||
| − | == Recommended Reading == | + | == Recommended Reading == |
For more information on Watson Assistant, see: | For more information on Watson Assistant, 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]] | ||
| − | |||
* [[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]] | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
Latest revision as of 04:14, 29 May 2024
Set up a Watson Assistant (Conversation) Integration Account
Integrations with IBM Watson Assistant (formerly Conversation) are enabled through integration accounts, which store the credentials of third-party services so that Bright Pattern Contact Center can access and work with them.
Bright Pattern integrates with both IBM Watson Assistant (Conversation) (legacy version) and IBM Watson Assistant (latest version).
In this article, you will learn how to set up your Watson Assistant (Conversation) integration account and edit its properties.
Procedure
Step 1: Add integration account
Add a bot/chat suggestions engine integration account, and select type Watson Assistant (Conversation).
Step 2: Edit properties
In the Properties dialog, enter the credentials of your IBM Watson Assistant (Conversation) bot instance as follows. This allows Bright Pattern to access your bot and use it in chat interactions.
Name
The unique name of this integration account (any).
Type
By default, the type is “Watson Assistant (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:
- To find the Legacy v1 Workspace URL, go to IBM Watson Assistant (Conversation) > Skills, click on the desired skill’s Actions button, and select View API details.
- On the page that opens, copy your Legacy v1 Workspace URL.
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.
- To find this ID, go to IBM Watson Assistant > Skills, click on the desired skill’s Actions button, and select View API details.
- On the page that opens, copy your workspace ID.
Username
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.
Password
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.
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).
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."
Step 3: Save properties
Click Apply at the bottom of the screen to save your account properties. Your Watson Assistant (Conversation) integration configuration is now complete.
Recommended Reading
For more information on Watson Assistant, see: