SuperAPI AI 工具集

iii-sdk-reference

编程与开发

查看项目

更新于 10-15 22:17

技能介绍

用途:查询 iii SDK 在 Node.js、浏览器、Python、Rust 中的语言级细节,包括包名、导出、初始化选项、浏览器安全约束、通道 API 与语法。通用 Function/Trigger/Worker 模型见 iii-core-primitives,异常处理见 iii-error-handling,部署与 RBAC 见 iii-engine-config。

安装:Node/TypeScript 用 npm install iii-sdk;浏览器用 npm install iii-browser-sdk;Python 用 pip install iii-sdk;Rust 用 cargo add iii-sdk。Logger/OpenTelemetry、HTTP、stream、queue 等类型在 helpers 包(Node 为 @iii-dev/helpers,Python 为 iii-helpers,Rust 为 iii_helpers),需与 SDK 一同安装。

主要能力:连接 worker(registerWorker/register_worker)、注册本地函数(registerFunction/register_function)、注册触发器(registerTrigger)、调用函数(trigger,Python 异步用 trigger_async)、持久化入队(TriggerAction.Enqueue)、创建通道(createChannel)。Node 支持自定义 WebSocket 头、Logger、OpenTelemetry、HTTP 调用函数;Rust 支持类型化 handler 与 schemars 模式提取,用 OpenTelemetry 需启用 otel feature。

使用方式:Node 示例 registerWorker("ws://localhost:49134", { workerName, invocationTimeoutMs }),再 registerFunction("users::lookup", handler)。浏览器通过 rbac-proxy worker 的公开端口连接,不可暴露引擎端口,不能发送自定义 WebSocket 头,也不得持有后端密钥。Python handler 可同步或异步,异步内用 await iii.trigger_async(request)。通道用于二进制、大负载或流式传输,通过 payload 传 readerRef/writerRef。

命名空间:worker 归属单一命名空间,优先级为 options.namespace → III_NAMESPACE 环境变量 → 引擎默认。路由严格,函数仅在其注册的命名空间可达;同项目 worker 调用无需命名空间;引擎自有函数(engine::、configuration::、stream::*)注册在 default,跨命名空间调用需显式传 namespace: "default"。函数 id 不得加命名空间前缀。CLI 用 iii trigger -n dev 选择命名空间。

限制:浏览器 worker 必须经 rbac-proxy,且不得保存后端密钥;registerTrigger 绑定在 worker 命名空间,trigger_namespace 应留空。资料未提供收费、价格与效果信息。