改版履歴日付版変更内容 2013/11/ 初版 ii

Size: px

Start display at page:

Download "改版履歴日付版変更内容 2013/11/ 初版 ii"

いっけいつまがみ
5 years ago
Views:

1 雑談対話 API インタフェース仕様書第版 2013 年 11 月 11 日株式会社 NTT ドコモ i

2 改版履歴日付版変更内容 2013/11/ 初版 ii

3 目次 1. はじめに雑談対話 API 仕様共通仕様リクエスト仕様プロトコルクエリパラメータリクエストボディ部リクエストサンプルレスポンス仕様レスポンスボディ部レスポンスサンプル場所リスト HTTP ステータスコード一覧雑談対話 API を利用した会話例会話の継続システムへの質問ユーザのニックネーム等の利用しりとりの開始しりとりの継続... 9 iii

4 1. はじめに雑談対話 API はユーザの発話( テキスト ) に対して返答を行う機能である発話 ( テキスト ) を株式会社 NTT ドコモ ( 以下ドコモ ) の提供する雑談対話サーバ上の API( 以下雑談対話 API) に送信することで発話に対する返答を取得できる下記に雑談対話 API を用いたアプリの会話例 ( 図 1) を示す本書はこの雑談対話機能における HTTP インタフェースに関する仕様を示したものである図 1. 雑談対話 API を用いたアプリでの会話例 1

5 2. 雑談対話 API 仕様本章では雑談対話 API の利用にあたってのリクエスト / レスポンスの仕様を記載する 2.1. 共通仕様プロトコル文字コード Content-type HTTP UTF-8 application/json 2.2. リクエスト仕様プロトコル URL メソッド POST クエリパラメータ項番項目名キー型必須説明備考 1 API キー api_key string API キーアプリケーションに対してユニークに付与リクエストボディ部項番項目名キー型必須説明備考 1 ユーザ発話 utt string ユーザの発話 255 文字以下設定例こんにちは 2 コンテキスト ID context string - システムから出力され 255 文字以下 3 ユーザのニックネーム 4 ユーザのニックネームの読みた context を入力することにより会話を継続設定例 aaabbb nickname string - ユーザのニックネームを設定設定例光 nickname_y string - ユーザのニックネームの読みを設定設定例ヒカリ全角 10 文字 ( 半角 10 文字 ) 以下全角 20 文字以下 ( カタカナのみ ) 2

6 項番項目名キー型必須説明備考 5 ユーザの性別 sex string - ユーザの性別を設定男または女 6 ユーザの血液型 7 ユーザの誕生日 ( 年 ) 8 ユーザの誕生日 ( 月 ) 9 ユーザの誕生日 ( 日 ) 設定例女 bloodtype string - ユーザの血液型を設定設定例 B birthdatey int - ユーザの誕生日 ( 年 ) を設定設定例 1997 birthdatem int - ユーザの誕生日 ( 月 ) を設定設定例 5 birthdated int - ユーザの誕生日 ( 日 ) を設定設定例 30 A B AB O のいずれか 1~ 現在の都市までのいずれかの整数 1~12 までのいずれかの整数 1~31 までのいずれかの整数 10 ユーザの年齢 age int - ユーザの年齢を設定正の整数設定例ユーザの星座 constellations string - ユーザの星座を設定設定例双子座牡羊座牡牛座双子座蟹座獅子座乙女座天秤座蠍座射手座山羊座水瓶座魚座のいずれか 12 ユーザの場所 place string - ユーザの地域情報を設定 2.4 場所リストに含まれるもののいずれか設定例東京 13 モード mode string - 現在の対話のモード dialog または srtr システムから出力された mode を入力することによりしりとりを継続設定例 dialog 3

7 リクエストサンプル POST/dialog/v1/dialogue?APIKEY=<API キー > HTTP/1.1 Host: api.apigw.smt.docomo.ne.jp Connection: keep-alive Content-Length: 28 Accept: application/json Origin: < リクエスト生成元 URI> User-Agent: < 各クライアント > Content-Type: application/json Accept-Encoding: gzip,deflate,sdch Accept-Language: en-us,en;q=0.8 { "utt":" あいうえお " } 4

8 2.3. レスポンス仕様レスポンスボディ部項番項目名キー型必須説明備考 1 システムの返答 2 音声合成用読み出力 utt string - システムからの返答返答例こんにちは光さん yomi string - 音声合成にシステム返答を読ませるための出力返答例こんにちはヒカリさん 3 モード mode string - 対話のモードこの値をそのまま入力とする返答例 dialog 4 対話番号 da int - ユーザとシステムの対話に対してサーバが付与した番号返答例 0 5 コンテキスト ID context string - 自動的にシステムより出力される ID この値をそのまま入力とする返答例 aaabbb レスポンスサンプル HTTP/ OK Access-Control-Allow-Credentials: true Access-Control-Allow-Origin: < リクエスト生成元 URI> asyncserviceinvoke: false Content-Type: application/json;charset=utf-8 Date: Wed, 06 Nov :18:46 GMT Server: Apache-Coyote/1.1 X-Powered-By: Servlet 2.5; JBoss-5.0/JBossWeb-2.1 Content-Length: 104 Connection: keep-alive { } "utt": " かきくけこ ", "yomi": " かきくけこ ", "mode": "dialog", "da": "2", "context": "v-2wcqz6fdacgqjzvpgm5a" 5

9 2.4. 場所リスト稚内山形銚子福井広島中津旭川米沢館山大野呉日田留萌酒田横浜敦賀福山佐伯網走新庄小田原金沢庄原熊本北見仙台甲府輪島下関阿蘇乙姫紋別古川河口湖大津山口牛深根室石巻長野彦根柳井人吉釧路白石松本津萩宮崎帯広福島諏訪上野高松油津室蘭郡山軽井沢四日市徳島延岡浦河白河飯田尾鷲池田都城札幌小名浜静岡京都日和佐高千穂岩見沢相馬網代舞鶴松山鹿児島倶知安若松石廊崎奈良新居浜阿久根函館田島三島風屋宇和島枕崎江差宇都宮浜松和歌山高知鹿屋青森大田原御前崎潮岬室戸岬種子島弘前水戸新潟大阪清水名瀬深浦土浦津川神戸福岡沖永良部むつ前橋長岡姫路八幡那覇八戸みなかみ湯沢洲本飯塚名護秋田さいたま高田豊岡久留米久米島横手熊谷相川鳥取佐賀南大東島鷹巣秩父富山米子伊万里宮古島盛岡東京伏木岡山長崎石垣島二戸大島岐阜津山佐世保与那国島一関八丈島高山松江厳原海外宮古父島名古屋浜田福江大船渡千葉豊橋西郷大分 2.5. HTTP ステータスコード一覧項番ステータスコード内容正常に応答を返却した場合要求パラメータ不良の場合サポートされていない HTTP メソッドを使用した場合サーバ内で予期せぬエラーが発生した場合 6

10 3. 雑談対話 API を利用した会話例本章では雑談対話 API を利用した会話の事例を紹介する 3.1. 会話の継続レスポンスのモード (mode) とコンテキスト ID(context) の内容を引き継ぐことにより対話を継続することができる 7

11 3.2. システムへの質問システム自身への質問をすることも可能である 3.3. ユーザのニックネーム等の利用ユーザのニックネーム (nickname) 等のユーザの属性を入力することにより返答が変化する場合がある 8

12 3.4. しりとりの開始しりとりやろう等しりとり開始を示唆する発話を行うことでしりとりを開始することができる 3.5. しりとりの継続システムからのレスポンスのモード (mode) とコンテキスト ID(context) を引き継ぐことによりしりとりを継続することができる 9

改版履歴日付版変更内容 2013/11/ 初版 2013/11/ /3/ /12/ プロトコルの URL 名を訂正クエリパラメータのキー名を訂正リクエストボディ部に上限値を追記

改版履歴日付版変更内容 2013/11/ 初版 2013/11/ /3/ /12/ プロトコルの URL 名を訂正クエリパラメータのキー名を訂正リクエストボディ部に上限値を追記雑談対話 API インタフェース仕様書第 1.0.6 版 2015 年 12 月 1 日株式会社 NTT ドコモ i 改版履歴日付版変更内容 2013/11/11 1.0 初版 2013/11/28 1.0.1 2014/3/27 1.0.2 2014/12/5 1.0.3 2.2.1. プロトコルの URL 名を訂正 2.2.2. クエリパラメータのキー名を訂正 2.2.3. リクエストボディ部に上限値を追記

改版履歴 日付版変更内容 2013/11/ 初版 ii

改版履歴日付版変更内容 2013/11/ 初版 ii