Skip to content

Instantly share code, notes, and snippets.

@MarshalW
Last active September 20, 2024 03:03
Show Gist options
  • Save MarshalW/97ff16b5ec77b22b66dd3d3aafc357be to your computer and use it in GitHub Desktop.
Save MarshalW/97ff16b5ec77b22b66dd3d3aafc357be to your computer and use it in GitHub Desktop.
使用 Cloud-KBS 检索使用 Obsidian 知识库

Cloud-KBS 基于 Obsidian 知识库的检索工具

Obsidian 笔记在本地,mardown 格式。

Cloud-KBS 提供了一种快速的检索笔记知识的交互方法,即:

  • 通过对话形式快速找到知识,而不必通过目录、标签、关键字检索的传统方式
  • 对话尾部提供了检索的笔记片段和链接,方便导航到笔记做详细查看和修改
  • 笔记的任何改动,都将立即在下次对话中生效

使用效果:

Kapture 2024-09-19 at 15 53 32

安装要求

首先,需要安装 Obsidian,并且创建你的笔记集合 vault

vault 将保存在本地,记录保存路径,比如 /Users/marshal/Desktop/my-vault

Cloud-KBS 依赖 Docker compose,需要安装 Docker 和 compose 插件。

Cloud-KBS 使用云端大语言模型处理检索和实现对话,因此不需要本地的算力设备。

目前的版本,使用的是 智谱AI,需要创建账号,目前新用户免费赠送专享 2500万 tokens体验包。

为什么选用智谱AI:

  • 智谱AI有免费的对话模型 GLM-4-Flash, 其他模型平台大多给的是限期使用的 token,比如豆包等
  • 智谱AI提供的检索模型,技术上方便集成,其他模型,比如豆包,目前不好集成
  • 智谱AI提供的检索模型很便宜,¥0.0005/1000 token,使用1天都不到1分钱

安装步骤

创建 ./docker-compose.yaml 文件:

networks:
  cloud-kbs:
    name: cloud-kbs

services:
  cloud-kbs:
    image: marshalw/cloud-kbs
    container_name: cloud-kbs
    init: true
    restart: always
    networks:
      - cloud-kbs
    volumes:
      - ${OBSIDIAN_VAULT_ROOT}:/data
      - ./index:/index
      - /etc/localtime:/etc/localtime:ro
    ports:
      - 9800:8501
    environment:
      - LLM_BASE_URL=https://open.bigmodel.cn/api/paas/v4/
      - LLM_MODEL_NAME=GLM-4-Flash
      - EMBEDDING_MODEL_NAME=embedding-3
    env_file:
      - .env

创建 ./.env,这里的值需要根据自己情况配置:

OBSIDIAN_VAULT_ROOT="/Users/marshal/Desktop"
VAULT_NAME=my-vault

ZHIPUAI_API_KEY=xxxx

运行 Cloud-KBS:

docker compose up -d

访问: http://localhost:9800

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment