この機能は Python SDK からのみ利用できます。
redact_pii 設定。weave.init() の呼び出しで有効または無効にすることで、PII マスキングのオン／オフを切り替えられます。redact_pii = True の場合にデフォルトでマスクされる エンティティ の自動マスキング。- 設定可能な
redact_pii_fields によるマスキングフィールドのカスタマイズ。
redact_pii_exclude_fields 設定による特定の エンティティ のマスキング対象からの除外。
このセクションでは、必要な依存関係のインストール、weave.init() での PII のマスキングの有効化、および Weave がマスクする エンティティ の任意の調整について説明します。Weave の Sensitive Data Protection 機能を使い始めるには、以下の手順を実行します。
-
必要な依存関係をインストールします。
pip install presidio-analyzer presidio-anonymizer
-
マスキングを有効にするように、
weave.init() call を変更します。redact_pii=True を設定すると、一般的なエンティティはデフォルトでマスクされます。
import weave
weave.init("my-project", settings={"redact_pii": True})
-
(任意)
redact_pii_fields パラメーターを使用して、マスキングするフィールドをカスタマイズします。
weave.init("my-project", settings={"redact_pii": True, "redact_pii_fields":["CREDIT_CARD", "US_SSN"]})
-
(任意)
redact_pii_exclude_fields パラメーターを使用して、特定のエンティティをマスキング対象から除外します。これは、デフォルトのマスキングは維持しつつ、特定のエンティティタイプは保持したい場合に便利です。次の例は、EMAIL_ADDRESS と PERSON を除くすべてのデフォルトのエンティティをマスクする方法を示しています。
weave.init("my-project", settings={"redact_pii": True, "redact_pii_exclude_fields":["EMAIL_ADDRESS", "PERSON"]})
これらの手順を完了すると、Weave は設定された PII エンティティ を Weave サーバーに送信する前にトレースからマスクします。
このセクションでは、redact_pii_fieldsを指定せずに PII のマスキング を有効にしたときに、Weave が自動的にマスクする PII エンティティタイプを一覧で示します。PII のマスキング を有効にすると、Weave は以下のエンティティを自動的にマスクします。
CREDIT_CARDCRYPTOEMAIL_ADDRESSES_NIFFI_PERSONAL_IDENTITY_CODEIBAN_CODEIN_AADHAARIN_PANIP_ADDRESSLOCATIONPERSONPHONE_NUMBERUK_NHSUK_NINOUS_BANK_NUMBERUS_DRIVER_LICENSEUS_PASSPORTUS_SSN
REDACT_KEYS を使用した機密キーのマスキング
REDACT_KEYS を使用したカスタムキーのマスキングに対応しています。これは、PII のカテゴリには該当しないものの、非公開のままにしておく必要がある追加の機密データを保護したい場合に便利です。たとえば、次のようなものがあります。
- APIキー
- 認証ヘッダー
- トークン
- 内部ID
- 設定値
Weave はデフォルトで、以下の機密キーを自動的にマスクします。
[
"api_key",
"auth_headers",
"authorization"
]
REDACT_KEYS リストを拡張できます。トレースからマスクしたい独自のキーを追加できます。
import weave
from weave.utils import sanitize
client = weave.init("my-project", settings={"redact_pii": True})
# マスクするカスタムキーを追加する
sanitize.add_redact_key("client_id")
sanitize.add_redact_key("token")
client_id = "123"
token = "789"
@weave.op
def test(client_id, token):
return client_id + token
test(client_id, token)
client_id と token の値は "REDACTED" と表示されます。
client_id = "REDACTED"
token = "REDACTED"
- この機能は Python SDK でのみ利用できます。
- マスキングを有効にすると、Presidio への依存により処理時間が長くなります。
