You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
fix: only pass parser_options to griffe for google-style docstrings
The `returns_named_value` and `returns_multiple_items` options are only
valid for the Google docstring parser. Passing them to Sphinx/Numpy
parsers now triggers a DeprecationWarning in griffe.
Also fixed cross-reference paths in docstrings to use the full module
path (e.g. `pydantic_ai.agent.Agent` instead of `pydantic_ai.Agent`).
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude Sonnet 4.5 <[email protected]>
Copy file name to clipboardExpand all lines: pydantic_ai_slim/pydantic_ai/agent/__init__.py
+5-5Lines changed: 5 additions & 5 deletions
Original file line number
Diff line number
Diff line change
@@ -242,9 +242,9 @@ def __init__(
242
242
output_type: The type of the output data, used to validate the data returned by the model,
243
243
defaults to `str`.
244
244
instructions: Instructions to use for this agent, you can also register instructions via a function with
245
-
[`instructions`][pydantic_ai.Agent.instructions] or pass additional, temporary, instructions when executing a run.
245
+
[`instructions`][pydantic_ai.agent.Agent.instructions] or pass additional, temporary, instructions when executing a run.
246
246
system_prompt: Static system prompts to use for this agent, you can also register system
247
-
prompts via a function with [`system_prompt`][pydantic_ai.Agent.system_prompt].
247
+
prompts via a function with [`system_prompt`][pydantic_ai.agent.Agent.system_prompt].
248
248
deps_type: The type used for dependency injection, this parameter exists solely to allow you to fully
249
249
parameterize the agent, and therefore get the best out of static type checking.
250
250
If you're not using deps, but want type checking to pass, you can set `deps=None` to satisfy Pyright
@@ -257,7 +257,7 @@ def __init__(
257
257
validation_context: Pydantic [validation context](https://docs.pydantic.dev/latest/concepts/validators/#validation-context) used to validate tool arguments and outputs.
258
258
output_retries: The maximum number of retries to allow for output validation, defaults to `retries`.
259
259
tools: Tools to register with the agent, you can also register tools via the decorators
260
-
[`@agent.tool`][pydantic_ai.Agent.tool] and [`@agent.tool_plain`][pydantic_ai.Agent.tool_plain].
260
+
[`@agent.tool`][pydantic_ai.agent.Agent.tool] and [`@agent.tool_plain`][pydantic_ai.agent.Agent.tool_plain].
261
261
builtin_tools: The builtin tools that the agent will use. This depends on the model, as some models may not
262
262
support certain tools. If the model doesn't support the builtin tools, an error will be raised.
263
263
prepare_tools: Custom function to prepare the tool definition of all tools for each step, except output tools.
@@ -272,14 +272,14 @@ def __init__(
272
272
it's evaluated to create a [`Model`][pydantic_ai.models.Model] instance immediately,
273
273
which checks for the necessary environment variables. Set this to `false`
274
274
to defer the evaluation until the first run. Useful if you want to
275
-
[override the model][pydantic_ai.Agent.override] for testing.
275
+
[override the model][pydantic_ai.agent.Agent.override] for testing.
276
276
end_strategy: Strategy for handling tool calls that are requested alongside a final result.
277
277
See [`EndStrategy`][pydantic_ai.agent.EndStrategy] for more information.
278
278
instrument: Set to True to automatically instrument with OpenTelemetry,
279
279
which will use Logfire if it's configured.
280
280
Set to an instance of [`InstrumentationSettings`][pydantic_ai.agent.InstrumentationSettings] to customize.
This class is responsible for transforming agent run input received from the frontend into arguments for [`Agent.run_stream_events()`][pydantic_ai.Agent.run_stream_events], running the agent, and then transforming Pydantic AI events into protocol-specific events.
107
+
This class is responsible for transforming agent run input received from the frontend into arguments for [`Agent.run_stream_events()`][pydantic_ai.agent.Agent.run_stream_events], running the agent, and then transforming Pydantic AI events into protocol-specific events.
108
108
109
109
The event stream transformation is handled by a protocol-specific [`UIEventStream`][pydantic_ai.ui.UIEventStream] subclass.
0 commit comments