cliffordx/logseq-plugin-gpt3-openai

A plugin for GPT-3 AI assisted note taking in Logseq

logseq-plugin-gpt3-openai

---

A plugin for GPT-3 AI assisted note taking in Logseq

Usage

Just type /gpt3 in a block or select gpt3 from the block menu.

See here for example usages.

Demo

📝 Table of Contents

• About
• Examples with GIFs
• Getting Started
• Deployment
• Usage
• Built Using
• TODO
• Contributing
• Authors
• Acknowledgments

About

logseq-plugin-gpt3-openai allows users to generate human-like text using GPT-3 within the LogSeq editor.

Write a GPT-3 command in a block, then run the open gpt3 command via the slash or block menu. The plugin will generate a GPT-3 response using the OpenAI API and insert it beneath the block.

Getting Started

• You need to get an OpenAI API Key here and add the key in the plugin settings.

• Make sure you read OpenAI's usage guidelines and avoid generating certain types of content.

• Download the plugin in the Logseq marketplace by searching for gpt3 or openai.

Example Use Cases

Summarizing or explaining a block of text

Creating bullet point outlines for a given topic

Creating study plan for a given topic

Write a travel itinerary

Explain how to do something

Parse tabular data from plain english

• Generate code to do a given task

• Correct grammar

• Translate into other languages

• Classification and keyword tagging of text

• Generate lists of given topics

  • List 10 top selling science fiction books

• Write about a given topic

  • Write a tagline for an ice cream shop.

• Answer Questions

  • Q: How does a telescope work?

Just for fun

Crazy recipes

]

FAQ

What is GPT-3 and OpenAI, and how does it work?

See this article for a good overview.

I see an "OpenAI Plugin Error"

]

• Open the developer tools (Menu -> View -> Toggle Developer tools)

• See if you can figure out the error on your own. Maybe you had a network issue if it says something like "timed out." Sometimes the OpenAI API has issues. You also have a limited number of tokens, so you may run out and need to refill. You may be hitting a rate limit.

• If you can't figure it out based on the error message and it doesn't go away. Make an issue on GitHub.

Prerequisites

An API key from OpenAI Click here to get one

Installing

npm i

Running the tests

• Add Tests

Build

npm run build

💻 Local Development

This enables the local dev server with hot reloading, via the logseq vite plugin.

npm i
npm run dev

Prod build

First run npm i and npm run build

Open LogSeq

Go to Settings > Turn on Developer Mode

This will bring up the "Plugins" entry in three dots more menu list on the top right of the head bar. Go to Plugins page, and you will get a button with the Load unpacked plugin label. Select the root folder of this plugin repo.

Make sure you add your OpenAI Key

🚀 Deployment

Creates a build using semantic release when a commit is pushed with a smart commit message.

Built Using

• LogSeq - Privacy-first, open-source knowledge base that works on top of local plain-text Markdown and Org-mode files.
• Vite - Next Generation Frontend Tooling

Contributing

Do you have a bug or idea? I would love to hear from you! Open a Github issue here.

PRs welcome. Open an issue to discuss first if possible.

Authors

• @briansunter - Author

Acknowledgements

• OpenAI Examples