その他の Streamlit in Snowflake 機能

このトピックでは、 Streamlit in Snowflake の追加機能について説明します。

Streamlit in Snowflake の外部ネットワークアクセス

Snowflakeの外部にある特定のネットワークロケーションへの安全なアクセスを作成し、Streamlitアプリのコード内からそのアクセスを使用できるようになりました。アクセスは、外部アクセス統合を介して有効にすることができます。

Streamlit アプリが外部アクセス統合を使用できるようにするには、 CREATE STREAMLIT または ALTER STREAMLIT コマンドを実行し、 EXTERNAL_ACCESS_INTEGRATIONS パラメータにその統合を含めるように設定します。

外部アクセス統合を使えば、 requestsurllib のような、外部の場所にアクセスする Python ライブラリを使ったり、ネットワークの場所にアクセスする必要のあるサードパーティのライブラリを使ったりすることができます。

詳細については、 外部ネットワークアクセスの概要 をご参照ください。

例: OpenAI API にアクセスする

次の例は、 OpenAI API へのアウトバウンド リクエストのために、外部アクセス統合を作成する方法を示しています。この例には、セキュリティ統合の設定と必要な権限の付与が含まれます。

  1. 外部ネットワークの場所とアクセス制限を表すネットワークルールを作成するには、 CREATE NETWORK RULE コマンドを使用します。

    CREATE OR REPLACE NETWORK RULE network_rules
      MODE = EGRESS
      TYPE = HOST_PORT
      VALUE_LIST = ('api.openai.com');
    
    Copy

    詳細については、 外部ネットワークロケーションを表すネットワークルールの作成 をご参照ください。

  2. 外部ネットワーク拠点との認証情報に相当するシークレットを作成するには、 CREATE SECRET コマンドを使用します。

    CREATE OR REPLACE SECRET openai_key
      TYPE = GENERIC_STRING
      SECRET_STRING = '<any_string>';
    
    Copy

    詳細については、 認証情報を表すシークレットの作成 をご参照ください。

  3. 外部アクセス統合を作成するには、 CREATE EXTERNAL ACCESS INTEGRATION コマンドを実行し、 ALLOWED_NETWORK_RULES を作成したネットワークルールに、 ALLOWED_AUTHENTICATION_SECRETS を作成したシークレットに設定します。

    CREATE OR REPLACE EXTERNAL ACCESS INTEGRATION openai_access_int
      ALLOWED_NETWORK_RULES = (network_rules)
      ALLOWED_AUTHENTICATION_SECRETS = (openai_key)
      ENABLED = TRUE;
    
    Copy
  4. Streamlit アプリ作成者に外部アクセス用の SECRET および INTEGRATION オブジェクトを使用するために必要な権限を付与するには、 GRANT <権限> ... TO ROLE コマンドを使用します。

    GRANT READ ON SECRET openai_key TO ROLE streamlit_app_creator_role;
    GRANT USAGE ON INTEGRATION openai_access_int TO ROLE streamlit_app_creator_role;
    
    Copy
  5. Streamlit アプリが統合を使用できるようにするには、 ALTER STREAMLIT コマンドを実行し、 EXTERNAL_ACCESS_INTEGRATIONS プロパティを統合にセットします。

    USE ROLE streamlit_app_creator_role;
    
    ALTER STREAMLIT streamlit_db.streamlit_schema.streamlit_app
      SET EXTERNAL_ACCESS_INTEGRATIONS = (openai_access_int)
      SECRETS = ('my_openai_key' = streamlit_db.streamlit_schema.openai_key);
    
    Copy

    注釈

    CREATE STREAMLIT コマンドの実行時に EXTERNAL_ACCESS_INTEGRATIONS パラメーターを指定することで、外部アクセス統合を使用する新しい Streamlit オブジェクトをセットアップすることもできます。

    CREATE STREAMLIT streamlit_db.streamlit_schema.streamlit_app
      ROOT_LOCATION = '<stage_path_and_root_directory>'
      MAIN_FILE = '<path_to_main_file_in_root_directory>'
      EXTERNAL_ACCESS_INTEGRATIONS = (openai_access_int)
      SECRETS = ('my_openai_key' = streamlit_db.streamlit_schema.openai_key);
    
    Copy
  6. Streamlit アプリのコードで、外部 API を呼び出します。

    from openai import OpenAI
    import streamlit as st
    import _snowflake
    
    st.title(":speech_balloon: Simple chat app using an external LLM")
    st.write("This app shows how to call an external LLM to build a simple chat application.")
    
    # Use the _snowflake library to access secrets
    secret = _snowflake.get_generic_secret_string('my_openai_key')
    client = OpenAI(api_key=secret)
    
    # ...
    # code to use API
    # ...
    
    Copy

Streamlitアプリのカスタムスリープタイマー

Streamlitアプリを自動的に一時停止するためのカスタムスリープタイマーを設定できます。

  1. カスタムスリープタイマーを設定するには、 STREAMLIT オブジェクトの ROOT_LOCATION パラメーターで指定されたパスにある .streamlit フォルダー内に config.toml 構成ファイルを作成します。

    たとえば、Streamlitアプリを8分後に自動的に一時停止させる場合は、 config.toml ファイルに次のコードを追加します。

    [snowflake]
    [snowflake.sleep]
    streamlitSleepTimeoutMinutes = 8
    
    Copy
  2. config.toml ファイルをステージの場所にアップロードします。

    PUT file:///<path_to_your_root_folder>/my_app/config.toml @streamlit_db.streamlit_schema.streamlit_stage/.streamlit/ overwrite=true auto_compress=false;
    
    Copy

Streamlit ファイルの操作に関する情報は、 SQL を使用してStreamlitアプリを作成し、デプロイします。 を参照してください。

注釈

streamlitSleepTimeoutMinutes は、5分から240分の間で任意の値を設定できます。

タイマーを指定するための構成ファイルを作成しない場合、デフォルトの自動一時停止時間は15分になります。

Streamlit in Snowflake のコンテキスト関数と行アクセス・ポリシー

Streamlit in Snowflake アプリで、 CURRENT_USER のような コンテキスト関数 と、 行アクセスポリシー を持つテーブルからのデータを使用するには、 ACCOUNTADMIN ロールを持つユーザーが、次の例に示すように、グローバル READ SESSION 権限を Streamlit アプリ所有者ロールに付与する必要があります。

USE ROLE ACCOUNTADMIN;
GRANT READ SESSION ON ACCOUNT TO ROLE streamlit_owner_role;
Copy

注釈

Streamlit in Snowflake アプリでは、 CURRENT_ROLE を使用する行アクセス・ポリシーは使用できません。 Streamlit in Snowflake アプリはオーナー権限で実行されるため、Streamlit アプリ内で CURRENT_ROLE を使用すると、常にアプリのオーナー・ロールが返されます。詳細については、 所有者の権利と Streamlit in Snowflake アプリの理解 をご参照ください。

例: CURRENT_USER を使用して行アクセスポリシーのテーブルのデータにアクセスします。

Streamlit in Snowflake アプリを使って、行アクセスポリシーで保護されたテーブルの行へのアクセスを管理することができます。行アクセスポリシーの本文に CURRENT_USER 関数を指定し、行アクセスポリシーをテーブルに追加します。

次の例は、 Streamlit in Snowflake アプリで、行アクセス・ポリシーで保護されたテーブルへのアクセスを管理する方法を示しています。

  1. テーブルを作成してデータを挿入します。

    CREATE TABLE row_access_policy_test_table (
        id INT,
        some_data VARCHAR(100),
        the_owner VARCHAR(50)
    );
    
    INSERT INTO row_access_policy_test_table (id, some_data, the_owner)
    VALUES
        (4, 'Some information 4', 'ALICE'),
        (5, 'Some information 5', 'FRANK'),
        (6, 'Some information 6', 'ALICE');
    
    Copy
  2. 行アクセスポリシーを作成します。

    CREATE OR REPLACE ROW ACCESS POLICY st_schema.row_access_policy
    AS (the_owner VARCHAR) RETURNS BOOLEAN ->
        the_owner = CURRENT_USER();
    
    Copy
  3. 行アクセスポリシーをテーブルに追加します。

    ALTER TABLE row_access_policy_test_table ADD ROW ACCESS POLICY st_schema.row_access_policy ON (the_owner);
    
    Copy
  4. Streamlitアプリを作成します。

  5. グローバル READ SESSION 権限を Streamlit アプリの所有者ロールに付与します。

    GRANT READ SESSION ON ACCOUNT TO ROLE streamlit_owner_role;
    
    Copy
  6. 以下のコードを Streamlit アプリに追加します。

    # Import Python packages
    import streamlit as st
    from snowflake.snowpark.context import get_active_session
    
    st.title("CURRENT_USER() + Row Access Policy in SiS Demo :balloon:")
    st.write(
            """You can access `CURRENT_USER()` and data from tables with row access policies
            in Streamlit in Snowflake apps
            """)
    
    # Get the current credentials
    session = get_active_session()
    
    st.header('Demo')
    
    st.subheader('Credentials')
    sql = "SELECT CURRENT_USER();"
    df = session.sql(sql).collect()
    st.write(df)
    
    st.subheader('Row Access on a Table')
    sql = "SELECT * FROM st_db.st_schema.row_access_policy_test_table;"
    df = session.sql(sql).collect()
    
    st.write(df)
    
    Copy