インターフェース仕様書/開発ガイド

ドコモAIエージェントAPIと接続するアプリケーションの開発を行う上で必要となるインターフェース仕様書や開発ガイドラインを以下に公開致します。
開発を行うアプリケーションの用途に応じて必要な機能のインターフェース仕様書をダウンロードしてご利用ください。

インターフェース仕様書

ドコモAIエージェントAPIのインターフェース仕様書となります。

ドコモAIエージェントAPI インターフェース仕様書

APIリファレンス

ドコモAIエージェントAPIのリファレンスとなります。

音声対話、テキスト対話でUDSを利用する場合

テキスト対話でUDSを利用しない場合

2020年12月追加機能について

2020/12/10より、下記機能が追加・変更されました。

【追加機能】
1.個人情報を含む対話の取り扱い機能
2.テキストチャットUI共通の記載形式(balloon形式)の共通化
【機能変更】
3.対話ログのダウンロードファイル種別変更
4.前回発話の保存時間の変更 ※
5.その他の変更

追加・変更された機能の詳細につきましては、こちらをご覧ください。

「1.個人情報を含む対話の取り扱い機能」における、シナリオの構築マニュアルにつきましては、こちらをご覧ください。
また、「1.個人情報を含む対話の取り扱い機能」におきまして、個人情報を格納する場合は「暗号化CGS」を使用する必要がございます。暗号化CGSの使用方法についてはこちらをご覧ください。


※「4.前回発話の保存時間の変更」について
現在不具合が発覚したため、12/10より開始した「4.前回発話の保存時間の変更」の処理を一時停止しております。
原因については特定できておらず、今後の別の処理に影響がないとも限らないため、原因が解決するまでは本処理を止めさせていただきます。

以前と同様システム発話には、同じユーザIDとの対話が発生するまで情報が残る状態となっております。

音声制御ライブラリ仕様概要

音声制御ライブラリの機能概要を記載したドキュメントとなります。
本ドキュメントに記載されている内容よりもより詳細な仕様や情報については、音声制御ライブラリご契約後に開示させていただきますので、ご了承ください。

音声制御ライブラリ仕様概要

音声制御ライブラリのエラー・パラメータ一覧

音声制御ライブラリのパラメータとなります。

音声制御ライブラリ_パラメータ一覧

音声制御ライブラリのエラー一覧です。

音声制御ライブラリ_エラー一覧

音声制御ライブラリ開発リファレンス

音声制御ライブラリを利用してのアプリ開発時にご利用いただけるリファレンスとなります。

音声制御ライブラリ開発リファレンス(android版)

音声制御ライブラリ開発リファレンス-Appendix

音声制御ライブラリの詳細組込手順

音声制御ライブラリを利用してのアプリ開発時にご利用いただける詳細な組込手順となります。

(Androidはこちら, iOSはこちら

デバイスSDK

デバイスSDKの仕様書及びSDKファイルのダウンロード(GitHubからのダウンロード)が可能となります。
※デバイスSDKはお問い合わせ・サポートは受け付けておりません。予めご了承ください。

デバイスSDK for Android

デバイスSDK for iOS

デバイスSDK for python

デバイスSDK for C++

デバイスSDK for Unity

デバイスSDK for Javascript

サンプルアプリ

デバイスSDKを利用したサンプルアプリを公開しています。
※サンプルアプリは、お問い合わせ・サポートは受け付けておりません。予めご了承ください。

Androidサンプルアプリ

iOSサンプルアプリ

Pythonサンプルアプリ

C++サンプルアプリ

Unityサンプルアプリ

Javascriptサンプルアプリ

チュートリアル

デバイスSDKを活用したサンプルアプリとチュートリアルを公開しています

エージェント作成チュートリアル ~Python SDK編~
(pdfはこちら, pptxはこちら

エージェント作成チュートリアル ~Android SDK編~
(pdfはこちら, pptxはこちら

エージェント作成チュートリアル ~UnitySDK編~
(pdfはこちら)※2020.3.30更新

エージェント作成チュートリアル ~JavascriptSDK編~
(pdfはこちら