mirror of
https://github.com/LibreChat-AI/librechat.ai.git
synced 2026-03-27 10:48:32 +07:00
feat: Enhance documentation for Flux and related tools, including setup instructions and parameters
This commit is contained in:
Danny Avila
@@ -1,3 +1,4 @@
|
||||
export default {
|
||||
index: 'Intro',
|
||||
flux: 'Flux',
|
||||
}
|
||||
|
||||
@@ -11,9 +11,9 @@ Flux is a powerful image generation tool that can create high-quality images fro
|
||||
|
||||
1. Get your API key from [bfl.ml](https://bfl.ml)
|
||||
2. Set the `FLUX_API_KEY` environment variable in your `.env` file:
|
||||
\\\
|
||||
```bash
|
||||
FLUX_API_KEY=your_api_key_here
|
||||
\\\
|
||||
```
|
||||
|
||||
## Features
|
||||
|
||||
@@ -31,13 +31,42 @@ FLUX_API_KEY=your_api_key_here
|
||||
- `/v1/flux-dev` - Development version
|
||||
- `/v1/flux-pro-1.1-ultra` - Premium quality endpoint
|
||||
|
||||
### Customization Parameters
|
||||
- **Width/Height**: Image dimensions (multiples of 32, default: 1024x768)
|
||||
- **Steps**: Generation quality (1-50, default: 40)
|
||||
- **Safety Tolerance**: Content filtering level (0-6)
|
||||
- **Prompt Upsampling**: Enhanced prompt processing
|
||||
- **Raw Mode**: Natural-looking results (ultra endpoint only)
|
||||
- **Seed**: Reproducible generations
|
||||
### Parameters
|
||||
|
||||
The Flux tool supports three main actions:
|
||||
|
||||
1. **generate** - Create a new image from a text prompt
|
||||
2. **generate_finetuned** - Create an image using a fine-tuned model
|
||||
3. **list_finetunes** - List available custom models for the user
|
||||
|
||||
|
||||
For `generate` action:
|
||||
|
||||
• **prompt** – Text description for the image (required)
|
||||
• **width** – Width in pixels (multiple of 32)
|
||||
• **height** – Height in pixels (multiple of 32)
|
||||
• **prompt_upsampling** – Whether to perform upsampling on the prompt (default: false)
|
||||
• **steps** – Number of diffusion steps (1-50, default: 40)
|
||||
• **seed** – Optional seed for reproducibility
|
||||
• **safety_tolerance** – Tolerance level for moderation (0-6, default: 6)
|
||||
• **endpoint** – Model endpoint to use:
|
||||
- `/v1/flux-pro-1.1` (default)
|
||||
- `/v1/flux-pro`
|
||||
- `/v1/flux-dev`
|
||||
- `/v1/flux-pro-1.1-ultra`
|
||||
• **raw** – Generate less processed images (only for ultra endpoint, default: false)
|
||||
|
||||
For `generate_finetuned` action:
|
||||
|
||||
• All parameters from `generate` plus:
|
||||
• **finetune_id** – ID of the fine-tuned model (required)
|
||||
• **finetune_strength** – Strength of the fine-tuning effect (0.1-1.2, default: 1.1)
|
||||
• **guidance** – Guidance scale (default: 2.5)
|
||||
• **aspect_ratio** – Aspect ratio for ultra models (default: "16:9")
|
||||
• **endpoint** – Must be one of:
|
||||
- `/v1/flux-pro-finetuned` (default)
|
||||
- `/v1/flux-pro-1.1-ultra-finetuned`
|
||||
|
||||
|
||||
## Best Practices
|
||||
|
||||
@@ -76,13 +105,9 @@ FLUX_API_KEY=your_api_key_here
|
||||
|
||||
Here are some example prompts that work well with Flux:
|
||||
|
||||
\\\
|
||||
A serene mountain landscape at sunset, with snow-capped peaks reflected in a crystal-clear alpine lake. Warm golden light illuminates wispy clouds, creating a dramatic atmosphere. Photorealistic style with rich colors and sharp details.
|
||||
\\\
|
||||
> A serene mountain landscape at sunset, with snow-capped peaks reflected in a crystal-clear alpine lake. Warm golden light illuminates wispy clouds, creating a dramatic atmosphere. Photorealistic style with rich colors and sharp details.
|
||||
|
||||
\\\
|
||||
A futuristic cityscape at night, featuring neon-lit skyscrapers and flying vehicles. Cyberpunk style with deep blues and purples, accented by bright neon colors. Rain-slicked streets reflect the city lights, creating a moody atmosphere.
|
||||
\\\
|
||||
> A futuristic cityscape at night, featuring neon-lit skyscrapers and flying vehicles. Cyberpunk style with deep blues and purples, accented by bright neon colors. Rain-slicked streets reflect the city lights, creating a moody atmosphere.
|
||||
|
||||
## Error Handling
|
||||
|
||||
|
||||
@@ -19,14 +19,14 @@ description: Tools and Plugins setup instructions
|
||||
- [OpenWeather](/docs/configuration/tools/openweather)
|
||||
|
||||
### Stable Diffusion
|
||||
- [Stable Diffusion](/docs/configuration/tools/stable_diffusion)
|
||||
- [Stable Diffusion](/docs/features/image_gen#3--stable-diffusion-local)
|
||||
|
||||
### Flux
|
||||
- [Flux Image Generation](/docs/features/image_gen#4--flux)
|
||||
|
||||
### Wolfram|Alpha
|
||||
- [Wolfram|Alpha](/docs/configuration/tools/wolfram)
|
||||
|
||||
### Flux
|
||||
- [Flux Image Generation](/docs/configuration/tools/flux)
|
||||
|
||||
### DALL-E
|
||||
- You just need an OpenAI key, and it's made distinct from your main API key to make Chats but it can be the same one
|
||||
|
||||
|
||||
@@ -1,9 +1,9 @@
|
||||
---
|
||||
title: 🌤️ OpenWeather Plugin
|
||||
title: 🌤️ OpenWeather
|
||||
description: Configure the OpenWeather plugin for LibreChat
|
||||
---
|
||||
|
||||
# OpenWeather Plugin Configuration
|
||||
# OpenWeather Configuration
|
||||
|
||||
The OpenWeather plugin allows you to get weather data including current conditions, forecasts, historical data, and daily summaries using OpenWeather's One Call API 3.0.
|
||||
|
||||
|
||||
@@ -63,14 +63,6 @@ With the docker deployment you can skip step 2 and step 3, use the setup instruc
|
||||
- Or `http://127.0.0.1:7860` from the webui
|
||||
|
||||
|
||||
#### Select the plugins endpoint
|
||||
#### Add the tool to an Agent
|
||||
|
||||
|
||||
|
||||
#### Open the Plugin store and Install Stable Diffusion
|
||||
|
||||
|
||||
|
||||
|
||||
### 5. Select the plugin and enjoy!
|
||||
|
||||
See the [Agents](/docs/features/agents#tools) section for more information on how to add the tool to an Agent.
|
||||
|
||||
@@ -16,17 +16,6 @@ An AppID must be supplied in all calls to the Wolfram|Alpha API.
|
||||
- Visit the **[Developer Portal](https://developer.wolframalpha.com/portal/myapps/)** and click on `Get an AppID`
|
||||
- Select `LLM API` as the `API` and copy the key
|
||||
|
||||
### Configure it in LibreChat
|
||||
- Select the plugins endpoint
|
||||
|
||||
- Open the Plugin store
|
||||
|
||||
- Install Wolfram and Provide your AppID
|
||||
|
||||
#### Add the tool to an Agent
|
||||
|
||||
> Alternatively: you (the admin) can set the value in `\.env` to bypass the prompt: `WOLFRAM_APP_ID=your_app_id`
|
||||
|
||||
|
||||
### Select the plugin and enjoy!
|
||||
|
||||
|
||||
See the [Agents](/docs/features/agents#tools) section for more information on how to add the tool to an Agent.
|
||||
|
||||
@@ -111,14 +111,16 @@ For the type attribute, use one of:
|
||||
|
||||
Agents can also be enhanced with various built-in tools:
|
||||
|
||||
- **DALL-E-3**: Image generation from text descriptions
|
||||
- **Tavily Search**: Advanced search API with diverse data source integration
|
||||
- **[OpenAI Image Tools](/docs/features/image_gen#1--openai-image-tools-recommended)**: Image generation & editing using **[GPT-Image-1](https://platform.openai.com/docs/models/gpt-image-1)**
|
||||
- **[DALL-E-3](/docs/features/image_gen#2--dalle-legacy)**: Image generation from text descriptions
|
||||
- **[Stable Diffusion](/docs/features/image_gen#3--stable-diffusion-local)** / **[Flux](/docs/features/image_gen#4--flux)**: Text-to-image generation
|
||||
- **[Wolfram](/docs/configuration/tools/wolfram)**: Computational and mathematical capabilities
|
||||
- **[OpenWeather](/docs/configuration/tools/openweather)**: Weather data retrieval
|
||||
- **[Google Search](/docs/configuration/tools/google_search)**: Access to web search functionality
|
||||
- **Calculator**: Mathematical calculations
|
||||
- **Google Search**: Access to web search functionality
|
||||
- **Stable Diffusion**: Text-to-image generation
|
||||
- **Tavily Search**: Advanced search API with diverse data source integration
|
||||
- **Azure AI Search**: Information retrieval
|
||||
- **Traversaal**: A robust search API for LLM Agents
|
||||
- **Wolfram**: Computational and mathematical capabilities
|
||||
|
||||
- Tools can be disabled using the [`librechat.yaml`](/docs/configuration/librechat_yaml) configuration file:
|
||||
- [More info](/docs/configuration/librechat_yaml/object_structure/agents#capabilities)
|
||||
|
||||
@@ -170,6 +170,8 @@ SD_WEBUI_URL=http://127.0.0.1:7860 # URL to your Automatic1111 WebUI
|
||||
|
||||
No API key required—just the reachable URL.
|
||||
|
||||
More details on setting up Automatic1111 can be found in the dedicated [Stable Diffusion guide](/docs/configuration/tools/stable_diffusion).
|
||||
|
||||
---
|
||||
|
||||
## 4 · Flux
|
||||
@@ -189,32 +191,7 @@ The Flux tool supports three main actions:
|
||||
2. **generate_finetuned** - Create an image using a fine-tuned model
|
||||
3. **list_finetunes** - List available custom models for the user
|
||||
|
||||
For `generate` action:
|
||||
|
||||
• **prompt** – Text description for the image (required)
|
||||
• **width** – Width in pixels (multiple of 32)
|
||||
• **height** – Height in pixels (multiple of 32)
|
||||
• **prompt_upsampling** – Whether to perform upsampling on the prompt (default: false)
|
||||
• **steps** – Number of diffusion steps (1-50, default: 40)
|
||||
• **seed** – Optional seed for reproducibility
|
||||
• **safety_tolerance** – Tolerance level for moderation (0-6, default: 6)
|
||||
• **endpoint** – Model endpoint to use:
|
||||
- `/v1/flux-pro-1.1` (default)
|
||||
- `/v1/flux-pro`
|
||||
- `/v1/flux-dev`
|
||||
- `/v1/flux-pro-1.1-ultra`
|
||||
• **raw** – Generate less processed images (only for ultra endpoint, default: false)
|
||||
|
||||
For `generate_finetuned` action:
|
||||
|
||||
• All parameters from `generate` plus:
|
||||
• **finetune_id** – ID of the fine-tuned model (required)
|
||||
• **finetune_strength** – Strength of the fine-tuning effect (0.1-1.2, default: 1.1)
|
||||
• **guidance** – Guidance scale (default: 2.5)
|
||||
• **aspect_ratio** – Aspect ratio for ultra models (default: "16:9")
|
||||
• **endpoint** – Must be one of:
|
||||
- `/v1/flux-pro-finetuned` (default)
|
||||
- `/v1/flux-pro-1.1-ultra-finetuned`
|
||||
More details can be found in the dedicated [Flux guide](/docs/configuration/tools/flux#parameters).
|
||||
|
||||
### Setup
|
||||
|
||||
|
||||
Reference in New Issue
Block a user