SiYuan Notes AI Assistant Plugin, which enables rich functionalities such as Q&A and editing based on the content of SiYuan Notes.
Note: Using this plugin requires you to prepare your own API keys from AI platforms. The plugin itself does not provide AI services. Please comply with the terms of use and privacy policies of each platform.
For friends who need to use top-tier models like GPT-5, Gemini 2.5 Pro, Claude 4.5, etc.
- Recommended V3 API Website. It's very easy to use, pay-as-you-go, supports various AI models, and can save you a lot of money compared to using the official API. Register using my invitation link to get a $0.3 balance bonus for trial.
See CHANGELOG.md
- Multi-platform AI Support:
- Built-in support for common platforms (OpenAI, Google Gemini, DeepSeek, Volcano Engine)
- Also supports adding any platform compatible with the OpenAI API, allowing flexible switching of chat models
- Model Settings
- Supports independent configuration of parameters for each model (temperature, max tokens)
- Identifies special model capabilities (thinking mode, vision support)
- Three Chat Mode Switching: Switch between ask, edit, and agent chat modes
- Ask Mode: For daily Q&A, supports selecting multiple models to reply simultaneously and choosing satisfactory answers
- Edit Mode: For editing and modifying notes, supports viewing differences after editing and undo functionality
- Agent Mode: Provides tools for the AI to autonomously query note content, edit notes, create documents, etc.
- Conversation Management
- Supports saving conversation history, pinning and deleting historical records
- Supports copying conversations as Markdown
- Supports saving conversations as documents
- Multimodal Support
- SiYuan Notes Content: Upload note content by dragging blocks, dragging page tabs, or dragging documents from the document tree
- Image Upload: Supports pasting, uploading images, and also supports dragging image blocks directly for upload
- File Upload (Supports Markdown, text files, etc.)
- Prompt Management
- Supports creating and saving commonly used prompts for quick insertion into the input box
pnpm install
pnpm run devsrc\tools\index.ts: Implementation code for tools called in agent mode
GPL3 License
- Developed based on the plugin-sample-vite-svelte template
- Referenced the GPT conversation functionality implementation from sy-f-misc
If you have any issues or suggestions, please feel free to raise them in GitHub Issues.
If you like my plugin, you are welcome to give a star on the GitHub repository and offer appreciation via WeChat. This will motivate me to continue improving this plugin and developing new ones.
Maintaining plugins is time-consuming and labor-intensive. Personal time and energy are limited. Open source is about sharing, but it does not mean I have to waste my time implementing features for users for free.
I will gradually improve features that I need. Appreciation can expedite updates. For some features I think can be improved but are not currently necessary, they may require appreciation to be prioritized (marked with an appreciation tag and the required amount). Features that are not needed or are very complicated to implement will have their issues closed directly without consideration.
Friends who have accumulated appreciation totaling 50 RMB and wish to add me on WeChat can send an email to achuan-2@outlook.com to request adding as a friend (If the appreciation does not reach 50 RMB, I will not reply to the email or add you as a friend, as I do not wish to be a free customer service representative).