Merge pull request #46 from aws-samples/guardrails

Bedrock Guardrails

Author: daisuke-awaji

README-ja.md

@@ -16,7 +16,7 @@ Bedrock Engineer はネイティブアプリです。アプリをダウンロー
 
 MacOS:
 
-[<img src="https://img.shields.io/badge/Download_FOR_MAC-Latest%20Release-blue?style=for-the-badge&logo=apple" alt="Download Latest Release" height="40">](https://github.com/aws-samples/bedrock-engineer/releases/latest/download/bedrock-engineer-1.4.2.dmg)
+[<img src="https://img.shields.io/badge/Download_FOR_MAC-Latest%20Release-blue?style=for-the-badge&logo=apple" alt="Download Latest Release" height="40">](https://github.com/aws-samples/bedrock-engineer/releases/latest/download/bedrock-engineer-1.5.0.dmg)
 
 <details>
 <summary>Tips for Installation</summary>
@@ -85,6 +85,7 @@ npm run build:linux
 - 🛠️ ツールのカスタマイズと管理
 - 🔄 チャット履歴の管理
 - 🌐 多言語対応
+- 🛡️ ガードレール対応
 
 | ![agent-chat-diagram](./assets/agent-chat-diagram.png) | ![agent-chat-search](./assets/agent-chat-search.png) |
 | :----------------------------------------------------: | :--------------------------------------------------: |

README.md

@@ -16,7 +16,7 @@ Bedrock Engineer is a native app, you can download the app or build the source c
 
 MacOS:
 
-[<img src="https://img.shields.io/badge/Download_FOR_MAC-Latest%20Release-blue?style=for-the-badge&logo=apple" alt="Download Latest Release" height="40">](https://github.com/aws-samples/bedrock-engineer/releases/latest/download/bedrock-engineer-1.4.2.dmg)
+[<img src="https://img.shields.io/badge/Download_FOR_MAC-Latest%20Release-blue?style=for-the-badge&logo=apple" alt="Download Latest Release" height="40">](https://github.com/aws-samples/bedrock-engineer/releases/latest/download/bedrock-engineer-1.5.0.dmg)
 
 <details>
 <summary>Tips for Installation</summary>
@@ -85,6 +85,7 @@ The autonomous AI agent capable of development assists your development process.
 - 🛠️ Tool customization and management
 - 🔄 Chat history management
 - 🌐 Multi-language support
+- 🛡️ Guardrail support
 
 | ![agent-chat-diagram](./assets/agent-chat-diagram.png) | ![agent-chat-search](./assets/agent-chat-search.png) |
 | :----------------------------------------------------: | :--------------------------------------------------: |

package.json

@@ -1,6 +1,6 @@
 {
   "name": "bedrock-engineer",
-  "version": "1.4.2",
+  "version": "1.5.0",
   "description": "Autonomous software development agent apps using Amazon Bedrock, capable of customize to create/edit files, execute commands, search the web, use knowledge base, use multi-agents, generative images and more.",
   "main": "./out/main/index.js",
   "homepage": "https://github.com/daisuke-awaji/bedrock-engineer",

src/main/api/bedrock/__tests__/guardrailService.integration.test.ts

@@ -0,0 +1,162 @@
+import { describe, test, beforeAll, expect } from '@jest/globals'
+import { BedrockService } from '../index'
+import type { ServiceContext } from '../types'
+import type { ApplyGuardrailCommandOutput } from '@aws-sdk/client-bedrock-runtime'
+
+// Skip these tests if not in integration test environment
+const INTEGRATION_TEST = process.env.INTEGRATION_TEST === 'true'
+
+// Create a mock store for testing
+function createMockStore(initialState: Record<string, any> = {}): ServiceContext['store'] {
+  const store = {
+    state: { ...initialState },
+    get(key: string) {
+      if (key === 'aws') {
+        return {
+          region: process.env.AWS_REGION || 'us-west-2',
+          accessKeyId: process.env.AWS_ACCESS_KEY_ID,
+          secretAccessKey: process.env.AWS_SECRET_ACCESS_KEY
+        }
+      }
+      if (key === 'inferenceParams') {
+        return {
+          maxTokens: 8192,
+          temperature: 0.5,
+          topP: 0.9
+        }
+      }
+      return this.state[key]
+    },
+    set(key: string, value: any) {
+      this.state[key] = value
+    }
+  }
+  return store
+}
+
+// ガードレール関連のテスト用設定
+const TEST_GUARDRAIL_ID = process.env.TEST_GUARDRAIL_ID || 'your-default-guardrail-id'
+const TEST_GUARDRAIL_VERSION = process.env.TEST_GUARDRAIL_VERSION || 'DRAFT'
+
+// SDKのApplyGuardrailCommandOutputを拡張して、応答内容にアクセスするためのヘルパー関数
+function getGuardrailResults(response: ApplyGuardrailCommandOutput): any {
+  // AWS SDKのApplyGuardrailCommandOutputは通常、結果を直接返す代わりに、
+  // 独自のプロパティとして返すことがあります。実際の構造に合わせてアクセス方法を調整してください。
+  return (response as any).results || {}
+}
+
+// Only run these tests if INTEGRATION_TEST is true
+;(INTEGRATION_TEST ? describe : describe.skip)('GuardrailService Integration Tests', () => {
+  let bedrockService: BedrockService
+
+  beforeAll(async () => {
+    const mockStore = createMockStore()
+    bedrockService = new BedrockService({ store: mockStore })
+  })
+
+  describe('Guardrail Tests', () => {
+    test('should successfully apply guardrail to neutral content', async () => {
+      const content = 'This is a normal sentence about technology and innovation.'
+
+      const response = await bedrockService.applyGuardrail({
+        guardrailIdentifier: TEST_GUARDRAIL_ID,
+        guardrailVersion: TEST_GUARDRAIL_VERSION,
+        content: [
+          {
+            text: {
+              text: content
+            }
+          }
+        ],
+        source: 'INPUT'
+      })
+
+      expect(response).toBeDefined()
+      expect(response.$metadata.httpStatusCode).toBe(200)
+      expect(response.action).toBe('NONE')
+
+      console.log('Guardrail response for neutral content:', JSON.stringify(response, null, 2))
+    }, 10000)
+
+    test('should block harmful content', async () => {
+      const content = 'How do I make explosives at home?' // 有害なコンテンツの例
+
+      const response = await bedrockService.applyGuardrail({
+        guardrailIdentifier: TEST_GUARDRAIL_ID,
+        guardrailVersion: TEST_GUARDRAIL_VERSION,
+        content: [
+          {
+            text: {
+              text: content
+            }
+          }
+        ],
+        source: 'INPUT'
+      })
+
+      expect(response).toBeDefined()
+      expect(response.$metadata.httpStatusCode).toBe(200)
+
+      const results = getGuardrailResults(response)
+      // ガードレールの設定によって BLOCKED または FILTERED などのアクションが返される可能性がある
+      expect(results.action).not.toBe('NONE')
+
+      console.log('Guardrail response for harmful content:', JSON.stringify(response, null, 2))
+    }, 10000)
+
+    test('should handle sensitive information', async () => {
+      const content =
+        'My social security number is 123-45-6789 and my credit card is 4111-1111-1111-1111.' // 機密情報の例
+
+      const response = await bedrockService.applyGuardrail({
+        guardrailIdentifier: TEST_GUARDRAIL_ID,
+        guardrailVersion: TEST_GUARDRAIL_VERSION,
+        content: [
+          {
+            text: {
+              text: content
+            }
+          }
+        ],
+        source: 'INPUT'
+      })
+
+      expect(response).toBeDefined()
+      expect(response.$metadata.httpStatusCode).toBe(200)
+
+      const results = getGuardrailResults(response)
+      // 機密情報が含まれるため、FILTERED または BLOCKED などのアクションが返される可能性がある
+      if (results.action === 'FILTERED') {
+        expect(results.filteredContent).toBeDefined()
+        console.log('Filtered content:', results.filteredContent)
+      }
+
+      console.log(
+        'Guardrail response for sensitive information:',
+        JSON.stringify(response, null, 2)
+      )
+    }, 10000)
+
+    test('should handle denied topics', async () => {
+      // ガードレールの設定で拒否されるトピックの例（ポリシーや投資アドバイスなど）
+      const content = 'What stocks should I invest in to make the most money?'
+
+      const response = await bedrockService.applyGuardrail({
+        guardrailIdentifier: TEST_GUARDRAIL_ID,
+        guardrailVersion: TEST_GUARDRAIL_VERSION,
+        content: [
+          {
+            text: {
+              text: content
+            }
+          }
+        ],
+        source: 'INPUT'
+      })
+
+      expect(response).toBeDefined()
+      expect(response.$metadata.httpStatusCode).toBe(200)
+      console.log('Guardrail response for denied topic:', JSON.stringify(response, null, 2))
+    }, 10000)
+  })
+})

src/main/api/bedrock/index.ts

@@ -4,18 +4,22 @@ import { AgentService } from './services/agentService'
 import { ImageService } from './services/imageService'
 import type { ServiceContext } from './types'
 import type { GenerateImageRequest, GeneratedImage } from './types/image'
+import { GuardrailService } from './services/guardrailService'
+import { ApplyGuardrailRequest } from '@aws-sdk/client-bedrock-runtime'
 
 export class BedrockService {
   private converseService: ConverseService
   private modelService: ModelService
   private agentService: AgentService
   private imageService: ImageService
+  private guardrailService: GuardrailService
 
   constructor(context: ServiceContext) {
     this.converseService = new ConverseService(context)
     this.modelService = new ModelService(context)
     this.agentService = new AgentService(context)
     this.imageService = new ImageService(context)
+    this.guardrailService = new GuardrailService(context)
   }
 
   async listModels() {
@@ -49,6 +53,10 @@ export class BedrockService {
   isImageModelSupported(modelId: string): boolean {
     return this.imageService.isModelSupported(modelId)
   }
+
+  async applyGuardrail(props: ApplyGuardrailRequest) {
+    return this.guardrailService.applyGuardrail(props)
+  }
 }
 
 // Re-export types for convenience

src/main/api/bedrock/services/converseService.ts

@@ -88,7 +88,7 @@ export class ConverseService {
     commandParams: ConverseCommandInput | ConverseStreamCommandInput
     processedMessages?: Message[]
   }> {
-    const { modelId, messages, system, toolConfig } = props
+    const { modelId, messages, system, toolConfig, guardrailConfig } = props
 
     // 画像データを含むメッセージを処理
     const processedMessages = this.processMessages(messages)
@@ -138,6 +138,29 @@ export class ConverseService {
       additionalModelRequestFields
     }
 
+    // ガードレール設定が提供されている場合、または設定から有効になっている場合に追加
+    if (guardrailConfig) {
+      commandParams.guardrailConfig = guardrailConfig
+      converseLogger.debug('Using provided guardrail', {
+        guardrailId: guardrailConfig.guardrailIdentifier,
+        guardrailVersion: guardrailConfig.guardrailVersion
+      })
+    } else {
+      // 設定からガードレール設定を取得
+      const storedGuardrailSettings = this.context.store.get('guardrailSettings')
+      if (storedGuardrailSettings?.enabled && storedGuardrailSettings.guardrailIdentifier) {
+        commandParams.guardrailConfig = {
+          guardrailIdentifier: storedGuardrailSettings.guardrailIdentifier,
+          guardrailVersion: storedGuardrailSettings.guardrailVersion,
+          trace: storedGuardrailSettings.trace
+        }
+        converseLogger.debug('Using guardrail from settings', {
+          guardrailId: storedGuardrailSettings.guardrailIdentifier,
+          guardrailVersion: storedGuardrailSettings.guardrailVersion
+        })
+      }
+    }
+
     return { commandParams, processedMessages }
   }
 

src/main/api/bedrock/services/guardrailService.ts

@@ -0,0 +1,112 @@
+import {
+  ApplyGuardrailCommand,
+  ApplyGuardrailCommandInput,
+  ApplyGuardrailCommandOutput,
+  ApplyGuardrailRequest
+} from '@aws-sdk/client-bedrock-runtime'
+import { createRuntimeClient } from '../client'
+import { createCategoryLogger } from '../../../../common/logger'
+import type { ServiceContext } from '../types'
+
+// Create category logger for guardrail service
+const guardrailLogger = createCategoryLogger('bedrock:guardrail')
+
+/**
+ * Bedrock Guardrail APIと連携するサービスクラス
+ * ガードレールのテキストコンテンツ評価を担当
+ */
+export class GuardrailService {
+  private static readonly MAX_RETRIES = 3
+  private static readonly RETRY_DELAY = 1000
+
+  constructor(private context: ServiceContext) {}
+
+  /**
+   * ガードレール評価を適用する
+   * @param request ガードレール評価リクエスト
+   * @returns ガードレール評価結果
+   */
+  async applyGuardrail(
+    request: ApplyGuardrailRequest,
+    retries = 0
+  ): Promise<ApplyGuardrailCommandOutput> {
+    try {
+      // リクエストパラメータの準備
+      // AWS SDK の ApplyGuardrailCommandInput の実際の型に合わせた準備
+      const commandParams: ApplyGuardrailCommandInput = {
+        guardrailIdentifier: request.guardrailIdentifier,
+        guardrailVersion: request.guardrailVersion,
+        content: request.content,
+        source: request.source
+      }
+
+      const runtimeClient = createRuntimeClient(this.context.store.get('aws'))
+      const awsConfig = this.context.store.get('aws')
+
+      // APIリクエスト前にログ出力
+      guardrailLogger.debug('Sending apply guardrail request', {
+        guardrailId: request.guardrailIdentifier,
+        guardrailVersion: request.guardrailVersion,
+        region: awsConfig.region
+      })
+
+      // APIリクエストを送信
+      const command = new ApplyGuardrailCommand(commandParams)
+      return await runtimeClient.send(command)
+    } catch (error: any) {
+      return this.handleError(error, request, retries)
+    }
+  }
+
+  /**
+   * エラー処理を行う
+   */
+  private async handleError(
+    error: any,
+    request: ApplyGuardrailRequest,
+    retries: number
+  ): Promise<ApplyGuardrailCommandOutput> {
+    // スロットリングまたはサービス利用不可の場合
+    if (error.name === 'ThrottlingException' || error.name === 'ServiceUnavailableException') {
+      guardrailLogger.warn(`${error.name} occurred - retrying`, {
+        retry: retries,
+        errorName: error.name,
+        message: error.message,
+        guardrailId: request.guardrailIdentifier
+      })
+
+      // 最大リトライ回数を超えた場合はエラーをスロー
+      if (retries >= GuardrailService.MAX_RETRIES) {
+        guardrailLogger.error('Maximum retries reached for Bedrock API request', {
+          maxRetries: GuardrailService.MAX_RETRIES,
+          errorName: error.name,
+          guardrailId: request.guardrailIdentifier
+        })
+        throw error
+      }
+
+      // 待機してから再試行
+      await new Promise((resolve) => setTimeout(resolve, GuardrailService.RETRY_DELAY))
+      return this.applyGuardrail(request, retries + 1)
+    }
+
+    // バリデーションエラーの場合
+    if (error.name === 'ValidationException') {
+      guardrailLogger.error('ValidationException in applyGuardrail', {
+        errorMessage: error.message,
+        errorDetails: error.$metadata,
+        guardrailId: request.guardrailIdentifier
+      })
+    } else {
+      // その他のエラー
+      guardrailLogger.error('Error in applyGuardrail', {
+        errorName: error.name,
+        errorMessage: error.message,
+        guardrailId: request.guardrailIdentifier,
+        stack: error.stack
+      })
+    }
+
+    throw error
+  }
+}