Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -80,8 +80,9 @@ else ifeq ($(PPPR_TOKEN),)
@exit 1
else
@echo 'installing insiders packages...'
@uv pip install -U mkdocs-material mkdocstrings-python \
--extra-index-url https://pydantic:${PPPR_TOKEN}@pppr.pydantic.dev/simple/
@uv pip install -U \
--extra-index-url https://pydantic:${PPPR_TOKEN}@pppr.pydantic.dev/simple/ \
mkdocs-material mkdocstrings-python
endif

.PHONY: docs-insiders # Build the documentation using insiders packages
Expand All @@ -98,10 +99,10 @@ cf-pages-build:
uv python install 3.12
uv sync --python 3.12 --frozen --group docs
uv pip install -U \
--extra-index-url https://pydantic:$(PPPR_TOKEN)@pppr.pydantic.dev/simple/ \
--extra-index-url https://pydantic:${PPPR_TOKEN}@pppr.pydantic.dev/simple/ \
mkdocs-material mkdocstrings-python
uv pip freeze
uv run --no-sync mkdocs build
uv run --no-sync mkdocs build -f mkdocs.insiders.yml

.PHONY: all
all: format lint typecheck testcov
2 changes: 1 addition & 1 deletion docs/examples/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Examples

Examples of how to use Pydantic AI and what it can do.
Examples of how to use PydanticAI and what it can do.

## Usage

Expand Down
4 changes: 3 additions & 1 deletion docs/examples/pydantic-model.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
Simple example of using Pydantic AI to construct a Pydantic model from a text input.
# Pydantic Model

Simple example of using PydanticAI to construct a Pydantic model from a text input.

Demonstrates:

Expand Down
4 changes: 2 additions & 2 deletions docs/examples/rag.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Demonstrates:
* RAG search

This is done by creating a database containing each section of the markdown documentation, then registering
the search tool as a retriever with the Pydantic AI agent.
the search tool as a retriever with the PydanticAI agent.

Logic for extracting sections from markdown files and a JSON file with that data is available in
[this gist](https://gist.github.com/samuelcolvin/4b5bb9bb163b1122ff17e29e48c10992).
Expand All @@ -34,7 +34,7 @@ With that running and [dependencies installed and environment variables set](./i
python/uv-run -m pydantic_ai_examples.rag build
```

(Note building the database doesn't use Pydantic AI right now, instead it uses the OpenAI SDK directly.)
(Note building the database doesn't use PydanticAI right now, instead it uses the OpenAI SDK directly.)

You can then ask the agent a question with:

Expand Down
2 changes: 1 addition & 1 deletion docs/examples/sql-gen.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# SQL Generation

Example demonstrating how to use Pydantic AI to generate SQL queries based on user input.
Example demonstrating how to use PydanticAI to generate SQL queries based on user input.

Demonstrates:

Expand Down
2 changes: 1 addition & 1 deletion docs/examples/weather-agent.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Example of Pydantic AI with multiple tools which the LLM needs to call in turn to answer a question.
Example of PydanticAI with multiple tools which the LLM needs to call in turn to answer a question.

Demonstrates:

Expand Down
4 changes: 2 additions & 2 deletions pydantic_ai_examples/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Pydantic AI Examples
# PydanticAI Examples

Examples of how to use Pydantic AI and what it can do.
Examples of how to use PydanticAI and what it can do.

Full documentation of these examples and how to run them is available at [ai.pydantic.dev/examples/](https://ai.pydantic.dev/examples/).
2 changes: 1 addition & 1 deletion pydantic_ai_examples/pydantic_model.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
"""Simple example of using Pydantic AI to construct a Pydantic model from a text input.
"""Simple example of using PydanticAI to construct a Pydantic model from a text input.

Run with:

Expand Down
2 changes: 1 addition & 1 deletion pydantic_ai_examples/pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ build-backend = "hatchling.build"
[project]
name = "pydantic-ai-examples"
version = "0.0.6"
description = "Agent Framework / shim to use Pydantic with LLMs"
description = "Examples of how to use PydanticAI and what it can do."
authors = [
{ name = "Samuel Colvin", email = "samuel@pydantic.dev" },
]
Expand Down
2 changes: 1 addition & 1 deletion pydantic_ai_examples/roulette_wheel.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
"""Example demonstrating how to use Pydantic AI to create a simple roulette game.
"""Example demonstrating how to use PydanticAI to create a simple roulette game.

Run with:
uv run -m pydantic_ai_examples.roulette_wheel
Expand Down
2 changes: 1 addition & 1 deletion pydantic_ai_examples/sql_gen.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
"""Example demonstrating how to use Pydantic AI to generate SQL queries based on user input.
"""Example demonstrating how to use PydanticAI to generate SQL queries based on user input.

Run postgres with:

Expand Down
2 changes: 1 addition & 1 deletion pydantic_ai_examples/weather_agent.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
"""Example of Pydantic AI with multiple tools which the LLM needs to call in turn to answer a question.
"""Example of PydanticAI with multiple tools which the LLM needs to call in turn to answer a question.

In this case the idea is a "weather" agent — the user can ask for the weather in multiple cities,
the agent will use the `get_lat_lng` tool to get the latitude and longitude of the locations, then use
Expand Down
2 changes: 1 addition & 1 deletion pydantic_ai_slim/pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ build-backend = "hatchling.build"
[project]
name = "pydantic-ai-slim"
version = "0.0.6"
description = "Agent Framework / shim to use Pydantic with LLMs"
description = "Agent Framework / shim to use Pydantic with LLMs, slim package"
authors = [
{ name = "Samuel Colvin", email = "samuel@pydantic.dev" },
]
Expand Down
Loading