API 参考¶
本栏目按 OR-Tools pdoc 的“对象入口 -> 成员 -> 示例”方式组织 OptAgent 的公开接口。每个页面都从调用者视角说明用途、参数、返回值、后端边界和最小 Python 示例。
公开 API 页面只覆盖白名单中的稳定接口，不展示实现源码、kernel binding、内部模块或私有成员。首次接入时，建议先阅读 快速入门。
公开接口地图¶
| 类别 | 公开接口 | 参考页面 |
|---|---|---|
| 统一建模 | ModelBuilder、Expr、TransitionGraph |
ModelBuilder |
| 调度建模 | SchedulingModel |
SchedulingModel |
| strategy 求解 | solve、StrategyConfig、GaConfig |
求解与策略 |
| 精确求解 | solve_optx、solve_milp、solve_cpsat |
求解与策略 |
| 求解配置 | OptxConfig、MilpConfig、CpSatConfig |
求解与策略 |
| 结果与状态 | UnifiedSolution、SolutionStatus |
UnifiedSolution |
| 兼容性 | CP-SAT、MILP 的建模支持范围 | 精确求解兼容性 |
最小调用样例¶
from optagent import ModelBuilder, solve
model = ModelBuilder()
x = model.int_var(lb=0, ub=10, name="x")
model.maximize(x, name="value")
solution = solve(model)
print(solution.status.value)
print(solution.objective_value)
如果模型是任务、资源和工序关系，先看 SchedulingModel；如果模型是线性或混合整数问题，先看 线性与混合整数优化。
阅读入口¶
- Builder API：
ModelBuilder建模入口的完整方法参考。 - Scheduling API：
SchedulingModel、Task、Resource和Alternative的调度便利层参考。 - solve() & StrategyConfig：
solve()完整关键字参数、所有策略配置参数详情。 - UnifiedSolution：解对象字段、状态枚举、metadata 常见键。
- 精确求解器接口兼容性：CP-SAT 和 MILP 分别支持的建模接口。