docmd-assistant v0.1.0 が利用可能になりました →
ドキュメントに根ざしたAIアシスタント。
OpenAI gpt-4o-mini
ドキュメントに根ざしたAIアシスタント。
任意のLLMプロバイダー。 APIキーがサーバー外に出ることはありません。
ドキュメントを読み取り、コンテキストに応じて質問に回答。100以上のモデル、あらゆるWebサイトに対応し、APIキーを安全に保護。
独立したヘッドレスエンジン
サーバー側安全キー管理
検索連携RAG
100以上のAIモデル
docmd-assistant 動作デモ
docmd アシスタントの回答
RAGコンテキスト: /configuration/workspaces & docmd.config.json
複数ワークスペースをルーティングするには、
docmd.config.json内にprefixとsrcを持つworkspaces配列を定義します。アーキテクチャ
仕組み
独立しても一緒でも動作するように設計された、ヘッドレスエンジンとフレームワークプラグイン。
ヘッドレスでどこでも使用可能
docmd-assistantはUIの制約がない単体ライブラリです。React、Vue、Svelte、Node.js、または任意のJavaScriptアプリに統合可能です。
DocmdAssistantEngine (ESM/CJS)
APIキーは常にサーバー上で管理
AIプロバイダーのクレデンシャルはサーバー上に安全に保持されます。ブラウザクライアントが生APIキーを保持・送信・露出することはありません。
KMS Envelope Encryption
コンテンツに根ざした正確な回答
回答を生成する前に、エンジンがdocmd-searchインデックスを用いて関連箇所を抽出するため、正確で文脈に沿った回答が得られます。
RAG Search Index Binding
LLMプロバイダー
あらゆるAIプロバイダーに対応
クラウドプロバイダーへ直接接続、またはセキュアなリレイ経由。ローカルモデルを使えば完全オフラインでも動作。
| プロバイダー | 対応モデル | 接続モード | セキュリティアーキテクチャ |
|---|---|---|---|
| OpenAI | gpt-4o, gpt-4o-mini | Direct / Relay | サーバー側KMSエンベロープ暗号化 |
| Anthropic | claude-3-5-sonnet, haiku | Direct / Relay | サーバー側KMSエンベロープ暗号化 |
| Google Gemini | gemini-1.5-flash, pro | Direct / Relay | サーバー側KMSエンベロープ暗号化 |
| DeepSeek & Groq | deepseek-chat, llama-3.3 | Direct / Relay | サーバー側KMSエンベロープ暗号化 |
| Ollama (Local) | llama3, mistral, qwen | Direct Offline | 100% ローカル / クラウドなし |
開発者向け統合
数行のコードで統合可能
エンジンインスタンスを作成し、検索インデックスを接続して質問への回答を開始。ストリーミング、カスタムツール、対話履歴に対応。
import { DocmdAssistantEngine } from 'docmd-assistant'; import * as Search from '@docmd/plugin-search/client'; // 1. Initialise engine instance with provider configuration const engine = new DocmdAssistantEngine({ provider: 'openai', model: 'gpt-4o-mini', systemPrompt: 'You are a helpful software documentation assistant.', ragCallback: async (query) => { const matches = await Search.search(query, 5); return matches.map(m => m.chunk.text).join('\\n\\n'); } }); // 2. Register custom client-side execution tool engine.registerTool({ name: 'fetch_user_workspace', description: 'Retrieve active workspace configuration', parameters: { type: 'object', properties: { workspaceId: { type: 'string' } } }, handler: async ({ workspaceId }) => ({ activeTheme: 'summer', mode: 'spa' }) }); // 3. Listen to real-time stream events and execute query turn engine.on('token', (chunk) => process.stdout.write(chunk)); await engine.sendMessage('How do I set up custom navigation in docmd?');
よくある質問
docmd-assistantおよびAIプラグインに関するFAQ。
どうやって正しい回答を把握するのですか?
言語モデルに問い合わせる前に、ドキュメントの検索インデックスから関連する文章を抽出しプロンプトにアタッチします。これにより、実際のコンテンツに基づいた回答が保証されます。
BYOK利用時にAPIキーは安全ですか?
はい。クレデンシャルはサーバー側のみで復号・使用されます。ブラウザクライアントが未暗号化のキーを受け取ることはありません。
完全にオフラインで動作できますか?
はい。Ollamaなどのローカルモデルプロバイダーを設定することで、検索抽出とAI回答のパイプライン全体が外部通信なしでローカル実行されます。