Documentation Powered by ReDoc

意図解釈APIリファレンス (2.6)

意図解釈APIリファレンス

意図解釈サーバ

意図解釈サーバ通信

ユーザの発話テキストを意図解釈サーバに送信し、意図解釈結果を取得する。

Request Body schema: application/json
required
object

プロジェクト情報

transactionId
string

通信を一意に識別する情報

clientVer
string

クライアントバージョン情報

dialogMode
required
string

対話モード:on/off

onの場合、タスク状態を引き継ぐ。offの場合、タスク状態を引き継がない。

language
required
string

言語情報。「ja-JP」や「en-JP」などシステムでサポートされている言語

userId
string

ユーザー識別情報。タスクの状態遷移を行う際に識別をするためのID

taskScores
boolean

タスクスコアの取得。

trueの場合、レスポンスにtaskScoresが出力される。falseの場合、レスポンスにtaskScoresが出力されない。

required
object

ユーザ発話内容

projectSpecific
object

案件固有情報であるprojectSpecific内はクライアント側で任意に要素情報を追加することが可能な領域。

projectSpecificに設定された要素情報はレスポンス時に同一内容が返却される。

※projectSpecific内に要素が無い場合はprojectSpecificは省略する。

required
object

対話ステータス情報

Responses

Request samples

Content type
application/json
{
  • "projectInfo": {
    },
  • "transactionId": "2014091817533012345678",
  • "clientVer": "1.0.0",
  • "dialogMode": "on",
  • "language": "ja-JP",
  • "userId": "12 123456 123456 0",
  • "taskScores": true,
  • "userUtterance": {
    },
  • "projectSpecific": { },
  • "dialogStatus": {
    }
}

Response samples

Content type
application/json
{
  • "projectInfo": {
    },
  • "appInfo": {
    },
  • "transactionId": "2014091817533012345678",
  • "clientVer": "1.0.0",
  • "dialogMode": "on",
  • "language": "JP",
  • "userId": "12 123456 123456 0",
  • "taskScores": [
    ],
  • "dialogStatus": {
    },
  • "projectSpecific": { },
  • "userUtterance": {
    },
  • "taskIdList": [
    ],
  • "serverSendTime": "YYYY-MM-DDThh:mm:ss+/-hh:mm"
}