Files
deepseek-harness/docs/user/guide/python-sdk-minimal.zh.md
T

4.1 KiB

使用 Python SDK 运行极简 agent(智能体)

English | 中文

本教程介绍如何在不使用 Web UI 的情况下运行极简 agent。仓库内置的 Cordis 组合固定了系统提示词、工具目录、持久 shell 行为和压缩(compaction)策略,因此 SDK 运行与 Web minimal preset 使用相同的面向模型约定。

前置要求

  • Python 3.10 或更高版本
  • Linux x64、Linux arm64 或 macOS arm64
  • DeepSeek 兼容的 API 端点与凭据
  • agent 可以修改的隔离 workspace

请创建虚拟环境,并安装 SDK 及其同版本内置运行时:

python -m venv .venv
. .venv/bin/activate
python -m pip install deepseek-harness

运行时 wheel 包含 JSON-RPC 可执行文件,以及完整 minimal.cordis.yml 使用的每个插件,因此安装后的 SDK 不需要 Node.js。

运行仓库内置示例

请在环境中设置凭据。如果模型不是由默认 DeepSeek 端点提供,而是通过 OpenAI 兼容代理提供,还需要设置 DEEPSEEK_BASE_URL

export DEEPSEEK_API_KEY=sk-your-key-here
# export DEEPSEEK_BASE_URL=http://127.0.0.1:8000/v1

从仓库 checkout 运行一个任务:

python examples/jsonrpc-agent/minimal.py \
  --workspace /absolute/path/to/workspace \
  --session-root /absolute/path/to/trajectories \
  --session-id example-001 \
  "Inspect the repository and fix the failing tests."

脚本会打印 assistant 的最终回复。会话根目录会收到 JSONL 运行轨迹,其中包含组装后的模型请求与每次工具调用。

在自己的程序中使用 SDK

该示例是以下 SDK 调用的轻量包装层:

from pathlib import Path

from deepseek_harness import DeepSeekHarness

config = Path("examples/jsonrpc-agent/minimal.cordis.yml").resolve()
workspace = Path("/absolute/path/to/workspace").resolve()
sessions = Path("/absolute/path/to/trajectories").resolve()

with DeepSeekHarness(
    provider="deepseek-official",
    model="deepseek-v4-flash",
    max_tokens=49_152,
    cwd=str(workspace),
    session_root=str(sessions),
    cordis=str(config),
) as harness:
    result = harness.run(
        "Inspect the repository and fix the failing tests.",
        session_id="example-001",
    )

print(result.final_response)

DeepSeekHarness 会延迟启动内置 JSON-RPC 运行时,并持续复用,直至退出上下文管理器。在多次调用中复用同一个 harness 和 session id,还会保留该会话拥有的 Bash 进程,包括其工作目录、已导出的变量与 shell 函数。

配置复现的约定

方面 固定值
系统提示词 You are a helpful software engineer assistant.
面向模型的工具 仅持久 bashstr_replace_editor
Bash 超时 300 秒
编辑器输出上限 16,000 个字符
压缩 触发比例 0.8、保留 20,480 个 token、摘要上限 8,192 个 token、重试 1 次
会话持久化 DSH_SESSION_ROOT 下未压缩的 JSONL

该配置省略了 harness 身份、workspace 提示词文本、skill(技能)、一次性 Bash、任务工具和其他所有面向模型的插件。文件系统策略事实记录为运行时用户上下文,而不会追加到系统提示词中。编辑器无条件要求绝对路径,因此配置中没有已经废弃的 requireAbsolutePath 选项。

保持运行可复现

为了让运行轨迹可复现且便于比较,请配套固定 Harness commit 与 Python 包版本,保留确切的 Cordis 文件,并为每次运行记录提供方、模型、端点、max_tokens、任务输入、workspace 状态和 session id。独立运行应使用干净的 workspace 和新的 session id;只有有意保留多轮状态时才复用会话。

该组合使用 danger-full-access。只能在可丢弃的 checkout 或容器内运行:Bash 与编辑器可以修改运行时进程有权访问的任何路径。持久 PTY 后端需要 POSIX 终端环境,因此该模式不适用于 Windows agent。

完整的 SDK 生命周期与结果约定见 Python SDK 参考。Cordis 组合语法见配置