Back to Details

cuopt-server-common

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

cuOpt Server (common)

cuOpt Server (通用版)

Domain concepts for the cuOpt REST server. No deploy commands or client code here.
cuOpt REST服务器的领域概念讲解。此处不涉及部署命令或客户端代码。

What the server does

服务器功能

  • Accepts optimization requests (routing, LP, MILP) over HTTP.
  • Returns a request ID; solution is obtained by polling with that ID.
  • Does not support QP via REST.
  • 通过HTTP接收优化请求（路由、LP、MILP）。
  • 返回请求ID；需通过该ID轮询获取解决方案。
  • 不支持通过REST发送QP请求。

Problem types supported

支持的问题类型

Problem typeSupported
Routing✓
LP✓
MILP✓
QP✗
问题类型是否支持
路由✓
LP✓
MILP✓
QP✗

Request flow (conceptual)

请求流程（概念性说明）

  1. Client sends problem data in the required schema (matrices, tasks, fleet, solver config).
  2. Server returns a 
    reqId
    .
  3. Client polls the solution endpoint with 
    reqId
    until the job completes.
  4. Response contains status and, on success, solution (routes, objective, primal values, etc.).
  1. 客户端按照要求的 schema（矩阵、任务、车队、求解器配置）发送问题数据。
  2. 服务器返回
    reqId
    。
  3. 客户端使用
    reqId
    轮询解决方案端点，直到任务完成。
  4. 响应包含状态信息，成功时还会返回解决方案（路线、目标值、原始值等）。

Required questions (deployment and usage)

部署与使用需明确的问题

Ask these if not already clear:
  1. Problem type — Routing or LP/MILP? (QP not available.)
  2. Deployment — Local, Docker, Kubernetes, or cloud?
  3. Client — Which language or tool will call the API (e.g. Python, curl, another service)?
若以下问题尚未明确，请确认：
  1. 问题类型——路由问题还是LP/MILP问题？（暂不支持QP。）
  2. 部署方式——本地、Docker、Kubernetes还是云端？
  3. 客户端——将使用哪种语言或工具调用API（例如Python、curl、其他服务）？

Key endpoints (conceptual)

核心端点（概念性说明）

  • Health check.
  • Submit request (POST).
  • Get solution by request ID (GET).
  • OpenAPI spec (e.g. for payload format).
  • 健康检查。
  • 提交请求（POST）。
  • 通过请求ID获取解决方案（GET）。
  • OpenAPI规范（用于查看负载格式等）。