Skip to content

Update documentation for configuring web search options in config.yaml #11537

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.

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

Merged
merged 5 commits into from
Jun 9, 2025

Conversation

colesmcintosh
Copy link
Collaborator

Title

Update documentation for configuring web search options in config.yaml

Relevant issues

Pre-Submission checklist

Please complete all items before asking a LiteLLM maintainer to review your PR

  • I have Added testing in the tests/litellm/ directory, Adding at least 1 test is a hard requirement - see details
  • I have added a screenshot of my new test passing locally
  • My PR passes all unit tests on make test-unit
  • My PR's scope is as isolated as possible, it only solves 1 specific problem

Type

📖 Documentation

Changes

Added comprehensive documentation for configuring web search options directly in config.yaml files:

What was added:

  • New section "Configuring Web Search in config.yaml"
  • Examples showing how to enable web search with default settings (web_search_options: {})
  • Examples demonstrating custom search context size configuration for different providers (xAI, OpenAI, Gemini)
  • Clear explanation that config-level settings apply to all requests but can be overridden by request-level parameters

Why this was needed:

  • Users previously had no documentation on how to set web search options at the configuration level
  • Only request-level configuration was documented, leaving a gap in the documentation
  • This addresses community feedback about missing configuration documentation

Files changed:

  • docs/my-website/docs/completion/web_search.md: Added new configuration section with examples

The documentation now provides complete coverage of web search configuration options for both request-level and config-level settings.

colesmcintosh and others added 5 commits June 7, 2025 09:15
…nhance web search options, and improve documentation for using web search with various AI models.
…ig.yaml

This update introduces sections for setting default and custom web search options in the proxy config file, including examples for different models and context sizes. A note clarifies that users can override these settings in API requests.
Copy link

vercel bot commented Jun 8, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
litellm ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 8, 2025 2:30pm

@ishaan-jaff ishaan-jaff merged commit 322aefb into BerriAI:main Jun 9, 2025
6 checks passed
stefan-- pushed a commit to stefan--/litellm that referenced this pull request Jun 12, 2025
BerriAI#11537)

* Update web_search.md to include new supported providers and models, enhance web search options, and improve documentation for using web search with various AI models.

* Update LiteLLM version in web_search.md to reflect the latest stable release.

* Fix formatting in web_search.md for model declaration consistency.

* docs(web_search.md): add configuration options for web search in config.yaml

This update introduces sections for setting default and custom web search options in the proxy config file, including examples for different models and context sizes. A note clarifies that users can override these settings in API requests.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants