Skip to content

feat: add COHERE_BASE_URL configuration for custom Cohere endpoints #409

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
busla wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: add COHERE_BASE_URL configuration for custom Cohere endpoints #409

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions pages/docs/configuration/dotenv.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -288,6 +288,7 @@ For detailed configuration and customization options, see: [Web Search Configura
['FIRECRAWL_API_URL', 'string', 'Custom Firecrawl API URL (optional). Only needed for custom Firecrawl instances.', '# FIRECRAWL_API_URL='],
['JINA_API_KEY', 'string', 'API key for Jina reranker service. Get your key from https://jina.ai/api-dashboard/', '# JINA_API_KEY='],
['COHERE_API_KEY', 'string', 'API key for Cohere reranker service. Get your key from https://dashboard.cohere.com/welcome/login', '# COHERE_API_KEY='],
['COHERE_BASE_URL', 'string', 'Custom Cohere API base URL (optional). Only needed for custom Cohere endpoints or proxies.', '# COHERE_BASE_URL='],
]}
/>

Expand Down
11 changes: 11 additions & 0 deletions pages/docs/configuration/librechat_yaml/object_structure/web_search.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ webSearch:
# Reranker Configuration
jinaApiKey: "${JINA_API_KEY}"
cohereApiKey: "${COHERE_API_KEY}"
cohereApiUrl: "${COHERE_BASE_URL}"
rerankerType: "jina" # Options: "jina", "cohere"

# General Settings
Expand Down Expand Up @@ -295,6 +296,16 @@ webSearch:

**Note:** Get your API key from [Cohere Dashboard](https://dashboard.cohere.com/welcome/login)

### cohereApiUrl

<OptionTable
options={[
['cohereApiUrl', 'String', 'Environment variable name for the Cohere API base URL. If not set in .env, users will be prompted to provide it via UI.', '${COHERE_BASE_URL}'],
]}
/>

**Note:** This is optional and only needed if you're using a custom Cohere endpoint or proxy.

### rerankerType

<OptionTable
Expand Down
1 change: 1 addition & 0 deletions pages/docs/features/web_search.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,7 @@ Each component of the web search feature requires its own API key. Here's how to
3. Navigate to the API Keys section
4. Copy your API key
5. Set it in your environment variables or provide it through the UI
6. (Optional) Set `COHERE_BASE_URL` if using a custom Cohere endpoint or proxy

## Components

Expand Down
Loading