ThoughtPartner for Obsidian
The Obsidian Thought Partner plugin brings the power of GPT-3 to Obsidian.
It's aim is to not just be an easy way to generate text, but to help you think through your ideas and be a better writer.
Installation
1. Manually install the plugin
Download the zip of this repo and unzip it into your vault's <vault>/.obsidian/plugins/
folder, then reload Obsidian.
Note: the .obsidian folder may be hidden. On MacOS you should be able to press Command+Shift+Dot
to show the folder in Finder. You may need to enable 'Community Plugins' and to create the plugins
folder if it doesn't exist.
2. Bring your own OpenAI key
Thought Partner uses GPT-3. It's free software, you'll just pay (the very reasonable) cost of the tokens to GPT-3 (and you'll have $18 of free credit).
-
Create an account on OpenAI
-
Grab your API key from https://beta.openai.com/account/api-keys
-
Enable ThoughtPartner in 'Community plugins' and paste your API key into the settings.
Usage Guide
Understanding the context window
To use the plugin efffectively you need to understand the context that the AI considers. If text is selected, it will use that. If the line is empty it will use as much of the previous content as possible. For features like "tldr" it will use the whole file.
Possible commands
You can access the commands through the command pallette, the right-click menu or keyboard shortcuts. Please use the feedback buttons ('good'/'bad') on the generations, to help improve the prompts used for each feature.
ctrl+j
extend Take the context and generate the next few sentences
ctrl+t
tldr Generate a summary of the file and insert it at the top
ctrl+q
critique ThoughtPartner will outline possible assumptions or flaws in your reasoning
prose-ify
Convert your crappy bullet points notes into flowing prose
suggestions
ThoughtPartner will sympathetically evaluate your writing and suggest where there is "room for improvement"
Terms and policy
Your requests and responses are logged by OpenAI (under your API key) and Humanloop (anonymously). You can read more about this in the OpenAI terms of service.