https://github.com/lucagrippa/obsidian-ai-tagger

Simplify tagging in Obsidian. Instantly analyze and tag your document with one click for efficient note organization. OpenAI or MistralAI API key required
https://github.com/lucagrippa/obsidian-ai-tagger

ai llm obsidian-md obsidian-plugin openai

Last synced: 3 months ago
JSON representation

Simplify tagging in Obsidian. Instantly analyze and tag your document with one click for efficient note organization. OpenAI or MistralAI API key required

• Host: GitHub
• URL: https://github.com/lucagrippa/obsidian-ai-tagger
• Owner: lucagrippa
• License: mit
• Created: 2023-10-06T22:04:57.000Z (about 1 year ago)
• Default Branch: master
• Last Pushed: 2024-07-25T22:39:26.000Z (4 months ago)
• Last Synced: 2024-07-27T00:59:35.395Z (4 months ago)
• Topics: ai, llm, obsidian-md, obsidian-plugin, openai
• Language: TypeScript
• Homepage:
• Size: 3.06 MB
• Stars: 30
• Watchers: 3
• Forks: 5
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• jimsghstars - lucagrippa/obsidian-ai-tagger - Simplify tagging in Obsidian. Instantly analyze and tag your document with one click for efficient note organization. OpenAI or MistralAI API key required (TypeScript)

README

        
# AI Tagger

AI Tagger is an Obsidian (https://obsidian.md) plugin that simplifies tagging by using OpenAI's advance Large Language Models (LLMs) to analyze and tag your document with one click! 

The plugin analyzes the current document that you have open in the editor and all of the previous tags that you have used. AI tagger will return up to 5 relevant tags that you have previously used and will generate up to 3 completely new tags.

## How to use

### Supported LLM Providers

**OpenAI**

- `GPT-3.5-Turbo`

- `GPT-4`

- `GPT-4 Turbo`

- `GPT-4o`

**Mistral AI**

- `Mistral Small`

- `Mistral Large`

### Setting up the AI Tagger

- Enter your LLM provider API key in the settings tab. 

- Pick the model (LLM) that you would like to use

### One click tagging

- the simplest way to use the plugin is from the ribbon located on the left sidebar.

- click the "Wand" ribbon icon to automatically generate tags for your current document.

    ![One click tagging](images/one_click_tagging.gif)

### More precise tagging

- another way to call the AI Tagger is from the Command palette (`Ctrl+P` or `Cmd+P` on macOS).

- using the Command palette navigate to the "Generate tags" command to tag your current document.

- to tag a specific part of your document highlight the text before using the Command palette.

    ![Command palette tagging](images/command_palette_tagging.gif)

### Lowercase Mode

- if you prefer your tags to be in lowercase, you can enable the lowercase mode in the settings tab.

- this mode forces every generated tag to be lowercase

## Installation

Navigate to the Obsidian settings and search AI Tagger in the Community plugins section. You can also manually download the latest release from this repository's GitHub releases by extracting the ZIP file to your Obsidian plugins folder.

## Support

If you encounter any issues while using the AI Tagger plugin or have any suggestions for improvement, submit an issue on this GitHub repository. Pull requests are also welcome.

## License

[MIT License](LICENSE)