mirror of
https://github.com/danny-avila/LibreChat.git
synced 2026-02-03 00:01:49 +01:00
🔍 chore: Clean Up Documentation (#2217)
* fix(initializeClient.spec.js): remove condition failing test on local installations * docs: remove comments and invalid html as is required by embeddings generator and add new documentation guidelines
This commit is contained in:
Danny Avila
GitHub
parent
2259bf8b03
commit
7f83a060a0
16 changed files with 17 additions and 131 deletions
|
|
@ -21,7 +21,7 @@ Some of the endpoints are marked as **Known,** which means they might have speci
|
|||
|
||||
- **Known:** icon provided.
|
||||
|
||||
- **Temperature:** If you set a temperature value of 0, it will be converted to 1e-8. If you run into any issues, please try setting the value to a float32 > 0 and <= 2.
|
||||
- **Temperature:** If you set a temperature value of 0, it will be converted to 1e-8. If you run into any issues, please try setting the value to a float32 greater than 0 and less than or equal to 2.
|
||||
|
||||
- Groq is currently free but rate limited: 10 queries/minute, 100/hour.
|
||||
|
||||
|
|
|
|||
|
|
@ -4,37 +4,6 @@ description: This doc explains how to setup your AI providers, their APIs and cr
|
|||
weight: -8
|
||||
---
|
||||
|
||||
<!-- # Table of Contents
|
||||
|
||||
- [Table of Contents](#table-of-contents)
|
||||
- [AI Setup](#ai-setup)
|
||||
- [General](#general)
|
||||
- [Free AI APIs](#free-ai-apis)
|
||||
- [Setting a Default Endpoint](#setting-a-default-endpoint)
|
||||
- [Setting a Default Preset](#setting-a-default-preset)
|
||||
- [OpenAI](#openai)
|
||||
- [Anthropic](#anthropic)
|
||||
- [Google](#google)
|
||||
- [Generative Language API (Gemini)](#generative-language-api-gemini)
|
||||
- [Vertex AI (PaLM 2 \& Codey)](#vertex-ai-palm-2--codey)
|
||||
- [1. Once signed up, Enable the Vertex AI API on Google Cloud:](#1-once-signed-up-enable-the-vertex-ai-api-on-google-cloud)
|
||||
- [2. Create a Service Account with Vertex AI role:](#2-create-a-service-account-with-vertex-ai-role)
|
||||
- [3. Create a JSON key to Save in your Project Directory:](#3-create-a-json-key-to-save-in-your-project-directory)
|
||||
- [Azure OpenAI](#azure-openai)
|
||||
- [Required Variables](#required-variables)
|
||||
- [Model Deployments](#model-deployments)
|
||||
- [Setting a Default Model for Azure](#setting-a-default-model-for-azure)
|
||||
- [Enabling Auto-Generated Titles with Azure](#enabling-auto-generated-titles-with-azure)
|
||||
- [Using GPT-4 Vision with Azure](#using-gpt-4-vision-with-azure)
|
||||
- [Optional Variables](#optional-variables)
|
||||
- [Using Plugins with Azure](#using-plugins-with-azure)
|
||||
- [OpenRouter](#openrouter)
|
||||
- [Unofficial APIs](#unofficial-apis)
|
||||
- [BingAI](#bingai)
|
||||
- [Conclusion](#conclusion) -->
|
||||
|
||||
---
|
||||
|
||||
# AI Setup
|
||||
|
||||
This doc explains how to setup your AI providers, their APIs and credentials.
|
||||
|
|
@ -287,26 +256,6 @@ As noted earlier, [review the Custom Config Guide (click here)](./custom_config.
|
|||
|
||||
**Important:** Stability for Unofficial APIs are not guaranteed. Access methods to these APIs are hacky, prone to errors, and patching, and are marked lowest in priority in LibreChat's development.
|
||||
|
||||
<!-- ### ChatGPTBrowser
|
||||
|
||||
**Backend Access to https://chat.openai.com/api**
|
||||
|
||||
This is not to be confused with [OpenAI's Official API](#openai)!
|
||||
|
||||
> Note that this is disabled by default and requires additional configuration to work.
|
||||
> Also, using this may have your data exposed to 3rd parties if using a proxy, and OpenAI may flag your account.
|
||||
|
||||
To get your Access token for ChatGPT Browser Access, you need to:
|
||||
|
||||
- Go to **[https://chat.openai.com](https://chat.openai.com)**
|
||||
- Create an account or log in with your existing one
|
||||
- Visit **[https://chat.openai.com/api/auth/session](https://chat.openai.com/api/auth/session)**
|
||||
- Copy the value of the "accessToken" field and save it in ./.env as CHATGPT_ACCESS_TOKEN
|
||||
|
||||
Warning: There may be a chance of your account being banned if you deploy the app to multiple users with this method. Use at your own risk.
|
||||
|
||||
--- -->
|
||||
|
||||
### BingAI
|
||||
I recommend using Microsoft Edge for this:
|
||||
|
||||
|
|
|
|||
|
|
@ -108,7 +108,8 @@ These settings apply globally to all Azure models and groups within the endpoint
|
|||
|
||||
8. **groups** (Array/List, Required): Specifies the list of Azure OpenAI model groups. Each group represents a set of models with shared configurations. The groups field is an array of objects, where each object defines the settings for a specific group. This is a required field at the endpoint level, and at least one group must be defined. The group-level configurations are detailed in the Group-Level Configuration section.
|
||||
|
||||
<!-- 9. **customOrder** (Number, Optional): Allows you to specify a custom order for the Azure endpoint in the user interface. Higher numbers will appear lower in the list. If not provided, the default order is determined by the order in which the endpoints are defined in the `librechat.yaml` file. -->
|
||||
[ 9. **customOrder** (Number, Optional): Allows you to specify a custom order for the Azure endpoint in the user interface. Higher numbers will appear lower in the list. If not provided, the default order is determined by the order in which the endpoints are defined in the `librechat.yaml` file.
|
||||
]: #
|
||||
|
||||
Here's an example of how you can configure these endpoint-level settings in your `librechat.yaml` file:
|
||||
|
||||
|
|
|
|||
|
|
@ -268,28 +268,6 @@ BINGAI_TOKEN=user_provided
|
|||
BINGAI_HOST=
|
||||
```
|
||||
|
||||
<!-- ### ChatGPT
|
||||
see: [ChatGPT Free Access token](../configuration/ai_setup.md#chatgptbrowser)
|
||||
|
||||
> **Warning**: To use this endpoint you'll have to set up your own reverse proxy.
|
||||
|
||||
```bash
|
||||
CHATGPT_REVERSE_PROXY=<YOUR-REVERSE-PROXY>
|
||||
```
|
||||
|
||||
> **Note:** If you're a GPT plus user you can try adding `gpt-4`, `gpt-4-plugins`, `gpt-4-code-interpreter`, and `gpt-4-browsing` to the list above and use the models for these features; **however, the view/display portion of these features are not supported**, but you can use the underlying models, which have higher token context
|
||||
|
||||
> This method **might only works** with `text-davinci-002-render-sha` and **might stop working** at any moment.
|
||||
|
||||
- Leave `CHATGPT_TOKEN=` blank to disable this endpoint
|
||||
- Set `CHATGPT_TOKEN=` to "user_provided" to allow users to provide their own API key from the WebUI
|
||||
- It is not recommended to provide your token in the `.env` file since it expires often and sharing it could get you banned.
|
||||
|
||||
```bash
|
||||
CHATGPT_TOKEN=
|
||||
CHATGPT_MODELS=text-davinci-002-render-sha
|
||||
``` -->
|
||||
|
||||
### Google
|
||||
Follow these instructions to setup the [Google Endpoint](./ai_setup.md#google)
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue