Indexace korpusu dokumentů
Na této stránce
Cíle
- Vytvořit kompletní index pro sémantické vyhledávání
- Zpracovávat různé formáty dokumentů (text, PDF, Markdown)
- Aktualizovat index přírůstkově
Architektura sémantického indexu
Sémantický index stojí na třech pilířích, které musí zůstat v synchronizaci: původní dokumenty uložené i s metadaty, vektory (embeddings) vypočítané z jejich textu a mapování, které spojuje každý vektor se zdrojovým dokumentem. Právě ta třetí část je nejchatrnější – téměř vždy dochází k poškození indexu tehdy, když se na jedné straně něco smaže a posunou se indexy, zatímco na druhé straně zůstanou stejné.
Třída Document níže automaticky generuje MD5 hash při svém vytvoření. Později ho využijeme k detekci toho, co už bylo indexováno.
from dataclasses import dataclass, field
from openai import OpenAI
import numpy as np
import json
import hashlib
@dataclass
class Document:
id: str
texte: str
metadata: dict = field(default_factory=dict)
hash: str = ""
def __post_init__(self):
self.hash = hashlib.md5(self.texte.encode()).hexdigest()
Pipeline indexace
Krok 1: Načtení dokumentů
Načítání závisí na formátu a formát určuje granularitu. Obyčejný textový soubor se stane jedním dokumentem; soubor Markdown však často obsahuje několik odlišných témat a jeho indexace jako jednoho bloku by každé téma utopila v průměru těch ostatních. Druhý načítač proto rozděluje obsah podle nadpisů druhé úrovně a znovu vkládá název sekce do indexovaného textu – jde o techniku obohacení, kterou jsme probírali v lekci 3.
from pathlib import Path
def charger_fichiers_texte(dossier: str) -> list[Document]:
"""Načte všechny textové soubory ze složky."""
documents = []
for fichier in Path(dossier).rglob("*.txt"):
contenu = fichier.read_text(encoding="utf-8").strip()
if contenu:
documents.append(Document(
id=fichier.stem,
texte=contenu,
metadata={
"fichier": str(fichier),
"type": "txt",
"taille": len(contenu)
}
))
return documents
def charger_fichiers_markdown(dossier: str) -> list[Document]:
"""Načte soubory Markdown a rozdělí je podle sekcí."""
documents = []
for fichier in Path(dossier).rglob("*.md"):
contenu = fichier.read_text(encoding="utf-8")
sections = contenu.split("\n## ")
for i, section in enumerate(sections):
if not section.strip():
continue
titre = section.split("\n")[0].strip("# ")
corps = "\n".join(section.split("\n")[1:]).strip()
if corps:
documents.append(Document(
id=f"{fichier.stem}_section_{i}",
texte=f"{titre}\n\n{corps}",
metadata={
"fichier": str(fichier),
"section": titre,
"type": "markdown"
}
))
return documents
Krok 2: Vytvoření indexu
Třída IndexSemantique sjednocuje dávkovou konstrukci, vyhledávání na základě prahu a perzistenci na disk. Parametr seuil (prah) v metodě rechercher si zaslouží pozornost: bez něj by i dotaz mimo téma vrátil pět „nejméně špatných“ dokumentů se skóre kolem 0,15, které by nezkušený volající považoval za platné odpovědi. Odfiltrování všeho pod určitou hranicí ti umožní upřímně odpovědět: „Nic jsem nenašel.“
class IndexSemantique:
def __init__(self, model: str = "text-embedding-3-large"):
self.client = OpenAI()
self.model = model
self.documents: list[Document] = []
self.embeddings: np.ndarray | None = None
def construire(self, documents: list[Document], batch_size: int = 100):
"""Vytvoří index ze seznamu dokumentů."""
self.documents = documents
textes = [d.texte for d in documents]
tous_embeddings = []
for i in range(0, len(textes), batch_size):
batch = textes[i:i + batch_size]
response = self.client.embeddings.create(
input=batch,
model=self.model
)
batch_sorted = sorted(response.data, key=lambda x: x.index)
tous_embeddings.extend([e.embedding for e in batch_sorted])
print(f" Batch {i // batch_size + 1} processed "
f"({min(i + batch_size, len(textes))}/{len(textes)})")
self.embeddings = np.array(tous_embeddings, dtype=np.float32)
print(f"Index built: {len(self.documents)} documents, "
f"{self.embeddings.shape[1]} dimensions")
def rechercher(self, requete: str, k: int = 5,
seuil: float = 0.0) -> list[dict]:
"""Vyhledá k nejrelevantnějších dokumentů."""
query_emb = self.client.embeddings.create(
input=requete,
model=self.model
).data[0].embedding
scores = self.embeddings @ np.array(query_emb)
top_indices = np.argsort(scores)[-k:][::-1]
resultats = []
for idx in top_indices:
score = float(scores[idx])
if score >= seuil:
doc = self.documents[idx]
resultats.append({
"id": doc.id,
"texte": doc.texte[:200],
"score": score,
"metadata": doc.metadata
})
return resultats
def sauvegarder(self, chemin: str):
"""Uloží index na disk."""
np.save(f"{chemin}_embeddings.npy", self.embeddings)
docs_serialisables = [
{"id": d.id, "texte": d.texte,
"metadata": d.metadata, "hash": d.hash}
for d in self.documents
]
with open(f"{chemin}_documents.json", "w") as f:
json.dump(docs_serialisables, f, ensure_ascii=False)
def charger(self, chemin: str):
"""Načte index z disku."""
self.embeddings = np.load(f"{chemin}_embeddings.npy")
with open(f"{chemin}_documents.json") as f:
docs = json.load(f)
self.documents = [
Document(id=d["id"], texte=d["texte"],
metadata=d["metadata"])
for d in docs
]
Metody sauvegarder a charger zapisují dva soubory se stejnou prefixovou částí názvu. Zacházej s nimi jako s nerozlučnou dvojicí: zkopírování jednoho bez druhého nebo obnovení částečné zálohy vytvoří index, kde vektory již neodpovídají dokumentům – jde o tichou chybu, která se projeví až jako absurdní výsledky.
Přírůstkové aktualizace
Korpus se vyvíjí: tři dokumenty upravené v pondělí, deset přidaných ve středu. Přepočítávání patnácti tisíc vektorů při každé změně plýtvá časem i penězi. Zde přichází na řadu MD5 hash: identifikuje obsah, nikoliv soubor, takže přejmenovaný, ale nezměněný dokument nebude znovu indexován, zatímco upravený dokument vyprodukuje odlišný hash.
def mettre_a_jour(self, nouveaux_docs: list[Document]):
"""Přidá dokumenty do existujícího indexu."""
# Odfiltruje již indexované dokumenty
hashes_existants = {d.hash for d in self.documents}
docs_a_ajouter = [
d for d in nouveaux_docs if d.hash not in hashes_existants
]
if not docs_a_ajouter:
print("No new documents to index")
return
textes = [d.texte for d in docs_a_ajouter]
response = self.client.embeddings.create(
input=textes,
model=self.model
)
nouveaux_vecteurs = np.array(
[e.embedding for e in sorted(response.data, key=lambda x: x.index)],
dtype=np.float32
)
self.documents.extend(docs_a_ajouter)
self.embeddings = np.vstack([self.embeddings, nouveaux_vecteurs])
print(f"{len(docs_a_ajouter)} documents added. "
f"Total: {len(self.documents)}")
Funkce np.vstack naskládá nové vektory pod staré ve stejném pořadí, v jakém extend rozšířil seznam dokumentů: tato symetrie zachovává mapování. Všimni si však omezení této implementace – pouze přidává, nemaže ani nenahrazuje. Upravený dokument se tak v indexu objeví dvakrát, ve staré i nové verzi. Řešení mazání vyžaduje odstranění odpovídajícího řádku z matice, což je v NumPy nákladná operace, a to je jeden z důvodů, proč týmy přecházejí na specializované vektorové databáze.
Kompletní použití
Od začátku do konce zabere vytvoření indexu nad dokumentací jen několik řádků.
# Vytvoření a naplnění indexu
index = IndexSemantique()
docs = charger_fichiers_markdown("./documentation/")
print(f"{len(docs)} sections loaded")
index.construire(docs)
index.sauvegarder("mon_index")
# Vyhledávání
resultats = index.rechercher("how to configure authentication", k=3)
for r in resultats:
print(f"[{r['score']:.3f}] {r['id']}")
print(f" {r['texte'][:100]}...")
Spusť to na vlastní dokumentaci a polož tři otázky, u kterých znáš odpovědi. Pokud se správný dokument neumístí na první místo, viníkem je téměř vždy chunking – sekce jsou příliš dlouhé nebo chybí znovu vložené nadpisy – spíše než samotný model pro vytváření vektorů.
Klíčové poznatky
- Sémantický index propojuje dokumenty, vektory a metadata
- Načítej dokumenty z různých formátů (text, Markdown atd.)
- Vytvářej index po dávkách, abys zvládl velké korpusy
- Ukládej a aktualizuj přírůstkově, abys předešel přepočítávání všeho