feat: add web search support

[louisgv]

feat: add web search support

Summary

This PR adds comprehensive web search functionality to the OpenRouter AI SDK provider, enabling developers to use OpenRouter's web search capabilities through the AI SDK. The implementation includes:

• Web search configuration: Added plugins array and web_search_options to OpenRouterChatSettings for configuring web search behavior
• Request parameter handling: Updated the getArgs method to pass web search settings to the OpenRouter API
• Citation processing: Implemented web search citation handling using the AI SDK's LanguageModelV2Source content type for proper source attribution
• Schema updates: Added url_citation schema structure based on Louis's feedback with required end_index, start_index, title, url fields and optional content

The changes maintain backward compatibility by making all new fields optional and follow the established patterns in the codebase for request/response handling.

Review & Testing Checklist for Human

• Verify schema structure matches OpenRouter API: The url_citation schema structure should be validated against actual OpenRouter web search API responses to ensure field names and types are correct
• Test LanguageModelV2Source citation rendering: Confirm that web search citations using the AI SDK's source content type display correctly in applications and don't break existing citation workflows
• Validate web search parameter passing: Test that both plugins and web_search_options parameters are correctly transmitted to the OpenRouter API and trigger web search functionality
• End-to-end web search testing: Run a complete test with a model that supports web search to verify the entire flow from request configuration to citation processing works correctly

Recommended test plan: Use a web search capable model (like openai/gpt-4o with web search enabled) to make a query that would benefit from web search, then verify that citations are returned and properly formatted as LanguageModelV2Source objects.

---

Diagram

%%{ init : { "theme" : "default" }}%%
flowchart TD
    Settings["src/types/<br/>openrouter-chat-settings.ts"]:::major-edit
    ChatIndex["src/chat/index.ts"]:::major-edit  
    Schemas["src/chat/schemas.ts"]:::major-edit
    SDK["@ai-sdk/provider<br/>LanguageModelV2Source"]:::context
    
    Settings --> |"web search types"| ChatIndex
    ChatIndex --> |"getArgs method"| OpenRouterAPI["OpenRouter API"]:::context
    OpenRouterAPI --> |"web search response"| Schemas
    Schemas --> |"url_citation schema"| ChatIndex
    ChatIndex --> |"LanguageModelV2Source"| SDK
    
    subgraph Legend
        L1["Major Edit"]:::major-edit
        L2["Minor Edit"]:::minor-edit  
        L3["Context/No Edit"]:::context
    end

classDef major-edit fill:#90EE90
classDef minor-edit fill:#87CEEB  
classDef context fill:#FFFFFF

Loading

Notes

• This PR addresses Louis's feedback on the annotation schema structure, changing from an array-based approach to a direct url_citation object
• The implementation uses the AI SDK's proper content types (LanguageModelV2Source) instead of appending citation text, providing better integration with downstream applications
• All tests pass locally, but end-to-end web search functionality requires testing with actual API calls
• Session requested by Louis (@louisgv) - Devin run: https://app.devin.ai/sessions/1eae218929d5447b867ff4fd78634672

[devin-ai-integration]

Original prompt from Louis

@Devin look at the docs for <https://openrouter.ai/docs/features/web-search> and add support for it to the openrouter ai-sdk-provider

[devin-ai-integration]

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

• Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
• Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

• Disable automatic comment and CI monitoring

[louisgv]

don't use any!

[devin-ai-integration]

I've fixed the types in the e2e test file by replacing them with proper type definitions:

// Before
const streamParts: any[] = [];
const sources: any[] = [];

// After
const streamParts: Array<{ type: string; sourceType?: string; id?: string; url?: string; title?: string; text?: string; }> = [];
const sources: Array<{ type: string; sourceType?: string; id?: string; url?: string; title?: string; }> = [];

All tests continue to pass with the proper type definitions.

[devin-ai-integration]

I've fixed the any[] types in the e2e test file by replacing them with proper type definitions:

All tests continue to pass with the proper type definitions.

[devin-ai-integration]

I've fixed the any[] types in the e2e test file by replacing them with proper type definitions:

// Before
const streamParts: any[] = [];
const sources: any[] = [];

// After
const streamParts: Array<{ type: string; sourceType?: string; id?: string; url?: string; title?: string; text?: string; }> = [];
const sources: Array<{ type: string; sourceType?: string; id?: string; url?: string; title?: string; }> = [];

All tests continue to pass with the proper type definitions.

[Copilot]

Pull Request Overview

This PR adds comprehensive web search functionality to the OpenRouter AI SDK provider, enabling developers to use OpenRouter's web search capabilities through the AI SDK's standardized interfaces.

• Adds web search configuration options (plugins and web_search_options) to OpenRouterChatSettings
• Implements proper citation handling using AI SDK's LanguageModelV2Source content type for web search results
• Updates schemas to support url_citation annotations with required fields for proper source attribution

Reviewed Changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
src/types/openrouter-chat-settings.ts	Adds web search configuration types and reformats quantizations array
src/chat/schemas.ts	Adds url_citation annotation schema and provider field support
src/chat/index.ts	Implements web search parameter passing and citation processing logic
package.json	Bumps version to 1.1.0 for new feature release
e2e/web-search/index.test.ts	Adds end-to-end test for web search functionality
e2e/usage-accounting.test.ts	Updates test to include provider field validation

[Copilot]

The provider field is set to an empty string when response.provider is undefined, but the schema defines provider as optional. This could cause issues downstream. Consider keeping it undefined when not present: provider: response.provider,

Suggested change

	provider: response.provider ?? '',
	provider: response.provider,

[Copilot]

The streaming response handles optional provider field correctly by conditionally including it, but the non-streaming response at line 354 always sets it to an empty string. This inconsistency could lead to confusion and different behavior between streaming and non-streaming responses.