返回顶部
m

moss-docsMoss文档参考

Documentation and capabilities reference for Moss semantic search.

作者: admin | 来源: ClawHub
源自
ClawHub
版本
V 1.0.3
安全检测
已通过
878
下载量
免费
免费
1
收藏
概述
安装方式
版本历史

moss-docs

Moss 代理技能

能力概述

Moss 是面向对话式 AI 的实时语义搜索运行时。它提供亚 10 毫秒的查询速度和即时索引更新,可在浏览器、设备端或云端运行——无论您的代理部署在何处。代理可以创建索引、嵌入文档、执行语义/混合搜索以及管理文档生命周期,而无需管理基础设施。该平台负责嵌入生成、索引持久化和可选的云同步——让代理专注于检索逻辑而非基础设施。

技能

索引管理

  • - 创建索引:使用文档和嵌入模型选择构建新的语义索引
  • 加载索引:从持久化存储加载现有索引以供查询
  • 获取索引:检索特定索引的元数据(文档数量、模型等)
  • 列出索引:枚举项目下的所有索引
  • 删除索引:移除索引及其所有关联数据

文档操作

  • - 添加文档:向现有索引插入或更新文档,可附带元数据
  • 获取文档:按 ID 检索存储的文档或获取所有文档
  • 删除文档:按 ID 从索引中移除特定文档

搜索与检索

  • - 语义搜索:使用自然语言进行向量相似度匹配查询
  • 关键词搜索:使用基于 BM25 的关键词匹配进行精确词条查找
  • 混合搜索:结合语义搜索和关键词搜索,支持可配置的 alpha 权重(Python SDK)
  • 元数据过滤:按文档元数据(类别、语言、标签)约束结果
  • Top-K 结果:返回可配置数量的最佳匹配文档及其评分

嵌入模型

  • - moss-minilm:针对边缘/离线使用优化的快速轻量级模型(默认)
  • moss-mediumlm:更高精度的模型,适用于对精度要求较高的场景,性能表现合理

SDK 方法

JavaScriptPython描述
createIndex()createindex()使用文档创建索引
loadIndex()
loadindex() | 从存储加载索引 | | getIndex() | get_index() | 获取索引元数据 | | listIndexes() | list_indexes() | 列出所有索引 | | deleteIndex() | delete_index() | 删除索引 | | addDocs() | add_docs() | 添加/更新文档 | | getDocs() | get_docs() | 检索文档 | | deleteDocs() | delete_docs() | 移除文档 | | query() | query() | 语义 / 混合搜索 |

API 操作

所有 REST API 操作均通过 POST /v1/manage(基础 URL:https://service.usemoss.dev/v1)进行,并包含 action 字段:

操作目的额外必填字段
initUpload获取用于上传索引数据的预签名 URLindexName, modelId, docCount, dimension
startBuild
上传数据后触发索引构建 | jobId |
| getJobStatus | 检查异步构建作业的状态 | jobId |
| getIndex | 获取单个索引的元数据 | indexName |
| listIndexes | 枚举项目下的所有索引 | — |
| deleteIndex | 移除索引记录和资源 | indexName |
| getIndexUrl | 获取已构建索引的下载 URL | indexName |
| addDocs | 向现有索引更新文档 | indexName, docs |
| deleteDocs | 按 ID 移除文档 | indexName, docIds |
| getDocs | 检索存储的文档(不含嵌入) | indexName |

工作流程

基本语义搜索工作流程

  1. 1. 使用项目凭据初始化 MossClient
  2. 使用文档和模型选项调用 createIndex()(JS 中为 { modelId: moss-minilm };Python 中为 moss-minilm 字符串)
  3. 调用 loadIndex() 准备索引以供查询
  4. 使用搜索文本和 topK(JS)或 QueryOptions(top_k=...)(Python)调用 query()
  5. 处理返回的带评分文档

混合搜索工作流程(Python)

通过 alpha 进行的混合融合在 Python SDK 中通过 QueryOptions 提供:

  1. 1. 按上述方法创建并加载索引
  2. 使用指定了 alpha 的 QueryOptions 对象调用 query()
  3. alpha=1.0 = 纯语义,alpha=0.0 = 纯关键词,alpha=0.6 = 60/40 混合
  4. 对于对话场景,默认为语义优先

文档更新工作流程

  1. 1. 初始化客户端并确保索引存在
  2. 使用新文档调用 addDocs()(默认执行更新——现有 ID 会被更新)
  3. 调用 deleteDocs() 按 ID 移除过时文档

语音代理上下文注入工作流程

这是语音代理管道的可选集成模式——并非此技能的自动行为。

  1. 1. 在代理启动时初始化 MossClient 并加载索引
  2. 在您的应用程序代码中,对每条用户消息调用 query() 以检索相关上下文
  3. 在生成响应之前将搜索结果注入 LLM 上下文
  4. 基于知识的回答进行响应(无工具调用延迟)

离线优先搜索工作流程

  1. 1. 使用本地嵌入模型创建包含文档的索引
  2. 从本地存储加载索引
  3. 查询完全在设备端运行,延迟低于 10 毫秒
  4. 可选择同步到云端进行备份和共享

集成

语音代理框架

  • - LiveKit:使用 inferedge-moss SDK 将上下文注入语音代理管道
  • Pipecat:通过 pipecat-moss 包实现的管道处理器,可自动注入检索结果

上下文

身份验证

SDK 需要项目凭据:

  • - MOSSPROJECTID:来自 Moss Portal 的项目标识符
  • MOSSPROJECTKEY:来自 Moss Portal 的项目访问密钥

bash theme={null}
export MOSSPROJECTID=yourprojectid
export MOSSPROJECTKEY=yourprojectkey

REST API 在每个请求中都需要以下内容:

  • - x-project-key 标头:项目访问密钥
  • x-service-version: v1 标头:API 版本
  • JSON 正文中的 projectId 字段

bash theme={null}
curl -X POST https://service.usemoss.dev/v1/manage \
-H Content-Type: application/json \
-H x-service-version: v1 \
-H x-project-key: mossaccesskey_xxxxx \
-d {action: listIndexes, projectId: project_123}

包安装

语言安装命令
JavaScript/TypeScript@inferedge/mossnpm install @inferedge/moss
Python
inferedge-moss | pip install inferedge-moss | | Pipecat 集成 | pipecat-moss | pip install pipecat-moss |

文档模式

typescript theme={null}
interface DocumentInfo {
id: string; // 必需:唯一标识符
text: string; // 必需:要嵌入和搜索的内容
metadata?: object; // 可选:用于过滤的键值对
}

查询参数

参数SDK类型默认值描述
indexNameJS + Pythonstring目标索引名称(必需)
query
JS + Python | string | — | 自然语言搜索文本(必需) | | topK | JS | number | 5 | 返回的最大结果数 | | top_k | Python | int | 5 | 返回的最大结果数 | | alpha | 仅 Python | float | ~0.8 | 混合权重:0.0=关键词,1.0=语义 | | filters | JS

标签

skill ai

通过对话安装

该技能支持在以下平台通过对话安装:

OpenClaw WorkBuddy QClaw Kimi Claude

方式一:安装 SkillHub 和技能

帮我安装 SkillHub 和 moss-1776331333 技能

方式二:设置 SkillHub 为优先技能安装源

设置 SkillHub 为我的优先技能安装源,然后帮我安装 moss-1776331333 技能

通过命令行安装

skillhub install moss-1776331333

下载

⬇ 下载 moss-docs v1.0.3(免费)

文件大小: 4.4 KB | 发布时间: 2026-4-17 13:52

v1.0.3 最新 2026-4-17 13:52
- No user-facing changes in this release.
- Version bump to 1.0.3 with no file modifications.

Archiver·手机版·闲社网·闲社论坛·智能体自动化市场· 多链控股集团有限公司 · 苏ICP备2025199260号-1

Powered by Discuz! X5.0   © 2024-2026 闲社网·AI智能体论坛·AI自动化解决方案·http://xianshe.com

p2p_official_large
返回顶部