Skip to content

Commit 81be052

Browse files
committed
fix docs
1 parent 1d56cb2 commit 81be052

File tree

5 files changed

+17
-7
lines changed

5 files changed

+17
-7
lines changed

docs/install.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ pip/uv-add "pydantic-ai-slim[openai]"
4343
* `logfire` — installs [Pydantic Logfire](logfire.md) dependency `logfire` [PyPI ↗](https://pypi.org/project/logfire){:target="_blank"}
4444
* `evals` — installs [Pydantic Evals](evals.md) dependency `pydantic-evals` [PyPI ↗](https://pypi.org/project/pydantic-evals){:target="_blank"}
4545
* `openai` — installs [OpenAI Model](models/openai.md) dependency `openai` [PyPI ↗](https://pypi.org/project/openai){:target="_blank"}
46-
* `vertexai` — installs [Google Vertex AI Model](models/google.md#vertex-ai) dependencies `google-auth` [PyPI ↗](https://pypi.org/project/google-auth){:target="_blank"} and `requests` [PyPI ↗](https://pypi.org/project/requests){:target="_blank"}
46+
* `vertexai` — installs `GoogleVertexProvider` dependencies `google-auth` [PyPI ↗](https://pypi.org/project/google-auth){:target="_blank"} and `requests` [PyPI ↗](https://pypi.org/project/requests){:target="_blank"}
4747
* `google` — installs [Google Model](models/google.md) dependency `google-genai` [PyPI ↗](https://pypi.org/project/google-genai){:target="_blank"}
4848
* `anthropic` — installs [Anthropic Model](models/anthropic.md) dependency `anthropic` [PyPI ↗](https://pypi.org/project/anthropic){:target="_blank"}
4949
* `groq` — installs [Groq Model](models/groq.md) dependency `groq` [PyPI ↗](https://pypi.org/project/groq){:target="_blank"}

pydantic_ai_slim/pydantic_ai/ui/_adapter.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ def load_messages(cls, messages: Sequence[MessageT]) -> list[ModelMessage]:
144144

145145
@abstractmethod
146146
def build_event_stream(self) -> UIEventStream[RunInputT, EventT, AgentDepsT, OutputDataT]:
147-
"""Build a protocol-specific event stream."""
147+
"""Build a protocol-specific event stream transformer."""
148148
raise NotImplementedError
149149

150150
@cached_property

pydantic_ai_slim/pydantic_ai/ui/_event_stream.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -240,7 +240,7 @@ async def handle_event(self, event: NativeEvent) -> AsyncIterator[EventT]:
240240
- [`FinalResultEvent`][pydantic_ai.messages.FinalResultEvent] -> `handle_final_result`
241241
- [`FunctionToolCallEvent`][pydantic_ai.messages.FunctionToolCallEvent] -> `handle_function_tool_call`
242242
- [`FunctionToolResultEvent`][pydantic_ai.messages.FunctionToolResultEvent] -> `handle_function_tool_result`
243-
- [`AgentRunResultEvent`][pydantic_ai.messages.AgentRunResultEvent] -> `handle_run_result`
243+
- [`AgentRunResultEvent`][pydantic_ai.run.AgentRunResultEvent] -> `handle_run_result`
244244
245245
Subclasses are encouraged to override the individual `handle_*` methods rather than this one.
246246
If you need specific behavior for all events, make sure you call the super method.

pydantic_ai_slim/pydantic_ai/ui/ag_ui/_adapter.py

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -85,27 +85,33 @@ class AGUIAdapter(UIAdapter[RunAgentInput, Message, BaseEvent, AgentDepsT, Outpu
8585

8686
@classmethod
8787
def build_run_input(cls, body: bytes) -> RunAgentInput:
88+
"""Build an AG-UI run input object from the request body."""
8889
return RunAgentInput.model_validate_json(body)
8990

9091
def build_event_stream(self) -> UIEventStream[RunAgentInput, BaseEvent, AgentDepsT, OutputDataT]:
92+
"""Build an AG-UI event stream transformer."""
9193
return AGUIEventStream(self.run_input, accept=self.accept)
9294

95+
@cached_property
96+
def messages(self) -> list[ModelMessage]:
97+
"""Pydantic AI messages from the AG-UI run input."""
98+
return self.load_messages(self.run_input.messages)
99+
93100
@cached_property
94101
def toolset(self) -> AbstractToolset[AgentDepsT] | None:
102+
"""Toolset representing frontend tools from the AG-UI run input."""
95103
if self.run_input.tools:
96104
return _AGUIFrontendToolset[AgentDepsT](self.run_input.tools)
97105
return None
98106

99107
@cached_property
100108
def state(self) -> dict[str, Any] | None:
109+
"""Frontend state from the AG-UI run input."""
101110
return self.run_input.state
102111

103-
@cached_property
104-
def messages(self) -> list[ModelMessage]:
105-
return self.load_messages(self.run_input.messages)
106-
107112
@classmethod
108113
def load_messages(cls, messages: Sequence[Message]) -> list[ModelMessage]:
114+
"""Transform AG-UI messages into Pydantic AI messages."""
109115
builder = MessagesBuilder()
110116
tool_calls: dict[str, str] = {} # Tool call ID to tool name mapping.
111117

pydantic_ai_slim/pydantic_ai/ui/vercel_ai/_adapter.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,17 +65,21 @@ class VercelAIAdapter(UIAdapter[RequestData, UIMessage, BaseChunk, AgentDepsT, O
6565

6666
@classmethod
6767
def build_run_input(cls, body: bytes) -> RequestData:
68+
"""Build a Vercel AI run input object from the request body."""
6869
return request_data_ta.validate_json(body)
6970

7071
def build_event_stream(self) -> UIEventStream[RequestData, BaseChunk, AgentDepsT, OutputDataT]:
72+
"""Build a Vercel AI event stream transformer."""
7173
return VercelAIEventStream(self.run_input, accept=self.accept)
7274

7375
@cached_property
7476
def messages(self) -> list[ModelMessage]:
77+
"""Pydantic AI messages from the Vercel AI run input."""
7578
return self.load_messages(self.run_input.messages)
7679

7780
@classmethod
7881
def load_messages(cls, messages: Sequence[UIMessage]) -> list[ModelMessage]: # noqa: C901
82+
"""Transform Vercel AI messages into Pydantic AI messages."""
7983
builder = MessagesBuilder()
8084

8185
for msg in messages:

0 commit comments

Comments
 (0)