Documentation / 入口

文档，从一条能跑通的路径开始。

先跑起来，再接 SDK，最后按部署指南把它放稳。所有入口指向 GitHub 主仓的 main 分支；文档与代码同版本演进。

快速上手

30 分钟从启动走到写入、检索、过滤、删除与重启恢复；包含 Docker、macOS 预编译包与源码构建三种启动方式。

Start here

Docker Compose、systemd 与 Helm；端口、WAL 目录、备份与手动主备的边界。生产部署必须显式设置 --wal-path，默认临时目录不能承载生产数据。

Operate

启动参数、pgwire 与 HTTP API、OpenAI 兼容网关、指标与可观测性；含 HNSW 调优旋钮与回退开关。运行时 OpenAPI 位于 /v1/openapi.json。

Reference

内核不做 embedding 推理；通过 OpenAI 兼容的 /v1/embeddings 网关连接 OpenAI、Ollama、TEI、vLLM 等上游，并可用 collection 字段自动入库。

Integrate

Python、TypeScript、Go、Rust、.NET、Java 六语言客户端；Python 另带 LangChain 与 LlamaIndex 适配器。六种语言共享同一套 stable_id 规则。

Build

源码已就绪：stdio MCP server，支持 collection 列表、向量检索、混合检索与可选写入。npm 包发布前请从源码运行，发布后再补 npx 命令。

Open

2026-10 单机实测：1×/2×、过滤连续向量缓存、streaming plan/apply；附口径、复现命令与测量协议。只包含 HouyiDB 自身数据。

Measure