123 lines
4.7 KiB
Markdown
123 lines
4.7 KiB
Markdown
# LeafLLM: an AI-powered Overleaf
|
|
This Chrome extension adds the power of large-language models (LLMs) to Overleaf through a Chrome extension.
|
|
|
|
The extension originated from [GPT4Overleaf](https://github.com/e3ntity/gpt4overleaf).
|
|
|
|
## Installation from Chrome Web Store (preferred option)
|
|
Unless you are a developer, this is probably your preferred option.
|
|
|
|
Just go to the [extension's page](https://chrome.google.com/webstore/detail/leafllm/feomoidgfifpofabcapiipjjjoigjeoa) in Chrome Web Store and press "Add to Chrome"
|
|
|
|
## Manual installation
|
|
1. Clone the repository
|
|
2. Open Chrome and go to `chrome://extensions/`
|
|
3. Enable developer mode
|
|
4. Click "Load unpacked" and select the repository folder
|
|
|
|
## Configuration
|
|
The plugin can be configured by clicking the plugin button in the Chrome toolbar.
|
|
|
|
It requires inserting an API key from [OpenAI](https://platform.openai.com/account/api-keys).
|
|
|
|
You also need to choose which tools you wish to enable. See the [Issues](#issues) section if you have problems activating the tools.
|
|
|
|
## Usage
|
|
These are the tools that are currently available:
|
|
|
|
### Auto-complete
|
|
Select a text and press `Alt+C` to trigger the auto-complete tool.
|
|
|
|
### Improve
|
|
Select a text and press `Alt+I` to trigger the improvement tool. The original text will be commented out and the improved text will be inserted below it.
|
|
|
|
### Ask
|
|
Select a text and press `Alt+A` to trigger the ask tool. The original text will be deleted and the answer will be inserted in its place.
|
|
|
|
For example: "Create a table 4x3 that the first row is boldface" will be replaced with, e.g.:
|
|
```latex
|
|
\begin{tabular}{|c|c|c|}
|
|
\hline
|
|
\textbf{Column 1} & \textbf{Column 2} & \textbf{Column 3}\\
|
|
\hline
|
|
Entry 1 & Entry 2 & Entry 3\\
|
|
\hline
|
|
Entry 4 & Entry 5 & Entry 6\\
|
|
\hline
|
|
Entry 7 & Entry 8 & Entry 9\\
|
|
\hline
|
|
\end{tabular}
|
|
```
|
|
|
|
You can then, for example:
|
|
1. Write before the table: Place the following tabular inside a table environment, center it, and give the following title: "The comparison of the three approaches"
|
|
2. Select the sentence and the table
|
|
3. Press `Alt+A` to trigger the ask tool.
|
|
|
|
The result will be:
|
|
```latex
|
|
\begin{table}[h]
|
|
\centering
|
|
\caption{The comparison of the three approaches}
|
|
\begin{tabular}{|c|c|c|}
|
|
\hline
|
|
\textbf{Column 1} & \textbf{Column 2} & \textbf{Column 3}\\
|
|
\hline
|
|
Entry 1 & Entry 2 & Entry 3\\
|
|
\hline
|
|
Entry 4 & Entry 5 & Entry 6\\
|
|
\hline
|
|
Entry 7 & Entry 8 & Entry 9\\
|
|
\hline
|
|
\end{tabular}
|
|
\end{table}
|
|
```
|
|
|
|
## Using non-GPT Models
|
|
Other LLM deployments/models are supported as long as they can be accessed via OpenAI Chat Completion API. Some examples: [vLLM models](https://docs.vllm.ai/en/latest/getting_started/quickstart.html#using-openai-chat-api-with-vllm), [LLAMA models](https://github.com/c0sogi/llama-api#usage-chat-completion), and [easyLLM](https://philschmid.github.io/easyllm/examples/chat-completion-api/).
|
|
|
|
Use the plugin's JSON editor to change the URL and the model. See [Issue #8](https://github.com/bThink-BGU/LeafLLM/issues/8) for further details.
|
|
|
|
## Issues
|
|
If nothing happens when you use the plugin, verify that the plugin's shortcuts are not in conflict with other plugins' shortcuts. To do so, go to `chrome://extensions/shortcuts`.
|
|
|
|
If you encounter any problem/question, please open an issue in the project's repository.
|
|
|
|
## Privacy
|
|
The plugin saves its configuration locally on the user's computer. The plugin sends the API key and the selected text to OpenAI only, and only for the purpose it was made for (i.e., completing and improving text and asking GPT questions). The plugin's authors are not responsible for what OpenAI does with this data. The plugin's authors do not collect any data from the plugin's users.
|
|
|
|
## Advanced Configuration
|
|
If you feel advanced, you can also change the request JSON sent to OpenAI and the base URL.
|
|
To do that, go to the 'Advance Configuration' component on the configuration page. By default, the value is
|
|
```json
|
|
{
|
|
"openai": {
|
|
"url": "https://api.openai.com/v1/chat/completions",
|
|
"base": {
|
|
"n": 1,
|
|
"temperature": 0.5,
|
|
"model": "gpt-3.5-turbo"
|
|
},
|
|
"Complete": {
|
|
"max_tokens": 512,
|
|
"messages": [{
|
|
"role": "system",
|
|
"content": "You are an assistant in a Latex editor that continues the given text. No need to rewrite the given text"
|
|
}]
|
|
},
|
|
"Improve": {
|
|
"messages": [{
|
|
"role": "system",
|
|
"content": "You are an assistant in a Latex editor that improves the given text"
|
|
}]
|
|
},
|
|
"Ask": {
|
|
"messages": [{
|
|
"role": "system",
|
|
"content": "You are an assistant in a Latex editor. Answer questions without introduction/explanations"
|
|
}]
|
|
}
|
|
}
|
|
}
|
|
```
|
|
Base is the default configuration which is overridden by the specific command configuration.
|