Skip to main content

Entity APIクライアント

Version: 1
    Download Canvas JSON
    logo

    GUIからCanvas上のEntityに対してデータの入出力をテストするツールです。Entityに値を入力し、APIリクエストを送信することで、結果を確認できます。

    想定ユーザー​

    Entityの使い方をマスターしたい、または使用したいStudio利用者。
    このtemplateを用いることで、entityにGUIからデータやファイルをアップロードすることができます。
    ※ Studio入門編

    紹介動画​

    概要​

    テンプレート動作​

    • 入力

      • 環境変数で用意された、以下

        環境変数内容備考
        DATA_ENTITY_ID_LISTデータのEntity IDex) data-ent
        FILE_ENTITY_ID_LISTファイルのEntity IDex) file-ent
        LAYER_DATA_ENTITY_ID_LISTレイヤー化されたデータのEntity IDex) layer-data
        LAYER_FILE_ENTITY_ID_LISTレイヤー化されたファイルのEntity IDex) layer-file
        ALL_ENTITY_ID_LISTCanvasにあるすべてのEntity IDex) data-ent,file-ent,layer-data,layer-file
        LAYER_ALL_ENTITY_ID_LISTレイヤー化されたすべてのEntity IDex) layer-data,layer-file

      • Injection機能による初期設定

        • Injectionに追加している各jsonファイルの中身を編集することで対応する各ページの表示を変更することができる。

    • Output

      • Entityにデータやファイルへの参照を保持させたり、保持しているデータやファイルを確認することができる。これにより、functionへの入出力や、特定の条件が満たされたときに自動的に動作する仕組み（trigger）を設定できる。

    利用方法​

    単体での動作確認​

    1. テンプレート動作に従い、環境変数を設定。
    2. デプロイボタンを押す。
    3. /streamlit-apiのエンドポイントにアクセスする。
    4. POST Request (エンティティにWriteを行う。)
      左側のサイドバーからpost requestを選択。
      1. Data
        1. Data uploadを選択。
        2. "Write data to post to an entity"にpostしたいデータを入力。
        3. "Upload Data"をクリックする。
      2. File
        1. File uploadを選択。
        2. "Browse files"をクリックし、postしたいファイルを選択。
        3. "Upload File"をクリックする。
      3. 複数のData(レイヤー化されたデータ)
        1. Data upload (layered)を選択。
        2. "Insert layer ID"に任意のlayer-idを設定。
        3. "Write data to post to an entity"にpostしたいデータを入力。
        4. "Upload Data"をクリックする。
      4. 複数のFile(レイヤー化されたデータ)
        1. File upload (layered)を選択。
        2. "Insert layer ID"に任意のlayer-idを設定。
        3. "Browse files"をクリックし、postしたいファイルを選択。
        4. "Upload File"をクリックする。
      5. subscription
        1. subscriptionタブを選択
        2. 過去にpostしたリクエストのentity IDとlayer IDを設定。
        3. "Subscribe to Entity"をクリックする。
        4. 指定したリクエストの情報を取得することができる。
    5. GET Request (エンティティにReadを行う。)
      左側のサイドバーからget requestを選択。
      1. Data
        1. Get Dataを選択。
        2. "Get Data"をクリックすると過去にpostしたdataが取得できる。
      2. File
        1. Get Fileを選択。
        2. "Get File data"をクリックする。
        3. "Download File"をクリックするとファイルがダウンロードされる。
      3. 複数のData(レイヤー化されたデータ)
        1. Get Data (layered)を選択。
        2. "Layer ID"に過去にデータをpostした際のlayer IDを設定。
        3. "Get Data"をクリックすると指定したlayer IDのdataが取得できる。
      4. 複数のFile(レイヤー化されたデータ)
        1. Get File (layered)を選択。
        2. "Entity ID"はlayer-fileを選択。
        3. "Layer ID"に過去にファイルをpostした際のlayer IDを設定。
        4. "Retrieve file data"をクリックする。
        5. "Download File"をクリックすると指定したlayer IDのファイルがダウンロードされる。
      5. すべてのレイヤー化されたエンティティのLayer IDを確認する。
        1. Get all layer id in entityを選択。
        2. "Entity ID"にDataのLayer IDを確認したい場合はlayer-dataを、FileのLayer IDを確認したい場合はlayer-fileを設定。
        3. "Get Layer ID"をクリックすると、過去にlayeredにpostした、すべてのデータやファイルのLayer IDが表示される。
    6. DELETE Request
      1. あるentityのすべてのデータまたはファイルを削除する。
        1. Delete all layer in an entityを選択。
        2. "Delete all layer"に削除したいentity IDを選択する。
        3. "Delete all layer"をクリックすると指定したentity IDのすべてのデータが削除される。
      2. 特定のレイヤーのデータまたはファイルを削除する。
        1. Delete specific layerを選択。
        2. "Entity ID"にデータを削除したい場合はlayer-dataを、Fileを削除したい場合はlayer-fileを設定。
        3. "Layer ID"に削除したいデータまたはファイルのlayer IDを設定。
        4. "Delete specific layer"をクリックすると指定したデータまたはファイルが削除される。

    他のアセットとの連携​

    • このtemplateを用いることで、entityを用いるアプリケーションを開発する際に、entityへのデータやファイルのアップロードをGUIから行うことが可能になります。
    • 方法は以下の通りです。
      1. こちらのtemplateをコピー&ペーストをして配置する。
      2. 使用したいentityにtriggerやfunctionを繋げる。
    • 上記の手順により、GUIからアップロードしたデータやファイルを用いて、functionの入力やtriggerの設定に利用できます。

    関連情報​

    1. Entity
      • ref) https://docs.<cluster_name>.studio.exabase.ai/docs/references/components/entity
        • <cluster_name>は、お使いの環境を指定する文字列が入ります。担当者に確認してください。