Ir para o conteúdo principal
Português— Escolher um idioma
Menu

Indexar um corpus documental

Aula 7 de 22 Atualizada a 29 de julho de 2026 Programador
Nesta página
  1. Objetivos
  2. Arquitetura de um índice semântico
  3. Pipeline de indexação
  4. Atualizações incrementais
  5. Utilização de ponta a ponta
  6. Pontos-chave

Objetivos

  • Construir um índice de pesquisa semântica completo
  • Gerir diferentes formatos de documentos (texto, PDF, Markdown)
  • Atualizar o índice de forma incremental

Arquitetura de um índice semântico

Um índice semântico assenta em três elementos que devem permanecer sincronizados: os documentos originais armazenados com os seus metadados, as embeddings calculadas a partir do seu texto e o mapeamento que liga cada vetor ao seu documento de origem. Esta terceira peça é a mais frágil — é quase sempre aqui que os índices se corrompem, quando uma eliminação desloca os índices de um lado mas não do outro.

A classe Document abaixo adiciona um hash MD5 calculado automaticamente na criação. Vamos utilizá-lo mais tarde para detetar o que já foi indexado.

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 de indexação

Passo 1: Carregar documentos

O carregamento depende do formato, e o formato determina a granularidade. Um ficheiro de texto simples torna-se um único documento; um ficheiro Markdown, no entanto, contém frequentemente vários tópicos distintos, e indexá-lo como um único bloco afogaria cada tópico na média dos outros. O segundo carregador divide, portanto, pelos cabeçalhos de nível 2 e reinjeta o título da secção no texto indexado — esta é a técnica de enriquecimento abordada na lição 3.

from pathlib import Path

def charger_fichiers_texte(dossier: str) -> list[Document]:
    """Carregar todos os ficheiros de texto de uma pasta."""
    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]:
    """Carregar ficheiros Markdown, dividindo por secções."""
    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

Passo 2: Construir o índice

A classe IndexSemantique reúne a construção em lote, a pesquisa baseada em limiar e a persistência em disco. O parâmetro seuil (limiar) no método rechercher merece atenção: sem ele, uma consulta fora de tema devolve ainda assim os cinco documentos “menos piores”, com pontuações à volta de 0,15 que um chamador ingénuo tratará como respostas válidas. Filtrar tudo o que esteja abaixo de uma pontuação mínima permite-lhe responder honestamente: «Não encontrei nada».

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):
        """Construir o índice a partir de uma lista de documentos."""
        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]:
        """Pesquisar os k documentos mais relevantes."""
        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):
        """Guardar o índice no disco."""
        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):
        """Carregar um índice do disco."""
        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
        ]

Os métodos sauvegarder e charger escrevem dois ficheiros que partilham o mesmo prefixo. Trate-os como um par inseparável: copiar um sem o outro, ou restaurar uma cópia de segurança parcial, produz um índice onde os vetores já não correspondem aos documentos — uma falha silenciosa que só se manifestará através de resultados absurdos.

Atualizações incrementais

Um corpus evolui: três documentos modificados na segunda-feira, dez adicionados na quarta-feira. Recalcular quinze mil vetores para cada alteração desperdiça tempo e dinheiro. É aqui que o hash MD5 entra em ação: ele identifica o conteúdo, não o ficheiro, pelo que um documento renomeado mas inalterado não será reindexado, enquanto um documento modificado produzirá um hash diferente.

def mettre_a_jour(self, nouveaux_docs: list[Document]):
    """Adicionar documentos ao índice existente."""
    # Filtrar documentos já indexados
    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)}")

O np.vstack empilha os novos vetores abaixo dos antigos, na mesma ordem do extend na lista de documentos: esta simetria preserva o mapeamento. Note, no entanto, a limitação desta implementação — ela adiciona, mas não elimina nem substitui. Um documento modificado acaba, portanto, por estar presente duas vezes, nas suas versões antiga e nova. Gerir eliminações requer remover a linha correspondente da matriz, uma operação dispendiosa no NumPy, e esta é uma das razões que levam as equipas a optar por uma base de dados vetorial adequada.

Utilização de ponta a ponta

De ponta a ponta, construir um índice sobre documentação requer apenas algumas linhas.

# Criar e povoar o índice
index = IndexSemantique()

docs = charger_fichiers_markdown("./documentation/")
print(f"{len(docs)} sections loaded")

index.construire(docs)
index.sauvegarder("mon_index")

# Pesquisar
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]}...")

Execute-o na sua própria documentação e faça três perguntas cujas respostas conhece. Se o documento correto não ocupar o primeiro lugar, o culpado é quase sempre a fragmentação (chunking) — secções demasiado longas ou títulos não reinjetados — e não o modelo de embedding.

Pontos-chave

  • Um índice semântico liga documentos, embeddings e metadados
  • Carregue documentos de diferentes formatos (texto, Markdown, etc.)
  • Construa o índice em lotes para gerir grandes corpora
  • Guarde e atualize incrementalmente para evitar recalcular tudo