Skip to content

pydantic_ai.builtin_tools

AbstractBuiltinTool dataclass

Bases: ABC

A builtin tool that can be used by an agent.

This class is abstract and cannot be instantiated directly.

The builtin tools are passed to the model as part of the ModelRequestParameters.

Source code in pydantic_ai_slim/pydantic_ai/builtin_tools.py 
23
24
25
26
27
28
29
30
31
32
33
@dataclass(kw_only=True)
class AbstractBuiltinTool(ABC):
    """A builtin tool that can be used by an agent.

    This class is abstract and cannot be instantiated directly.

    The builtin tools are passed to the model as part of the `ModelRequestParameters`.
    """

    kind: str = 'unknown_builtin_tool'
    """Built-in tool identifier, this should be available on all built-in tools as a discriminator."""

kind class-attribute instance-attribute 

kind: str = 'unknown_builtin_tool'

Built-in tool identifier, this should be available on all built-in tools as a discriminator.

WebSearchTool dataclass

Bases: AbstractBuiltinTool

A builtin tool that allows your agent to search the web for information.

The parameters that PydanticAI passes depend on the model, as some parameters may not be supported by certain models.

Supported by:

  • Anthropic
  • OpenAI Responses
  • Groq
  • Google
Source code in pydantic_ai_slim/pydantic_ai/builtin_tools.py 
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
@dataclass(kw_only=True)
class WebSearchTool(AbstractBuiltinTool):
    """A builtin tool that allows your agent to search the web for information.

    The parameters that PydanticAI passes depend on the model, as some parameters may not be supported by certain models.

    Supported by:

    * Anthropic
    * OpenAI Responses
    * Groq
    * Google
    """

    search_context_size: Literal['low', 'medium', 'high'] = 'medium'
    """The `search_context_size` parameter controls how much context is retrieved from the web to help the tool formulate a response.

    Supported by:

    * OpenAI Responses
    """

    user_location: WebSearchUserLocation | None = None
    """The `user_location` parameter allows you to localize search results based on a user's location.

    Supported by:

    * Anthropic
    * OpenAI Responses
    """

    blocked_domains: list[str] | None = None
    """If provided, these domains will never appear in results.

    With Anthropic, you can only use one of `blocked_domains` or `allowed_domains`, not both.

    Supported by:

    * Anthropic, see <https://docs.anthropic.com/en/docs/build-with-claude/tool-use/web-search-tool#domain-filtering>
    * Groq, see <https://console.groq.com/docs/agentic-tooling#search-settings>
    """

    allowed_domains: list[str] | None = None
    """If provided, only these domains will be included in results.

    With Anthropic, you can only use one of `blocked_domains` or `allowed_domains`, not both.

    Supported by:

    * Anthropic, see <https://docs.anthropic.com/en/docs/build-with-claude/tool-use/web-search-tool#domain-filtering>
    * Groq, see <https://console.groq.com/docs/agentic-tooling#search-settings>
    """

    max_uses: int | None = None
    """If provided, the tool will stop searching the web after the given number of uses.

    Supported by:

    * Anthropic
    """

    kind: str = 'web_search'
    """The kind of tool."""

search_context_size class-attribute instance-attribute 

search_context_size: Literal["low", "medium", "high"] = (
    "medium"
)

The search_context_size parameter controls how much context is retrieved from the web to help the tool formulate a response.

Supported by:

  • OpenAI Responses

user_location class-attribute instance-attribute 

user_location: WebSearchUserLocation | None = None

The user_location parameter allows you to localize search results based on a user's location.

Supported by:

  • Anthropic
  • OpenAI Responses

blocked_domains class-attribute instance-attribute 

blocked_domains: list[str] | None = None

If provided, these domains will never appear in results.

With Anthropic, you can only use one of blocked_domains or allowed_domains, not both.

Supported by:

allowed_domains class-attribute instance-attribute 

allowed_domains: list[str] | None = None

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

With Anthropic, you can only use one of blocked_domains or allowed_domains, not both.

Supported by:

max_uses class-attribute instance-attribute 

max_uses: int | None = None

If provided, the tool will stop searching the web after the given number of uses.

Supported by:

  • Anthropic

kind class-attribute instance-attribute 

kind: str = 'web_search'

The kind of tool.

WebSearchUserLocation

Bases: TypedDict

Allows you to localize search results based on a user's location.

Supported by:

  • Anthropic
  • OpenAI Responses
Source code in pydantic_ai_slim/pydantic_ai/builtin_tools.py 
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
class WebSearchUserLocation(TypedDict, total=False):
    """Allows you to localize search results based on a user's location.

    Supported by:

    * Anthropic
    * OpenAI Responses
    """

    city: str
    """The city where the user is located."""

    country: str
    """The country where the user is located. For OpenAI, this must be a 2-letter country code (e.g., 'US', 'GB')."""

    region: str
    """The region or state where the user is located."""

    timezone: str
    """The timezone of the user's location."""

city instance-attribute 

city: str

The city where the user is located.

country instance-attribute 

country: str

The country where the user is located. For OpenAI, this must be a 2-letter country code (e.g., 'US', 'GB').

region instance-attribute 

region: str

The region or state where the user is located.

timezone instance-attribute 

timezone: str

The timezone of the user's location.

CodeExecutionTool dataclass

Bases: AbstractBuiltinTool

A builtin tool that allows your agent to execute code.

Supported by:

  • Anthropic
  • OpenAI Responses
  • Google
Source code in pydantic_ai_slim/pydantic_ai/builtin_tools.py 
123
124
125
126
127
128
129
130
131
132
133
134
class CodeExecutionTool(AbstractBuiltinTool):
    """A builtin tool that allows your agent to execute code.

    Supported by:

    * Anthropic
    * OpenAI Responses
    * Google
    """

    kind: str = 'code_execution'
    """The kind of tool."""

kind class-attribute instance-attribute 

kind: str = 'code_execution'

The kind of tool.

UrlContextTool dataclass

Bases: AbstractBuiltinTool

Allows your agent to access contents from URLs.

Supported by:

  • Google
Source code in pydantic_ai_slim/pydantic_ai/builtin_tools.py 
137
138
139
140
141
142
143
144
145
146
class UrlContextTool(AbstractBuiltinTool):
    """Allows your agent to access contents from URLs.

    Supported by:

    * Google
    """

    kind: str = 'url_context'
    """The kind of tool."""

kind class-attribute instance-attribute 

kind: str = 'url_context'

The kind of tool.

ImageGenerationTool dataclass

Bases: AbstractBuiltinTool

A builtin tool that allows your agent to generate images.

Supported by:

  • OpenAI Responses
  • Google
Source code in pydantic_ai_slim/pydantic_ai/builtin_tools.py 
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
@dataclass(kw_only=True)
class ImageGenerationTool(AbstractBuiltinTool):
    """A builtin tool that allows your agent to generate images.

    Supported by:

    * OpenAI Responses
    * Google
    """

    background: Literal['transparent', 'opaque', 'auto'] = 'auto'
    """Background type for the generated image.

    Supported by:

    * OpenAI Responses. 'transparent' is only supported for 'png' and 'webp' output formats.
    """

    input_fidelity: Literal['high', 'low'] | None = None
    """
    Control how much effort the model will exert to match the style and features,
    especially facial features, of input images.

    Supported by:

    * OpenAI Responses. Default: 'low'.
    """

    moderation: Literal['auto', 'low'] = 'auto'
    """Moderation level for the generated image.

    Supported by:

    * OpenAI Responses
    """

    output_compression: int = 100
    """Compression level for the output image.

    Supported by:

    * OpenAI Responses. Only supported for 'png' and 'webp' output formats.
    """

    output_format: Literal['png', 'webp', 'jpeg'] | None = None
    """The output format of the generated image.

    Supported by:

    * OpenAI Responses. Default: 'png'.
    """

    partial_images: int = 0
    """
    Number of partial images to generate in streaming mode.

    Supported by:

    * OpenAI Responses. Supports 0 to 3.
    """

    quality: Literal['low', 'medium', 'high', 'auto'] = 'auto'
    """The quality of the generated image.

    Supported by:

    * OpenAI Responses
    """

    size: Literal['1024x1024', '1024x1536', '1536x1024', 'auto'] = 'auto'
    """The size of the generated image.

    Supported by:

    * OpenAI Responses
    """

    kind: str = 'image_generation'
    """The kind of tool."""

background class-attribute instance-attribute 

background: Literal["transparent", "opaque", "auto"] = (
    "auto"
)

Background type for the generated image.

Supported by:

  • OpenAI Responses. 'transparent' is only supported for 'png' and 'webp' output formats.

input_fidelity class-attribute instance-attribute 

input_fidelity: Literal['high', 'low'] | None = None

Control how much effort the model will exert to match the style and features, especially facial features, of input images.

Supported by:

  • OpenAI Responses. Default: 'low'.

moderation class-attribute instance-attribute 

moderation: Literal['auto', 'low'] = 'auto'

Moderation level for the generated image.

Supported by:

  • OpenAI Responses

output_compression class-attribute instance-attribute 

output_compression: int = 100

Compression level for the output image.

Supported by:

  • OpenAI Responses. Only supported for 'png' and 'webp' output formats.

output_format class-attribute instance-attribute 

output_format: Literal['png', 'webp', 'jpeg'] | None = None

The output format of the generated image.

Supported by:

  • OpenAI Responses. Default: 'png'.

partial_images class-attribute instance-attribute 

partial_images: int = 0

Number of partial images to generate in streaming mode.

Supported by:

  • OpenAI Responses. Supports 0 to 3.

quality class-attribute instance-attribute 

quality: Literal['low', 'medium', 'high', 'auto'] = 'auto'

The quality of the generated image.

Supported by:

  • OpenAI Responses

size class-attribute instance-attribute 

size: Literal[
    "1024x1024", "1024x1536", "1536x1024", "auto"
] = "auto"

The size of the generated image.

Supported by:

  • OpenAI Responses

kind class-attribute instance-attribute 

kind: str = 'image_generation'

The kind of tool.

MemoryTool dataclass

Bases: AbstractBuiltinTool

A builtin tool that allows your agent to use memory.

Supported by:

  • Anthropic
Source code in pydantic_ai_slim/pydantic_ai/builtin_tools.py 
230
231
232
233
234
235
236
237
238
239
class MemoryTool(AbstractBuiltinTool):
    """A builtin tool that allows your agent to use memory.

    Supported by:

    * Anthropic
    """

    kind: str = 'memory'
    """The kind of tool."""

kind class-attribute instance-attribute 

kind: str = 'memory'

The kind of tool.