Package org.springframework.ai.anthropic

Class AnthropicWebSearchTool

java.lang.Object

org.springframework.ai.anthropic.AnthropicWebSearchTool

public class AnthropicWebSearchTool
extends Object

Configuration for Anthropic's built-in web search tool. When enabled, Claude can search the web during a conversation and use the results to generate cited responses.

Example usage:

 var webSearch = AnthropicWebSearchTool.builder()
     .allowedDomains(List.of("docs.spring.io", "github.com"))
     .maxUses(5)
     .build();

 var options = AnthropicChatOptions.builder()
     .webSearchTool(webSearch)
     .build();
 

Since:

1.0.0

Author:

Soby Chacko

See Also:

• Anthropic Web Search

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AnthropicWebSearchTool.Builder
static final record	AnthropicWebSearchTool.UserLocation	Approximate user location for localizing web search results.

Constructor Summary

Constructors

Constructor	Description
AnthropicWebSearchTool()

Method Summary

Modifier and Type	Method	Description
static AnthropicWebSearchTool.Builder	builder()
@Nullable List<String>	getAllowedDomains()
@Nullable List<String>	getBlockedDomains()
@Nullable Long	getMaxUses()
@Nullable AnthropicWebSearchTool.UserLocation	getUserLocation()
void	setAllowedDomains(@Nullable List<String> allowedDomains)
void	setBlockedDomains(@Nullable List<String> blockedDomains)
void	setMaxUses(@Nullable Long maxUses)
void	setUserLocation(@Nullable AnthropicWebSearchTool.UserLocation userLocation)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

AnthropicWebSearchTool

public AnthropicWebSearchTool()

Method Details

builder

public static AnthropicWebSearchTool.Builder builder()

getAllowedDomains

public @Nullable List<String> getAllowedDomains()

setAllowedDomains

public void setAllowedDomains(@Nullable List<String> allowedDomains)

getBlockedDomains

public @Nullable List<String> getBlockedDomains()

setBlockedDomains

public void setBlockedDomains(@Nullable List<String> blockedDomains)

getMaxUses

public @Nullable Long getMaxUses()

setMaxUses

public void setMaxUses(@Nullable Long maxUses)

getUserLocation

public @Nullable AnthropicWebSearchTool.UserLocation getUserLocation()

setUserLocation

public void setUserLocation(@Nullable AnthropicWebSearchTool.UserLocation userLocation)