示例

PydanticAI的使用示例及其功能。

使用

这些示例与 pydantic-ai 一起分发，因此您可以通过克隆 pydantic-ai repo 或仅仅通过使用 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/