Smart Mermaid：フローチャートやタイミング図をテキストで素早く生成するAIツール

Smart Mermaidは、ユーザーが入力した自然言語のテキストをMermaid形式のコードに変換し、視覚的なチャートを生成することに特化したオープンソースのAI駆動型ウェブアプリケーションです。AI技術によってチャート作成プロセスを簡素化し、手作業で複雑なコードを書く必要性を排除します。ユーザーは簡単なテキストでビジネスプロセスやロジックを記述するだけで、Smart Mermaidはインテリジェントに解析し、フローチャート、タイミング図、クラス図、その他の多様な図を生成することができます。このプロジェクトは、Dockerのワンクリックデプロイメントをサポートしており、開発者、プロダクトマネージャー、プロフェッショナルなダイアグラムを素早く生成する必要がある人々に適しています。コードはGitHubでホストされており、810のスターと92のブランチがあり、活発なコミュニティ・サポートを示しています。

機能一覧

• 自然言語生成チャートユーザーがテキストで説明を入力すると、AIが自動的に解析し、マーメイド形式でチャートコードを生成します。
• 複数のチャートタイプをサポートフローチャート、タイミング図、クラス図、ガントチャート、アーキテクチャ図など、一般的なビジネスシナリオを網羅。
• カスタムAIコンフィギュレーションAPIアドレスやキーなど、個々の要件に応じたAIサービスの設定をサポート。
• プロフェッショナル・チャート・エディター編集とプレビュー機能を提供し、チャートの専門性を高めるために複数のレンダリングモードをサポートします。
• DockerのワンクリックデプロイメントDockerを使えば、ローカル環境もサーバー環境も簡単に構築できます。
• アクセス制御ユーザーが作成したコンテンツを保護するためのアクセスパスワードの設定に対応。

ヘルプの使用

設置プロセス

Smart MermaidはDockerによる迅速なデプロイをサポートしています：

1. クローン・コード・リポジトリ
   ターミナルで以下のコマンドを実行し、プロジェクトをローカルにクローンする：

   git clone https://github.com/liujuntao123/smart-mermaid.git
   cd smart-mermaid
   

2. Dockerブランチへの切り替え
   注意: masterブランチにはDocker設定ファイルが含まれていないため、Docker設定ファイルを docker 分岐する：

   git checkout docker
   

3. AIサービスの設定
   Smart Mermaidは、テキストを解析するためにOpenAI APIなどの外部AIサービスに依存しています。以下の環境変数の設定が必要です：
   • コンパイラ docker-compose.yml または環境変数ファイルに以下を追加する：

     AI_API_URL=https://api.openai.com/v1
     AI_API_KEY=你的API密钥
     AI_MODEL_NAME=gpt-3.5-turbo
     

   • アクセス制御が必要な場合は設定する：

     ACCESS_PASSWORD=你的访问密码
     

4. サービス開始
   Docker Composeを使ってサービスを開始する：

   docker-compose up -d
   

   サービスが開始すると、Smart Mermaidはローカルで実行されます。 http://localhost:3000.

5. アプリケーションへのアクセス
   ブラウザを開き、次のサイトにアクセスする。 http://localhost:3000.アクセスパスワードが設定されている場合は、パスワードを入力して操作画面にアクセスします。

主な機能

1.チャートの生成

• 手続き::
  1. ホームページのテキスト入力ボックスに、ビジネス・プロセスを説明する自然言語テキストを入力します。例えば、"ユーザがシステムにログインし、システムが身元を確認し、成功するとホームページに移動し、失敗するとエラーが表示されます"。
  2. 生成ボタンをクリックすると、AIがテキストを分析し、対応するマーメイドコードを生成します。
  3. システムは自動的に適切なダイアグラム・タイプ（フローチャートやタイミング・ダイアグラムなど）を選択しますが、手動でタイプを指定することもできます。
  4. 生成されたチャートは右側のプレビューエリアに表示され、リアルタイムの調整が可能。
• ほら::
  • 論理的な関係を記述し、曖昧な記述を避け、できるだけ明確に文章を入力する。
  • 最大20,000文字の入力に対応、1日の生成回数は5回まで（プロファイルで設定可能） NEXT_PUBLIC_DAILY_USAGE_LIMIT (修正済み）。

2.編集とエクスポート

• 編集チャート::
  • プレビューエリアにある「編集」ボタンをクリックすることで、マーメイドコードを直接修正することができます。
  • コードを調整すると、チャートがリアルタイムで更新され、素早くデバッグできる。
• チャートのエクスポート::
  • SVG、PNG、Mermaidコードファイルへのチャートのエクスポートをサポート。
  • エクスポート "ボタンをクリックし、フォーマットを選択してローカルにダウンロードする。
• レンダリングモード::
  • 複数のレンダリングモードに対応（ダークテーマやライトテーマなど）。

3.カスタム設定

• AIサービス構成::
  • ある docker-compose.yml 修正 AI_API_URL 歌で応える AI_API_KEYまた、他のAIサービス（ローカルに配置されたモデルなど）へのアクセスもサポートしている。
  • 調整可能 AI_MODEL_NAME さまざまなモデルを使用して発電を最適化する。
• アクセス制限::
  • セットアップ ACCESS_PASSWORD その後、正しいパスワードを入力したユーザーだけがアプリケーションにアクセスできる。

4.閲覧履歴

• 生成されたチャートはローカル・セッションに保存され、"History "をクリックすれば過去に生成されたチャートを見ることができる。
• 過去のチャートの再編集や削除をサポートし、管理を容易にします。

よくある質問

• AI解析の失敗検査 AI_API_KEY それが有効かどうか、ネットワーク接続が機能しているかどうかを確認してください。
• Dockerの起動エラーに切り替わったことを確認します。 docker ブランチ、チェック docker-compose.yml コンフィギュレーションは正しい。
• チャート表示の異常Mermaidの公式ドキュメント(https://mermaid.js.org).

アプリケーションシナリオ

1. プロダクトマネージャーはビジネスプロセスを設計する
   プロダクトマネージャーは、ビジネスロジックを記述するフローチャートやタイミングダイアグラムを素早く作成する必要があります。 Smart Mermaidは、自然言語で要件を入力し、時間を節約するプロフェッショナルなダイアグラムを素早く生成することができます。
2. 開発者向けドキュメント
   技術文書を書くとき、開発者はSmart Mermaidを使ってアーキテクチャ図やクラス図を素早く作成し、Markdownファイルに埋め込んで読みやすさを向上させることができます。
3. チームワークとプレゼンテーション
   プロジェクトについて議論する際、チームはSmart Mermaidを使って、PPTやオンライン・プレゼンテーションで使用する図表を生成・エクスポートし、コミュニケーションを促進することができます。
4. 教育とトレーニング
   先生やトレーナーは、Smart Mermaidを使って複雑な論理関係を視覚的な図に変換し、生徒の理解を助けることができます。

品質保証

1. Smart Mermaidはどのようなチャートをサポートしていますか？
   フローチャート、タイミング図、クラス図、ガントチャート、アーキテクチャ図をサポートし、ほとんどのビジネスシナリオをカバーします。
2. AIが作成したチャートが正確であることを確認するにはどうすればよいですか？
   論理的な関係を明確にするために、明確なテキスト説明を入力します。生成されたチャートは、Mermaidのコードを手動で編集して、ニーズに合ったものにすることができます。
3. プログラミングの経験は必要ですか？
   Smart Mermaidは自然言語を通してチャートを生成するので、ノンプログラマーの方にも適しています。開発者はさらにコードを編集して最適化することができます。
4. Dockerのデプロイにはどのような前提条件が必要ですか？
   AIサービス（OpenAI APIなど）へのネットワークアクセスを確保するために、GitとDocker Composeをインストールする必要がある。