Wladefant / joplin-plugin-jarvis

AI note-taking assistant (GPT-3, ChatGPT, GPT-4)

Jarvis

Jarvis (Joplin Assistant Running a Very Intelligent System) is an AI note-taking assistant for Joplin, powered by OpenAI's LLM models (such as GPT-3, ChatGPT or GPT-4). You can chat with it, compile an automatic review of the scientific literature on any subject, ask it to generate text, or edit existing text based on free text instructions. You will need an OpenAI account for Jarvis to work (at the moment, new users get 18$ credit upon registering, which is equivalent to 900,000 GPT-3 tokens, or more than 600,000 generated words).

Usage

• Literature review: Run the command "Research with Jarvis", write what you're interested in, and optionally adjust the search parameters (high max_tokens is recommended). Wait 2-3 minutes for all the output to appear in the note (depending on internet traffic). Jarvis will update the content as it finds new information on the web (using Semantic Scholar, Crossref, Elsevier, Springer & Wikipedia databases). In the end you will get a report with the following sections: title, prompt, research questions, queries, references, review and follow-up questions.
• Chat: Start a new note, or continue an existing conversation in a saved note. Place the cursor after your prompt and run the command "Chat with Jarvis" (from the Tools/Jarvis menu). Each time you run the command Jarvis will append its response to the note at the current cursor position (given the previous content that both of you created). If you don't like the response, run the command again to replace it with a new one.
• Autocomplete anything: "Chat with Jarvis" will try to extend any content. Therefore, this essentially serves as a general-purpose autocomplete command. You can remove the speaker attribution ("User:") by cleaning the response suffix field in the settings.
• Text generation: Run the command "Ask Jarvis" and write your query in the pop-up window, or select a prompt text in the editor before running the command. You can also enhance your query with predefined (or customized) prompt templates from the dropdown lists.
• Text editing: Select a text to edit, run the command "Edit selection with Jarvis" and write your instructions in the pop-up window.

Installation

1. Install Jarvis from Joplin's plugin marketplace, or download it from github.
2. Setup your OpenAI account.
3. Enter your API key in the plugin settings page.
4. To make Jarvis more verbose and improve chat coherence, it is recommended to increase max_tokens (e.g., to 4000) and memory_tokens (e.g., to 500-1000). Note that these settings increase query costs.
5. For literature reviews, you can optionally add free API keys for Scopus/Elsevier as an additional powerful search engine and paper repository, and Springer as another paper repository. It is recommended to try both Scopus and Semantic Scholar as each has its pros and cons.

Disclaimer

• This plugin sends your queries to OpenAI (and only to it). Research queries are also sent to the selected literature search engine (Semantic Scholar / Scopus).
• This plugin uses your OpenAI API key in order to do so (and uses it for this sole purpose).
• You may incur charges (if you are a paying user) from OpenAI by using this plugin.
• Therefore, always check your usage statistics on OpenAI periodically.
• It is also recommended to rotate your API key occasionally.
• The developer is not affiliated with OpenAI in any way.

Future directions

• Add resampling techniques to improve output.
• Add support for other AI models.