mirror of
https://github.com/QwenLM/qwen-code.git
synced 2025-12-19 09:33:53 +00:00
166 lines
4.6 KiB
Markdown
166 lines
4.6 KiB
Markdown
# Web Search Tool (`web_search`)
|
|
|
|
This document describes the `web_search` tool for performing web searches using multiple providers.
|
|
|
|
## Description
|
|
|
|
Use `web_search` to perform a web search and get information from the internet. The tool supports multiple search providers and returns a concise answer with source citations when available.
|
|
|
|
### Supported Providers
|
|
|
|
1. **DashScope** (Official, Free) - Default provider, always available when using Qwen OAuth authentication
|
|
2. **Tavily** - High-quality search API with built-in answer generation
|
|
3. **Google Custom Search** - Google's Custom Search JSON API
|
|
|
|
### Arguments
|
|
|
|
`web_search` takes two arguments:
|
|
|
|
- `query` (string, required): The search query
|
|
- `provider` (string, optional): Specific provider to use ("dashscope", "tavily", "google")
|
|
- If not specified, uses the default provider from configuration
|
|
|
|
## Configuration
|
|
|
|
### Method 1: Settings File (Recommended)
|
|
|
|
Add to your `settings.json`:
|
|
|
|
```json
|
|
{
|
|
"webSearch": {
|
|
"provider": [
|
|
{ "type": "dashscope" },
|
|
{ "type": "tavily", "apiKey": "tvly-xxxxx" },
|
|
{
|
|
"type": "google",
|
|
"apiKey": "your-google-api-key",
|
|
"searchEngineId": "your-search-engine-id"
|
|
}
|
|
],
|
|
"default": "dashscope"
|
|
}
|
|
}
|
|
```
|
|
|
|
**Notes:**
|
|
|
|
- DashScope doesn't require an API key (official, free service)
|
|
- Only configure the providers you want to use
|
|
- Set `default` to specify which provider to use by default
|
|
|
|
### Method 2: Environment Variables
|
|
|
|
Set environment variables in your shell or `.env` file:
|
|
|
|
```bash
|
|
# Tavily
|
|
export TAVILY_API_KEY="tvly-xxxxx"
|
|
|
|
# Google
|
|
export GOOGLE_API_KEY="your-api-key"
|
|
export GOOGLE_SEARCH_ENGINE_ID="your-engine-id"
|
|
```
|
|
|
|
### Method 3: Command Line Arguments
|
|
|
|
Pass API keys when running Qwen Code:
|
|
|
|
```bash
|
|
# Tavily
|
|
qwen --tavily-api-key tvly-xxxxx
|
|
|
|
# Google
|
|
qwen --google-api-key your-key --google-search-engine-id your-id
|
|
|
|
# Specify default provider
|
|
qwen --web-search-default tavily
|
|
```
|
|
|
|
### Backward Compatibility (Deprecated)
|
|
|
|
⚠️ **DEPRECATED:** The legacy `tavilyApiKey` configuration is still supported for backward compatibility but is deprecated:
|
|
|
|
```json
|
|
{
|
|
"advanced": {
|
|
"tavilyApiKey": "tvly-xxxxx" // ⚠️ Deprecated
|
|
}
|
|
}
|
|
```
|
|
|
|
**Important:** This configuration is deprecated and will be removed in a future version. Please migrate to the new `webSearch` configuration format shown above. The old configuration will automatically configure Tavily as a provider, but we strongly recommend updating your configuration.
|
|
|
|
## Usage Examples
|
|
|
|
### Basic search (using default provider)
|
|
|
|
```
|
|
web_search(query="latest advancements in AI")
|
|
```
|
|
|
|
### Search with specific provider
|
|
|
|
```
|
|
web_search(query="latest advancements in AI", provider="tavily")
|
|
```
|
|
|
|
### Real-world examples
|
|
|
|
```
|
|
web_search(query="weather in San Francisco today")
|
|
web_search(query="latest Node.js LTS version", provider="google")
|
|
web_search(query="best practices for React 19", provider="dashscope")
|
|
```
|
|
|
|
## Provider Details
|
|
|
|
### DashScope (Official)
|
|
|
|
- **Cost:** Free
|
|
- **Authentication:** Automatically available with Qwen OAuth
|
|
- **Configuration:** No API key required
|
|
- **Best for:** General queries, always available
|
|
|
|
### Tavily
|
|
|
|
- **Cost:** Requires API key (paid service with free tier)
|
|
- **Sign up:** https://tavily.com
|
|
- **Features:** High-quality results with AI-generated answers
|
|
- **Best for:** Research, comprehensive answers with citations
|
|
|
|
### Google Custom Search
|
|
|
|
- **Cost:** Free tier available (100 queries/day)
|
|
- **Setup:**
|
|
1. Enable Custom Search API in Google Cloud Console
|
|
2. Create a Custom Search Engine at https://programmablesearchengine.google.com
|
|
- **Features:** Google's search quality
|
|
- **Best for:** Specific, factual queries
|
|
|
|
## Important Notes
|
|
|
|
- **Response format:** Returns a concise answer with numbered source citations
|
|
- **Citations:** Source links are appended as a numbered list: [1], [2], etc.
|
|
- **Multiple providers:** If one provider fails, manually specify another using the `provider` parameter
|
|
- **DashScope availability:** Always available when authenticated with Qwen OAuth, no configuration needed
|
|
|
|
## Troubleshooting
|
|
|
|
**Tool not available?**
|
|
|
|
- Check if at least one provider is configured
|
|
- For DashScope: Ensure you're authenticated with Qwen OAuth
|
|
- For Tavily/Google: Verify your API keys are correct
|
|
|
|
**Provider-specific errors?**
|
|
|
|
- Use the `provider` parameter to try a different search provider
|
|
- Check your API quotas and rate limits
|
|
- Verify API keys are properly set in configuration
|
|
|
|
**Need help?**
|
|
|
|
- Check your configuration: Run `qwen` and use the settings dialog
|
|
- View your current settings in `~/.qwen-code/settings.json` (macOS/Linux) or `%USERPROFILE%\.qwen-code\settings.json` (Windows)
|