Indeksoidaan asiakirjakokoelma
Tällä sivulla
Tavoitteet
- Rakenna täydellinen semanttinen hakuhakemisto
- Käsittele erilaisia asiakirjamuotoja (teksti, PDF, Markdown)
- Päivitä hakemistoa inkrementaalisesti
Semanttisen hakemiston arkkitehtuuri
Semanttinen hakemisto nojaa kolmeen elementtiin, joiden on pysyttävä synkronoituina: alkuperäiset asiakirjat metatietoineen, niistä lasketut upotukset (embeddings) sekä kuvaus, joka yhdistää jokaisen vektorin lähdeasiakirjaansa. Tämä kolmas osa on haurain – juuri tässä hakemistot useimmiten vioittuvat, kun poisto siirtää indeksejä toisella puolella muttei toisella.
Alla oleva Document-luokka lisää MD5-tiivisteen, joka lasketaan automaattisesti luonnin yhteydessä. Käytämme sitä myöhemmin havaitsemaan, mitä on jo indeksoitu.
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()
Indeksointiputki
Vaihe 1: Asiakirjojen lataaminen
Lataaminen riippuu muodosta, ja muoto määrittää granulaarisuuden. Tavallinen tekstiedosto muodostaa yhden asiakirjan; Markdown-tiedosto sen sijaan sisältää usein useita erillisiä aiheita, ja sen indeksointi yhtenä lohkona hukuttaisi jokaisen aiheen muiden keskiarvoon. Toinen lataustoiminto jakaa tekstin tason 2 otsikoiden perusteella ja lisää osion otsikon indeksoitavaan tekstiin – tämä on oppitunnilla 3 käsitelty rikastustekniikka.
from pathlib import Path
def charger_fichiers_texte(dossier: str) -> list[Document]:
"""Lataa kaikki tekstitiedostot kansiosta."""
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]:
"""Lataa Markdown-tiedostot jaettuna osioihin."""
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
Vaihe 2: Hakemiston rakentaminen
IndexSemantique-luokka yhdistää erämuotoisen rakentamisen, kynnysarvoon perustuvan haun ja pysyvyyden levyllä. rechercher-metodin seuil-parametri (kynnys) ansaitsee huomiota: ilman sitä aiheeseen kuulumaton kysely palauttaa silti viisi vähiten huonoa asiakirjaa, joiden pisteet ovat noin 0,15:n luokkaa – naiivi kutsuja pitää näitä virheellisesti kelvollisina vastauksina. Kaiken kynnysarvon alapuolella olevan suodattaminen pois antaa sinun rehellisesti vastata: “En löytänyt mitään.”
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):
"""Rakenna hakemisto asiakirjalistasta."""
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]:
"""Etsi k merkityksellisintä asiakirjaa."""
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):
"""Tallenna hakemisto levylle."""
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):
"""Lataa hakemisto levyltä."""
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
]
Metodit sauvegarder ja charger kirjoittavat kaksi tiedostoa, joilla on sama etuliite. Kohtele niitä erottamattomana parina: toisen kopioiminen ilman toista tai osittaisen varmuuskopion palauttaminen tuottaa hakemiston, jossa vektorit eivät enää täsmää asiakirjoihin – tämä on hiljainen virhe, joka ilmenee vasta absurdeina tuloksina.
Inkrementaaliset päivitykset
Kokoelma elää: kolme asiakirjaa muuttui maanantaina, kymmenen lisättiin keskiviikkona. Viidentoistatuhannen vektorin uudelleenlaskeminen jokaisen muutoksen yhteydessä tuhlaa aikaa ja rahaa. Tässä MD5-tiiviste astuu kuvaan: se tunnistaa sisällön, ei tiedostoa, joten uudelleennimetty mutta muuttumaton asiakirja ei indeksoidu uudelleen, kun taas muokattu asiakirja tuottaa erilaisen tiivisteen.
def mettre_a_jour(self, nouveaux_docs: list[Document]):
"""Lisää asiakirjoja olemassa olevaan hakemistoon."""
# Suodata pois jo indeksoidut asiakirjat
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)}")
np.vstack pinoo uudet vektorit vanhojen alapuolelle samassa järjestyksessä kuin extend asiakirjalistalle: tämä symmetria säilyttää kuvauksen. Huomaa kuitenkin tämän toteutuksen rajoitus: se lisää, mutta ei poista tai korvaa. Muokattu asiakirja päätyy siis esiin kahdesti, sekä vanhassa että uudessa versiossaan. Poistojen käsittely vaatii vastaavan rivin poistamista matriisista, mikä on kallista NumPyssa – tämä on yksi syy, miksi tiimit siirtyvät käyttämään varsinaista vektoritietokantaa.
End-to-end-käyttö
Kokonaisuudessaan hakemiston rakentaminen dokumentaatiolle vie vain muutaman rivin.
# Luo ja täytä hakemisto
index = IndexSemantique()
docs = charger_fichiers_markdown("./documentation/")
print(f"{len(docs)} sections loaded")
index.construire(docs)
index.sauvegarder("mon_index")
# Haku
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]}...")
Suorita se omalla dokumentaatiollasi ja esitä kolme kysymystä, joiden vastaukset tiedät. Jos oikea asiakirja ei nouse ensimmäiseksi, syyllinen on lähes aina paloitelussa (chunking) – osiot ovat liian pitkiä tai otsikoita ei ole lisätty takaisin – eikä upotusmallissa.
Keskeiset asiat
- Semanttinen hakemisto yhdistää asiakirjat, upotukset ja metatiedot
- Lataa asiakirjoja eri muodoista (teksti, Markdown jne.)
- Rakenna hakemisto erissä suurten kokoelmien käsittelyä varten
- Tallenna ja päivitä inkrementaalisesti välttääksesi kaiken uudelleenlaskemisen