ドコモAIエージェントAPI

よくある質問

お客様からよくいただく質問を下記にまとめました。ぜひご参考ください。FAQでも解決しない場合はこちらから問い合わせください。

よくある質問一覧

カテゴリ Q A
ドコモAIエージェントAPIについて 多言語利用は可能でしょうか。 多言語機能は現在ございません。
雑談用のAPIを使用したいと考えているのですが、
別途お申込みが必要なのでしょうか。		 『かたらい』というAPIを使用する必要がございます。 (ドコモAIエージェントAPIとは別サービスとなっております)
料金について 使い始めるのに料金はかかりますか？ 開発ツールであるAgentcraft®は無料でご利用いただけます。商用目的での利用をお考えの方はお考えの方は、
料金プランのページからご希望のプランを選択して下さい。
FAQチャットボット関連 FAQチャットボットで対話を行おうとすると、「#FAQ_EXACT_TALK」などが返ってきて想定通りの対話ができない。 ・サンプルとして配布しております『FAQConfig.aiml』の「key_acquisition_count」の値が「3」となっていた場合、「1」へと変更ください。
・『FAQTalk.aiml』『FAQConfig.aiml』の格納漏れがないかご確認ください。
・Agentcraft®のボット追加時、「FAQ」を選択ください。
外部API呼び出しとFAQチャットボットの組み合わせは可能ですか。 可能となります。
Agentcraft®関連 Agentcraft®のテスト対話側から初回発話をすることは可能ですか。 Agentcraft®のテスト対話側から発話を開始することはできません。
連携ボット(AIMLファイル)をアップロードしようとすると
「エラーが発生しました。ページの再読込み等で状況が改善しない場合はサポートにご連絡をお願いします。」が表示されてしまう。		 下記のパターンが考えられます。
・AIMLのバージョンが『2.0.0〜2.5.0』でない
・ファイルの文字コードが『UTF-8』でない(set, mapファイルも同様)
・set, mapファイルに重複がある
・AIML構文に誤りがある(SUNABAでご確認ください)
連携ボットからAgentcraft®に値を渡すことは可能ですか。 変数を定義し、「ボットの発話」として値を渡すことで対応可能です。
チャットUI導入関連 各UI連携における、改行方法を教えてください。 こちらのページで各UIに対するコマンド記述方法についてのファイルをアップロードしており、その中に改行コマンドが記載されております。ご確認ください。
（尚、WowTalkにつきましては現在改行記述は出来かねます。）
各UI連携における、UI側からの発話の方法を教えてください。 各UIによって異なります。ご確認ください。

  • WebUI　　　　　　　　『index.html』ファイル内のdata-init-voice-textを設定することで変更可能です。
  • WowTalk　　　　　　　システムからの発話は出来かねます。
  • Microsoft Teams　　　システムからの発話は出来かねます。
  • LINE　　　　　　　　　Developerサイトより、初回発話を設定します。AIML上の設定は不要です。
  • LINE WORKS　　　　　ユーザ発話側から「利用開始」と発話するため、それに合わせたAIMLの設定が必要です。
各UI毎にAIMLが対応できるように変更することは可能ですか。 可能です。既に契約している場合は、別途料金も不要です。
(WebUI)
clientDataは利用可能ですか。		 WebUIではクライアント情報を利用できません。
(Microsoft Teams)
チームではなく、個別チャットでのやりとりは可能でしょうか？		 個別でのチャットを行うことはできません。
(Microsoft Teams)
チームの作成毎に別エージェントの契約が必要となるのでしょうか。		 1チームにつき1エージェントとなるため、別エージェントの契約が必要となります。
辞書関連（シナリオでの対話） 専門用語が多いので、独自の辞書を作成したいのですが作成可能ですか。 可能となります。setファイルもしくは、mapファイルを用いて作成します。
文字の揺らぎには対応していますか。 類義語などを判定できるよう設定可能です。
Agentcraft®で設定する場合はこちらをご覧ください。
連携ボットで設定する場合は、patternタグのlevelを調整することで設定可能となります。詳しくはこちらをご覧ください。
カテゴリ別の辞書は存在しますか？
（食べ物、色　等）		 上位概念語という概念が存在します。
辞書関連（FAQチャットボット） 文字の揺らぎには対応していますか。 ゆらぎに対応しております。こちらでダウンロードしていただく初期シート内にございます。
動詞の揺らぎにつきましては「動詞ゆらぎ辞書」、名詞の揺らぎにつきましては、「専門用語辞書」にて設定が可能です。
対話設計関連 ユーザー発話に対して想定していないパターンにマッチする。 こちらをご確認いただき、展開レベルを下げることをご検討ください。
SPF・NLUの仕様として、VoiceTextに設定してはいけない禁則文字を教えてください。 voice_textについては特に禁則文字は存在しません。
SPF・NLUの仕様として、VoiceTextの有効文字数を教えてください。 200を超える文字数を受け付けますが、有効文字数は200文字です。
発話しても、対話が返ってきません。 下記の可能性がございます。
■音声対話の場合
　・認証に失敗している
　・端末側の音声がミュートになっている
　・playTTS:OFFになっている

■テキスト対話の場合
　・UI連携に誤りがある
　・AIMLのコマンド記述に誤りがある

■その他
　・マネジメントサイトの設定が『Disable』となっている
　・ネットワーク接続環境の悪い場所にいる

マネジメントサイト関連 契約IDはどこで確認できますか。 マネジメントサイトにログインしていただき、画面左側のメニューから「契約参照・更新」をクリックください。
契約基本情報の一番上の項目に、契約IDが記載されております。
マネジメントサイトで確認できる対話アクセス数の更新タイミングを教えてください。 対話アクセス数は月単位で管理されており、月初に初期化され、日次バッチで更新されます。
マネジメントサイトで確認できる対話ログの更新タイミングを教えてください。 対話ログは毎時00分に更新されます。
UDS関連 UDSのログイン画面を介さず、音声対話を行いたい。 個社UDSのご利用をご検討ください。
SDKについて SDKはどこで入手できますか？ 無料でご利用いただけるSDKはこちらで公開しております。有償版の音声制御ライブラリについてはお問い合わせください。
SDKのバージョン番号の付け方についてどうなっていますか？ メジャー番号.マイナー番号.リビジョン番号で構成されており、
リビジョン番号のカウントアップはバグフィックス、
マイナー番号のカウントアップはAPIレベルの下位互換性を保ったままの機能アップ、
メジャー番号は下位互換がなく、APIレベルで変更が生じた場合にカウントアップされます。
音声制御ライブラリにおけるエラーについて エラーコード40101について教えてください。 デバイストークンの取得に失敗している可能性があります。
デバイストークン取得手順について確認してください。
音声制御ライブラリで発生したエラーの詳細を知りたい。 音声制御ライブラリからアプリケーションに通知された異常イベントをご確認ください。
同時接続数上限を超えた場合のエラーについて教えてください。 サーバ側からはエラーコード 01xxx~05000 の websocket系エラー として 返却されています。
エラーコード
1013 (try_again_later)
エラー詳細
Maximum number of connections exceeded client.hpp:696: close code: 1013 (Unknown), close reason: Maximum number of connections exceeded
失効チェック異常（ILLEGAL_CERTIFICATE）について教えてください。 TC接続確立後のOCSP認証の実行時に接続タイムアウトしています。
利用環境の通信速度が著しく低速の場合や、混線している場合などで発生しやすくなります。
音声制御ライブラリのサーバ証明書失効チェック実施有無設定をOFFにし、OCSP認証を実施しないようにすることで対処できます。
エラーコード131について教えてください。 エラーコード131は合成音声再生長が長すぎるため、デバイスSDK内部での音声データバッファが溢れているため発生しています。
SpeakSDKではOggデータ(サンプリングレート22.05kHz)で約47秒分のバッファを持っています。サイズ固定となります。
対処方法としては、1回の合成音再生を約47秒以内に収めて頂きますようお願いいたします。
エラーコード4005について教えてください。 エラーコード4005はTLS handshake timeoutが発生した場合のエラーです。
通信遅延が発生しているため、別のネットワークに接続し、動作するかを確かめてください。
音声制御ライブラリ関連 音声制御ライブラリ利用時、
CommunicationParameterEntityに設定する値を教えてください。		 CommunicationParameterEntityはSPFへの接続情報を設定するパラメータを設定するエンティティです。
以下の値を設定します。
CommunicationParameterEntity("dospf.aiplat.jp", "/ciel", 443, "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx");
詳細は、音声制御ライブラリのIF仕様書をご確認ください。
音声制御ライブラリを利用し、ユーザーの音声発話をテキストとして取得したい。 音声制御ライブラリではユーザーの音声発話を音声認識した結果をNOTIFY_RECOGNIZED_DATAイベントにて取得可能です。
音声制御ライブラリでAIMLからのレスポンスを受け取るイベントが知りたい。 NOTIFY_META_DATA時のeventDataにAIMLからのレスポンスが格納されます。
音声制御ライブラリのSW常時待受機能について教えてください。 音声制御ライブラリのSW常時待ち受け機能とは、ユーザーの特定の音声発話によって音声入力画面を起動する機能です。
音声制御ライブラリを利用し、メタデータを送信したい。 音声制御ライブラリを利用し、メタデータを送信したい場合は、setMetaメソッドをご利用ください。
音声制御ライブラリでは、広告ID(IDFA)を使用していますか。 広告IDは使用しておりません。
ID関連 デバイスIDは変更可能ですか？ Client Secretを使えば再取得は可能ですが、別のデバイスとして認識しますので、デバイスIDは固有番号として利用することをおすすめします。
Client Secretは変更可能ですか？ 変更可能です。その場合、DeviceIDを変更してください
Shadow IDをユーザIDとして利用可能ですか？ 利用可能です。ただし、ShadowIDはBot毎に異なりますので、同じユーザに紐付いていたとしても同じユーザとして識別出来ません。
Device Tokenは再発行可能ですか？ いいえ、出来ません。その場合はDevice IDの再登録が必要になります。
Device Tokenの発行に関して失敗しました。どうすればよいですか？ Device IDをユーザに再登録し、再発行してください。
ユーザ識別が必要ないのですが、DeviceIDやDeviceTokenを利用しなければなりませんか？ テキストチャットボットGWを利用してください。各種IDの発行が不要になります。セッションごとに個別の識別子が発行されます。
発行済DeviceTokenを無効にしたいのですが？ Device IDでDelete Device Token APIを発行してください。削除可能です。
発行済Device IDを削除したいのですが？ Device IDでDelete Device ID APIを発行してください。削除可能です。
Access Tokenの有効期限はユーザがアクセスするたびに延長されますか。 Access Tokenはユーザーのアクセスによって延長されません。
Access Token、Refresh Tokenの有効期限を教えてください。 Access Tokenの有効期限は30日です。Refresh Tokenの有効期限は90日です。
音声認識関連 音声認識がうまくいきません。 音声がきちんと入力されているか、デバイスやアプリでマイクや音声のデバイスが動作しているかを確認してください。
ノイズが多い、サンプリングレートが間違っているなどで音声認識ができないこともあります。
音声認識で間違って認識される 音声の認識に関して近い音の間違った語（同音異義語）として認識されることがあります。音声認識辞書はシステム共通です。
NTTドコモでは新語に対応するために、適宜辞書を更新していますが、特殊な用語に関しては認識できないことがあります。
なお、音声認識の認識結果の判定には前後の文脈で判断するものもありますので、単語の認識ではなく、文として認識するとうまくいくことがあります。
音声認識が安定しない 特定の文や語によっては毎回同じように認識されないなどの問題がある場合があります。
これに関しては、音声認識へのノイズや話者によってもどうしても異なってしまう場合もありますので、
認識結果のログ（認識結果のメタデータ）を見た上でシナリオ側でロジックを複数作ることで吸収できる場合がありますので、そちらをご検討ください。
音声合成関連 音声合成を間違える。間違った読みで読んでしまう。 音声合成は現在のところ個別の読みを与える方法については提供されていませんが、
発話する音声と表示するテキストを変えることで強制的に発話させることが出来るようになっています。
例えば、どうしても読めないブランド名などの発話に関してはカタカナ表記で強制的に発話させ、
画面表示用には正しいブランド表記などで表示させるなどが可能です。音声合成のSDKのドキュメントを参照ください。
音声合成が途切れる。発話にノイズが乗る。発話が変。 発話の再生に問題がある場合は、大きく分けて下記の２通りが考えられます。
①通信品質が極端に悪く、発話できない
②CPU性能が足りていないために音声合成ができない

①に関しては通信の品質を上げる工夫をするなども効果的ですが、バッファリングのパラメータを変更することで
対応可能な場合がありますので、ドキュメントを参照ください。
②に関してはCPUの性能を高いものにするか、発話中に処理を減らすなどの工夫をすることで回避できることがあります。
音声合成の声が変わらない。 常にデフォルトの音声合成になる。 音声合成のキャラクタIDが正しく与えられていないか、KeyIDが間違っているために合成音声モデルを指定できていないと思われます。
発話時のメタデータに合成音声モデル名が記載されていますので、そちらを確認し、モデル名が期待されている値になっているかを確認ください。
音声再生をリピート再生したい。 再生したい文字列を音声制御ライブラリから連携ボットにメタデータとして送信して頂き、連携ボットがその文字列を発話することを検討ください。
200文字以上の長文を合成音声再生したい。 ドコモAIエージェントAPIではリソースの占有を避けるため、200文字を超えるような長文を合成音声再生することは出来ません。
合成音声の音量を変えたい。 合成音声の音量を変更したい場合は、メタデータのspeaker_params.power_rateを変更してください。
ログ関連 ボットのログレベルを変更するときの、ボットプロパティの設定方法を教えてください。 ドコモAIエージェントAPIではログレベルの変更は出来ず、常にDEBUGとなります。
メタデータ(アプリ→エージェント)関連 initTopicIdを指定しても、トピックが変わらない。 initTopicIdはフロントボットにのみ有効で、連携ボットのトピックの変更には利用できません。
AIMLから検証アプリへのレスポンスで使えるコマンドが知りたい。 検証アプリではWebUI向けのコマンドと同じコマンドが利用できます。
cacheFlagについて教えてください。 cacheFlagはメタデータをSPFにキャッシュするか否かの設定値です。 音声対話開始時に
cacheFlagを”true”としたメタデータを送信することで、以降のユーザーの音声発話に常に上記のメタデータを付与することができます。
cacheFlagが”false”の場合はメタデータの送信がユーザーの発話として扱われます。
音声制御ライブラリで音声対話時にメタデータを送信したい。 デバイスSDKを利用し、音声対話時にメタデータを利用したい場合は、音声発話の前にcacheFlagに”true”を設定したメタデータを送信(putMeta)してください。
クライアントからinitTalkingFlag をtrueに設定して動作確認を行ったところ、対話は初期化されず、継続した対話で動作してしまいました。 initTalkingFlagはAPIでアクセスするフロントボットに対してのみ有効です。
連携ボットに対してinitTalkingFlagを使うことはできません。 連携ボットの対話を初期化したい場合は、初期化用のCategoryを作成することを検討ください。
音声制御ライブラリを利用し、合成音声の読み上げをOFFにしたい。 音声制御ライブラリからエージェントに{"deviceInfo":{"playTTS":"off"}としたメタデータを送信してください。
AIMLから音声制御ライブラリへのレスポンスが知りたい。 エージェントのレスポンスに付与されるメタデータついては、メタデータの使い方をご確認ください。
連携ボットのレスポンスにメタデータを付与したい。 エージェントのレスポンスにメタデータを付与したい場合、predstoreタグ内でcommandオブジェクトを利用してください。 詳細はドキュメントサイトの「連携ボットのメタ情報について」をご確認ください。
連携ボットから話者を設定したい。 エージェントのレスポンスのメタデータのspeaker_paramsで話者を設定してください。
メタデータ(エージェント→アプリ)関連 連携ボットで設定したtalkendが音声制御ライブラリで取得できない。 talkendはフロントボットでのみ利用可能で、連携ボットでは利用できません。
検証アプリ関連 iPhoneにインストールした検証アプリでイヤホンが利用できません。 現状、iPhone向けの検証アプリではイヤホンジャックに接続したイヤホンマイクは利用できません。
外部CGS関連 HTTPヘッダを使用しCGSへパラメータを渡したい。 HTTPヘッダにパラメータを含めることはできません。パラメータ情報はボディで連携できるよう対応してください。
回線認証について docomoSIM通信で共通UDSにログインする際、dアカウント認証画面が表示されず、自動的にログインしてしまう。 docomoSIMを入れた端末では、共通UDSにログイン時、dアカウント認証画面が表示されず、回線認証にて自動的に認証完了します。
IPアドレスによる利用制限について エージェント利用ユーザーをIPアドレスで制限したい。 個社UDSを利用し、ユーザー認証時にIPアドレスによる制限を行うことを検討ください。