Andreas/LibreChat
1
0
Fork 0
mirror of https://github.com/danny-avila/LibreChat.git synced 2025-12-17 08:50:15 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 7

Docs: assets clean up (#598)

Browse source 
* Update ngrok.md

* Update linode.md

* Update cloudflare.md

* Update testing.md

* Update google_search.md

* Update introduction.md

* Update stable_diffusion.md

* Update wolfram.md

* docs: assets clean up
This commit is contained in:
Fuegovic 2023-07-06 17:41:22 -04:00 • committed by GitHub
parent fabd85ff40
commit 69d192bac3
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
46 changed files with 102 additions and 110 deletions
Download patch file Download diff file Expand all files Collapse all files

18
docs/features/plugins/google_search.md
View file

@ -21,14 +21,15 @@ Then you can get the API key, click the "Get a key" button on this page: https:/
Click to sign in(make a Google acct if you do not have one):
![image](../../assets/docs/features/plugins/google_search-1.png)
![google_search-1](https://github.com/danny-avila/LibreChat/assets/32828263/51db1a90-c2dc-493c-b32c-821257c27b4e)
## 3\. Register yourself a new account/Login to the Control Panel
After logging in, you will be redirected to the Control Panel to create a new search engine:
![image](../../assets/docs/features/plugins/google_search-2.png)
![google_search-2](https://github.com/danny-avila/LibreChat/assets/32828263/152cfe7c-4796-49c6-9160-92cddf38f1c8)
## 4\. Create a new search engine
@ -36,13 +37,12 @@ After logging in, you will be redirected to the Control Panel to create a new se
Fill in a name, select to "Search the entire web" and hit "Create":
![image](../../assets/docs/features/plugins/google_search-3.png)
![google_search-3](https://github.com/danny-avila/LibreChat/assets/32828263/c63441fc-bdb2-4086-bb7a-fcbe3d67aef9)
## 5\. Copy your Search engine ID to your .env file
![image](../../assets/docs/features/plugins/google_search-4.png)
![google_search-4](https://github.com/danny-avila/LibreChat/assets/32828263/e03b5c79-87e5-4a68-b83e-61faf4f2f718)
## 6\. Go to [custom-search docs](https://developers.google.com/custom-search/v1/introduction) to get a Google search API key
@ -50,16 +50,14 @@ Fill in a name, select to "Search the entire web" and hit "Create":
## 7\. Click "Get a Key":
![image](../../assets/docs/features/plugins/google_search-5.png)
![google_search-5](https://github.com/danny-avila/LibreChat/assets/32828263/2b93a2f9-5ed2-4794-96a8-a114e346a602)
## 8\. Name your project and agree to the Terms of Service
![image](../../assets/docs/features/plugins/google_search-6.png)
![google_search-6](https://github.com/danny-avila/LibreChat/assets/32828263/82c9c3ef-7363-40cd-a89e-fc45088e4c86)
## 9\. Copy your Google search API key to your .env file
![image](../../assets/docs/features/plugins/google_search-7.png)
![google_search-7](https://github.com/danny-avila/LibreChat/assets/32828263/8170206a-4ba6-40e3-b20e-bdbac21d6695)

13
docs/features/plugins/introduction.md
View file

@ -1,6 +1,6 @@
# Plugins Endpoint
![image](../../assets/docs/features/plugins/introduction-1.png)
![introduction-1](https://github.com/danny-avila/LibreChat/assets/32828263/7e426681-2bef-4dfc-9b4e-0cf2c09cb1d5)
The plugins endpoint opens the door to prompting LLMs in new ways other than traditional input/output prompting.
@ -17,17 +17,17 @@ More than this, you can use this endpoint for changing your conversation setting
The LLM process when using Plugins is illustrated below.
![Untitled-2023-06-04-1543(1)](../../assets/docs/features/plugins/introduction-2.png)
![introduction-2](https://github.com/danny-avila/LibreChat/assets/32828263/789406e1-7345-43d2-823b-8aed0588bb78)
**When you open the settings with the Plugins endpoint selected, you will view the default settings for the Completion Phase.**
Clicking on **"Show Agent Settings"** will allow you to modify parameters for the thinking phase
![image](../../assets/docs/features/plugins/introduction-3.png)
![introduction-3](https://github.com/danny-avila/LibreChat/assets/32828263/f3cf33d0-701f-409d-8ef6-f336993df55d)
---
![image](../../assets/docs/features/plugins/introduction-4.png)
![introduction-4](https://github.com/danny-avila/LibreChat/assets/32828263/c6a33fb2-aa14-4a88-9467-9f2c429e6338)
- You can specify which plugins you would like to select from by installing/uninstalling them in the Plugin store
- See this guide on how to create your own plugins (WIP)
@ -68,8 +68,7 @@ Clicking on **"Show Agent Settings"** will allow you to modify parameters for th
### Showcase
![image](../../assets/docs/features/plugins/introduction-5.png)
![introduction-5](https://github.com/danny-avila/LibreChat/assets/32828263/40cd1989-437f-49bb-9055-010e3efc468b)
![image](../../assets/docs/features/plugins/introduction-6.png)
![introduction-6](https://github.com/danny-avila/LibreChat/assets/32828263/b009a094-7311-45fb-a7ea-f5010f32ec45)

9
docs/features/plugins/stable_diffusion.md
View file

@ -57,12 +57,13 @@ With the docker deployment you can skip step 2 and step 3, use the setup instruc
### Select the plugins endpoint
![image](../../assets/docs/features/plugins/plugins_endpoint.png)
![plugins_endpoint](https://github.com/danny-avila/LibreChat/assets/32828263/9717e111-2e9e-43da-bd08-c5a0bbbc4d6d)
### Open the Plugin store and Install Stable Diffusion
![image](../../assets/docs/features/plugins/plugin_store.png)
![image](../../assets/docs/features/plugins/stable_diffusion-1.png)
![plugin_store](https://github.com/danny-avila/LibreChat/assets/32828263/add4d6a8-e5d6-4129-a334-4ff9290c0e2d)
![stable_diffusion-1](https://github.com/danny-avila/LibreChat/assets/32828263/b4364f41-0f7e-4197-af86-7d6061797366)
## 5. Select the plugin and enjoy!
![image](../../assets/docs/features/plugins/stable_diffusion-2.png)
![stable_diffusion-2](https://github.com/danny-avila/LibreChat/assets/32828263/8fa898b9-0826-42eb-bba4-6f85ec5f6ec2)

8
docs/features/plugins/wolfram.md
View file

@ -8,14 +8,14 @@ An AppID must be supplied in all calls to the Wolfram|Alpha API.
## 2. Go to the <a href='https://developer.wolframalpha.com/portal/myapps/'>Developer Portal</a> click on "Get an AppID".
## 3. Configure it in LibreChat
### Select the plugins endpoint
![image](../../assets/docs/features/plugins/plugins_endpoint.png)
![plugins_endpoint](https://github.com/danny-avila/LibreChat/assets/32828263/9717e111-2e9e-43da-bd08-c5a0bbbc4d6d)
### Open the Plugin store
![image](../../assets/docs/features/plugins/plugin_store.png)
![plugin_store](https://github.com/danny-avila/LibreChat/assets/32828263/add4d6a8-e5d6-4129-a334-4ff9290c0e2d)
### Install Wolfram and Provide your AppID
![image](../../assets/docs/features/plugins/wolfram-1.png)
![wolfram-1](https://github.com/danny-avila/LibreChat/assets/32828263/bd165497-d529-441d-8372-a68db19adc3f)
- Alternatively: you (the admin) can set the value in `\.env` to bypass the prompt: `WOLFRAM_APP_ID=your_app_id`
## 5. Select the plugin and enjoy!
![image](../../assets/docs/features/plugins/wolfram-2.png)
![wolfram-2](https://github.com/danny-avila/LibreChat/assets/32828263/2825e961-6c46-4728-96cd-1012a0862943)