汎用CGSは、xAIMLから外部APIを利用するCGSです。
ご注意
SUNABAでの汎用CGSの利用について、「対話ボット開発環境サービス」利用規約の禁止事項に抵触しないようご利用をお願いいたします。
サービス名
multicgs
リクエストパラメータ
汎用CGSにリクエストを送信する際のパラメータです。
名称 | 必須 | 型 | 解説 |
---|---|---|---|
request |
〇 | JSON |
リクエストをJSON 形式で指定します。 |
type |
– | string |
レスポンスパラメータのbody タイプを指定します。 |
request
リクエストをJSON
形式で記述します。JSON
の内容は下表のとおりです。
パラメータ名 | 必須 | 型 | 解説 |
---|---|---|---|
method |
〇 | string |
GET /POST /DELETE /PUT /PATCH を指定します。 |
url |
〇 | string |
接続先のURLを指定します。 |
header |
– | string |
HTTPヘッダを指定します。(複数指定可) |
body |
– | string |
接続先のリクエストパラメータを指定します。 |
type
レスポンスパラメータのbody
タイプを指定します。指定できるタイプは下表のとおりです。
タイプ | 解説 |
---|---|
JSON |
レスポンスパラメータのbody にJSON オブジェクトが設定され、<get> で値を取得できます。 |
レスポンスパラメータ
汎用CGSのレスポンスを受け取った際のパラメータです。
名称 | 必須 | 型 | 解説 |
---|---|---|---|
body |
〇 | string |
返却されたJSON 形式のレスポンスです。 |
remote_status |
〇 | string |
HTTPステータスコード |
使用例
汎用CGSを使用するためには<ext>
を使用します。
xAIML
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 |
<category> <pattern>汎用CGS</pattern> <template> <!-- 汎用CGS「multicgs」を実行します。 --> <ext name="multicgs"> <!-- リクエストパラメータを設定します。 --> <arg name="request"> { "method": "GET", "url": "http://api.thni.net/jzip/X0401/JSON/064/0941.js", "header": {"HTTP-Version": "HTTP/1.1","Content-Type":"application/json;charset=utf-8"} } </arg> <arg name="type">JSON</arg> </ext> <!-- 実行結果を取得します。 --> <get name="_ext_multicgs_body.stateName"/> </template> </category> |
実行結果
1 2 |
user > 汎用CGS bot > 北海道 |
ご注意
リクエストパラメータのtype
を指定しない場合、レスポンスパラメータのbody
にJSON
文字列がそのまま設定されます。
その場合は<predstore>
を介して、JSON
オブジェクトから値を取得します。
1 2 |
<think><predstore>result.setJson(<get name="_ext_multicgs_body"/>)</predstore></think> <predstore>result.value</predstore> |