目次


連載: IBM Watson Workspace #鬼わか アプリケーション開発

第 3 回: IBM Watson Workspace へのアプリ登録 #鬼わか 解説

Comments

コンテンツシリーズ

このコンテンツは全#シリーズのパート#です: 連載: IBM Watson Workspace #鬼わか アプリケーション開発

このシリーズの続きに乞うご期待。

このコンテンツはシリーズの一部分です:連載: IBM Watson Workspace #鬼わか アプリケーション開発

このシリーズの続きに乞うご期待。

1

はじめに

連載: IBM Watson Workspace #鬼わか アプリケーション開発」にアクセスいただきどうもありがとうございます。

新しいソリューションである IBM Watson Workspace (以下、WWS と表記) のアプリケーション開発は敷居が高いかもしれないと感じられた方も多かったかと思います。

しかし、第 2 回の記事を読まれて、連携アプリケーションを開発する際に利用できる API の動作をすぐに確認することができる GraphQL API Explorer が用意されていることがわかり、距離が近くなったのではないでしょうか。

連載第 3 回目となる今回は WWS との連携アプリケーションの登録について #鬼わか 解説をします。

WWS で主に作業する場所を「スペース」と呼びます。管理の観点で考えますと、スペースを新規作成する、スペースに会話したいユーザを招待するといったことができます。

加えて、スペースでアプリケーションを使用するために、そのアプリケーションをスペースに紐付けることができます。この紐付けを行うためにはアプリケーションを IBM Watson Work Services (以下、Watson Work Services と表記) を利用して登録する必要があります。この紐付け作業が今回ご紹介する「登録」です。

それでは、アプリケーション開発の主な流れの中で、アプリケーション登録方法などを実際に見てみましょう!

2

連携アプリケーション開発の流れ

WWS との連携アプリケーションを開発する際、必ず最初のステップとして Watson Work Services を利用しての作業が必要となります。具体的には、これから開発するアプリケーションが WWS と連携可能となるようにアプリケーションを Watson Work Services に登録をすることと、そのアプリケーションが利用するサービスの構成の定義や設定を行うことが必要となります。

連携アプリケーションを開発する際に最初に行わなければならないのが、このアプリケーションの登録になります。Watson Work Services にアプリケーションを登録することで、アプリケーションが WWS に API を利用してアクセスする際に必要となるトークン (認証情報) を取得するためのアプリケーション ID とシークレット (パスワード) を取得できるようになります。

また、Watson Work Services にアプリケーションが登録されると、自身がメンバーとして登録されているスペースに追加可能なアプリケーションの一覧に、登録したアプリケーションがリストされるようになり、実際にスペースに追加することが可能となります。

(注意: スペースの設定によってはユーザーによるアプリケーションの追加が制限されていることがあります。)

Watson Work Services へのアプリケーションの登録が完了すると、次に、そのアプリケーションが利用するサービスの定義と構成を行うことが可能になります。

連携アプリケーションが WWS で発生したイベントをトリガーにアクションを実行したい場合には Webhook の設定、スラッシュコメントを利用したい場合や、IBM Watson Assistant を利用したい場合はそれらの設定を Watson Work Service 上で行うことができるようになっています。

また、開発した連携アプリケーションを第三者に提供するための、アプリケーションの共有も Watson Work Services へのアプリケーション登録の画面から行うことが可能になっています。

それでは、Watson Work Services を利用してのアプリケーションの登録方法や、各サービスを利用する際の設定方法について詳しくみていきましょう。

3

連携アプリケーションの登録方法

ここでは、Watson Work Services へのアプリケーション登録方法と、登録したアプリケーションをスペースに追加する方法を紹介します。

はじめに、Watson Work Services への新規アプリケーション登録方法についてです。

WWS にログインし、左下の設定アイコンをクリックし、[Developers] をクリックします。

 

すると、Watson Work Services のページが開くので、その画面右上のリンク [Your Apps] をクリックすると、あなたが作成したアプリケーションを一覧で確認できます。(初回は何も表示されません)

図 1. Watson Work Services 上でのアプリケーションの一覧

 

[Your Apps] で開いたページで、[Create new app] ボタンを押すと、[Create new app] 画面が開きます。

アプリケーション名とアプリケーションの概要説明を入力して [Create] ボタンを押します。

図 2. アプリケーションの登録画面

 

作成の成功を示す "Success!" というメッセージと共に、アプリケーション ID (App ID) およびアプリケーション・シークレット (App secret) が表示されるので、忘れないようにコピーしてメモ帳などに保存しておきます。App ID や App secret は、今後開発を進める上でアプリケーションを指定して呼び出す際に必要となります。

なお、App secret については今回一度しか表示されないため、確実に保存するようにしてください。万が一、忘れてしまった場合には Watson Work Service で App secret の再発行はできますが、以前のものとは異なるため、既に実装済みのアプリケーションに影響を与える可能性があることに注意してください。

図 3. アプリケーションが登録されて ID と Secret が表示

 

[Got it] ボタンを押すと、Watson Work Services へのアプリケーション登録は完了です。再度、画面右上の [Your Apps] リンクをクリックして、一覧に今回登録したアプリケーションが表示されていることを確認してください。

では次に、Watson Work Services へ登録したアプリケーションをスペースに追加してみましょう。

アプリケーションを追加したいスペースを開き、スペース名の右隣にある歯車アイコンをクリックして、スペース設定画面を開きます。

左メニューの [Apps] リンクをクリックすると、スペースに追加可能なアプリケーションが一覧され、先程登録したアプリケーケーションも表示されますので、そのアプリケーションをクリックします。

図 5. スペースから登録されたアプリケーションを確認

 

登録確認画面が表示されたら [Add App] ボタンを押します。

再度左メニューの [Apps] リンクをクリックし、[Apps Added to Space] タブを選択して、登録したアプリケーションが一覧されていることを確認できれば、Watson Work Services で登録したアプリケーションのスペースへの追加は完了です。

図 6. スペースへのアプリケーションの追加

 

以降、スペースで入力した文字列をもとにアプリケーションで処理を行う、アプリケーションの処理結果をスペースに返す、といったことが可能となります。具体的にどのような連携処理が行えるのか、次章でご説明します。

4

連携アプリで利用する機能を構成する

それではここから、前章で行なったアプリケーションの登録を行うことによってできるようになる 3 つの機能に関して説明します。

その 3 つの機能とは、

  • Webhook
  • Slash Command (スラッシュコマンド)
  • Make It Cognitive (AI 連携)

という機能です!ではそれぞれどのようなものか見ていきましょう。

Webhook

この機能を有効化することによって、連携アプリケーションは WWS のスペース上で発生した様々なイベントを取得することが可能になります。

Webhook がサポートするイベントの一覧

  • message-created
    スペースにメッセージが投稿されたというイベントを取得しまます
  • message-deleted
    スペースのメッセージが削除されたというイベントを取得しまます
  • space-members-added
    スペースにメンバーが追加されたというイベントを取得しますす
  • space-members-removed
    スペースからメンバーが削除されたというイベントを取得しまます
  • space-updated
    スペースの設定が変更されたというイベントを取得します
  • space-deleted
    スペースが削除されたというイベントを取得します
  • message-annotation-added
    投稿したメッセージに annotation が付与されたというイベントを取得します
  • message-annotation-edited
    メッセージに付与されている annotation が変更されたというイベントを取得します
  • message-annotation-removed
    メッセージに付与されている annotation が削除されたというイベントを取得します
  • reaction-added
    メッセージに対してリアクションが送られたというイベントを取得します
  • reaction-removed
    メッセージに対してされているリアクションが削除されたというイベントを取得します

例えば、message-created のイベントを取得するように設定しておくと、ユーザーの問いかけに対して自動で応答するチャットボットのようなアプリを作成できるようになります。

Slash Command

この機能を有効化することによって、スペース内のメッセージを投稿するテキストエリアに "/" を打ち込むと対象のアプリを呼び出すことができるようになります。

また、単に呼び出すだけではなく、引数をセットすることも可能なため、渡した引数によって動きが変化するアプリを作りたいときはこの機能を試してみるといいかもしれません!

Make It Cognitive

この機能は、IBM Cloud 上で利用できる Watson Assistant (旧 Watson Conversation) という API を利用します。

この機能を利用するためには、Watson Assistant のクレデンシャル情報を入力することが必要です。

この機能を有効化することによって、アプリケーションを追加した先のスペース内でやり取りされるメッセージは全てこの Watson Assistant に連携されるようになり、各メッセージに Intents が判別されます。Intents が true の場合、投稿したメッセージに annotation という形でメタデータが付与されます。これによって WWS 内で利用できる特徴的な機能である Moment 機能や、Actions Fulfillment 機能を利用することが可能となります。

(Moment 機能や、Actions Fulfillment 機能に関しては後日詳しく説明します!)

5

まとめ

今回は WWS の開発準備をするためにアプリケーションを登録する方法についてご紹介しました。

WWS の連携アプリケーション開発の流れを理解いただいた上で、実際どのようにして IBM Watson Work Services へアプリケーションを登録するのかを解説しています。

最後に、この登録作業の結果利用できるようになる Webhook、Slash Command、Make It Cognitive の説明を加えました。是非、試してみてください。

この記事に「いいね!」と感じた方は、ハッシュタグ「 #鬼わか 」をつけて是非共有してください。

次回は、Node-RED を使ったチャットボットの作り方について鬼わかりやすくご紹介したいと思います。お楽しみに!


ダウンロード可能なリソース


関連トピック


コメント

コメントを登録するにはサインインあるいは登録してください。

static.content.url=http://www.ibm.com/developerworks/js/artrating/
SITE_ID=60
Zone=Lotus
ArticleID=1060927
ArticleTitle=連載: IBM Watson Workspace #鬼わか アプリケーション開発: 第 3 回: IBM Watson Workspace へのアプリ登録 #鬼わか 解説
publish-date=05182018