HMS多语言SDK与CLI工具详解:Python、TypeScript、Go、Rust客户端及hms命令行完全指南
发布时间:2026/10/28 1:39:38 锦皓数字建站

【免费下载链接】HMS项目地址https://gitcode.com/gh_mirrors/hms11/HMS点击查看免费下载HMSHolographic Memory System是面向 AI 应用的开源长期记忆系统。为了让开发者在任何技术栈中都能方便地存取记忆HMS 官方提供了覆盖 Python、TypeScript、Go、Rust 的四种语言SDK以及功能强大的hms 命令行工具CLI。本文带你快速上手5 分钟搞清各语言客户端的安装与调用方式掌握 retain记忆写入、recall记忆召回、reflect记忆推理三大核心操作并学会用 hms CLI 完成日常运维。一、为什么需要 HMS 多语言 SDKHMS 的核心工作流只有三步操作说明典型场景retain把对话、文档等原始内容写入记忆库保存用户偏好、项目信息recall按查询语义召回相关记忆为下一次 LLM 调用注入上下文reflect基于记忆库的身份与记忆生成回答让 Agent 以第一人称推理作答所有 SDK 都基于同一份 OpenAPI 规范自动生成因此四端能力对齐、版本同步。无论你用 Python 写后端、TypeScript 写前端、Go 写服务还是 Rust 做高性能组件都能用一致的 API 风格接入 HMS。二、四种语言 SDK 速览语言包名定位源码位置Pythonhms-clientpip后端服务、Agent 框架集成首选interface/sdk/python/TypeScripthms-memory/hms-clientnpmWeb/Node 应用前端与后端interface/sdk/typescript/GohmsOpenAPI 生成Go 微服务、网关集成interface/sdk/go/Rusthms-clientcrates高性能异步服务CLI 底层依赖interface/sdk/rust/ 四个 SDK 的 API 方法几乎一一对应retain/recall/reflect/createBank…学会一种迁移到另一种只需要几十分钟。三、Python 客户端hms-client3.1 安装 Python 客户端pip install hms-clientPython 客户端由两层组成自动生成的底层 APIhms_client_api 人工维护的高层封装类HMS见 hms_client.py。每个便捷方法都有异步版本a前缀如aretain在 FastAPI、LangGraph 等异步框架中推荐优先使用异步方法。3.2 三步完成记忆读写from hms_client import HMS client HMS(base_urlhttp://localhost:8888, api_keyyour-api-key) # 1. 写入记忆 client.retain(bank_idalice, contentAlice 是一名热爱 Rust 的软件工程师) # 2. 语义召回 response client.recall(bank_idalice, queryAlice 喜欢什么编程语言) # 3. 基于记忆生成回答 answer client.reflect(bank_idalice, query我现在的兴趣是什么)进阶功能文档管理、实体浏览、Webhook、文件上传、异步任务跟踪可通过低层属性访问例如client.documents.list_documents(alice)、client.operations.get_operation_status(...)覆盖完整 API 面。四、TypeScript 客户端hms-memory/hms-client4.1 安装 TypeScript 客户端npm install hms-memory/hms-client4.2 核心调用示例import { HMSClient } from hms-memory/hms-client; const client new HMSClient({ baseUrl: http://localhost:8888, apiKey: your-api-key }); // 写入单条记忆 await client.retain(alice, Alice loves hiking, { context: Settings conversation, metadata: { source: chat }, }); // 批量写入 await client.retainBatch(alice, [{ content: Alice visited Paris last summer }], { async: true }); // 语义召回budget 控制召回深度low / mid / high const results await client.recall(alice, What are Alices hobbies?, { budget: mid }); // 生成上下文回答 const answer await client.reflect(alice, What should I do this weekend?); console.log(answer.text);TypeScript 客户端还内置了createBank创建/更新记忆库、银行模板manifest导入导出等能力完整类型定义位于 typescript/src/index.ts。五、Go 客户端OpenAPI 自动生成Go 客户端由 OpenAPI Generator 根据 openapi.yaml 生成适合在 Go 服务中做网关或微服务集成。import hms github.com/hms-memory/hms/interface/sdk/go // 通过 BanksAPI / MemoryAPI 等客户端调用各端点 client : hms.NewAPIClient(cfg) banks, _, err : client.BanksAPI.ListBanks(ctx).Execute()主要 API 分组见 go/README.mdBanksAPI记忆库创建、配置、统计、consolidation 触发MemoryAPIRetainMemories/RecallMemories/Reflect/ 图数据DocumentsAPI / EntitiesAPI文档与实体管理OperationsAPI异步任务查询、取消服务端 URL 支持 context 注入切换hms.ContextServerIndex方便多环境部署。六、Rust 客户端hms-clientRust 客户端在构建期通过 progenitor 从 OpenAPI 规范自动生成天然与 API schema 保持同步见 rust/README.md# Cargo.toml 中添加依赖 # hms-client 0.1.0use hms_client::Client; let client Client::new(http://localhost:8888); // 语义检索 let results client.search_memories(alice, search_request).await?; // 批量写入记忆 client.batch_put_memories(alice, memory_request).await?;特点全异步tokio reqwest、完全类型安全、错误统一由progenitor_client::Error处理。CLI 工具hms正是构建在这个 Rust 客户端之上依赖声明见 cli/Cargo.toml。七、hms 命令行工具完全指南hms CLI 是官方提供的终端运维工具Rust 编写当前版本 0.6.1支持彩色 Pretty 输出也支持-o json/-o yaml供脚本消费。命令定义位于 cli/src/main.rs各子命令实现位于 cli/src/commands/。7.1 首次配置configure 与 profile# 交互式配置 API 地址与密钥 hms configure --api-url http://localhost:8888 --api-key your-api-key # 管理多套命名配置适合切换 dev / prod 环境 hms profile create prod --api-url https://hms.example.com --api-key xxx hms profile list hms -p prod bank list配置优先级由高到低环境变量HMS_API_URL、HMS_API_KEY命名 profile-p参数或HMS_PROFILE环境变量配置文件~/.hms/config默认值http://localhost:88887.2 记忆库Bank管理hms bank list # 列出所有记忆库 hms bank create alice -n Alice 的助理 -m 记住她的项目与偏好 hms bank stats alice # 查看记忆统计 hms bank disposition alice # 查看性格/画像 hms bank consolidate alice --wait # 触发记忆整合并等待完成 hms bank export-template alice -o alice.json # 导出模板配置心智模型指令7.3 记忆核心操作retain / recall / reflect# 写入单条记忆 hms memory retain alice Alice 是一名热爱 Rust 的软件工程师 # 从文件/目录批量导入支持递归 hms memory retain-files alice ./notes/ -r --context 工作笔记 # 语义召回-b 控制思考预算--tags 按标签过滤 hms memory recall alice Alice 喜欢什么编程语言 -b mid # 基于记忆库身份生成回答--schema 支持 JSON Schema 结构化输出 hms memory reflect alice 我现在的兴趣是什么 --include-facts # 浏览与清理 hms memory list alice -t world -q rust hms memory history alice memory_id7.4 文档、实体与异步任务hms document list alice # 查看库内文档 hms entity list alice # 浏览实体 hms operation list alice # 查看异步任务 hms operation cancel alice op_id # 取消待处理任务 hms operation retry alice op_id # 重试失败任务7.5 运维与交互式探索hms health # API 健康检查 hms metrics # Prometheus 指标 hms version # API 版本与特性开关 hms audit list # 审计日志 hms webhook list alice # Webhook 管理 hms explore # 启动 k9s 风格的交互式 TUI别名 hms tui hms ui # 启动 Web 控制台hms explore内置基于 ratatui 的 TUI 界面可在终端里直接浏览银行、记忆、实体并执行 recall / reflect是排查记忆数据的利器实现见 cli/src/commands/explore.rs。7.6 构建与冒烟测试# 构建发布版多平台二进制见 build.sh bash interface/cli/build.sh # 对着运行中的 API 服务做冒烟测试 bash interface/cli/smoke-test.sh八、常见问题SDK 与 CLI 怎么选场景推荐方式Python 后端 / Agent 框架集成pip install hms-clientNode / Web 前后端npm install hms-memory/hms-clientGo 微服务、API 网关Go 客户端高性能 Rust 服务hms-clientcrate日常调试、数据巡检、CI 脚本hmsCLI-o json可直接被脚本消费不想写代码快速验证记忆内容hms exploreTUI九、延伸阅读端到端记忆流程说明docs/hms_end_to_end_flow.md系统架构与多模态指南docs/system_architecture_and_multimodal.md多模态记忆操作指南docs/multimodal_memory.md自动记忆演示脚本一行命令体验 retain recall 闭环scripts/run_memory_demo.sh 小结HMS 的四种语言 SDK 均以 OpenAPI 规范为单一事实来源自动生成API 一致、行为对齐hms CLI 则把银行管理、记忆读写、异步任务、审计、TUI 探索聚合到一个二进制里。按技术栈选择 SDK、用 CLI 做运维即可覆盖 HMS 的完整使用场景。赞分享【免费下载链接】HMS项目地址https://gitcode.com/gh_mirrors/hms11/HMS点击查看免费下载相关推荐PaddleOCR 官方 API SDK 全解析Python / TypeScript / Go 多语言客户端与 paddleocr api CLI 使用指南PaddleOCR 官方 API SDK 全解析Python / TypeScript / Go 多语言客户端与 paddleocr api CLI 使用指南人工智能计算机视觉深度学习PaddleOCR 官方 API SDK 全面指南Python / TypeScript / Go 三语言客户端与 CLI 实战PaddleOCR 官方 API SDK 全面指南Python / TypeScript / Go 三语言客户端与 CLI 实战 本指南围绕 PaddleOC人工智能计算机视觉深度学习多模态Argo Workflows 客户端库Client Libraries完全指南Go / Java / Python / TypeScript 多语言 SDK 集成实战Argo Workflows 客户端库Client Libraries完全指南Go / Java / Python / TypeScript 多语言 SD云原生工作流自动化流程编排任务调度后端上一篇Firebase JavaScript SDK Cloud Firestore API 完全指南从实例初始化到聚合查询与离线持久化下一篇WhoDB 前端动效设计指南用有意义的 motion 解释状态、关系与层级创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考
锦
锦皓数字建站
深耕本土企业品牌数字化升级,专注原创端正雅致商务官网,从视觉设计到稳定运维全程保驾护航。