提供: Bright Pattern Documentation
移動先: 案内検索
(Created page with "以前は、Watson AssistantはWatson Conversationと呼ばれ、そのWatson Conversationの認証情報にはユーザー名とパスワードが含まれていました。...")
 
(31 intermediate revisions by the same user not shown)
Line 7: Line 7:
 
以前は、Watson AssistantはWatson Conversationと呼ばれ、そのWatson Conversationの認証情報にはユーザー名とパスワードが含まれていました。 IBMはWatson Assistantという名前に変更し、ユーザー名とパスワードの情報をAPIキーに置き換えました。互換性を確保するために、統合アカウントは両方のタイプのボットに対応します。
 
以前は、Watson AssistantはWatson Conversationと呼ばれ、そのWatson Conversationの認証情報にはユーザー名とパスワードが含まれていました。 IBMはWatson Assistantという名前に変更し、ユーザー名とパスワードの情報をAPIキーに置き換えました。互換性を確保するために、統合アカウントは両方のタイプのボットに対応します。
  
In this article, you will learn how to set up your Watson Assistant integration account and edit its properties.
+
この記事では、 Watson Assistant 統合の設定方法、そのプロパティの編集方法について説明します。
  
== Procedure ==
+
==手順 ==
=== Step 1: Add integration account ===
+
=== ステップ 1: 統合アカウントを追加します。 ===
[[Tutorials-for-admins/HowtoAddBotChatSuggestionsEngine |  Add a bot/chat suggestions engine integration account]], and select type '''Watson Assistant'''.
+
[[Tutorials-for-admins/HowtoAddBotChatSuggestionsEngine |  ボット/チャットサジェスト機能エンジン統合アカウントを追加]]し、'''Watson Assistant'''を選択します。
  
  
[[File:Add-Bot-Account-1-53.PNG|450px|thumbnail|center|Bot/chat suggestions engine integration account types]]
+
[[File:Add-Bot-Account-1-53.PNG|450px|thumbnail|center|ボット/チャットサジェスト機能エンジン統合アカウントのタイプ]]
  
  
=== Step 2: Edit properties ===
+
=== ステップ 2: プロパティを編集します。 ===
In the Properties dialog, enter the credentials of your IBM Watson Assistant bot instance as follows. This allows Bright Pattern to access your bot and use it in chat interactions.
+
プロパティダイアログでは、お持ちの  IBM Watson Assistant ボットの認証情報を以下の通りに入力します。そうすることで、Bright Patternが ボットにアクセスし、チャット対話で使用できます。
  
  
[[File:Watson-Assistant-1-53.PNG|450px|thumbnail|center|Watson Assistant bot/chat suggestions engine integration account properties]]
+
[[File:Watson-Assistant-1-53.PNG|450px|thumbnail|center|Watson Assistant ボット/チャットサジェスト機能エンジン統合アカウントのプロパティ]]
  
  
==== 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.
+
アカウントを追加するときに“Watson Assistant”というタイプが選択されたため、既定のタイプも“Watson Assistant ”です。
  
  
==== Url ====
+
==== Url ====  
The endpoint of your Watson Assistant Skill in the following format: '''<Legacy v1 Workspace URL>?version=2017-05-26'''
+
以下のフォーマットで表示されるWatson Assistant スキルのエンドポイントです : '''<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'''
 
'''https://gateway.watsonplatform.net/assistant/api/v1/workspaces/12a3ab45-b12b-1234-12a3-12d34aebe56c/message?version=2017-05-26'''
  
  
# 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 />
+
# URLは、 ''スキル > マイ・スキル> オプション > API詳細の確認''で取得できます。<br /><br />[[File:Watson-Skill-URL2-53.png|center|thumb|800px|IBM> Watson スキル >オプション > API 詳細の確認]]<br /><br />
# 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 />
+
# 開いた''スキルの詳細''ページで、'''Legacy v1 Workspace URL'''をコピーします。<br /><br />[[File:Watson-Skill-API-Details-b-54.png|thumb|800px|center|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 />
+
# URLの末尾に'''?version 2017-05-26'''を付けます。例:<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.
+
統合アカウントでは、/messageメソッドを使ったV1ランタイムAPI へのリクエストが可能です。このメソッドの場合、ユーザーによる入力がWatson Assistantに送信され、返信が返されます。 /messageメソッドを使ったV2ランタイムAPIへのリクエストも可能です。
  
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.
+
APIリクエストには、''version=YYYY-MM-DD''というフォーマットの日付を使ったバージョンパラメーターが必要です。この統合では、/message ''version=2017-05-26''が使われています。このバージョンの日付はIBM Cloudによって指定された現行のバージョンと一致しない場合があります。しかし、Bright Patternアプリケーションと互換性があるため、このバージョンは当社の統合に使われる正しいものです。
  
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.
+
バージョンパラメータがURLプロパティの末尾に付くと、統合されたWatson AssistantがBright Patternチャットサービスで使用されるたびに、適切なバージョンがすべてのAPIリクエストに付きます。
  
  
==== Workspace ID ====
+
==== ワークスペース 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.
+
Watson Assistant (Conversation) のスキル (つまり、インスタンス)の識別番号(文字列)です。 IBM Watsonの場合、スキルはワークスペースと呼ばれています。
  
# 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 />
+
# IDは、 ''スキル > マイ・スキル> オプション > API詳細の確認''で取得できます。<br /><br />[[File:Watson-Skill-URL2-53.png|center|thumb|800px|IBM> Watson スキル >オプション > API 詳細の確認]]<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]]
+
# 開いた''スキルの詳細''ページで、'''ワークスペースID'''をコピーします。<br /><br />[[File:WatsonNew5b.png|thumb|800px|center|ワークスペースIDのコピー]]
  
  
==== API Key ====
+
==== API キー ====
The API Key (string) used to authenticate the service (e.g., “EEE-MTX13ZS1Ta4pD8qO4rmGP_SXR7HPB8IAAnPgTwKV”).
+
サービスの認証手続きに使われるAPIキー (文字列) です (例:“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 />
+
APIキーは、 ''スキル > マイ・スキル> オプション > API詳細の確認''で取得できます。<br /><br />[[File:Watson-Skill-URL2-53.png|center|thumb|800px|IBM> Watson スキル >オプション > API 詳細の確認]]<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]]
+
# 開いた''スキルの詳細''ページで、'''APIキー'''をコピーします。<br /><br />[[File:WatsonNew5b.png|thumb|800px|center|APIキーのコピー]]
  
The API key is either auto-generated for you or created manually in IBM Cloud.
+
APIキーは、自動生成されるか、IBM Cloudで手動で生成されます。
  
  
===== How to Create a New Key =====
+
===== 新しいキーの生成方法 =====
# Go to IBM's website and navigate to ''IBM Cloud > Access (IAM) > IBM Cloud API Keys''.<br /><br />
+
# IBMのウェブサイトの''IBM Cloud > アクセス (IAM) > IBM Cloud API キー''を開きます。<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 />
+
# '''IBM Cloud APIキーの生成'''をクリックします。<br /><br />[[File:IBM-Cloud-API-Key1-53.PNG|thumb|800px|center|IBM Cloud APIキー]]<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 />
+
# ''' API キーの生成'''ダイアログで名前と説明を追加します。<br /><br />[[File:IBM-Cloud-Create-Key2-53.PNG|thumb|450px|center|API キーの生成]]<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]]
+
#APIキーは一度しか表示されないため、ダウンロードして保存します。<br /><br />[[File:IBM-Cloud-Key2-53.PNG|thumb|650px|center|APIキーの生成]]
  
  
==== Max API calls per day ====
+
==== 1日あたりのAPIコールの最大件数 ====
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.
+
毎日発信できるコールの最大件数です。この制限は、無料アカウントに含まれている1000件以降のコールに対して追加料金が課されないようにするためのものです。
  
  
==== 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.
+
サジェストの最大件数(例:3)は、アクティブなチャット中にエージェントデスクトップに配信できるサジェストの最大件数です。サジェストは、エージェントがチャット中に選択して使用できるボットからの返信です。
  
  
==== Test Connection ====
+
==== 接続テスト ====
Click to be sure Bright Pattern Contact Center can connect to your Watson Assistant.
+
クリックして、Bright Pattern コンタクトセンターが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."
+
認証情報が無効な場合は、Urlプロパティに戻り、それらを正しく入力したことを確認してください。"アカウントの認証情報は有効です"というダイアログが表示されるまでテストします。
  
=== Step 3: Save properties ===
+
=== ステップ 3: プロパティを保存します。 ===
Click '''Apply''' at the bottom of the screen to save your account properties. Your Watson Assistant integration configuration is now complete.
+
画面の下部にある'''適用'''をクリックして、アカウントのプロパティを保存します。これで、Watson Assistant 統合設定が完了しました。
  
== Recommended Reading ==
+
== 参考書 ==
For more information on Watson Assistant, see:
+
Watson Assistantに関する詳しい情報:
* [[5.3:Tutorials-for-admins/HowtoCreateWatsonAssistant |  How to Create a Watson Assistant]]
+
* [[5.3:Tutorials-for-admins/HowtoCreateWatsonAssistant |  Watson Assistantの作成方法]]
  
* [[5.3:Contact-center-administrator-guide/HowtoIntegrateBotswithChat | How to Integrate Bots with Chat]]
+
* [[5.3:Contact-center-administrator-guide/HowtoIntegrateBotswithChat | ボットとチャットの統合方法]]

Latest revision as of 17:41, 10 April 2020

• English
• 5.19 • 5.3 • 5.8

Watson Assistant統合アカウントの設定

IBM Watson Assistantとの統合は、 統合アカウントを通じて有効になります。これらの統合アカウントには、サードパーティサービスの認証情報が保存されており、Bright Pattern コンタクトセンターがその情報にアクセスして操作できます。

Watson名に関するご注意

Bright Patternは、IBM Watson Assistant (Conversation) (旧バージョン) と IBM Watson Assistant (最新バージョン)と統合できます。

以前は、Watson AssistantはWatson Conversationと呼ばれ、そのWatson Conversationの認証情報にはユーザー名とパスワードが含まれていました。 IBMはWatson Assistantという名前に変更し、ユーザー名とパスワードの情報をAPIキーに置き換えました。互換性を確保するために、統合アカウントは両方のタイプのボットに対応します。

この記事では、 Watson Assistant 統合の設定方法、そのプロパティの編集方法について説明します。

手順

ステップ 1: 統合アカウントを追加します。

ボット/チャットサジェスト機能エンジン統合アカウントを追加し、Watson Assistantを選択します。


ボット/チャットサジェスト機能エンジン統合アカウントのタイプ


ステップ 2: プロパティを編集します。

プロパティダイアログでは、お持ちの IBM Watson Assistant ボットの認証情報を以下の通りに入力します。そうすることで、Bright Patternが ボットにアクセスし、チャット対話で使用できます。


Watson Assistant ボット/チャットサジェスト機能エンジン統合アカウントのプロパティ


アカウント名

この統合アカウントのユニークな名前です。


タイプ

アカウントを追加するときに“Watson Assistant”というタイプが選択されたため、既定のタイプも“Watson Assistant ”です。


Url

以下のフォーマットで表示されるWatson Assistant スキルのエンドポイントです : <Legacy v1 Workspace URL>?version=2017-05-26

例:

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


  1. URLは、 スキル > マイ・スキル> オプション > API詳細の確認で取得できます。

    IBM> Watson スキル >オプション > API 詳細の確認


  2. 開いたスキルの詳細ページで、Legacy v1 Workspace URLをコピーします。

    Legacy v1 Workspace URLのコピー


  3. URLの末尾に?version 2017-05-26を付けます。例:

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

この操作を行う理由とは:

統合アカウントでは、/messageメソッドを使ったV1ランタイムAPI へのリクエストが可能です。このメソッドの場合、ユーザーによる入力がWatson Assistantに送信され、返信が返されます。 /messageメソッドを使ったV2ランタイムAPIへのリクエストも可能です。

APIリクエストには、version=YYYY-MM-DDというフォーマットの日付を使ったバージョンパラメーターが必要です。この統合では、/message version=2017-05-26が使われています。このバージョンの日付はIBM Cloudによって指定された現行のバージョンと一致しない場合があります。しかし、Bright Patternアプリケーションと互換性があるため、このバージョンは当社の統合に使われる正しいものです。

バージョンパラメータがURLプロパティの末尾に付くと、統合されたWatson AssistantがBright Patternチャットサービスで使用されるたびに、適切なバージョンがすべてのAPIリクエストに付きます。


ワークスペース ID

Watson Assistant (Conversation) のスキル (つまり、インスタンス)の識別番号(文字列)です。 IBM Watsonの場合、スキルはワークスペースと呼ばれています。

  1. IDは、 スキル > マイ・スキル> オプション > API詳細の確認で取得できます。

    IBM> Watson スキル >オプション > API 詳細の確認


  2. 開いたスキルの詳細ページで、ワークスペースIDをコピーします。

    ワークスペースIDのコピー


API キー

サービスの認証手続きに使われるAPIキー (文字列) です (例:“EEE-MTX13ZS1Ta4pD8qO4rmGP_SXR7HPB8IAAnPgTwKV”).

APIキーは、 スキル > マイ・スキル> オプション > API詳細の確認で取得できます。

IBM> Watson スキル >オプション > API 詳細の確認



  1. 開いたスキルの詳細ページで、APIキーをコピーします。

    APIキーのコピー

APIキーは、自動生成されるか、IBM Cloudで手動で生成されます。


新しいキーの生成方法
  1. IBMのウェブサイトのIBM Cloud > アクセス (IAM) > IBM Cloud API キーを開きます。

  2. IBM Cloud APIキーの生成をクリックします。

    IBM Cloud APIキー


  3. API キーの生成ダイアログで名前と説明を追加します。

    API キーの生成


  4. APIキーは一度しか表示されないため、ダウンロードして保存します。

    APIキーの生成


1日あたりのAPIコールの最大件数

毎日発信できるコールの最大件数です。この制限は、無料アカウントに含まれている1000件以降のコールに対して追加料金が課されないようにするためのものです。


サジェストの最大件数

サジェストの最大件数(例:3)は、アクティブなチャット中にエージェントデスクトップに配信できるサジェストの最大件数です。サジェストは、エージェントがチャット中に選択して使用できるボットからの返信です。


接続テスト

クリックして、Bright Pattern コンタクトセンターがWatson Assistant に接続できることを確認します。

認証情報が無効な場合は、Urlプロパティに戻り、それらを正しく入力したことを確認してください。"アカウントの認証情報は有効です"というダイアログが表示されるまでテストします。

ステップ 3: プロパティを保存します。

画面の下部にある適用をクリックして、アカウントのプロパティを保存します。これで、Watson Assistant 統合設定が完了しました。

参考書

Watson Assistantに関する詳しい情報: