webSearch method

OpenRouterBuilder webSearch({
  1. int maxResults = 5,
  2. String? searchPrompt,
  3. bool useOnlineShortcut = true,
})

Configures web search for OpenRouter models

OpenRouter supports web search in two ways:

  1. Simple: Add :online to model name
  2. Advanced: Use web plugin with custom parameters

Example:

final provider = await ai()
    .openRouter((openrouter) => openrouter
        .webSearch(
          maxResults: 5,
          searchPrompt: 'Focus on recent developments',
        ))
    .apiKey(apiKey)
    .model('anthropic/claude-3.5-sonnet')
    .build();

Implementation

OpenRouterBuilder webSearch({
  int maxResults = 5,
  String? searchPrompt,
  bool useOnlineShortcut = true,
}) {
  _baseBuilder.extension(
      'webSearchConfig',
      WebSearchConfig.openRouter(
        maxResults: maxResults,
        searchPrompt: searchPrompt,
        useOnlineShortcut: useOnlineShortcut,
      ));
  return this;
}