Skip to main content
LibreChat is joining ClickHouse to power the open-source Agentic Data Stack 🎉 Learn more
LibreChat

メッセージフィルターオブジェクトの構造

概要

messageFilter オブジェクトは、サーバーサイドのメッセージフィルターを設定します。v1.3.13 では、サポートされているフィルタータイプは messageFilter.pii です。

messageFilter.pii は、送信されたメッセージテキストがモデレーション、モデルへのリクエスト、またはメッセージの永続化に到達する前に、認証情報のような形式のパターンやオペレーターが定義した正規表現に一致する場合、そのテキストを拒否します。

例

messageFilter:
  pii:
    starterPatterns:
      - sk_prefix
      - bearer_header
      - api_key_header
    customPatterns:
      - id: anthropic_api_key
        label: Anthropic API key
        regex: 'sk-ant-[A-Za-z0-9_-]{20,}'

フィールド

messageFilter.pii

KeyTypeDescriptionExample
pii.starterPatternsArray of Strings有効にする組み込みスターターパターンのオプションのサブセットID。すべてを有効にする場合は省略してください。starterPatterns: [sk_prefix, bearer_header]
pii.customPatternsArray of Objectsオペレーター定義のパターン。各エントリには `id`、`label`、`regex` が必要です。

組み込みのスターターパターンID:

  • sk_prefix: sk- スタイルのトークンプレフィックスと一致します。
  • bearer_header: テキスト内のベアラートークンと一致します。
  • api_key_header: api-key ヘッダー形式のテキストと一致します。

customPatterns

KeyTypeDescriptionExample
idStringログおよびデバッグに使用される安定したパターンID。id: anthropic_api_key
labelString拒否メッセージに表示される人間が読み取れるラベル。label: Anthropic API key
regexStringJavaScript形式の正規表現。LibreChatは設定の読み込み時にこれを検証し、グローバルフラグを付けてコンパイルします。regex: 'sk-ant-[A-Za-z0-9_-]{20,}'

動作

送信されたメッセージテキストが設定済みのPIIパターンと一致した場合、LibreChatは message_filter_pii_block とともにHTTP 400 エラーを返し、呼び出し元に対して一致した認証情報の種類を削除するよう求めるメッセージを表示します。

フィルターのチェック項目:

  • LibreChat UIを通じて送信されたチャットルートのユーザーテキスト。
  • OpenAI互換のChat Completionsリクエストにおける、すべての呼び出し元から提供されたメッセージロールにわたるテキストコンテンツ。
  • OpenAI互換のResponsesリクエストにおける、すべての呼び出し元が提供するメッセージロールにわたるテキストコンテンツ。

このフィルターは、リクエストボディで提供されたテキストを評価します。ファイルの内容はスキャンしません。

このガイドはいかがでしたか?