出力仕様
自然言語理解では、入力テキストと文脈情報(過去のリクエスト履歴など)を入力として受け取り、応答文や応答ドメインなどのレスポンスパラメータを出力します。
レスポンスパラメータは、必ず "キーと値のセット" で表されています。
ここでは、どのようなレスポンスパラメータが出力されるかの仕様を示します。
共通パラメータ
以下のレスポンスパラメータは共通となっており、全てのリクエストにおいて下記の内容が含まれています。
パラメータ | 例 | 説明 |
---|---|---|
result/INTEXT | 新宿の天気 | リクエストの入力テキスト。 |
result/METHOD | WEATHER | 応答ドメインの種類。TRANSIT(乗り換え)、WEATHER(天気)、SAY(雑談)など。 |
result/STATUS | 200 | 応答ステータスの種類。
|
キーのプレフィックス
レスポンスパラメータは、キーのプレフィックスごとに役割が異なります。
キーのプレフィックス | 例 | 説明 |
---|---|---|
PARAM | PARAM_QUERY | スロット値。 |
VAR | VAR_INTEXT_TIMESTAMP | その他の出力情報。過去のリクエスト履歴を引き継いだ際に、このパラメータを参照してレスポンスが変わることがあります。APIの利用者は、このプレフィックスのついたパラメータは無視してください。 |
NVM | NVM_THAT | 複数ターン、セッションで保存されるメモリ。過去のリクエスト履歴を引き継いだ際に、このパラメータを参照してレスポンスが変わることがあります。APIの利用者は、このプレフィックスのついたパラメータは無視してください。 |
レスポンスによって変わるパラメータ
METHODやSTATUSといった一部のパラメータ以外は、応答内容(応答ドメインや応答ドメインサブカテゴリ)によってレスポンスに含まれるかが異なります。
詳細は出力仕様(応答ドメイン)及びドメインに依らないパラメータをご覧ください。
※応答ドメインの種類やレスポンスの内容は、予告なく変わりうることに注意してください。