Class: Anthropic::Models::WebSearchTool20250305

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/anthropic/models/web_search_tool_20250305.rb

Defined Under Namespace

Classes: UserLocation

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, inspect, #inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(allowed_domains: nil, blocked_domains: nil, cache_control: nil, max_uses: nil, user_location: nil, name: :web_search, type: :web_search_20250305) ⇒ void

Some parameter documentations has been truncated, see Anthropic::Models::WebSearchTool20250305 for more details.

Parameters:

  • allowed_domains (Array<String>, nil) (defaults to: nil) —

    If provided, only these domains will be included in results. Cannot be used alon

  • blocked_domains (Array<String>, nil) (defaults to: nil) —

    If provided, these domains will never appear in results. Cannot be used alongsid

  • cache_control (Anthropic::Models::CacheControlEphemeral, nil) (defaults to: nil) —

    Create a cache control breakpoint at this content block.

  • max_uses (Integer, nil) (defaults to: nil) —

    Maximum number of times the tool can be used in the API request.

  • user_location (Anthropic::Models::WebSearchTool20250305::UserLocation, nil) (defaults to: nil) —

    Parameters for the user's location. Used to provide more relevant search results

  • name (Symbol, :web_search) (defaults to: :web_search) —

    Name of the tool.

  • type (Symbol, :web_search_20250305) (defaults to: :web_search_20250305) 



# File 'lib/anthropic/models/web_search_tool_20250305.rb', line 52

Instance Attribute Details

#allowed_domains ⇒ Array<String>?

If provided, only these domains will be included in results. Cannot be used alongside blocked_domains.

Returns:

  • (Array<String>, nil) 


24
 
# File 'lib/anthropic/models/web_search_tool_20250305.rb', line 24

optional :allowed_domains, Anthropic::Internal::Type::ArrayOf[String], nil?: true

#blocked_domains ⇒ Array<String>?

If provided, these domains will never appear in results. Cannot be used alongside allowed_domains.

Returns:

  • (Array<String>, nil) 


31
 
# File 'lib/anthropic/models/web_search_tool_20250305.rb', line 31

optional :blocked_domains, Anthropic::Internal::Type::ArrayOf[String], nil?: true

#cache_control ⇒ Anthropic::Models::CacheControlEphemeral?

Create a cache control breakpoint at this content block.

Returns:



37
 
# File 'lib/anthropic/models/web_search_tool_20250305.rb', line 37

optional :cache_control, -> { Anthropic::CacheControlEphemeral }, nil?: true

#max_uses ⇒ Integer?

Maximum number of times the tool can be used in the API request.

Returns:

  • (Integer, nil) 


43
 
# File 'lib/anthropic/models/web_search_tool_20250305.rb', line 43

optional :max_uses, Integer, nil?: true

#name ⇒ Symbol, :web_search

Name of the tool.

This is how the tool will be called by the model and in tool_use blocks.

Returns:

  • (Symbol, :web_search) 


12
 
# File 'lib/anthropic/models/web_search_tool_20250305.rb', line 12

required :name, const: :web_search

#type ⇒ Symbol, :web_search_20250305

Returns:

  • (Symbol, :web_search_20250305) 


17
 
# File 'lib/anthropic/models/web_search_tool_20250305.rb', line 17

required :type, const: :web_search_20250305

#user_location ⇒ Anthropic::Models::WebSearchTool20250305::UserLocation?

Parameters for the user's location. Used to provide more relevant search results.

Returns:



50
 
# File 'lib/anthropic/models/web_search_tool_20250305.rb', line 50

optional :user_location, -> { Anthropic::WebSearchTool20250305::UserLocation }, nil?: true