文档 / 开始

快速开始

开发者预览

三步：获取令牌、检索一次、问答一次。标「已有」的接口当前可用；标「规划中」的将随开放核心一并提供。

1
获取令牌
令牌位于数据目录的 token 文件，首次启动时自动生成，仅当前用户可读。
终端
cat <数据目录>/token
# 所有 /api/v1 接口均须携带;默认只监听 127.0.0.1:8090
2
检索
用自然语言检索资料。结果包含文件、位置与片段，不依赖文件名。
终端
curl http://127.0.0.1:8090/api/v1/search \
  -H "Authorization: Bearer $TOKEN" \
  -d '{"query": "供应商合同里的付款条件", "top_k": 5}'
3
问答
流式返回。启用 search 时，仅依据你的资料作答并附出处。
终端
curl -N http://127.0.0.1:8090/api/v1/chat/stream \
  -H "Authorization: Bearer $TOKEN" \
  -d '{"messages": [{"role": "user", "content": "上周的会定了哪些事?"}],
       "search": true}'

接口与状态

接口做什么状态
MCP · ownward-mcp
让支持 MCP 的智能体直接用检索、问答和资料库；有副作用的工具不对外开放。
已有
POST /api/v1/search
统一检索文档、图片、音频与视频。
已有
POST /api/v1/search-image
以图搜图。
已有
POST /api/v1/search/video-clips
定位视频中的具体片段。
已有
POST /api/v1/chat/stream
问答，SSE 流式返回，带出处。
已有
POST /api/v1/generate
出图与出片。超出本机可完成的时长会被即时拒绝，并返回可支持的上限。
已有
GET /hub/index.json
场景目录；按 sha256 校验后落盘。
已有
SDK · Python / JS / C++
将上述接口封装为各语言的客户端库。
规划中
OpenAI 兼容接口
现有工具修改端点地址即可接入。
规划中
MCP 连接器
通过 MCP 接入第三方工具与数据源。
规划中

模型

每类任务均有默认选型，可在设置中替换。云端模型为可选项，默认关闭。

检索
文本与多模态
文本嵌入 · 精排 · 稀疏 · 文档页视觉
图像
图像理解
图文语义 · 人脸 · 文字识别 · 描述
音频
音频理解
转写 · 词级对齐 · 说话人 · 事件
视频
视频解析
镜头分割 · 检测追踪
对话
问答与规划
本地对话模型
生成
出图出片
出图 · 出片 · 语音合成
文档
版面理解
版面结构 · 逐元素理解
可换
不锁定
在设置中按类切换
加入开发者预览
获取预览版文档与样例；SDK 与连接器发布时，第一批收到通知。
仅在有进展时发送。