Docs / SDK

SDK 接入说明

说明 TypeScript 与 Python SDK 的交付形态、初始化方式和验收边界。
返回文档中心获取项目 SDK

交付方式

  • SDK 当前按项目交付，支持私有 npm registry、Python wheel 包或离线压缩包。
  • 每个客户环境会绑定可用 API 版本、模型路由、租户标识和权限策略。
  • 交付包包含 SDK、类型定义、最小样例、版本说明和升级注意事项。

TypeScript SDK

  • 适用于 Web 管理台、Node.js 服务和业务系统中台集成。
  • 核心模块包括 client、tasks、modelRoutes、audit、webhooks 和 errors。
  • 建议在服务端完成令牌管理，不在浏览器端暴露长期 access key。

Python SDK

  • 适用于数据处理、离线评估、仿真任务、批量调用和运维脚本。
  • 支持任务创建、模型路由调用、审计查询和结果导出。
  • 生产脚本需启用超时、重试、审计 traceId 和异常分类处理。

验收要求

  • 能在客户测试环境完成鉴权、模型调用、审计查询和异常处理。
  • 能通过版本兼容矩阵确认 SDK、API、部署包和客户业务系统版本关系。
  • 能提供最小可运行样例、错误复现步骤和升级回滚说明。

Read Path

把 SDK 说明从“可看”推进到“可执行、可验收”。

  1. 确认交付方式和客户环境版本
  2. 完成服务端初始化与令牌管理
  3. 运行最小样例并写入 traceId
  4. 覆盖鉴权、权限、额度、超时和回滚

TypeScript 样板

TypeScript
import { JunhaoAgentClient } from "@customer-registry/junhao-agent-sdk";

const client = new JunhaoAgentClient({
  baseUrl: process.env.JUNHAO_API_BASE_URL,
  token: process.env.JUNHAO_API_TOKEN,
  tenantId: "customer-private-tenant"
});

const result = await client.modelRoutes.invoke("security-review", {
  traceId: "poc-20260615-001",
  input: { question: "提取审批风险点" },
  policyTags: ["audit-required"]
});

Python 样板

Python
from junhao_agent_sdk import JunhaoAgentClient

client = JunhaoAgentClient(
    base_url=JUNHAO_API_BASE_URL,
    token=JUNHAO_API_TOKEN,
    tenant_id="customer-private-tenant",
)

result = client.model_routes.invoke(
    "security-review",
    trace_id="poc-20260615-001",
    input={"question": "提取审批风险点"},
    policy_tags=["audit-required"],
)