🧹 docs: formatting fix for custom_config.md

This commit is contained in:
Danny Avila 2024-01-06 12:12:59 -05:00 committed by GitHub
parent 2990f32f48
commit e870e6e83f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -115,36 +115,46 @@ endpoints:
``` ```
### **name**: ### **name**:
> A unique name for the endpoint. > A unique name for the endpoint.
- Type: String - Type: String
- Example: `name: "Mistral"` - Example: `name: "Mistral"`
- **Required** - **Required**
- **Note**: Will be used as the "title" in the Endpoints Selector - **Note**: Will be used as the "title" in the Endpoints Selector
### **apiKey**: ### **apiKey**:
> Your API key for the service. Can reference an environment variable, or allow user to provide the value. > Your API key for the service. Can reference an environment variable, or allow user to provide the value.
- Type: String (apiKey | `"user_provided"`) - Type: String (apiKey | `"user_provided"`)
- Example: `apiKey: "${MISTRAL_API_KEY}"` | `apiKey: "your_api_key"` | `apiKey: "user_provided"` - Example: `apiKey: "${MISTRAL_API_KEY}"` | `apiKey: "your_api_key"` | `apiKey: "user_provided"`
- **Required** - **Required**
- **Note**: It's highly recommended to use the env. variable reference for this field, i.e. `${YOUR_VARIABLE}` - **Note**: It's highly recommended to use the env. variable reference for this field, i.e. `${YOUR_VARIABLE}`
### **baseURL**: ### **baseURL**:
> Base URL for the API. Can reference an environment variable, or allow user to provide the value. > Base URL for the API. Can reference an environment variable, or allow user to provide the value.
- Type: String (baseURL | `"user_provided"`) - Type: String (baseURL | `"user_provided"`)
- Example: `baseURL: "https://api.mistral.ai/v1"` | `baseURL: "${MISTRAL_BASE_URL}"` | `baseURL: "user_provided"` - Example: `baseURL: "https://api.mistral.ai/v1"` | `baseURL: "${MISTRAL_BASE_URL}"` | `baseURL: "user_provided"`
- **Required** - **Required**
- **Note**: It's highly recommended to use the env. variable reference for this field, i.e. `${YOUR_VARIABLE}` - **Note**: It's highly recommended to use the env. variable reference for this field, i.e. `${YOUR_VARIABLE}`
### **iconURL**: ### **iconURL**:
> The URL to use as the Endpoint Icon. > The URL to use as the Endpoint Icon.
- Type: Boolean - Type: Boolean
- Example: `iconURL: https://github.com/danny-avila/LibreChat/raw/main/docs/assets/LibreChat.svg` - Example: `iconURL: https://github.com/danny-avila/LibreChat/raw/main/docs/assets/LibreChat.svg`
- **Note**: The following are "known endpoints" (case-insensitive), which have icons provided for them. If your endpoint `name` matches the following names, you should omit this field: - **Note**: The following are "known endpoints" (case-insensitive), which have icons provided for them. If your endpoint `name` matches the following names, you should omit this field:
- "Mistral" - "Mistral"
- "OpenRouter" - "OpenRouter"
### **models**: ### **models**:
> Configuration for models. > Configuration for models.
- **Required** - **Required**
- **default**: An array of strings indicating the default models to use. At least one value is required. - **default**: An array of strings indicating the default models to use. At least one value is required.
- Type: Array of Strings - Type: Array of Strings
@ -155,45 +165,59 @@ endpoints:
- Example: `fetch: true` - Example: `fetch: true`
- **Note**: May cause slowdowns during initial use of the app if the response is delayed. Defaults to `false`. - **Note**: May cause slowdowns during initial use of the app if the response is delayed. Defaults to `false`.
### **titleConvo**: ### **titleConvo**:
> Enables title conversation when set to `true`. > Enables title conversation when set to `true`.
- Type: Boolean - Type: Boolean
- Example: `titleConvo: true` - Example: `titleConvo: true`
### **titleMethod**: ### **titleMethod**:
> Chooses between "completion" or "functions" for title method. > Chooses between "completion" or "functions" for title method.
- Type: String (`"completion"` | `"functions"`) - Type: String (`"completion"` | `"functions"`)
- Example: `titleMethod: "completion"` - Example: `titleMethod: "completion"`
- **Note**: Defaults to "completion" if omitted. - **Note**: Defaults to "completion" if omitted.
### **titleModel**: ### **titleModel**:
> Specifies the model to use for titles. > Specifies the model to use for titles.
- Type: String - Type: String
- Example: `titleModel: "mistral-tiny"` - Example: `titleModel: "mistral-tiny"`
- **Note**: Defaults to "gpt-3.5-turbo" if omitted. May cause issues if "gpt-3.5-turbo" is not available. - **Note**: Defaults to "gpt-3.5-turbo" if omitted. May cause issues if "gpt-3.5-turbo" is not available.
### **summarize**: ### **summarize**:
> Enables summarization when set to `true`. > Enables summarization when set to `true`.
- Type: Boolean - Type: Boolean
- Example: `summarize: false` - Example: `summarize: false`
- **Note**: This feature requires an OpenAI Functions compatible API - **Note**: This feature requires an OpenAI Functions compatible API
### **summaryModel**: ### **summaryModel**:
> Specifies the model to use if summarization is enabled. > Specifies the model to use if summarization is enabled.
- Type: String - Type: String
- Example: `summaryModel: "mistral-tiny"` - Example: `summaryModel: "mistral-tiny"`
- **Note**: Defaults to "gpt-3.5-turbo" if omitted. May cause issues if "gpt-3.5-turbo" is not available. - **Note**: Defaults to "gpt-3.5-turbo" if omitted. May cause issues if "gpt-3.5-turbo" is not available.
### **forcePrompt**: ### **forcePrompt**:
> If `true`, sends a `prompt` parameter instead of `messages`. > If `true`, sends a `prompt` parameter instead of `messages`.
- Type: Boolean - Type: Boolean
- Example: `forcePrompt: false` - Example: `forcePrompt: false`
- **Note**: This combines all messages into a single text payload, [following OpenAI format](https://github.com/pvicente/openai-python/blob/main/chatml.md), and - **Note**: This combines all messages into a single text payload, [following OpenAI format](https://github.com/pvicente/openai-python/blob/main/chatml.md), and
uses the `/completions` endpoint of your baseURL rather than `/chat/completions`. uses the `/completions` endpoint of your baseURL rather than `/chat/completions`.
### **modelDisplayLabel**: ### **modelDisplayLabel**:
> The label displayed in messages next to the Icon for the current AI model. > The label displayed in messages next to the Icon for the current AI model.
- Type: String - Type: String
- Example: `modelDisplayLabel: "Mistral"` - Example: `modelDisplayLabel: "Mistral"`
- **Note**: The display order is: - **Note**: The display order is:
@ -201,8 +225,10 @@ endpoints:
- 2. Label derived from the model name (if applicable) - 2. Label derived from the model name (if applicable)
- 3. This value, `modelDisplayLabel`, is used if the above are not specified. Defaults to "AI". - 3. This value, `modelDisplayLabel`, is used if the above are not specified. Defaults to "AI".
### **addParams**: ### **addParams**:
> Adds additional parameters to requests. > Adds additional parameters to requests.
- Type: Object/Dictionary - Type: Object/Dictionary
- **Description**: Adds/Overrides parameters. Useful for specifying API-specific options. - **Description**: Adds/Overrides parameters. Useful for specifying API-specific options.
- **Example**: - **Example**:
@ -211,8 +237,10 @@ endpoints:
safe_mode: true safe_mode: true
``` ```
### **dropParams**: ### **dropParams**:
> Removes [default parameters](#default-parameters) from requests. > Removes [default parameters](#default-parameters) from requests.
- Type: Array/List of Strings - Type: Array/List of Strings
- **Description**: Excludes specified [default parameters](#default-parameters). Useful for APIs that do not accept or recognize certain parameters. - **Description**: Excludes specified [default parameters](#default-parameters). Useful for APIs that do not accept or recognize certain parameters.
- **Example**: `dropParams: ["stop", "temperature", "top_p"]` - **Example**: `dropParams: ["stop", "temperature", "top_p"]`