ドキュメントに根ざしたAIアシスタント。
任意のLLMプロバイダー。 APIキーがサーバー外に出ることはありません。
ドキュメントを読み取り、コンテキストに応じて質問に回答。100以上のモデル、あらゆるWebサイトに対応し、APIキーを安全に保護。
DocmdAssistantEngine をローカルの Ollama インスタンスに接続します。埋め込み生成も推論もローカル完結し、クラウドキーや外部通信は一切不要です。
import { DocmdAssistantEngine } from 'docmd-assistant';
const engine = new DocmdAssistantEngine({
provider: 'ollama',
model: 'llama3.2',
baseUrl: 'http://localhost:11434'
});
仕組み
独立しても一緒でも動作するように設計された、ヘッドレスエンジンとフレームワークプラグイン。
ヘッドレスでどこでも使用可能
docmd-assistantはUIの制約がない単体ライブラリです。React、Vue、Svelte、Node.js、または任意のJavaScriptアプリに統合可能です。
APIキーは常にサーバー上で管理
AIプロバイダーのクレデンシャルはサーバー上に安全に保持されます。ブラウザクライアントが生APIキーを保持・送信・露出することはありません。
コンテンツに根ざした正確な回答
回答を生成する前に、エンジンがdocmd-searchインデックスを用いて関連箇所を抽出するため、正確で文脈に沿った回答が得られます。
ローカルモデルによる100%オフライン動作
ローカルの Ollama(llama3、mistral、qwen)にシームレスに接続し、クラウドを一切使わないエアギャップ運用が可能です。
100以上のAIプロバイダーとカスタムエンドポイントに対応
AIPlug ユニバーサルトランスポートランタイムを搭載。クラウドの最先端モデルへの直接接続、Cloud Relay を介したルーティング、ローカルハードウェアでの完全オフライン実行、または独自の企業向けAPIへの接続をベンダーロックインなしで実現します。
@memoryblock/aiplug)を介して接続を調整します。| プロバイダー | 対応モデル | 接続モード | セキュリティアーキテクチャ |
|---|---|---|---|
| OpenAI | gpt-4o, gpt-4o-mini, o1, o3-mini | ダイレクト / 中継 | ハードウェア KMS セキュア |
| Anthropic | claude-3-7-sonnet, haiku | ダイレクト / 中継 | ハードウェア KMS セキュア |
| Google Gemini | gemini-2.0-flash, pro | ダイレクト / 中継 | ハードウェア KMS セキュア |
| DeepSeek & Groq | deepseek-chat, deepseek-r1, llama-3.3 | ダイレクト / 中継 | ハードウェア KMS セキュア |
| Ollama (Local) | llama3.3, mistral, qwen2.5, phi-4 | 完全オフライン | 100% ローカル / クラウド不使用 |
| カスタム&エンタープライズ API | vLLM、LocalAI、社内 OpenAI 互換プロキシ、独自モデル | カスタムベース URL | テレメトリなし / オンプレミス |
| AIPlug 経由で100以上のプロバイダー | Mistral、Cohere、Bedrock、Together AI、Azure OpenAI、OpenRouter | AIPlug 統合トランスポート | 統合 BYOK&ハードウェア KMS |
静的ドキュメント向け無料 docmd Cloud Relay
GitHub Pages、Cloudflare Pages、Netlify、Vercel でデプロイしていますか? サーバーのセットアップ不要でドキュメント AI アシスタントを有効化できます。
ドメインを接続
GitHub アカウントで cloud.docmd.io にサインインし、ドキュメントのドメイン名を関連付けます。
暗号化された BYOK キーを保存
OpenAI、Anthropic、Gemini の API キーを登録します。ハードウェア KMS エンベロープにより安全に暗号化されます。
設定ファイルに Project ID を記述
docmd.config.json に projectId を追加します。クライアントはドメイン検証済みセッション経由で安全に通信します。
数行のコードで統合可能
エンジンインスタンスを作成し、検索インデックスを接続して質問への回答を開始。ストリーミング、カスタムツール、対話履歴に対応。
docmd.config.json
JSON設定不要のフレームワークプラグイン。プロジェクト設定でフローティングAIアシスタントを有効化し、Cloud Relay を直接連携できます。
assistant-engine.ts
TypeScriptNode.js および最新ランタイム向けのヘッドレスエンジン。Anthropic、OpenAI、Ollama を初期化し、トークン差分を直接ストリーミングします。
register-tools.ts
TypeScript拡張可能なツール実行。カスタム関数、ドキュメントナビゲーション、またはサーバー側ドメイン検索を登録できます。
// 1. Drop into docmd.config.json — zero server maintenance { "plugins": { "search": { "indexBody": true }, "ai": { "assistant": true, "projectId": "docmd_aiv77jc8ms8qtpvd", "position": "bottom-center", "greeting": "How can I help with these docs today?" } } }
import { DocmdAssistantEngine } from 'docmd-assistant'; // Initialise headless engine with any provider or custom gateway const assistant = new DocmdAssistantEngine({ provider: 'anthropic', model: 'claude-3-5-haiku-20241022', apiKey: process.env.ANTHROPIC_API_KEY, systemPrompt: 'You are an expert technical guide for our documentation.' }); // Subscribe to streaming response deltas assistant.on('chunk', (event) => process.stdout.write(event.data)); const response = await assistant.sendMessage('How do I configure custom plugins?'); console.log(response.message);
import { DocmdAssistantEngine, createStandardTools } from 'docmd-assistant'; // Connect via Cloud Relay with zero API key exposure on clients const assistant = new DocmdAssistantEngine({ projectId: 'docmd_aiv77jc8ms8qtpvd', endpoint: 'https://api.docmd.io/v1/ai/chat' }); // Register built-in search & navigation tools for (const tool of createStandardTools()) { assistant.registerTool(tool); } // Register custom domain tool (executed securely on server) assistant.registerTool({ name: 'lookup_account', description: 'Retrieve user account plan details', execute: async ({ email }) => ({ plan: 'enterprise', active: true }) });
よくある質問
docmd-assistantおよびAIプラグインに関するFAQ。
どうやって正しい回答を把握するのですか?
BYOK利用時にAPIキーは安全ですか?
完全にオフラインで動作できますか?
http://localhost:11434)に接続することで、ベクトル検索と LLM 生成を含む全パイプラインがクラウド呼び出しなしで自身のハードウェア上で100%オフライン動作します。docmd はユーザーの質問やドキュメントデータを保持しますか?
GitHub Sponsors で docmd を支援
docmd は完全無料でオープンソースです。スポンサー支援は開発とパブリックリレーインフラの維持に直接役立てられます。