Quickstart
快速开始
四种方式启动服务端:Docker 一条命令、裸机 pip、Kubernetes Helm,或直接用托管版跳过部署。启动后用 Python、Node.js、Go 或 CLI 客户端连上即可。
启动服务端
API :8888,UI :9999,数据卷 hindsight-data
docker run(推荐)
export OPENAI_API_KEY=sk-xxx
docker run -it --pull always --name hindsight --restart unless-stopped \
-p 8888:8888 -p 9999:9999 \
-e HINDSIGHT_API_LLM_API_KEY=$OPENAI_API_KEY \
-v hindsight-data:/home/hindsight/.pg0 \
ghcr.io/vectorize-io/hindsight:latest适合已有 PG 实例或需要统一运维数据库的团队
docker compose
export OPENAI_API_KEY=sk-xxx
export HINDSIGHT_DB_PASSWORD=choose-a-password
cd docker/docker-compose
docker compose upWindows 与离线环境同样支持
pip install hindsight-api
pip install hindsight-api
export HINDSIGHT_API_LLM_API_KEY=sk-xxx
hindsight-apiHelm chart 直接托管 PostgreSQL
helm install
helm install hindsight oci://ghcr.io/vectorize-io/charts/hindsight \
--set api.llm.provider=openai \
--set api.llm.apiKey=sk-xxx \
--set postgresql.enabled=true25+ 家 LLM 提供商
通过 HINDSIGHT_API_LLM_PROVIDER 选择模型来源。支持云端托管、完全本地、任意 OpenAI 兼容端点,以及可触达其余厂商的网关。
- 云端托管:
openai、anthropic、gemini、groq、bedrock、vertexai、minimax、deepseek、atlas、meta - 完全本地:
ollamalmstudiollamacpp等 - 网关:
litellmlitellmrouter等 - 已有订阅直接复用(无需 API Key):
openai-codexclaude-codecursorgithub-copilot,分别对应 ChatGPT Plus/Pro、Claude Pro/Max、Cursor 与 GitHub Copilot。
完整列表见官方文档的支持的模型。
托管版(无需服务端)
Hindsight Cloud 是托管方案:基础设施自动扩缩,附带仪表盘、备份、团队协作以及 99.9% 可用性 SLA。按用量计费,起步赠送免费额度,无固定月费或席位费。把任意客户端指向https://api.hindsight.vectorize.io 并带上你的 API Key,即可完全跳过部署环节。
指向托管端点
export HINDSIGHT_API_LLM_API_KEY=sk-xxx
# Cloud 版无需服务端:把客户端指向托管端点
export HINDSIGHT_API_URL=https://api.hindsight.vectorize.io连接客户端
安装客户端
# Python
pip install hindsight-client -U
# Node.js / TypeScript
npm install @vectorize-io/hindsight-client
# Go
go get github.com/vectorize-io/hindsight/hindsight-clients/go
# CLI
curl -fsSL https://hindsight.vectorize.io/get-cli | bashPython
hindsight_client
from hindsight_client import Hindsight
client = Hindsight(base_url="http://localhost:8888")
# Retain:存储信息
client.retain(bank_id="my-bank", content="Alice works at Google as a software engineer")
# Recall:检索记忆
client.recall(bank_id="my-bank", query="What does Alice do?")
# Reflect:生成带倾向性的回答
client.reflect(bank_id="my-bank", query="Tell me about Alice")Node.js / TypeScript
@vectorize-io/hindsight-client
const { HindsightClient } = require('@vectorize-io/hindsight-client');
const main = async () => {
const client = new HindsightClient({ baseUrl: 'http://localhost:8888' });
await client.retain('my-bank', 'Alice loves hiking in Yosemite');
const results = await client.recall('my-bank', 'What does Alice like?');
console.log(results);
};
main();支持的平台
| 平台 | Docker | 裸机(pip) | 嵌入式数据库(pg0) |
|---|---|---|---|
| Linuxx86_64 / ARM64 | 支持 | 支持 | 支持 |
| macOSApple Silicon / arm64 | 支持 | 支持 | 支持 |
| macOSIntel / x86_64 | 支持 | 需 slim 版 | 支持 |
| Windowsx86_64 | 支持 | 支持 | 支持 |
Python 嵌入式(无需服务端)
不想单独起进程时,可以直接在进程内启动一个完整服务端(自带 pg0 嵌入式数据库),适合脚本、Notebook 与本地工具。
安装
pip install hindsight-all -U进程内服务端
import os
from hindsight import HindsightServer, HindsightClient
with HindsightServer(
llm_provider="openai",
llm_model="gpt-5-mini",
llm_api_key=os.environ["OPENAI_API_KEY"]
) as server:
client = HindsightClient(base_url=server.url)
client.retain(bank_id="my-bank", content="Alice works at Google")
results = client.recall(bank_id="my-bank", query="Where does Alice work?")Node.js 等效方案与守护进程 CLI同样可用。
编程智能体用户
正在使用编程智能体的话,可以安装 Hindsight 文档技能,编码时即时查阅文档。适用于 Claude Code、Cursor 及其他 AI 编程助手。
安装文档技能
npx skills add https://github.com/vectorize-io/hindsight --skill hindsight-docs