製品をチェック

製品の詳細・30日間の無償トライアルはこちら

CData API Server

お困りの点はございませんか？

類似の事例やソリューションを探す

データ連携のスペシャリストにご相談ください

SingleStore 連携について相談する

SingleStore のデータをAI アシスタントのPEP から利用する方法

AI アシスタントPEP から SingleStore のデータに連携し、チャットボットでリアルタイムSingleStore のデータを使う方法

杉本和也
リードエンジニア
最終更新日：2022-06-24

この記事で実現できるSingleStore 連携のシナリオ

CData

こんにちは！リードエンジニアの杉本です。

CData API Server と ADO.NET Provider / JDBC Driver for SingleStore を使って、AI アシスタントPEP(https://pep.work/) から SingleStore に接続して、チャットボットでリアルタイムSingleStoreデータを使った応答を可能にする方法を説明します。

API Server の設定

次のステップに従い、セキュアな REST API サービスを立ち上げます

デプロイ

API Server はサーバー上で稼働します。Windows 版は、製品に組み込まれているスタンドアロンのサーバーかIIS に配置して稼働させることができます。Java 版では、Java servlet コンテナにAPI Server のWAR ファイルを配置します。デプロイの詳細は製品ヘルプを参照してください。API Server を Microsoft Azure、 Amazon EC2、Heroku にデプロイする方法はKB に記事があります。

SingleStore への接続

API Server の管理コンソールで［設定］→［接続］から新しい接続を追加してSingleStore を追加します。

SingleStore のアイコンがデフォルトのAPI Server の接続先にない場合には、API Server がJava 版の場合はJDBC Drivers、API Server がWindows 版の場合はADO.NET Data ProvidersからSingleStore ドライバーをAPI Server と同じマシンにインストールして、API Server を再起動します。

SingleStore への接続に必要な認証情報を入力します。接続のテストを行い、接続を確認して、設定を保存します。

データに接続するには、次の接続プロパティが必要です。

Server：SingleStore データベースをホスティングしているサーバーのホスト名またはIP アドレス。
Port：SingleStore データベースをホスティングしているサーバーのポート。

また、オプションで以下を設定することもできます。

SingleStore：SingleStore Server に接続する場合のデフォルトデータベース。設定されていない場合、すべてのデータベースのテーブルが返されます。

標準認証

標準認証で認証するには、次を設定します。

User：SingleStore サーバーに認証する際に使われるユーザー。
Password：SingleStore サーバーに認証する際に使われるパスワード。

統合セキュリティを使用した接続

標準のユーザー名とパスワードを提供する代わりに、Windows 認証を介して信頼されたされたユーザーをサーバーに認証できます。

SSL 認証

SSL 認証を活用してセキュアなセッションを介してSingleStore データに接続できます。次の接続プロパティを設定し、データに接続します。

SSLClientCert：クライアント証明書のための証明書ストア名に設定。クライアントとサーバーの両方のマシンでトラストストアとキーストアが保持される2-way SSL の場合に使用されます。
SSLClientCertPassword：クライアント証明書ストアがパスワードで保護されている場合、この値をストアのパスワードに設定します。
SSLClientCertSubject：TLS/SSL クライアント証明書のサブジェクト。ストア内の証明書を検索するために使用されます。
SSLClientCertType：クライアントストアの証明書タイプ。
SSLServerCert：サーバーが受け入れ可能な証明書。

SSH 認証

SSH を使用して、セキュアにリモートマシンにログインできます。SingleStore データにSSH 経由でアクセスするには、次の接続プロパティを設定します。

SSHClientCert：クライアント証明書のための証明書ストア名に設定。
SSHClientCertPassword：クライアント証明書ストアがパスワードで保護されている場合、この値をストアのパスワードに設定します。
SSHClientCertSubject：TLS/SSL クライアント証明書のサブジェクト。ストア内の証明書を検索するために使用されます。
SSHClientCertType：クライアントストアの証明書タイプ。
SSHPassword：SSH サーバーに認証するためのパスワード。
SSHPort：SSH 操作に使用するポート。
SSHServer：認証しようとしているSSH 認証サーバー。
SSHServerFingerPrint：接続先のホストの検証に使用するSSH サーバーのフィンガープリント。
SSHUser：SSH サーバーに認証するためのユーザー名。

接続を確立後、［設定］→［リソース］の画面でからREST API として公開するエンティティを選択します。

API Server のユーザー設定

［設定］→［ユーザー］からAPI にアクセスできるユーザーの認証設定を行います。API Server はトークンでの認証を行うことができます。 IP アドレスでAPI へのアクセスを制限することも可能です。デフォルトではローカルマシンからのアクセスのみが許可されています。SSL の設定も可能です。

オンプレミスDB やファイルからのAPI Server 使用（オプション）

オンプレミスRDB やExcel/CSV などのファイルのデータを使用する場合には、API Server のCloug Gateway / SSH ポートフォワーディングが便利です。是非、Cloud Gatway の設定方法記事を参考にしてください。

PEP でSingleStore のデータをチャットで使う設定

前項まででAPI ができたので、ここからはPEP 側での設定作業です。

PEP でSingleStore のAPI をコールするシナリオを作成

PEP 側ではあらかじめSlack などのアプリケーションを構成しておきます。ここにAPI Server をコールするAI アシスタントのシナリオを追加していきます。

「会話編集」→「シナリオ」に移動し、新しいシナリオを作成します。

シナリオ名を入力します。この例では、条件はSlack Homeを　選択しています。

「新規作成」ボタンをクリックすると、以下のようなシナリオエディタ画面に移動します。これでシナリオを作成する準備ができました。

SingleStore のAPI の接続箇所の設定

具体的にAPI連携を含めたシナリオを作っていきます。

最初に検索したい文字列を受け取るための対話ノードを配置して、以下のように構成します。

ポイントは分岐条件で「以下のすべての会話」、発言内容の記憶で「film_name」として、会話した内容を変数に保存することです。

対話ノードを配置したら、APIノードを追加して、対話ノードから接続していきます。

APIノードでは、以下のように CData API Server　へのリクエストを構成します。
ポイントは2つです。CData API Server は Filter　機能によって、取得するデータを絞り込むことができます。その指定が「$filter=contains(title,'{{ state.scenario_4.form.film_name }}')」の部分です。「{{ state.scenario_4.form.film_name }}」は直前の対話ノードで設定した変数をパラメータとして渡しています。「scenario_4」はPEP　のシナリオIDですので、作成したシナリオに合わせて変更してください。
HTTPヘッダーにAPI Server　のユーザートークンを指定します。
- API名：任意の名前を設定
- URL：http://apiserverurl/api.rsc/film_list?$filter=contains(title,'{{ state.scenario_4.form.film_name }}')
- HTTPメソッド：GET
- Content-Type：JSON
- HTTPヘッダー：キー「x-cdata-authtoken」、値「予め取得したAPI Serverのトークン」を指定

これで保存すると、API　ノードが使えるようになります。

取得したSingleStore からのレスポンスの表示方法

最後に後続の対話ノードを構成し、取得した検索結果を表示します。

対話ノードの応答文には、以下のような文章を埋め込みます。

検索結果は以下のとおりです。

    {% for item in state.scenario_4.api_response.film_search.value %}
    フィルムID：{{ item.FID }}
    タイトル : {{ item.title }}
    値段：{{ item.price }}
    カテゴリー：{{ item.category }}
    俳優： -----

    {% endfor %}

ここでポイントになるのは、API Server　から受け取るJSONのレスポンスの分解方法です。 API Server のレスポンスはオブジェクト直下にvalueという配列要素があり、このレスポンスは「{{state.scenario_4.api_response.film_search.value}}」の形でアクセスできます。
設定イメージ：state.シナリオID.api_response.APIノード名.value
これを「FOR」での繰り返し処理で取得して、文章として表示する仕組みになっています。

これで設定は完了です。実際に動かしてみると、SingleStore →API Server →　PEP　経由でデータを取得して表示していることがわかるかと思います。

CData API Server の無償版およびトライアル

CData API Server は、無償版および30日の無償トライアルがあります。是非、API Server ページから製品をダウンロードしてお試しください。

トライアル・お問い合わせ

30日間無償トライアルで、CData のリアルタイムデータ連携をフルにお試しいただけます。記事や製品についてのご質問があればお気軽にお問い合わせください。

無償トライアルへ

お問い合わせ

ソリューション

サポート

ブログへ →

ナレッジベース