Grey Swan

🚀 灰天鵝セキュリティアリーナ MongoDB ツールドキュメント

このドキュメントは、灰天鵝セキュリティアリーナにおけるMongoDBツールの使用方法を説明しています。MongoDBを使用して、モデル管理、スレッド管理、メッセージ管理などの機能を実現することができます。

🚀 クイックスタート

このセクションでは、灰天鵝セキュリティアリーナMongoDBツールのクイックスタートについて説明します。以下の手順に従って、ツールをインストールし、サービスを起動しましょう。

📦 インストール

依存関係のインストール

npm install express mongoose @types/express @types/node cors dotenv

サービスの起動

node src/index.ts

💻 使用例

基本的な使用法

1. MongoDBインスタンスの作成

config.json ファイルを編集します。

{
  "mongoUri": "mongodb://localhost:27017",
  "dbName": "securityArenaDB"
}

2. データベース接続の初期化

src/db/connection.ts で接続情報を設定します。

高度な使用法

モデルレコードの作成

const modelTool = new ModelTool();
await modelTool.create({
  name: "agent-redteam-session1",
  provider: "灰天鵝",
  version: "1.0",
  capabilities: ["redteaming", "prompt-injection"]
});

✨ 主な機能

コア機能

• モデル管理：モデルレコードの作成、読み取り、更新、削除を行います。
• スレッド管理：AIセキュリティチャレンジに関連するディスカッションスレッドを処理します。
• メッセージ管理：ユーザーとアシスタント間の会話内容を保存および照会します。

ツールリスト

// モデルツール
import { ModelTool } from './tools/mongoModel';
// スレッドツール
import { ThreadTool } from './tools/mongoThread';
// メッセージツール
import { MessageTool } from './tools/mongoMessage';

📚 ドキュメント

プロジェクト構造

src/
├── db/
│   ├── connection.ts         # MongoDB 接続設定
│   ├── controllers/          # データベース操作コントローラー
│   │   ├── modelController.ts
│   │   ├── threadController.ts
│   │   └── messageController.ts
│   └── models/               # データベーススキーマ定義
│       ├── Model.ts
│       ├── Thread.ts
│       └── Message.ts
├── tools/
│   ├── mongoModel.ts         # モデル管理ツール
│   ├── mongoThread.ts        # スレッド管理ツール
│   └── mongoMessage.ts       # メッセージ管理ツール
└── index.ts                  # アプリケーションエントリーファイル

ベストプラクティス

1. 命名規則：変数と関数の命名には英語または意味のある中国語を使用します。
2. エラー処理：各データベース操作にエラーキャッチとログ記録を追加します。
3. データ検証：入力データに対して厳格な形式チェックと検証を行います。

貢献ガイド

どんな貢献も歓迎します！詳細はプロジェクトリポジトリを参照してください。

📄 ライセンス

このプロジェクトはMITライセンスの下で提供されています。詳細な条項は LICENSE ファイルを参照してください。

謝辞

MongoDBコミュニティによる技術サポートに感謝します。