出力仕様

自然言語理解では、入力テキストと文脈情報(過去のリクエスト履歴など)を入力として受け取り、応答文や応答ドメインなどのレスポンスパラメータを出力します。 レスポンスパラメータは、必ず "キーと値のセット" で表されています。 ここでは、どのようなレスポンスパラメータが出力されるかの仕様を示します。

共通パラメータ

以下のレスポンスパラメータは共通となっており、全てのリクエストにおいて下記の内容が含まれています。
パラメータ 説明
result/intext 新宿の天気 リクエストの入力テキスト。
result/method WEATHER 応答ドメインの種類。TRANSIT(乗り換え)、WEATHER(天気)、SAY(雑談)など。
result/status 200 応答ステータスの種類。
  • 200 – 正常。言語理解できて応答が返せる場合。
  • 201 – 正常。言語理解できず応答が返せない場合。
  • 400 – 異常、エラー。

キーのプレフィックス

レスポンスパラメータは、キーのプレフィックスごとに役割が異なります。
キーのプレフィックス 説明
param param_query スロット値。
var var_intext_timestamp その他の出力情報。過去のリクエスト履歴を引き継いだ際に、このパラメータを参照してレスポンスが変わることがあります。APIの利用者は、このプレフィックスのついたパラメータは無視してください。
nvm nvm_that 複数ターン、セッションで保存されるメモリ。過去のリクエスト履歴を引き継いだ際に、このパラメータを参照してレスポンスが変わることがあります。APIの利用者は、このプレフィックスのついたパラメータは無視してください。

レスポンスによって変わるパラメータ

methodやstatusといった一部のパラメータ以外は、応答内容(応答ドメインや応答ドメインサブカテゴリ)によってレスポンスに含まれるかが異なります。 詳細は応答ドメインごとの仕様をご覧ください。 ※応答ドメインの種類やレスポンスの内容は、予告なく変わりうることに注意してください。