インターフェース仕様書/開発ガイド
ドコモAIエージェントAPIと接続するアプリケーションの開発を行う上で必要となるインターフェース仕様書や開発ガイドラインを以下に公開致します。
開発を行うアプリケーションの用途に応じて必要な機能のインターフェース仕様書をダウンロードしてご利用ください。
インターフェース仕様書
ドコモAIエージェントAPIのインターフェース仕様書となります。
APIリファレンス
ドコモAIエージェントAPIのリファレンスとなります。
個人情報を含むシナリオ対話の取り扱いについて
2020年12月機能リリースにより、個人情報を含んだシナリオ対話を作成することが可能となっています。
個人情報を含む対話シナリオの構築方法についてはこちらのドキュメントをご参照ください。
また、「個人情報を含む対話の取り扱い機能」におきまして、個人情報を格納する場合は「暗号化CGS」を使用する必要がございます。
暗号化CGSの使用方法についてはこちらをご覧ください。
テキストチャットUI共通の記載形式の共通化について
WebUIやLINE等サービスで標準で対応している各種UIについて、ボタンやカルー
セルなどの記述方式について、記載を統一した形式を提供しております。
こちらの形式を利用する事で、同じ対話シナリオであれば1つの統一した記載で対
応が可能となります。
＜対象UI＞
・Webサイト：WebUI
・チャットツール：LINE、LINE WORKS、Microsoft Teams、 WowTalk
＜利用方法＞
・ 「balloonコマンドの記述方法について」をご確認ください。
前回発話の保存時間の変更について
前回のシステム発話情報を確認して対話の分岐を行う場合などのために、前回のシステム発話情報を保持しています。
2020年12月10日の個人情報を含む対話の取り扱い機能リリース時に、対話保持時間を5分間へ設定しました。
2021年12月16日より、その保持時間を24時間へ延長いたしました。
変更前：前回発話から5分間発話情報を保持
変更後：前回発話から24時間発話情報を保持
音声制御ライブラリ仕様概要
音声制御ライブラリの機能概要を記載したドキュメントとなります。
本ドキュメントに記載されている内容よりもより詳細な仕様や情報については、音声制御ライブラリご契約後に開示させていただきますので、ご了承ください。
音声制御ライブラリのエラー・パラメータ一覧
音声制御ライブラリのパラメータとなります。
音声制御ライブラリのエラー一覧です。
音声制御ライブラリ開発リファレンス
音声制御ライブラリを利用してのアプリ開発時にご利用いただけるリファレンスとなります。
音声制御ライブラリの詳細組込手順
音声制御ライブラリを利用してのアプリ開発時にご利用いただける詳細な組込手順となります。
デバイスSDK
デバイスSDKの仕様書及びSDKファイル、デバイスSDKを利用したサンプルアプリを提供しております。
提供を希望される方は利用規約をご確認のうえ、申込書に記入しメールでお送りください。
申込先メールアドレス：d-aiagapi-houjin-ml@ntt.com
※提供後の技術的お問い合わせやサポートは、有償サポートご契約者様のみ受け付けております、予めご了承ください。
対象OS又はプログラミング言語は下記となっております。
- Android
- iOS
- Python
- C++
- Unity
- Javascript
バージョンアップ履歴
更新日：2021年9月30日
Android、iOS、Python、C++、Unityのバージョンアップ履歴はこちら
Javascriptの過去のバージョンアップ履歴はこちら
※最新バージョンのデバイスSDKの提供を希望される方は、申込書に記入しメールでお送りください。
申込先メールアドレス：d-aiagapi-houjin-ml@ntt.com
チュートリアル
デバイスSDKを活用したチュートリアルを公開しています。
エージェント作成チュートリアル ~Python SDK編~
（pdfはこちら, pptxはこちら）
エージェント作成チュートリアル ~Android SDK編~
（pdfはこちら, pptxはこちら）
エージェント作成チュートリアル ~UnitySDK編~
（pdfはこちら）※2020.3.30更新
エージェント作成チュートリアル ~JavascriptSDK編~
（pdfはこちら）
ログ整形ツール
出力したログをExcelで利用できるCSV形式へ整形するログ整形ツールの利用マニュアルになります。
ログ整形ツールマニュアル
ログ整形ツールをご希望の方は、オプション申込書にてお申込みください。
ログ整形ツールのバージョンアップ(ver2.0.0)に伴い、下記事象が解消いたしました。（2021/8/31）
・一部項目において、値が空白になる事象
・3.5万行以上のログを整形した際にエラーとなる事象