mirror of
https://github.com/danny-avila/LibreChat.git
synced 2025-12-18 01:10:14 +01:00
🧹📚 docs: refactor and clean up (#1392)
* 📑 update mkdocs * rename docker override file and add to gitignore * update .env.example - GOOGLE_MODELS * update index.md * doc refactor: split installation and configuration in two sub-folders * doc update: installation guides * doc update: configuration guides * doc: new docker override guide * doc: new beginner's guide for contributions - Thanks @Berry-13 * doc: update documentation_guidelines.md * doc: update testing.md * doc: update deployment guides * doc: update /dev readme * doc: update general_info * doc: add 0 value to doc weight * doc: add index.md to every doc folders * doc: add weight to index.md and move openrouter from free_ai_apis.md to ai_setup.md * doc: update toc so they display properly on the right had side in mkdocs * doc: update pandoranext.md * doc: index logging_system.md * doc: update readme.md * doc: update litellm.md * doc: update ./dev/readme.md * doc:🔖 new presets.md * doc: minor corrections * doc update: user_auth_system.md and presets.md, doc feat: add mermaid support to mkdocs * doc update: add screenshots to presets.md * doc update: add screenshots to - OpenID with AWS Cognito * doc update: BingAI cookie instruction * doc update: discord auth * doc update: facebook auth * doc: corrections to user_auth_system.md * doc update: github auth * doc update: google auth * doc update: auth clean up * doc organization: installation * doc organization: configuration * doc organization: features+plugins & update:plugins screenshots * doc organization: deploymend + general_info & update: tech_stack.md * doc organization: contributions * doc: minor fixes * doc: minor fixes
This commit is contained in:
Fuegovic
GitHub
parent
5c27fa304a
commit
51050cc4d3
66 changed files with 1617 additions and 869 deletions
|
|
@ -1,3 +1,7 @@
|
|||
---
|
||||
title: ⚡ Azure AI Search
|
||||
weight: -4
|
||||
---
|
||||
# Azure AI Search Plugin
|
||||
Through the plugins endpoint, you can use Azure AI Search for answers to your questions with assistance from GPT.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,3 +1,7 @@
|
|||
---
|
||||
title: 🧑💼 Official ChatGPT Plugins
|
||||
weight: -8
|
||||
---
|
||||
# Using official ChatGPT Plugins / OpenAPI specs
|
||||
|
||||
ChatGPT plugins are API integrations for OpenAI models that extend their capabilities. They are structured around three key components: an API, an **OpenAPI specification** (spec for short), and a JSON **Plugin Manifest** file.
|
||||
|
|
@ -7,15 +11,19 @@ To learn more about them, or how to make your own, read here: [ChatGPT Plugins:
|
|||
Thanks to the introduction of [OpenAI Functions](https://openai.com/blog/function-calling-and-other-api-updates) and their utilization in [Langchain](https://js.langchain.com/docs/modules/chains/openai_functions/openapi), it's now possible to directly use OpenAI Plugins through LibreChat, without building any custom langchain tools. The main use case we gain from integrating them to LibreChat is to allow use of plugins with gpt-3.5 models, and without ChatGPT Plus. They also find a great use case when you want to limit your own private API's interactions with chat.openai.com and their servers in favor of a self-hosted LibreChat instance.
|
||||
|
||||
### Table of Contents
|
||||
- [Intro](#intro)
|
||||
- [Adding a Plugin](#adding-a-plugin)
|
||||
- [Editing Manifest Files](#editing-manifest-files)
|
||||
- [Override Parameter Values](#override-parameter-values)
|
||||
- [Add Header Fields](#add-header-fields)
|
||||
- [Custom OpenAPI Spec files](#custom-openapi-spec-files)
|
||||
- [Plugins with Authentication](#plugins-with-authentication)
|
||||
- [Showcase](#showcase)
|
||||
- [Disclaimers](#disclaimers)
|
||||
- [Using official ChatGPT Plugins / OpenAPI specs](#using-official-chatgpt-plugins--openapi-specs)
|
||||
- [Table of Contents](#table-of-contents)
|
||||
- [Intro](#intro)
|
||||
- [**Plugin Manifest File:**](#plugin-manifest-file)
|
||||
- [**OpenAPI Spec**](#openapi-spec)
|
||||
- [Adding a Plugin](#adding-a-plugin)
|
||||
- [Editing Manifest Files](#editing-manifest-files)
|
||||
- [Override Parameter Values](#override-parameter-values)
|
||||
- [Add Header Fields](#add-header-fields)
|
||||
- [Custom OpenAPI Spec files](#custom-openapi-spec-files)
|
||||
- [Plugins with Authentication](#plugins-with-authentication)
|
||||
- [Showcase](#showcase)
|
||||
- [Disclaimers](#disclaimers)
|
||||
|
||||
## Intro
|
||||
|
||||
|
|
|
|||
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: 🔎 Google Search
|
||||
weight: -7
|
||||
---
|
||||
|
||||
# Google Search Plugin
|
||||
Through the plugins endpoint, you can use google search for answers to your questions with assistance from GPT! To get started, you need to get a Google Custom Search API key, and a Google Custom Search Engine ID. You can then define these as follows in your `.env` file:
|
||||
```env
|
||||
|
|
|
|||
13
docs/features/plugins/index.md
Normal file
13
docs/features/plugins/index.md
Normal file
|
|
@ -0,0 +1,13 @@
|
|||
---
|
||||
title: Plugins
|
||||
weight: -10
|
||||
---
|
||||
|
||||
# Plugins
|
||||
* 🔌 [Introduction](./introduction.md)
|
||||
* 🛠️ [Make Your Own](./make_your_own.md)
|
||||
* 🧑💼 [Official ChatGPT Plugins](./chatgpt_plugins_openapi.md)
|
||||
* 🔎 [Google Search](./google_search.md)
|
||||
* 🖌️ [Stable Diffusion](./stable_diffusion.md)
|
||||
* 🧠 [Wolfram|Alpha](./wolfram.md)
|
||||
* ⚡ [Azure AI Search](./azure_ai_search.md)
|
||||
|
|
@ -1,6 +1,11 @@
|
|||
---
|
||||
title: 🔌 Introduction
|
||||
weight: -10
|
||||
---
|
||||
# Plugins Endpoint
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
The plugins endpoint opens the door to prompting LLMs in new ways other than traditional input/output prompting.
|
||||
|
||||
|
|
@ -8,27 +13,21 @@ The first step is using chain-of-thought prompting & ["agency"](https://zapier.c
|
|||
|
||||
More than this, you can use this endpoint for changing your conversation settings mid-conversation. Unlike the official ChatGPT site and all other endpoints, you can switch models, presets, and settings mid-convo, even when you have no plugins selected. This is useful if you first want a creative response from GPT-4, and then a deterministic, lower cost response from GPT-3. Soon, you will be able to use Google, HuggingFace, local models, all in this or a similar endpoint in the same modular manner.
|
||||
|
||||
### Roadmap:
|
||||
- More plugins and advanced plugin usage (ongoing)
|
||||
- **[ChatGPT Plugins/OpenAPI Specs (complete)](./chatgpt_plugins_openapi.md)**
|
||||
- More LLMs to choose from for both Thinking and Completion Phases
|
||||
- Alternative prompting methods such as Tree-of-Thought
|
||||
|
||||
## Using Plugins
|
||||
|
||||
The LLM process when using Plugins is illustrated below.
|
||||
|
||||
|
||||
|
||||
|
||||
**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
|
||||
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
|
||||
|
||||
|
||||
- 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)
|
||||
|
|
|
|||
|
|
@ -1,3 +1,7 @@
|
|||
---
|
||||
title: 🛠️ Make Your Own
|
||||
weight: -9
|
||||
---
|
||||
# Making your own Plugin
|
||||
|
||||
Creating custom plugins for this project involves extending the `Tool` class from the `langchain/tools` module.
|
||||
|
|
|
|||
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: 🖌️ Stable Diffusion
|
||||
weight: -6
|
||||
---
|
||||
|
||||
# Stable Diffusion Plugin
|
||||
|
||||
To use Stable Diffusion with this project, you will either need to download and install [stable-diffusion-webui](https://github.com/AUTOMATIC1111/stable-diffusion-webui) or, for a dockerized deployment, you can also use [stable-diffusion-webui-docker](https://github.com/AbdBarho/stable-diffusion-webui-docker)
|
||||
|
|
@ -58,10 +63,10 @@ With the docker deployment you can skip step 2 and step 3, use the setup instruc
|
|||
|
||||
### Select the plugins endpoint
|
||||
|
||||
|
||||
|
||||
|
||||
### Open the Plugin store and Install Stable Diffusion
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: 🧠 Wolfram|Alpha
|
||||
weight: -5
|
||||
---
|
||||
|
||||
# Wolfram Alpha Plugin
|
||||
|
||||
An AppID must be supplied in all calls to the Wolfram|Alpha API.
|
||||
|
|
@ -8,9 +13,9 @@ 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
|
||||
|
||||
|
||||
### Open the Plugin store
|
||||
|
||||
|
||||
### Install Wolfram and Provide your AppID
|
||||
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue