Skip to content

docs(web-search): use canonical YDC_API_KEY for You.com (note YOUCOM_API_KEY fallback) #1307

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
brainsparker wants to merge 1 commit into
base: main
Choose a base branch
from
+3 −3
Open

docs(web-search): use canonical YDC_API_KEY for You.com (note YOUCOM_API_KEY fallback) #1307

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
2 changes: 1 addition & 1 deletion docs/features/chat-conversations/web-search/providers/youcom.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ services:
environment:
ENABLE_WEB_SEARCH: True
WEB_SEARCH_ENGINE: "youcom"
YOUCOM_API_KEY: "YOUR_API_KEY"
YDC_API_KEY: "YOUR_API_KEY" # legacy YOUCOM_API_KEY also accepted
WEB_SEARCH_RESULT_COUNT: 3
WEB_SEARCH_CONCURRENT_REQUESTS: 10
```
Expand Down
4 changes: 2 additions & 2 deletions docs/reference/env-configuration.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4365,11 +4365,11 @@ If you use `perplexity`, this variable is not relevant to you.

:::

#### `YOUCOM_API_KEY`
#### `YDC_API_KEY`

- Type: `str`
- Default: Empty string (' ')
- Description: Sets the API key for [You.com](https://you.com/) YDC Index API web search. Required when `WEB_SEARCH_ENGINE` is set to `youcom`. Obtain an API key from [You.com API](https://you.com/api).
- Description: Sets the API key for [You.com](https://you.com/) YDC Index API web search. Required when `WEB_SEARCH_ENGINE` is set to `youcom`. Obtain an API key from [You.com API](https://you.com/api). The legacy `YOUCOM_API_KEY` is also accepted as a fallback.
- Persistence: This environment variable is a `ConfigVar` variable.

### Web Loader Configuration
Expand Down