English | 中文

AI Bot Plugin 🤖

Overview 🌟

The AI Bot Plugin is a powerful tool designed to enhance your note-editing experience in Obsidian by leveraging the capabilities of AI. This plugin allows you to interact with an AI assistant directly within Obsidian, making it easier to generate, edit, and organize your notes with intelligent suggestions and automated tasks.

Features 🚀

• AI-Powered Assistance: Get intelligent suggestions and automated tasks directly within Obsidian.
• Contextual Understanding: The AI understands the context of your notes, providing more accurate and relevant responses.
• Customizable Settings: Configure the base URL, API key, and model to suit your needs.
• User-Friendly Interface: Intuitive modal interface for easy interaction with the AI.
• Integration with Obsidian: Seamlessly integrated with Obsidian's core features, including commands and editor menus.

Advantages 🌈

• Efficiency: Save time by automating repetitive tasks and getting quick suggestions.
• Accuracy: The AI provides accurate and context-aware responses, enhancing the quality of your notes.
• Flexibility: Customize the plugin to work with different AI models and APIs.
• User-Centric Design: Designed with the user in mind, offering a smooth and intuitive experience.

Supported AI Services 🧠

The AI Bot Plugin supports integration with popular AI services such as:

• DeepSeek: Access deepseek-chat model on DeepSeek.
• OpenAI: Utilize models like GPT-3, GPT-4, and others from OpenAI.
• Custom APIs: Configure the plugin to work with any custom AI service by specifying the base URL and API key.

Since the AI Bot plugin uses the OpenAI Node API Library at its core, in theory, the AI Bot plugin supports any service that the OpenAI Node API Library supports.

Installation 🛠️

Manual Installation

1. Clone the Repository: Clone this repo to your local machine.
2. Navigate to Plugin Folder: Place the cloned folder in your .obsidian/plugins/ directory.
3. Install Dependencies: Run npm install to install the necessary dependencies.
4. Build the Plugin: Run npm run dev to compile the plugin.
5. Enable the Plugin: Open Obsidian, go to Settings > Community Plugins, and enable the "AI Bot" plugin.

From Obsidian Community Plugins

1. Open Obsidian: Launch Obsidian and go to Settings.
2. Community Plugins: Navigate to the Community Plugins section.
3. Browse: Search for "AI Bot" and install it.
4. Enable: Enable the plugin from the list of installed plugins.

Usage 📚

Configuration

1. Open Settings: Go to the plugin settings by clicking on the "AI Bot" tab in the Obsidian settings.
2. Enter Base URL: Provide the base URL for the AI service.
3. API Key: Enter your API key for authentication.
4. Model: Specify the AI model you want to use.
5. Max Tokens: Specify the max tokens of the model.

Interacting with the AI

1. Ribbon Icon: Click on the AI bot icon in the ribbon to open the AI modal.
2. Commands: Use the "Ask AI" command from the command palette to interact with the AI.
3. Editor Menu: Right-click in the editor and select "Ask AI" from the context menu.

Modal Interface

• Input Field: Enter your query or command in the input field.
• Context Options: Choose the context for the AI's response (e.g., selected text, full note).
• Submit: Click "Ask AI" to get the AI's response.
• Actions: Use the provided buttons to copy, insert, or replace text based on the AI's response.

Contributing 🤝

We welcome contributions from the community! If you have ideas for improvements or new features, feel free to open an issue or submit a pull request.

Support 💖

If you find this plugin useful and would like to support its development, consider buying me a coffee ☕ or sponsoring the project on GitHub.

License 📄

This project is licensed under the MIT License. See the LICENSE file for more details.

Happy note-taking with AI assistance! 🎉