SanitizeUserPrompt ポリシー

このページは Apigee と Apigee ハイブリッドに適用されます。

Apigee Edge のドキュメントを表示する。

概要

SanitizeUserPrompt ポリシーは、生成 AI モデルに送信されるユーザー プロンプトをサニタイズすることで、AI アプリケーションを有害なコンテンツから保護します。このポリシーは、ユーザー プロンプトに有害なコンテンツが含まれていないかを Model Armor を使って評価し、Apigee を使った AI ワークロードに対してネイティブな保護を実現します。Model Armor は、大規模言語モデル（LLM）に関連するリスクを軽減するための AI セキュリティと安全対策を提供する Google Cloud サービスです。

このポリシーは、SanitizeModelResponse ポリシーと組み合わせて使用します。

このポリシーは拡張可能なポリシーです。Apigee ライセンスによっては、このポリシーの使用によって費用や使用量に影響する場合があります。ポリシータイプと使用量への影響については、ポリシータイプをご覧ください。

始める前に

SanitizeUserPrompt ポリシーを使用する前に、次のタスクを完了する必要があります。

• Model Armor テンプレートを作成する。SanitizeUserPrompt ポリシーを作成する前に、テンプレートを用意しておく必要があります。
• Model Armor サービスの API エンドポイントを設定する。
• SanitizeModelResponse ポリシーを作成する。SanitizeUserPrompt ポリシーをデプロイする前に、SanitizeModelResponse ポリシーを作成しておく必要があります。

必要なロール

SanitizeUserPrompt ポリシーを適用して使用するために必要な権限を取得するには、Apigee プロキシのデプロイに使用しているサービス アカウントに次の IAM ロールを付与するよう管理者に依頼してください。

• Model Armor ユーザー（roles/modelarmor.user)）
• Model Armor 閲覧者（roles/modelarmor.viewer）

ロールの付与については、プロジェクト、フォルダ、組織に対するアクセス権の管理をご覧ください。

必要な権限は、カスタムロールや他の事前定義ロールから取得することもできます。

API を有効にする

Enable the Model Armor API.

Enable the API

<SanitizeUserPrompt> 要素

SanitizeUserPrompt ポリシーを定義します。

<SanitizeUserPrompt> 要素の構文は次のとおりです。

<SanitizeUserPrompt async="false" continueOnError="false" enabled="true" name="sanitize-text">
  <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
  <DisplayName>Sanitize-Text-sample</DisplayName>
  <ModelArmor>
    <TemplateName>projects/{project}/locations/{location}/templates/{template-name}</TemplateName>
  </ModelArmor>
  <UserPromptSource>{jsonPath('$.contents[-1].parts[-1].text',request.content,true)}</UserPromptSource>
</SanitizeUserPrompt>

<SanitizeUserPrompt async="false" continueOnError="false" enabled="true" name="sanitize-text">
  <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
  <DisplayName>Sanitize-Text-sample</DisplayName>
  <ModelArmor>
    <TemplateName>projects/{project}/locations/{location}/templates/{template-name}</TemplateName>
  </ModelArmor>
  <UserPromptSource>{jsonPath('$.contents[-1].parts[-1].text',request.content,true)}</UserPromptSource>
</SanitizeUserPrompt>

この要素には、すべてのポリシーに共通する次の属性があります。

次の表は、<SanitizeUserPrompt> の子要素の概要をまとめたものです。

{jsonpath('$.input.prompt.text',request.content,false)}

例

このセクションでは、<SanitizeUserPrompt> の使用例を見ていきます。

この例では、モデルの検出とプロンプトの抽出にすべてのデフォルト値を使用します。

<SanitizeUserPrompt async="false" continueOnError="false" enabled="true" name="sanitize-text">
  <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
  <DisplayName>Sanitize-Text-sample</DisplayName>
  <ModelArmor>
    <TemplateName>projects/{project}/locations/{location}/templates/{template-name}</TemplateName>
  </ModelArmor>
</SanitizeUserPrompt>

子要素のリファレンス

このセクションでは、<SanitizeUserPrompt> の子要素について説明します。

<DisplayName>

name 属性に加えて、管理 UI プロキシ エディタでポリシーを別の、より自然な響きの名前でラベル付けするために使います。

<DisplayName> 要素はすべてのポリシーに共通です。

<DisplayName> 要素の構文は次のとおりです。

<PolicyElement>
  <DisplayName>POLICY_DISPLAY_NAME</DisplayName>
  ...
</PolicyElement>

<PolicyElement>
  <DisplayName>My Validation Policy</DisplayName>
</PolicyElement>

<DisplayName> 要素に属性や子要素はありません。

<IgnoreUnresolvedVariables>

変数が解決されない場合に処理を停止するかどうかを決定します。true を設定すると、未解決の変数を無視して処理を続行できます。

<ModelArmor>

Model Armor テンプレートの指定に必要な情報が含まれています。

<ModelArmor> 要素の構文は次のとおりです。

<ModelArmor>
  <TemplateName>projects/{project}/locations/{location}/templates/{template-name}</TemplateName>
</ModelArmor>

<ModelArmor>
  <TemplateName>projects/{organization.name}/locations/{system.region.name}/templates/{id}</TemplateName>
</ModelArmor>

次の表は、<ModelArmor> の子要素の概要をまとめたものです。

projects/{organization.name}/locations/{system.region.name}/templates/{id}

<UserPromptSource>

ユーザー プロンプト テキストを抽出するペイロードの場所。このフィールドは、変数や JSON Path 関数の使用など、Apigee メッセージ テンプレートの構文をサポートしています。次に例を示します。

{jsonpath('$.input.prompt.text',request.content,false)}

フロー変数

フロー変数を使用すると、HTTP ヘッダー コンテンツ、メッセージ コンテンツ、またはフローのコンテキストに基づいて、ポリシーとフローが実行時に動的に動作するよう構成できます。フロー変数の詳細については、フロー変数のリファレンスをご覧ください。

ポリシーは実行時にこれらの読み取り専用変数を設定できます。

エラー リファレンス

このセクションでは、SanitizeUserPrompt ポリシーに特有の Apigee によって返される障害コードやエラーメッセージ、そして設定される障害変数について説明します。これは、障害に対処するための障害ルールを作成するうえで重要な情報です。詳細については、ポリシーエラーについて知っておくべきことと障害の処理をご覧ください。

ランタイム エラー

このエラーは、ポリシーの実行時に発生することがあります。

デプロイエラー

以下のエラーは、このポリシーを含むプロキシをデプロイするときに発生することがあります。

障害変数

次の変数は、このポリシーでランタイム エラーが発生したときに設定されます。詳細については、ポリシーエラーについて知っておくべきことをご覧ください。

エラー レスポンスの例

{
  "fault": {
    "faultstring": "SanitizeUserPrompt[sanitize-prompt]: unable to resolve variable [variable_name]",
    "detail": {
      "errorcode": "steps.sanitizeuserprompt.UnresolvedVariable"
    }
  }
}

障害ルールの例

<FaultRule name="SanitizeUserPrompt Faults">
    <Step>
        <Name>SUP-CustomSetVariableErrorResponse</Name>
        <Condition>(fault.name = "SetVariableFailed")</Condition>
    </Step>
    <Condition>(sanitizeuserprompt.failed = true)</Condition>
</FaultRule>

Model Armor テンプレートのエラーコードとエラー メッセージ

Model Armor テンプレートは、SanitizeUserPrompt ポリシーの API リクエストによってスローされるエラーコードとエラー メッセージのオーバーライドをサポートしています。ユーザーがオーバーライドを設定すると、Model Armor のエラーコードとエラー メッセージがフロー変数に入力されます。

たとえば、Model Armor のエラーコードとメッセージを含むレスポンスは次のようになります。

{
  "sanitizationResult": {
    "filterMatchState": "MATCH_FOUND",
    "filterResults": {...},
    "sanitizationMetadata": {
      "errorCode": "890",
      "errorMessage": "get out"
      },
    "invocationResult": "SUCCESS"
  }
}

スキーマ

各ポリシータイプは XML スキーマ（.xsd）によって定義されます。参照用のポリシー スキーマは GitHub から入手できます。