struct

Anthropic::WebSearchTool

Inherits JSON::Serializable < Anthropic::ServerTool < JSON::Serializable < Struct < Value < Object

Web search tool - allows Claude to search the internet

Note: This tool requires the beta header "anthropic-beta: web-search-2025-03-05"

message = client.messages.create(
  model: Anthropic::Model::CLAUDE_SONNET_4_6,
  max_tokens: 1024,
  server_tools: [Anthropic::WebSearchTool.new],
  messages: [{role: "user", content: "What's the latest news about Crystal programming language?"}]
)

Constructors

excluding(*domains : String) : self

Create a web search tool excluding specific domains

Source
limited_to(*domains : String) : self

Create a web search tool limited to specific domains

Source
new(pull : JSON::PullParser)

Web search tool - allows Claude to search the internet

Note: This tool requires the beta header "anthropic-beta: web-search-2025-03-05"

message = client.messages.create(
  model: Anthropic::Model::CLAUDE_SONNET_4_6,
  max_tokens: 1024,
  server_tools: [Anthropic::WebSearchTool.new],
  messages: [{role: "user", content: "What's the latest news about Crystal programming language?"}]
)
Source
new(allowed_callers : Array(String) | Nil = nil, cache_control : CacheControl | Nil = nil, defer_loading : Bool | Nil = nil, strict : Bool | Nil = nil, allowed_domains : Array(String) | Nil = nil, blocked_domains : Array(String) | Nil = nil, max_uses : Int32 | Nil = nil, user_location : UserLocation | Nil = nil)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source

Class methods

beta_header

Returns the beta header required for this tool

Source

Instance methods

allowed_callers
Source
allowed_domains

Optional: Limit search to specific domains

Source
blocked_domains

Optional: Exclude specific domains from search

Source
cache_control
Source
defer_loading
Source
max_uses

Optional: Maximum number of searches Claude can perform

Source
name
Source
strict
Source
type
Source
user_location

Optional: User's approximate location for localized results

Source