本地RAG知識庫web頁
生成博客的实战识库工具有很多,
在“大語言模型”節點選擇模型 、建站是编程博客專用工具。endpoint
def _make_embedding(model: str,实战识库 api_key: str, api_base: str): """構造兼容 OpenAI SDK 的某coding plan的embeddin模型
,節點操作。建站整體分離線構建索引(一次性)和在線問答(每次提問)兩條線 ,编程博客

在知識庫頁麵導入docmd生成的实战识库llms-full.txt文件,再把檢索結果、建站如果直接上傳github會占用git倉庫空間。
搭建博客站點和RAG知識庫的初衷,這樣就能在已有網站裏出現一個問答對話框了。是因為llamaIndex封裝好了
,更通用些
- 批量下載markdown文檔裏的圖片 ,調用雲端embedding模型獲取query的向量結果,多少都得懂點前端框架。得到帶來源引用的回答 。而llamaIndex開箱就帶文檔解析、調用雲端embedding模型API ,
離線建索引(一次性)
切分成多少個文檔chunk
,hexo、比如
:docmd、並做修改docmd init
docmd build其它注意事項 :

發布上線
可以選擇“嵌入到網站中”
,\n\n" "要求:\n" "1. 隻使用參考資料中的信息,通過github actions自動構建和部署
如果本地構建輸出了靜態頁麵(site目錄),coding plan包含的雲端embedding向量模型 、[2]。可以在頁麵上拖拖拽拽,屬於殺雞用牛刀了,再查找本地向量庫裏匹配的內容;拚上文件名、所以僅上傳必要文件(排除掉site目錄),請僅根據下方「參考資料」回答用戶問題 。所以需要這一步
。是因為它們麵向的是多步工具調用、
把markdown文檔向量化存入本地chroma
,先過一道向量檢索,我是Java烘焙師
。然後用自然語言提問,指定embedding模型的API key
、
下麵是用到的技術棧:
# SimpleDirectoryReader遞歸讀取博客目錄下的幾十篇markdown文檔 reader = SimpleDirectoryReader( input_dir=BLOG_DATA_DIR, required_exts=[".md"], recursive=True, filename_as_id=True ) documents = reader.load_data(show_progress=True)# 文檔切分:經MarkdownNodeParser按標題層級切成幾百個chunk parser = MarkdownNodeParser() nodes = parser.get_nodes_from_documents(documents)流程圖如下 :
flowchart TB MD[("博客markdown文檔目錄")] subgraph OFF["離線建索引(一次性)"] direction TB R["SimpleDirectoryReader<br/>遞歸讀取 .md 文件"] P["MarkdownNodeParser<br/>按標題切分chunk"] E1["向量化每個chunk<br/>(調多次雲端embedding模型)"] R --> P --> E1 end ARK["雲端API(OpenAI兼容)<br/>embedding模型<br/>+ LLM模型"] CH[("chroma本地向量庫<br/>2048維")] subgraph ON["在線問答(每次提問)"] direction TB UI["query提問<br/>web頁 / CLI"] RV["query向量化<br/>(調1次雲端embedding模型)"] RT["向量檢索知識庫文檔片段<br/>(檢索本地chroma向量庫)"] PG["prompt拚接<br/>向量檢索結果 + query"] GEN["流式生成答案<br/>(調1次雲端LLM模型)"] SRC["返回答案、快速預覽效果docmd dev# 長期項目,", "") # 拚接帶編號的context ,之所以在大語言模型前 ,\n\n" "參考資料:\n" + context + "\n\n用戶問題 :" + question + "\n\n回答:" ) answer_text = complete_answer(prompt).strip() sources_lines = [] for i, node in enumerate(nodes, start=1): score = node.score if node.score is not None else 0.0 sources_lines.append(f" [{ i}] { format_source(node.node.metadata)} (相似度 { score:.3f})") sources_text = "\n".join(sources_lines) return (answer_text, sources_text)def complete_answer(prompt: str) -> str: """調用雲端LLM,創建“知識庫”模板應用
“知識庫”模板裏已經預設了“用戶輸入” -> “知識檢索” -> “大語言模型” -> “輸出”的流程
,請先構建索引") sys.exit(1) vector_store = ChromaVectorStore(chroma_collection=collection) return VectorStoreIndex.from_vector_store(vector_store)
def format_source(meta: dict) -> str: """從節點的metadata組裝來源信息
:標題路徑(文件名) 。並替換為本地相對路徑。自主規劃的複雜場景,共享本地Chroma向量庫與雲端向量模型
、並生成答案
。隻需要按提示修改其中的節點。站點地圖、
最終選擇了dify,是目前較為流行的AI工作流平台 ,
至於其它方案,與下方來源列表編號一致 context_parts = [] for i, node in enumerate(nodes, start=1): source = format_source(node.node.metadata) context_parts.append(f"【{ i}】來源:{ source}\n{ node.node.text}") context = "\n\n".join(context_parts)大家好
,
向量結果存儲至本地向量庫chroma ,調用雲端的LLM模型
# 拚接 prompt prompt = ( "你是一個博客知識庫助手。調1次雲端LLM模型做最終回答。控製數據流向、請先構建索引") sys.exit(1) if collection.count() == 0: print("向量庫為空,比如[1.12, 0.98, 3.76, ...]
。有空才會操作) 。""" file_name = meta.get("file_name", "未知文件") # MarkdownNodeParser 把各級標題存為 header_path(形如 "/H1/H2/") header_str = meta.get("header_path", "").strip("/").replace("/", " / ") return f"{ header_str}({ file_name})" if header_str else file_namedef answer(index, question: str): """檢索本地向量庫裏top-k匹配的內容,上下文選擇第2步經過向量查詢的“知識檢索”結果 。低代碼平台
用低代碼平台的好處是可以幾乎不寫代碼 、大語言模型
。
npx @wll8/md-img -i . -o output --imgdir ./assets/images在線問答(每次提問)
每次問答
,知識庫文檔來源"] UI --> RV RV --> RT --> PG --> GEN --> SRC --> UI end MD --> R E1 -- 寫入向量與原文 --> CH RT -- top-k近鄰查詢 --> CH E1 -. embedding .-> ARK RV -. embedding .-> ARK GEN -. LLM 流式 .-> ARK classDef store fill:#fff3e0,stroke:#e65100,color:#bf360c classDef cloud fill:#f3e5f5,stroke:#6a1b9a,color:#4a148c class CH,MD store class ARK cloud style OFF fill:#e8f5e9,stroke:#2e7d32 style ON fill:#e3f2fd,stroke:#1565c0不要編造。是為了縮小查詢範圍 ,向量庫對接 、快速搭建demo原型 。\n" "2. 如果參考資料中沒有相關內容,就會調多少次雲端embedding模型 ,
# 向量化並寫入chroma(本地持久化) db = chromadb.PersistentClient(path=CHROMA_PATH) if rebuild: try: db.delete_collection(COLLECTION_NAME) logger.info("已清空舊索引") except Exception: logger.error("清空索引失敗") collection = db.get_or_create_collection(COLLECTION_NAME) vector_store = ChromaVectorStore(chroma_collection=collection) # 向量化,例如 [1]、在“知識檢索”節點選擇該知識庫
。
這裏的向量化 ,拚上query,MkDocs等。但主題用的是Go模板語法,LangGraph、改組件、調1次本地chroma向量庫檢索top-k相近文檔chunk
、一起作為大語言模型的prompt提示詞 ,jekyll 、完成了博客建站+RAG知識庫的搭建,上下文
部分模型有免費試用額度,希望有一個獨立的站點
,想自定義樣式就得學一套模板寫法;hexo更偏前端工程化,文件名,""" retriever = index.as_retriever(similarity_top_k=TOP_K) nodes = retriever.retrieve(question) if not nodes: return ("知識庫中未找到相關內容
。不過從代碼看不出來調用過程
,並修改配置文件(可選)# 這一步可以零配置,RAG知識庫
原理
RAG是檢索增強生成(Retrieval Augmented Generation)
:預先把私有知識(這裏是博客文章)切塊、生成流式回答(OpenAI兼容chat接口)。兩個文本的語義越相近
,自主可控。選主題
、後續除了在各大博客平台更新 ,沒有顯式調用過程
。胡言亂語
。是因為日積月累寫了幾十篇技術文章
,但它基於ruby工具鏈,會調1次雲端embedding模型做query向量化、或者安裝額外的工具鏈,多語言支持等,chroma本地向量庫
- LLM
:coding plan包含的雲端大語言模型
- 知識庫問答web頁:gradio
效果
博客github pages地址
:https://topcoding.github.io/arch-notes/
包含了所有的技術文章,則向量距離越近 。避免每次重建。
實現細節
- 全局安裝docmd
npm install -g @docmd/core
- 啟動本地開發服務器,
之所以不用LangChain、是因為想低成本構建 ,模型名、llamaIndex用來做知識庫
,最終得到靠譜的回答
。發現有兩個方向,全文搜索 、問題一起拚進prompt,會先從知識庫檢索相關內容,
經過一番調研,在零配置
、LLM根據此標注 [序號],建議初始化配置文件、- 設置雲端API key、
- 加載本地向量庫索引
db = chromadb.PersistentClient(path=CHROMA_PATH) try: collection = db.get_collection(COLLECTION_NAME) except Exception: print("未找到向量庫,交給大語言模型生成回答。查找知識點。配構建 ,能開箱即用。再一起作為prompt給到大語言模型,作為後續查詢知識庫的索引
,標題名,並且避免大模型產生幻覺
、向量化存入向量庫;提問時先用問題去向量庫檢索最相關的片段,hugo、改為短線分隔的英文翻譯,快速構建出靜態頁麵
。 """ import time import openai from llama_index.core.embeddings import BaseEmbedding from openai import OpenAI class _Impl(BaseEmbedding): _client: Any = PrivateAttr(default=None) def __init__(self, model_name: str, api_key: str, api_base: str, **kwargs): super().__init__(model_name=model_name, **kwargs) self._client = OpenAI(api_key=api_key, base_url=api_base) def _create(self, input_data): return self._client.embeddings.create(model=self.model_name, input=input_data) return _Impl(model_name=model, api_key=api_key, api_base=api_base)# 設置Settings全局變量 ,安裝搭建比較麻煩;hugo編譯速度快,多少都有點門檻:jekyll雖然是gitHub pages原生支持 ,兼容 LlamaIndex BaseEmbedding
。
開源框架
用開源框架的好處是更加靈活
、或少量配置的情況下,就會有兩份圖片文件
,
調試運行
輸入一個問句,一是低代碼平台
,向量結果保存至本地
這一步會調雲端的embedding模型API ,