v1.0.6 bedrock_retrieveツールにガードレール指定機能を追加

Author: r3-yamauchi

README.md

@@ -1,7 +1,7 @@
 # my_aws_tools
 
-**Author:** r3-yamauchi
-**Version:** 1.0.5  
+**Author:** r3-yamauchi  
+**Version:** 1.0.6  
 **Type:** tool
 
 English | [Japanese](https://github.com/r3-yamauchi/dify-my-aws-tools-plugin/blob/main/readme/README_ja_JP.md)
@@ -55,7 +55,7 @@ This project is distributed under the Apache License 2.0. See `LICENSE` for the
 
 ### Amazon Bedrock
 
-- **Bedrock Retrieve** – Calls the `bedrock-agent-runtime` Retrieve API to run semantic or hybrid searches against a selected Knowledge Base. You can switch metadata filters, result counts, and Bedrock Reranking models (cohere.rerank-v3-5 / amazon.rerank-v1), and receive outputs as JSON or ranked text.
+- **Bedrock Retrieve** – Calls the `bedrock-agent-runtime` Retrieve API to run semantic or hybrid searches against a selected Knowledge Base. You can switch metadata filters, result counts, Bedrock Reranking models (cohere.rerank-v3-5 / amazon.rerank-v1), and apply optional Guardrails via `guardrail_id` / `guardrail_version`, and receive outputs as JSON or ranked text.
 
 ```json
 {
@@ -84,17 +84,17 @@ This project is distributed under the Apache License 2.0. See `LICENSE` for the
 
 - **Apply Guardrail** – Uses Bedrock Runtime `apply_guardrail` with these features:
   - Inputs: `content` array (multiple texts and/or images via bytes or S3 URI) or a single `text` that is auto-chunked into 1000-character pieces and wrapped as content.
-  - `source`: PREPROCESS (default) or POSTPROCESS to target pre/post LLM stages.
+  - `source`: INPUT (default) or OUTPUT to target pre/post LLM stages.
   - Outputs: action, processedOutputs (masked), outputs (raw), assessments, warnings/actionReasons; returned as human-readable text plus a JSON blob.
   - Long-text protection via chunking aligned with Guardrails billing/limits.
 
 #### Apply Guardrail example (multi-text)
 
 ```json
 {
-  "guardrail_id": "gr-123",
-  "guardrail_version": "2",
-  "source": "PREPROCESS",
+  "guardrail_id": "ab1cd2e3f45g",
+  "guardrail_version": "1",
+  "source": "INPUT",
   "content": [
     { "text": { "text": "User message 1" } },
     { "text": { "text": "User message 2" } }
@@ -106,9 +106,9 @@ This project is distributed under the Apache License 2.0. See `LICENSE` for the
 
 ```json
 {
-  "guardrail_id": "gr-123",
+  "guardrail_id": "ab1cd2e3f45g",
   "guardrail_version": "2",
-  "source": "POSTPROCESS",
+  "source": "OUTPUT",
   "content": [
     {
       "image": {

manifest.yaml

@@ -1,4 +1,4 @@
-version: 1.0.5
+version: 1.0.6
 type: plugin
 author: r3-yamauchi
 name: my_aws_tools

readme/README_ja_JP.md

@@ -1,7 +1,7 @@
 # my_aws_tools
 
 **Author:** r3-yamauchi  
-**Version:** 1.0.5  
+**Version:** 1.0.6  
 **Type:** tool
 
 英語版ドキュメントはリポジトリ直下の `README.md` を参照してください。
@@ -14,7 +14,7 @@
 
 ## 概要
 
-My AWS Tools プラグインは、複数の AWS サービスに基づくツールセットを提供し、Dify アプリケーションの内部から AWS の機能を直接活用できるようにします。コンテンツモデレーション、テキストのリランク、テキスト読み上げ、音声認識など、幅広い機能領域をカバーします。
+このツール・プラグインは、いくつかの AWS サービスに基づくツールセットを提供し、Dify アプリケーションの中で AWS の機能を直接活用できるようにします。
 
 含まれるツール:
 - Apply Guardrail
@@ -51,7 +51,7 @@ My AWS Tools プラグインは、複数の AWS サービスに基づくツー
 
 ### Amazon Bedrock 系
 
-- **Bedrock Retrieve**: `bedrock-agent-runtime` の Retrieve API を直接呼び出し、指定 Knowledge Base に対してセマンティックまたは HYBRID 検索を実行します。メタデータフィルタ、検索件数、Bedrock Reranking (cohere.rerank-v3-5 や amazon.rerank-v1) を切り替えられ、結果は JSON あるいは順位付きテキストで取得できます。
+- **Bedrock Retrieve**: `bedrock-agent-runtime` の Retrieve API を直接呼び出し、指定 Knowledge Base に対してセマンティックまたは HYBRID 検索を実行します。メタデータフィルタ、検索件数、Bedrock Reranking (cohere.rerank-v3-5 や amazon.rerank-v1) を切り替えられ、`guardrail_id` / `guardrail_version` で Bedrock ガードレールを任意適用し、結果は JSON あるいは順位付きテキストで取得できます。
 
 ```json
 {
@@ -80,17 +80,17 @@ My AWS Tools プラグインは、複数の AWS サービスに基づくツー
 
 - **Apply Guardrail**: Bedrock Runtime の `apply_guardrail` を呼び出し、以下の特徴を持ちます。
   - 入力: `content` 配列（テキスト複数・画像 bytes/S3 URI）または単一 `text`（1000 文字ごとに自動分割し content 化）。
-  - `source`: PREPROCESS（既定）/POSTPROCESS を指定可能。
+  - `source`: 入力（既定） に適用するか、 出力 に適用するかを指定可能。
   - 出力: action、processedOutputs（マスク後）、outputs（マスク前）、assessments、warnings/actionReasons をテキストと JSON blob で返却。
   - チャンク分割で長文の課金/サイズ上限に対応。
 
 #### Apply Guardrail サンプルリクエスト (複数テキスト)
 
 ```json
 {
-  "guardrail_id": "gr-123",
-  "guardrail_version": "2",
-  "source": "PREPROCESS",
+  "guardrail_id": "ab1cd2e3f45g",
+  "guardrail_version": "1",
+  "source": "入力",
   "content": [
     { "text": { "text": "ユーザーの入力テキスト1" } },
     { "text": { "text": "ユーザーの入力テキスト2" } }
@@ -102,9 +102,9 @@ My AWS Tools プラグインは、複数の AWS サービスに基づくツー
 
 ```json
 {
-  "guardrail_id": "gr-123",
+  "guardrail_id": "ab1cd2e3f45g",
   "guardrail_version": "2",
-  "source": "POSTPROCESS",
+  "source": "出力",
   "content": [
     {
       "image": {

requirements.txt

@@ -1,4 +1,4 @@
 dify_plugin>=0.4.2,<0.5.0
-boto3>=1.40.45
-Pillow>=11.3.0
-bedrock-agentcore>=1.0.6
+boto3>=1.41.3
+Pillow>=12.0.0
+bedrock-agentcore>=1.1.1

tools/apply_guardrail.py

@@ -55,12 +55,24 @@ def _one_of_text_or_image(cls, v, values):
 
 class GuardrailParameters(BaseModel):
     guardrail_id: str = Field(..., description="The identifier of the guardrail")
-    guardrail_version: str = Field(..., description="The version of the guardrail")
-    source: str = Field("PREPROCESS", description="PREPROCESS or POSTPROCESS or custom source")
+    guardrail_version: str = Field(
+        "DRAFT",
+        description="The version of the guardrail. Defaults to DRAFT when omitted.",
+    )
+    source: str = Field("INPUT", description="INPUT or OUTPUT")
     text: Optional[str] = Field(None, description="Text to apply the guardrail to (legacy single input)")
     content: Optional[list[ContentItem]] = Field(None, description="List of content items (text/image)")
     aws_region: Optional[str] = Field(None, description="AWS region for the Bedrock client")
 
+    @validator("guardrail_version", pre=True, always=True)
+    def _default_guardrail_version(cls, value: Optional[str]) -> str:
+        """guardrail_version が空や未指定の場合は DRAFT を適用する。"""
+        if value is None:
+            return "DRAFT"
+        if isinstance(value, str) and value.strip() == "":
+            return "DRAFT"
+        return value
+
 
 class ApplyGuardrailTool(Tool):
     def _invoke(
@@ -134,6 +146,10 @@ def _invoke(
                 "warnings": warnings,
                 "actionReasons": action_reasons,
             }
+
+            # JSON 形式でも返却し、ワークフロー内で扱いやすくする
+            yield self.create_json_message(structured_payload)
+
             yield self.create_blob_message(
                 blob=json.dumps(structured_payload, ensure_ascii=False).encode("utf-8"),
                 meta={"mime_type": "application/json"},

tools/apply_guardrail.yaml

@@ -4,108 +4,121 @@ identity:
   label:
     en_US: Content Moderation Guardrails
     zh_Hans: 内容审查护栏
-    ja_JP: コンテンツモデレーションガードレール
+    ja_JP: ガードレールによるコンテンツモデレーション
 description:
   human:
     en_US: "Content Moderation Guardrails utilizes the ApplyGuardrail API, a feature of Guardrails for Amazon Bedrock. This API is capable of evaluating input prompts and model responses for all Foundation Models (FMs), including those on Amazon Bedrock, custom FMs, and third-party FMs. By implementing this functionality, organizations can achieve centralized governance across all their generative AI applications, thereby enhancing control and consistency in content moderation."
     zh_Hans: "内容审查护栏采用 Guardrails for Amazon Bedrock 功能中的 ApplyGuardrail API 。ApplyGuardrail 可以评估所有基础模型(FMs)的输入提示和模型响应，包括 Amazon Bedrock 上的 FMs、自定义 FMs 和第三方 FMs。通过实施这一功能, 组织可以在所有生成式 AI 应用程序中实现集中化的治理，从而增强内容审核的控制力和一致性。"
     ja_JP: "Amazon Bedrock Guardrails の ApplyGuardrail API を利用し、ユーザー入力やモデル出力を横断的に審査できるコンテンツモデレーションツールです。Bedrock 標準モデルやカスタム/サードパーティ FM を統合的に管理し、生成 AI アプリ全体の統制と一貫性を高めます。"
   llm: "Content Moderation Guardrails utilizes the ApplyGuardrail API, a feature of Guardrails for Amazon Bedrock. This API is capable of evaluating input prompts and model responses for all Foundation Models (FMs), including those on Amazon Bedrock, custom FMs, and third-party FMs. By implementing this functionality, organizations can achieve centralized governance across all their generative AI applications, thereby enhancing control and consistency in content moderation."
 parameters:
-  - name: aws_access_key_id
-    type: string
-    required: false
-    label:
-      en_US: AWS Access Key ID
-      ja_JP: AWS アクセスキー ID
-    human_description:
-      en_US: Override the provider Access Key ID for this tool if needed.
-      ja_JP: 必要に応じてプロバイダー設定を上書きする Access Key ID。
-    form: form
-
-  - name: aws_secret_access_key
-    type: string
-    required: false
-    label:
-      en_US: AWS Secret Access Key
-      ja_JP: AWS シークレットアクセスキー
-    human_description:
-      en_US: Override the provider Secret Access Key for this tool if needed.
-      ja_JP: 必要に応じてプロバイダー設定を上書きするシークレットキー。
-    form: form
-
-  - name: aws_region
-    type: string
-    required: false
-    label:
-      en_US: AWS Region
-      ja_JP: AWS リージョン
-    human_description:
-      en_US: Override the default AWS Region for this tool.
-      ja_JP: このツール固有の AWS リージョンを指定します。
-    form: form
-
   - name: guardrail_id
     type: string
     required: true
     label:
       en_US: Guardrail ID
       zh_Hans: Guardrail ID
-      ja_JP: ガードレール ID
+      ja_JP: "Amazon Bedrock ガードレール の ID"
     human_description:
-      en_US: Please enter the ID of the Guardrail that has already been created on Amazon Bedrock, for example 'qk5nk0e4b77b'.
-      zh_Hans: 请输入已经在 Amazon Bedrock 上创建好的 Guardrail ID, 例如 'qk5nk0e4b77b'.
-      ja_JP: "Amazon Bedrock で作成済みの Guardrail ID（例: qk5nk0e4b77b）を入力してください。"
-    llm_description: Please enter the ID of the Guardrail that has already been created on Amazon Bedrock, for example 'qk5nk0e4b77b'.
+      en_US: Please enter the ID of the Guardrail that has already been created on Amazon Bedrock, for example 'ab1cd2e3f45g'.
+      zh_Hans: 请输入已经在 Amazon Bedrock 上创建好的 Guardrail ID, 例如 'ab1cd2e3f45g'.
+      ja_JP: "Amazon Bedrock で作成済みの Guardrail ID（例: ab1cd2e3f45g）を入力してください。"
+    llm_description: Please enter the ID of the Guardrail that has already been created on Amazon Bedrock, for example 'ab1cd2e3f45g'.
     form: form
+
   - name: guardrail_version
     type: string
-    required: true
+    required: false
     label:
       en_US: Guardrail Version Number
       zh_Hans: Guardrail 版本号码
-      ja_JP: ガードレールのバージョン
+      ja_JP: "適用するガードレールのバージョン"
     human_description:
-      en_US: Please enter the published version of the Guardrail ID that has already been created on Amazon Bedrock. This is typically a version number, such as 2.
-      zh_Hans: 请输入已经在Amazon Bedrock 上创建好的Guardrail ID发布的版本, 通常使用版本号, 例如2.
-      ja_JP: "対象 Guardrail の公開バージョン番号（例: 2）を入力してください。"
-    llm_description: Please enter the published version of the Guardrail ID that has already been created on Amazon Bedrock. This is typically a version number, such as 2.
+      en_US: "Guardrail version (numeric or DRAFT). Defaults to DRAFT when omitted."
+      zh_Hans: "Guardrail 版本（数字或 DRAFT）。未指定时使用 DRAFT。"
+      ja_JP: "対象 Guardrail の公開バージョン番号（例: 1）または DRAFT。未指定時は DRAFT を使用"
+    llm_description: "Guardrail version (numeric or DRAFT). Defaults to DRAFT when omitted."
     form: form
+
   - name: source
-    type: string
+    type: select
     required: false
+    default: INPUT
+    options:
+      - value: INPUT
+        label:
+          en_US: INPUT
+          ja_JP: 入力
+      - value: OUTPUT
+        label:
+          en_US: OUTPUT
+          ja_JP: 出力
     label:
-      en_US: Guardrail stage (PREPROCESS/POSTPROCESS)
-      ja_JP: ガードレール適用段階（PREPROCESS/POSTPROCESS）
+      en_US: "Guardrail stage (INPUT/OUTPUT)"
+      ja_JP: "ガードレールを適用する段階"
     human_description:
-      en_US: Stage to apply the guardrail. Default PREPROCESS. POSTPROCESS can be used for LLM outputs.
-      ja_JP: ガードレールを適用する段階。デフォルト PREPROCESS。LLM 出力に適用する場合は POSTPROCESS を指定。
-    llm_description: Stage to apply the guardrail. Default PREPROCESS. POSTPROCESS for post-response checks.
+      en_US: Stage to apply the guardrail. Default INPUT. OUTPUT can be used for LLM outputs.
+      ja_JP: "ガードレールを適用する段階。LLM 出力に対して適用する場合は 出力 を指定してください"
+    llm_description: Stage to apply the guardrail. Default INPUT. OUTPUT for post-response checks.
     form: form
 
   - name: text
     type: string
     required: false
     label:
-      en_US: Text to be reviewed (single input)
-      ja_JP: 審査対象テキスト（単一入力）
+      en_US: "Text to be reviewed (single input)"
+      ja_JP: "審査対象テキスト（単一入力）"
     human_description:
-      en_US: Optional single text. If provided, it will be chunked by 1000 chars and sent as content array.
-      ja_JP: 単一テキスト入力（任意）。指定すると 1000 文字ごとに分割され content 配列として送信されます。
+      en_US: "Optional single text. If provided, it will be chunked by 1000 chars and sent as content array."
+      ja_JP: "単一テキスト入力（任意） 1000文字ごとに分割され content 配列として送信されます。"
     llm_description: Optional single text to review. Will be chunked and wrapped into the content array.
     form: llm
 
   - name: content
     type: string
     required: false
     label:
-      en_US: Content array (JSON)
-      ja_JP: content 配列（JSON）
+      en_US: "Content array (JSON)"
+      ja_JP: "content 配列（JSON）"
     human_description:
       en_US: "JSON array of items: {\"text\": {\"text\": \"...\"}} or {\"image\": {\"format\": \"png|jpeg\", \"source\": {\"bytes\": \"...\" | \"s3Uri\": \"s3://...\"}}}. Use this for multiple texts or images."
-      ja_JP: "複数テキスト・画像を送る場合の JSON 配列。例 {\"text\":{\"text\":\"...\"}} または {\"image\":{\"format\":\"png|jpeg\",\"source\":{\"bytes\":\"...\" または \"s3Uri\":\"s3://...\"}}}。"
+      ja_JP: "複数テキストや画像を送る場合の JSON 配列。例 {\"text\":{\"text\":\"...\"}} または {\"image\":{\"format\":\"png|jpeg\",\"source\":{\"bytes\":\"...\" または \"s3Uri\":\"s3://...\"}}}"
     llm_description: JSON array for multi text/image inputs. See human description for shape.
     form: llm
+
+  - name: aws_access_key_id
+    type: string
+    required: false
+    label:
+      en_US: AWS Access Key ID
+      ja_JP: AWS アクセスキー ID
+    human_description:
+      en_US: Override the provider Access Key ID for this tool if needed.
+      ja_JP: 必要に応じてプロバイダー設定を上書きする Access Key ID。
+    form: form
+
+  - name: aws_secret_access_key
+    type: string
+    required: false
+    label:
+      en_US: AWS Secret Access Key
+      ja_JP: AWS シークレットアクセスキー
+    human_description:
+      en_US: Override the provider Secret Access Key for this tool if needed.
+      ja_JP: 必要に応じてプロバイダー設定を上書きするシークレットキー。
+    form: form
+
+  - name: aws_region
+    type: string
+    required: false
+    label:
+      en_US: AWS Region
+      ja_JP: AWS リージョン
+    human_description:
+      en_US: Override the default AWS Region for this tool.
+      ja_JP: このツール固有の AWS リージョンを指定します。
+    form: form
+
 extra:
   python:
     source: tools/apply_guardrail.py