Guidance テンプレートの置換用辞書について

回答済み
フォローする
原井麻有

お世話になっております。
API のSchema 情報の中に

description:

Guidance テンプレートの置換用辞書。 詳細は Guidance の messageTemplate の説明を参照。

という記載がございます。
見ているAPIは /api/apps/pigeon/results の　items[ ResultList{ parameters の詳細説明です。
多分ガイダンスのメッセージテンプレート上に指定してある {{key}} の指定箇所かと思いますが、 「Guidance テンプレートの置換用辞書」というのは私どもユーザが参照する物理的な辞書ではなく、このパラメータをガイダンステンプレートに置き換えるための機能としての説明でしょうか？
もし物理的辞書があるならご紹介願います。

また以前も問い合わせしたとは思うのですが、APIを利用するために JSONで提供している各情報の説明（文書一式）などはありませんでしょうか？
以前のご回答は、この
Kompira cloud APIドキュメント
自体がマニュアルであり、それ以外のご用意はない。ということだったと思います。

もしご用意がなければ、JSON指定構文など参考情報を掲載しているサイトなどはご存じないでしょうか？また Enterprie 側マニュアルに掲載しているなどありますか？
ご教示いただけるとありがたいです。
よろしくお願いいたします。

0

コメント

5件のコメント

日付 投票
  • Kompiraサポートチーム

    ご質問ありがとうございます。
    回答させていただきます。

    多分ガイダンスのメッセージテンプレート上に指定してある {{key}} の指定箇所かと思いますが、 「Guidance テンプレートの置換用辞書」というのは私どもユーザが参照する物理的な辞書ではなく、このパラメータをガイダンステンプレートに置き換えるための機能としての説明でしょうか？

    ご理解の通りで、連絡実行時にガイダンステンプレートに埋め込むための値をここでは「辞書」と呼んでおります。別途物理的辞書があるというわけではございません。

    今回質問いただき、これは誤解を生む表現であると感じられましたので、APIドキュメントの記載について改善を検討させていただきます。

    APIを利用するために JSONで提供している各情報の説明（文書一式）などはありませんでしょうか？
    JSON指定構文など参考情報を掲載しているサイトなどはご存じないでしょうか？

    こちら、どういった内容のものをイメージされているかによって提示する回答が変わってくるように思いますので、お手数ですが何か「こういったことを知りたい時に使う」という具体例を教えていただいてもよろしいでしょうか。

    よろしくお願いいたします。

    0
    コメントアクション Permalink
  • 原井麻有

    お世話になっております。
    ご返答ありがとうございました。

    ＞＞何か「こういったことを知りたい時に使う」という具体例を教えていただいてもよろしいでしょうか。
    ありがとうございます。
    私どもは現在、TeraTerm on Linux にて、curl コマンドにてAPI情報を取得しております。
    json構文だけではなく、curlコマンドの構文も必要になっております。

    そういった状況において、以下①②を記載させていただきます。
    有用な情報サイトを教えていただけるとありがたいです。また、
    API を業務に多用する場合、どういったツールでjson形式の送信を行うのがやりやすいかなどもご教示いただけるとありがたいです。(Enterprize 以外。例えば　Power Automate のアダプティブカード利用など）

    ①認証定義　 -H "X-Authorization において、必要な要素（パラメータ）の一覧
    ②API発行時に、sortパラメータを追加指定する際、
      -x <プロキシサーバーアドレス> "https://<スペース名>.cloud.kompira.jp/api/apps/pigeon/results?sort= のように、API名とsortパラメータの間を "&" でつながなくてはならない等

    以上、よろしくお願いいたします。



    0
    コメントアクション Permalink
  • Kompiraサポートチーム

    ご返答ありがとうございます。

    現在 curl を用いて行われている、APIへの「HTTPリクエスト」に関する初歩のノウハウを求められているものかと思いますが、調べてはみたもののわかりやすく包括的で、 curl のような特定のツールを使う上で混乱せずに読めるような情報を見つけるのは困難でございました。
    基本的には具体的にぶつかったケースごとに、個別に解決していく必要があるかと思います。

    一方で、APIを実行する上で curl よりも扱いが簡単なツールはあり、「APIクライアントツール」等のワードで検索すると他にも選択肢が色々と挙がりますが、中でも有名なものを1つ挙げさせていただきます。

    Postman

    公式のマニュアルは英語ですが、下記の記事にて使い方が日本語でわかりやすく解説されています。
    （記事自体は5年前のものですので、多少最新版と異なる部分がございます）

    RESTサービスを触る際の必須ツールPostmanを使ってみました

    Postman のようなクライアントツールを使用する場合、例えば下記のような仕様は意識する必要がなくなるかと思います。

    ②API発行時に、sortパラメータを追加指定する際、
      -x <プロキシサーバーアドレス> "https://<スペース名>.cloud.kompira.jp/api/apps/pigeon/results?sort= のように、API名とsortパラメータの間を "&" でつながなくてはならない等

    一方で curl のようなコンソール上で動作するコマンドは、よく行う操作であれば Linux のシェルスクリプト等を用いて処理を一括で行いやすい、というメリットがあります。
    またコピー＆ペーストで処理を再現できるため、本コミュニティでも回答に使用させていただいております。

    よろしくお願いいたします。

    0
    コメントアクション Permalink
  • 原井麻有

    ご回答ありがとうございました。
    >>調べてはみたもののわかりやすく包括的で、 curl のような特定のツールを使う上で混乱せずに読めるような>>情報を見つけるのは困難でございました。
    調べていただきありがとうございます。
    参考にさせていただきます。

    また、確認ですが、
    Enterprise はjsonに対応しており、公開されているAPI ドキュメントの情報がそのまま有用であったと記憶しています。
    この点は間違いなかったでしょうか？

    0
    コメントアクション Permalink
  • Kompiraサポートチーム

    Enterprise はjsonに対応しており、公開されているAPI ドキュメントの情報がそのまま有用であったと記憶しています。

    ご認識のとおり、EnterpriseではJSONの取り扱いに対応しており、APIリクエスト時のJSONデータの構築、APIからのレスポンスJSONデータへのアクセス共に可能です。

    よろしくお願いいたします。

    0
    コメントアクション Permalink

サインインしてコメントを残してください。

お探しのものを見つけられませんでしたか？

新規投稿