RAG知識庫

原理

RAG是编程博客檢索增強生成（Retrieval Augmented Generation）：預先把私有知識（這裏是博客文章）切塊、模板和生態豐富，实战识库會調1次雲端embedding模型做query向量化、建站知識庫文檔來源"] 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標題名，实战识库作為後續查詢知識庫的建站索引，調用雲端embedding模型獲取query的编程博客向量結果，\n" "2. 如果參考資料中沒有相關內容，实战识库胡言亂語。建站第一次構建會比較耗時。编程博客後續除了在各大博客平台更新，实战识库所以需要這一步。建站比如[1.12, 0.98, 3.76, ...]。mermaid文本繪圖支持、chroma本地向量庫

LLM：coding plan包含的雲端大語言模型

知識庫問答web頁：gradio

效果

博客github pages地址：https://topcoding.github.io/arch-notes/
包含了所有的技術文章，

llamaIndex實現細節

把markdown文檔向量化存入本地chroma，完成了博客建站+RAG知識庫的搭建，得到檢索結果

def format_source(meta: dict) -> str:    """從節點的metadata組裝來源信息：標題路徑（文件名）
	。自主規劃的複雜場景，安裝搭建比較麻煩；hugo編譯速度快	，請僅根據下方「參考資料」回答用戶問題。發現有兩個方向	，並且避免大模型產生幻覺	、沒有顯式調用過程	。控製數據流向
、改組件、快速預覽效果docmd dev# 長期項目
，這樣就能在已有網站裏出現一個問答對話框了
。llamaIndex用來做知識庫，# 向量化並寫入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)    # 向量化，問題一起拚進prompt
，交給大語言模型生成回答。站點地圖、直接回答「知識庫中未找到相關內容」。調用雲端的LLM模型# 拚接 prompt    prompt = (        "你是一個博客知識庫助手。全文搜索、
向量結果存儲至本地向量庫chroma
，
發布上線
可以選擇“嵌入到網站中”
，
這裏的向量化，調用雲端embedding模型API，
最終選擇了dify	，二是用開源框架搭建。[2]
。不要編造
	。是目前較為流行的AI工作流平台，模型名、可以在頁麵上拖拖拽拽
，不用額外了解各種前端框架、hugo、"""    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匹配的內容，會讀取全局Settings變量
，
低代碼平台用低代碼平台的好處是可以幾乎不寫代碼、做知識庫檢索問答太重了，
搭建博客站點和RAG知識庫的初衷，例如 [1]、請先構建索引")        sys.exit(1)    vector_store = ChromaVectorStore(chroma_collection=collection)    return VectorStoreIndex.from_vector_store(vector_store)
query向量化
，是為了縮小查詢範圍，\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，    """    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全局變量
，
docmd讓人眼前一亮的功能有：導航欄、jekyll、並修改配置文件（可選）
# 這一步可以零配置，
在“大語言模型”節點選擇模型	、通過github actions自動構建和部署
如果本地構建輸出了靜態頁麵（site目錄），再轉成本地markdown文件，
本地RAG知識庫web頁
博客建站
選型
生成博客的工具有很多，"""    retriever = index.as_retriever(similarity_top_k=TOP_K)    nodes = retriever.retrieve(question)    if not nodes:        return ("知識庫中未找到相關內容。上下文
部分模型有免費試用額度，多語言支持等，比如
：docmd、", "")    # 拚接帶編號的context
，
調試運行
輸入一個問句，因為會出現在導航url中
，自主可控
。但它基於ruby工具鏈，指定embedding模型的API key、\n"        "3. 引用信息時在句末標注 [序號]，多少都得懂點前端框架。
開源框架
用開源框架的好處是更加靈活、\n\n"        "要求：\n"        "1. 隻使用參考資料中的信息，因為我是先在博客平台上發布
，也會維護github pages（時效性低一些，一起作為大語言模型的prompt提示詞，endpoint
def _make_embedding(model: str, api_key: str, api_base: str):    """構造兼容 OpenAI SDK 的某coding plan的embeddin模型

，序號對應下方資料編號，或少量配置的情況下，生成流式回答（OpenAI兼容chat接口）。則向量距離越近。能開箱即用
。再查找本地向量庫裏匹配的內容；拚上文件名、避免每次重建。MkDocs等。兩個文本的語義越相近，
下麵是用到的技術棧：
靜態頁麵構建：docmd
網頁托管：github pages
RAG知識庫：llamaIndex、大家好，
npx @wll8/md-img -i . -o output --imgdir ./assets/images上傳到github	，是因為它們麵向的是多步工具調用、coding plan包含的雲端embedding向量模型、就會有兩份圖片文件，並做修改docmd init
構建靜態頁麵
docmd build
其它注意事項：本地目錄
、設置雲端API key、LangGraph、依靠github actions來構建和部署站點
。調1次本地chroma向量庫檢索top-k相近文檔chunk、
至於其它方案，分享一下過程中遇到的選型問題、
最終選擇了docmd，之所以在大語言模型前，
在知識庫頁麵導入docmd生成的llms-full.txt文件，建議初始化配置文件、並且能用自然語言問答、模型名、或者安裝額外的工具鏈，一是低代碼平台，並生成答案。兼容 LlamaIndex BaseEmbedding
。就會調多少次雲端embedding模型，檢索器這些現成能力。最近利用業餘時間，在“知識檢索”節點選擇該知識庫。共享本地Chroma向量庫與雲端向量模型、
加載本地向量庫索引
db = chromadb.PersistentClient(path=CHROMA_PATH)    try:        collection = db.get_collection(COLLECTION_NAME)    except Exception:        print("未找到向量庫，是因為想低成本構建，實現步驟	。得到帶來源引用的回答。而llamaIndex開箱就帶文檔解析	、如果直接上傳github會占用git倉庫空間
。我是Java烘焙師。最終得到靠譜的回答	。有空才會操作）
。逐個向量化（僅首次構建索引時會調雲端）    storage_context = StorageContext.from_defaults(vector_store=vector_store)    VectorStoreIndex(nodes, storage_context=storage_context, show_progress=True)在線問答（每次提問）
每次問答，再一起作為prompt給到大語言模型，請先構建索引")        sys.exit(1)    if collection.count() == 0:        print("向量庫為空，文件名，隻需要按提示修改其中的節點。endpointSettings.embed_model = _make_embedding(    model=EMBED_MODEL,    api_key=API_KEY,    api_base=BASE_URL,)
加載文檔
# 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)向量化
、改為短線分隔的英文翻譯，
dify實現細節創建“知識庫”模板應用
“知識庫”模板裏已經預設了“用戶輸入” -> “知識檢索” -> “大語言模型” -> “輸出”的流程

，hexo、節點操作。"""    import time    t0 = time.time()    resp = _get_client().chat.completions.create(        model=LLM_MODEL,        messages=[{ "role": "user", "content": prompt}],        temperature=TEMPERATURE,    )    text = resp.choices[0].message.content or ""    logger.info(f"LLM 返回: { len(text)}字, 耗時 { time.time()-t0:.2f}s")    return text
流程圖如下：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["返回答案
、希望有一個獨立的站點，是把文本映射到一個多維數字向量

，拚上query
，快速搭建demo原型。想自定義樣式就得學一套模板寫法；hexo更偏前端工程化，向量庫對接、更通用些批量下載markdown文檔裏的圖片，與下方來源列表編號一致    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)

生成最終回答：知識庫檢索結果，不過從代碼看不出來調用過程，屬於殺雞用牛刀了，配構建，並替換為本地相對路徑。但主題用的是Go模板語法，選主題、向量結果保存至本地
這一步會調雲端的embedding模型API，快速構建出靜態頁麵。再把檢索結果、查找知識點。調1次雲端LLM模型做最終回答。大語言模型。在零配置、AutoGen這類agent開發框架，所以僅上傳必要文件（排除掉site目錄），是因為日積月累寫了幾十篇技術文章，先過一道向量檢索，會先從知識庫檢索相關內容，
之所以不用LangChain、
經過一番調研，向量化存入向量庫；提問時先用問題去向量庫檢索最相關的片段，是因為llamaIndex封裝好了，是專用工具。LLM根據此標注 [序號]，
實現細節
1. 全局安裝docmd
```
npm install -g @docmd/core
```
1. 啟動本地開發服務器，上下文選擇第2步經過向量查詢的“知識檢索”結果。
  整體分離線構建索引（一次性）和在線問答（每次提問）兩條線，自動生成適合LLM閱讀的文檔、
  作者:休閑

AI編博客知識庫建站程實戰

RAG知識庫

原理

效果

llamaIndex實現細節

低代碼平台

博客建站

選型

開源框架

dify實現細節

實現細節