示例

关于如何使用 PydanticAI 以及其功能的示例。

用法

这些示例与 pydantic-ai 一起分发，因此您可以通过克隆 pydantic-ai 仓库，或者通过使用 pip 或 uv 从 PyPI 简单安装 pydantic-ai 来运行它们。

无论哪种方式，您都需要安装额外的依赖项才能运行一些示例，您只需要安装 examples 可选依赖项组。

如果您已通过 pip/uv 安装了 pydantic-ai，您可以使用以下命令安装额外的依赖项

pipuv

pip install "pydantic-ai[examples]"

uv add "pydantic-ai[examples]"

如果您克隆了仓库，则应使用 uv sync --extra examples 来安装额外的依赖项。

这些示例需要您设置与一个或多个 LLM 的身份验证，有关如何执行此操作的详细信息，请参阅模型配置文档。

简而言之：在大多数情况下，您需要设置以下环境变量之一

OpenAIGoogle Gemini

export OPENAI_API_KEY=your-api-key

export GEMINI_API_KEY=your-api-key

要运行示例（无论您是安装了 pydantic_ai 还是克隆了仓库，这都适用），请运行

pipuv

python -m pydantic_ai_examples.<example_module_name>

uv run -m pydantic_ai_examples.<example_module_name>

例如，要运行非常简单的 pydantic_model 示例

pipuv

python -m pydantic_ai_examples.pydantic_model

uv run -m pydantic_ai_examples.pydantic_model

如果您喜欢单行命令并且您正在使用 uv，您可以零设置运行 pydantic-ai 示例

OPENAI_API_KEY='your-api-key' \
  uv run --with "pydantic-ai[examples]" \
  -m pydantic_ai_examples.pydantic_model

除了运行示例之外，您可能还想编辑示例。您可以使用以下命令将示例复制到新目录

pipuv

python -m pydantic_ai_examples --copy-to examples/

uv run -m pydantic_ai_examples --copy-to examples/