かたらいお試しAPIの利用方法

ボットエディタでかたらいお試しAPIを利用する方法をご確認いただけます。

ご注意
かたらいお試しAPIはSUNABAにて、非商用目的でのみ利用可能なAPIです。

商用目的での利用をご検討の場合は、ドコモが提供するkataraiにご契約いただく必要があります。
ドコモAIエージェントAPIでかたらいを利用する場合も、別途ご契約が必要です。

設定手順

以下の手順で、かたらいお試しAPIを設定します。

ボットを追加

操作手順

  1. ボットエディタにログインしてください。
  2. ボット管理画面で新規ボットを追加してください。
    追加時の設定値は任意で設定してください。

     

    詳細な手順は、マニュアルをご覧ください。

シナリオを追加

操作手順

  1. シナリオ編集画面で新規シナリオを追加してください。
    追加時の設定値は任意のシナリオIDとシナリオ名を入力し、「かたらいお試しシナリオ」テンプレートを選択してください。

    詳細な手順は、マニュアルをご覧ください。

APIキーの発行

操作手順

  1. 画面右上のアカウントアイコンからマイページ(1)を選択してください。
  2. お試し利用APIのAPIキー発行(1)を押下してください。
  3. APIキー発行後、かたらいAPIの有効化する(1)を押してください。
    ポイント
    • 有効化することにより、発行されたAPIキーでかたらいAPIにアクセスできるようになります。
    • 発行されたAPIキーで初回アクセスした日時から有効期限が過ぎると、かたらいAPIにアクセスできなくなります。

APIキーの設定

操作手順

  1. 作成したシナリオのGUIエディタ編集を押下し、GUIエディタ画面を表示してください。
    GUIエディタの使い方については、マニュアルをご覧ください。
    ポイント
    「かたらいお試しシナリオ」テンプレートを選択して作成したシナリオには、かたらいお試しAPIとの対話に必要なシナリオが用意されています。
  2. 外部API連携ボックス(1)を選択し、メニューからリクエスト情報タブ(2)を選択してください。
  3. 「リクエストヘッダーを指定してください」のx-api-keyに有効化したAPIキーを設定してください。
    外部API連携ボックスの詳しい設定内容については、こちらをご覧ください。
    ご注意
    2つの外部API連携ボックスに設定するAPIキーは、同一のものを指定してください。
  4. 保存して公開を押下し、シナリオを保存してください。

動作確認

操作手順

  1. 再度、シナリオ編集画面を表示し、作成したシナリオをデプロイしてください。
    詳細な手順は、マニュアルをご覧ください。
  2. メニューからAPIコンソール(1)を選択し、作成したシナリオをプルダウン(2)から選択してください。
  3. 発話入力欄(1)にメッセージを入力し、送信(2)を押下してください。
    ボットの案内に従っていただくことで、かたらいとお話ができます。