Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/the-3labs-team/tinymce-chatgpt-plugin
🤖 A TinyMCE plugin for ChatGPT (gpt model) OpenAI or Custom LLM compatible endpoints
https://github.com/the-3labs-team/tinymce-chatgpt-plugin
ai llm opensource tinymce tinymce-plugin
Last synced: 18 days ago
JSON representation
🤖 A TinyMCE plugin for ChatGPT (gpt model) OpenAI or Custom LLM compatible endpoints
- Host: GitHub
- URL: https://github.com/the-3labs-team/tinymce-chatgpt-plugin
- Owner: The-3Labs-Team
- License: mit
- Created: 2023-07-17T12:57:57.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-03-28T10:47:57.000Z (9 months ago)
- Last Synced: 2024-04-15T00:14:58.689Z (8 months ago)
- Topics: ai, llm, opensource, tinymce, tinymce-plugin
- Language: JavaScript
- Homepage: https://3labs.it
- Size: 812 KB
- Stars: 9
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# TinyMCE ChatGPT Plugin
[](https://github.com/The-3Labs-Team/tinymce-chatgpt-plugin/actions/workflows/lint.yml)
[](https://codeclimate.com/github/The-3Labs-Team/tinymce-chatgpt-plugin/maintainability)
This plugin integrates ChatGPT (or your OpenAI compatible LLM) within TinyMCE, allowing you to generate realistic and creative text with the push of a button.
To use the plugin, simply install and activate it in TinyMCE. Once activated, you will see a new "ChatGPT" button in the TinyMCE toolbar. Click this button to open a dialog box where you can enter a request to ChatGPT. ChatGPT will then generate the requested text and enter it into your editor.
ChatGPT can be used to generate a variety of text formats, including articles, blog posts, e-mails, letters, and more. It can also be used to translate languages, write different types of creative content, and answer your questions in an informative way.
ChatGPT is a powerful tool that can help you improve your productivity and the quality of your work. Try it out today!
## Features
- 🤖 OpenAI and Custom LLM OpenAI compatible
- ⚙️ Support custom prompts defined by you!
- 🧑🎨 Generates realistic and creative text with the push of a button
- 🧬 Can be used to generate a variety of text formats
- 🈷️ Can be used to translate languages
- 🙋 Can be used to answer your questions in an informative way
| :warning: WARNING |
| :-------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Consider this plugin as a prototype and not suitable for production deployment at this time. Use it only in controlled environments and at your own risk. |
## Requirements
- TinyMCE 6|7 or later
- OpenAI API key ([get one here](https://openai.com))
- (Optional) Custom LLM API
## Installation
This plugin comes as an _external plugin_; however, you can download the _.js file_ and upload it to your host.
To install, simply **edit the init configuration** of your TinyMCE as follows:
```js
tinymce.init({
// 1. Add the plugin to the list of external plugins
external_plugins: {
chatgpt:
"https://cdn.jsdelivr.net/gh/The-3Labs-Team/tinymce-chatgpt-plugin@2/dist/chatgpt.js",
},
// 2. Configure the ChatGPT plugin
openai: {
api_key: "sk-yourapikeyhere", // Your OpenAI API key
model: "gpt-3.5-turbo",
temperature: 0.5,
max_tokens: 150,
prompts: [
"Translate from English to Italian",
"Summarize",
"Proofread",
"Write a blog post about",
],
// Optional: Add your custom LLM
// baseUri: "https://your-llm-endpoint.com",
},
// 3. Add the ChatGPT button to the toolbar
toolbar: ["chatgpt"],
});
```
If you are using our [TinyMCE Laravel Nova Package 4](https://github.com/murdercode/Nova4-TinymceEditor) you can configure as follows:
```php
[
// 1. Add the plugin to the list of external plugins
'external_plugins' => [
'chatgpt' => 'https://cdn.jsdelivr.net/gh/The-3Labs-Team/tinymce-chatgpt-plugin@2/dist/chatgpt.js'
],
// 2. Configure the plugin
'openai' => [
'api_key' => 'sk-yourapikeyhere', // Your OpenAI API key
'model' => 'gpt-3.5-turbo',
'temperature' => 0.5,
'max_tokens' => 150,
'prompts' => [
'Translate from English to Italian',
'Summarize',
'Proofread',
'Write a blog post about',
],
// Optional: Add your custom LLM
// 'base_uri' => 'https://your-llm-endpoint.com',
],
],
// 3. Add the plugin to the toolbar
'toolbar' => ['chatgpt']
//...
```
### Breaking Changes from v1 to v2
- We are using the new `/chat/completions` endpoint from OpenAI
- The `model` default now must be a chat model, like `gpt-3.5-turbo`
- If you want to use the old `/completion` endpoint, you can use the `baseUri` option to set your custom LLM endpoint like `https://api.openai.com/v1/completions`
### Custom LLM
If you have a custom LLM, you can use it by setting the `baseUri` option in the configuration. The plugin will use this endpoint to generate the text.
```js
baseUri: "https://your-llm-endpoint.com"
```
Please note that the custom LLM must be OpenAI compatible and follow the same API as OpenAI.
Also, the custom LLM must be accessible from the client-side.
Check the `demo-lm-studio.html` file for an example of how to use a custom LLM.