示例
这里我们提供了一些关于如何使用 Pydantic AI 及其功能的示例。
用法
这些示例随 pydantic-ai 一同分发，因此您可以通过克隆 pydantic-ai 仓库或直接通过 pip 或 uv 从 PyPI 安装 pydantic-ai 来运行它们。
安装必需的依赖项
无论采用哪种方式，您都需要安装额外的依赖项才能运行某些示例，只需安装 examples 这个可选依赖组即可。
如果您已通过 pip/uv 安装了 pydantic-ai，可以使用以下命令安装额外依赖项：
pip install "pydantic-ai[examples]"
uv add "pydantic-ai[examples]"
如果您克隆了仓库，则应改用 uv sync --extra examples 来安装额外依赖项。
设置模型环境变量
这些示例需要您为一个或多个大语言模型（LLM）设置身份验证，有关如何操作的详细信息，请参阅模型配置文档。
简而言之：在大多数情况下，您需要设置以下环境变量之一：
export OPENAI_API_KEY=your-api-key
export GEMINI_API_KEY=your-api-key
运行示例
要运行示例（无论您是安装了 pydantic_ai 还是克隆了仓库，此方法都有效），请运行：
python -m pydantic_ai_examples.<example_module_name>
uv run -m pydantic_ai_examples.<example_module_name>
例如，要运行非常简单的 pydantic_model 示例：
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
除了仅仅运行示例，您可能还想编辑它们。您可以使用以下命令将示例复制到一个新目录：
python -m pydantic_ai_examples --copy-to examples/
uv run -m pydantic_ai_examples --copy-to examples/