Reordenação

Constrói listas curtas BM25 de 30 passagens para 40 consultas legais do CLERC e depois usa uma pergunta do TypeSafe por par consulta-candidato para subir a exatidão top-1 de 5% para 18% e a exatidão top-10 de 38% para 62%.

Tens milhares de documentos e precisas de encontrar aquele que responde a uma pergunta específica. Então, como o encontras?

Primeiro, usa um método rápido como a correspondência de palavras-chave para reduzir esses milhares de candidatos a uma lista curta de candidatos plausíveis. Chamamos a isto pesquisa rápida.

A pesquisa rápida é boa nisso, mas não te consegue dizer qual dos candidatos da lista curta é o correto. É aí que entra a reordenação. Pontua cada candidato da lista curta diretamente contra a consulta e coloca o melhor em primeiro lugar.

Ambos os passos correm abaixo sobre 3 565 passagens de opiniões judiciais do conjunto de dados CLERC: o BM25 constrói uma lista curta de pesquisa rápida de 30 candidatos para cada uma das 40 consultas, e depois o TypeSafe reordena cada lista curta. Com a reordenação, a passagem correta fica em primeiro lugar em 18% das consultas, contra 5% da pesquisa rápida sozinha.

Ao longo do caminho, vais aprender:

• O que a pesquisa rápida faz, e porque não é a resposta completa
• O que é a reordenação, e como encaixa depois de um passo de pesquisa rápida
• Como o TypeSafe pontua um candidato contra uma consulta, e quanto isso melhora o resultado

Experimenta tu mesmo

Abre uma consulta, um candidato e uma pergunta de reordenação no Playground do TypeSafe

Como encontramos um documento entre milhares?

Tens uma pilha de documentos e uma consulta, um pedaço de texto que descreve o que procuras. Algures na pilha está o documento que lhe responde.

Verificar cada documento contra a consulta um a um funciona, a uma comparação por documento: milhões de documentos significam milhões de comparações por consulta. Podes melhorar o desempenho com uma abordagem em dois passos:

1. Reduz a pilha a uma lista curta de candidatos prováveis, usando um método suficientemente rápido para correr sobre a pilha inteira.
2. Aplica um passo mais preciso a essa lista curta, para encontrar a resposta exata.

Este cookbook testa essa configuração num conjunto de dados de opiniões judiciais, em Um exemplo de reordenação abaixo.

O que é a pesquisa rápida?

A pesquisa rápida é qualquer método capaz de comparar uma consulta com cada documento de um corpus grande e devolver rapidamente uma lista curta ordenada. Entre os métodos comuns estão a pesquisa por palavras-chave, como o BM25, e os embeddings densos, que comparam passagens pelo significado. Os sistemas combinam frequentemente os dois métodos.

O primeiro passo aqui é o BM25 e nada mais. O BM25 ordena as passagens por palavras partilhadas. Manter este passo simples deixa a atenção na reordenação, que é o objetivo do cookbook. A escolha do método de pesquisa rápida é uma questão secundária: a reordenação só vê as passagens que entram na lista curta.

O que é a reordenação?

A reordenação pega na lista curta que a pesquisa rápida já produziu e coloca-a numa ordem melhor. Em vez de comparar a consulta com todo o corpus de uma vez, compara a consulta com cada candidato da lista curta individualmente, e ordena a lista curta por essa pontuação.

A pontuação pode vir de um modelo de linguagem. Dá-lhe a consulta e um candidato juntos e pergunta-lhe quão bem o candidato responde à consulta. A reordenação encontra então a melhor correspondência na lista curta, mesmo quando a sua redação difere da da consulta.

Reordenação com o TypeSafe

Um reordenador precisa de uma pontuação comparável para cada par consulta-candidato. Um modelo de linguagem de propósito geral pode produzir essas pontuações, ou ordenar diretamente toda a lista curta. Para pontuar pares de forma independente, no entanto, precisas de definir uma escala de pontuação e instruir o modelo a aplicar o mesmo padrão a cada candidato. Chamadas repetidas podem ainda produzir pontuações diferentes para o mesmo par, enquanto a geração de propósito geral acrescenta tempo e custo a uma tarefa que só precisa de um número.

O que o TypeSafe devolve

Com o TypeSafe, o pedido de pontuação pode continuar a ser uma pergunta de sim/não:

Could this candidate passage be from the cited precedent?

Um simples sim ou não não chegaria para ordenar 30 candidatos. Uma Noul devolve, em vez disso, um número entre 0 e 1, chamado noul. O noul é a estimativa do TypeSafe da probabilidade de a resposta ser sim.

Os criteria da pergunta definem o que conta como verdadeiro e como falso. O TypeSafe aplica-os a cada par consulta-candidato e devolve o noul diretamente. Esse noul é a pontuação pela qual a aplicação ordena. Não é preciso inventar uma escala de pontuação para um modelo de propósito geral, e o TypeSafe foi construído para fazer esta pontuação repetida de forma mais rápida, mais barata e mais consistente.

Em pseudocódigo simplificado, uma chamada de pontuação ao TypeSafe é assim:

question = Noul(
    instructions="Is this candidate the cited case?",
    criteria=NoulCriteria(
        true="The candidate states the specific rule the query cites.",
        false="The candidate is only on a similar topic.",
    ),
)
response = client.system_one(state={...}, questions={"is_cited_source": question})
response.answers["is_cited_source"].noul  # -> 0.87

O TypeSafe lê a consulta e um candidato juntos contra essa pergunta e devolve um noul.

Podes usar isto para reordenar uma lista curta, correndo a mesma pergunta contra cada candidato dela e depois ordenando a lista curta pelo noul que cada chamada devolve, do mais alto para o mais baixo.

nouls = {candidate: ask_typesafe(query, candidate) for candidate in shortlist}
reranked = sorted(shortlist, key=lambda c: nouls[c], reverse=True)  # highest noul first

O diagrama abaixo mostra como um pedido por candidato produz as pontuações usadas para reordenar a lista curta.

flowchart LR
    q["query excerpt<br/><i>one opinion passage,<br/>citation removed</i>"]
    sl["shortlist from fast search<br/><i>30 candidate passages</i>"]
    quest["<b>one Noul</b><br/>could this candidate be<br/>from the cited precedent?<br/><i>criteria fix true and false</i>"]

    %% direction LR inside an LR chart keeps each state beside its noul, two columns,
    %% so the fan-out is four rows tall instead of eight
    subgraph fan["one request per candidate · no request sees another"]
        direction LR
        d1["state<br/>{query, candidate 1}"] --> n1["noul<br/>0.87"]
        d2["state<br/>{query, candidate 2}"] --> n2["noul<br/>0.41"]
        dx["⋮"] --> nx["⋮"]
        d30["state<br/>{query, candidate 30}"] --> n30["noul<br/>0.12"]
    end

    sort["sort by noul,<br/>highest first"]
    out["re-ranked shortlist<br/><i>same 30, better order</i>"]

    q --> fan
    sl --> fan
    quest --> fan
    fan --> sort --> out

    %% the elision is not a node - drop its box so it reads as "and so on"
    classDef elide fill:none,stroke:none
    class dx,nx elide
    linkStyle 2 stroke:none

Um exemplo de reordenação

A pesquisa rápida e a reordenação correm agora sobre o CLERC, um conjunto de dados de recuperação jurídica. Este exemplo usa 3 565 passagens de opiniões judiciais e 40 consultas.

Configuração

O primeiro passo instala os pacotes de que este percurso depende.

• bm25s e datasets constroem a lista curta de pesquisa rápida.
• typesafe-sdk e cooksafe tratam da reordenação e da cache da API.
• matplotlib desenha os gráficos de resultados.

pip install bm25s datasets matplotlib 'cooksafe>=0.2.0,<0.3.0'

O bloco seguinte configura o cliente TypeSafe e as constantes que o resto do percurso usa, como que modelo do TypeSafe chamar e quão grande é a lista curta que a pesquisa rápida entrega ao reordenador. Chamar o TypeSafe precisa de uma TYPESAFE_API_KEY.

import hashlib
import json
import os
import random
from concurrent.futures import ThreadPoolExecutor
from pathlib import Path

from cooksafe import JsonCache
from IPython.display import display
from typesafe_sdk import Noul, NoulCriteria, TypeSafeClient

TYPESAFE_MODEL = "jev-1.12"
PRICE = (
    0.042,
    0.00,
)  # $ per 1M tokens (input, output); TypeSafe jev-1.12 as of 2026-08
N_ROWS = 170  # CLERC rows pooled into the shared corpus
N_QUERIES = 40  # rows we evaluate
TOP_K = 30  # candidates the shortlist hands to the re-ranker, per query

client = TypeSafeClient(
    api_key=os.environ.get(
        "TYPESAFE_API_KEY", "cache-only"
    ),  # keyless kernels replay the cache
    base_url=os.environ.get("TYPESAFE_ENDPOINT"),
    timeout=120.0,
)
json_cache = JsonCache(Path("json_cache.json"))

Ordenar as passagens com pesquisa rápida

O conjunto de dados usado aqui é um corpus de opiniões judiciais dos EUA, 170 linhas reunidas. Cada linha decompõe-se assim:

• Query: um excerto de opinião com uma citação removida.
• Gold: a passagem para a qual a citação removida apontava, a única resposta correta à consulta.
• Candidates: todas as outras passagens do corpus, cada uma algo com que a consulta poderia ser emparelhada por engano.

Das 170 linhas, 40 são escolhidas para avaliar como consultas. As outras 130 só aparecem como candidatos.

A célula seguinte constrói a lista curta, usando a técnica descrita acima:

1. Carrega o corpus.
2. Ordena-o contra cada consulta com o BM25.

Ainda não há TypeSafe aqui, este é apenas o passo de pesquisa rápida.

CLERC_FILE = (
    "https://huggingface.co/datasets/jhu-clsp/CLERC/resolve/main/"
    "teva_train_dir/train_data.jsonl.gz"
)

def cid(text: str) -> str:
    """Corpus id: a content hash, so passages shared across queries dedupe."""
    return hashlib.sha1(text.encode("utf-8")).hexdigest()[:16]

@json_cache
def build_slice(n_rows: int, n_queries: int, seed: int) -> dict:
    """Stream CLERC rows, pool ``n_rows`` of them into a corpus, pick ``n_queries`` to evaluate."""
    from datasets import load_dataset  # heavy import, keep local

    stream = load_dataset("json", data_files=CLERC_FILE, streaming=True, split="train")
    rows = []
    for row in stream:
        if (
            row.get("positive_passages")
            and len(row.get("negative_passages") or []) == 20
        ):
            rows.append(row)
        if len(rows) >= 1000:
            break

    rng = random.Random(seed)
    picked = rng.sample(rows, n_rows)
    corpus, pool = {}, []
    for row in picked:
        gold = row["positive_passages"][0]["text"]
        corpus[cid(gold)] = gold
        for neg in row["negative_passages"]:
            corpus[cid(neg["text"])] = neg["text"]
        pool.append(
            {"qid": str(row["query_id"]), "query": row["query"], "gold": cid(gold)}
        )
    # hold out the first 20 pooled rows; evaluate on the rest
    queries = rng.sample(pool[20:], n_queries)
    # sort the corpus by id so every run — live or cache replay — iterates it identically
    return {"queries": queries, "corpus": dict(sorted(corpus.items()))}

def bm25_rankings(corpus: dict[str, str], queries: dict[str, str], k: int = 100):
    """Rank every passage in the corpus by word overlap with each query."""
    import bm25s

    cids = list(corpus)
    retriever = bm25s.BM25()
    retriever.index(bm25s.tokenize([corpus[c] for c in cids], stopwords="en"))
    qids = list(queries)
    idxs, _ = retriever.retrieve(
        bm25s.tokenize([queries[q] for q in qids], stopwords="en"), k=min(k, len(cids))
    )
    return {q: [cids[i] for i in idxs[row]] for row, q in enumerate(qids)}

def gold_rank(ranked: list[str], gold: str) -> int | None:
    """1-based rank of the gold id, or None if it isn't in the list."""
    return ranked.index(gold) + 1 if gold in ranked else None

SURFACE, INK, INK2, MUTED = "#f8f8f2", "#34342f", "#34342f", "#7c7c77"
GRID, AXIS, BLUE, GREEN = "#d8d8cf", "#d8d8cf", "#5d76a2", "#6f9b52"

def bar_chart(labels: list[str], shares: list[float], title: str) -> None:
    """A small single-series bar chart of shares (0-1, shown as percentages)."""
    import matplotlib.pyplot as plt

    fig, ax = plt.subplots(figsize=(5, 3.2), facecolor=SURFACE)
    ax.set_facecolor(SURFACE)
    for side in ("top", "right"):
        ax.spines[side].set_visible(False)
    for side in ("left", "bottom"):
        ax.spines[side].set_color(AXIS)
    ax.tick_params(colors=MUTED, labelcolor=INK2, labelsize=9)
    ax.set_axisbelow(True)
    ax.grid(axis="y", color=GRID, linewidth=0.8)

    bars = ax.bar(labels, shares, width=0.55, color=[BLUE, GREEN][: len(labels)])
    ax.bar_label(
        bars,
        labels=[f"{s * 100:.0f}%" for s in shares],
        padding=4,
        color=INK,
        fontsize=11,
    )
    ax.set_ylim(0, 1.1)
    ax.set_yticks([0, 0.25, 0.5, 0.75, 1.0])
    ax.set_yticklabels(["0%", "25%", "50%", "75%", "100%"])
    ax.set_ylabel(f"share of {len(queries)} queries", color=INK2, fontsize=9)
    ax.set_title(title, loc="left", color=INK, fontsize=11)
    plt.tight_layout()
    display(fig)
    plt.close(fig)

ds = build_slice(N_ROWS, N_QUERIES, seed=0)
corpus: dict[str, str] = ds["corpus"]
queries = {q["qid"]: q["query"] for q in ds["queries"]}
golds = {q["qid"]: q["gold"] for q in ds["queries"]}

candidates = {q: ranked[:TOP_K] for q, ranked in bm25_rankings(corpus, queries).items()}

in_top_k = sum(golds[q] in candidates[q] for q in queries)
at_rank_1 = sum(candidates[q][0] == golds[q] for q in queries)

bar_chart(
    [f"In top {TOP_K}", "At rank 1"],
    [in_top_k / len(queries), at_rank_1 / len(queries)],
    f"Where the correct passage lands, {len(queries)} queries against {len(corpus):,} candidates",
)

É pouco provável que a pesquisa rápida coloque a passagem certa em primeiro

O gráfico mostra onde a pesquisa rápida coloca a passagem correta, entre 3 565 candidatos.

A pesquisa rápida reduz de forma fiável o corpus a uma lista curta que contém a resposta certa. Contém a resposta certa em 100% das 40 consultas. Mas essa passagem raramente é a primeira da lista curta, apenas 5% das vezes.

A reordenação abaixo só reordena os 30 melhores candidatos que já estão na lista curta. Não pode acrescentar uma passagem que a pesquisa rápida não selecionou. Aqui, a lista curta contém a passagem correta para todas as 40 consultas, por isso a reordenação pode concentrar-se em colocar cada uma numa posição melhor.

Reordená-la com o TypeSafe

A reordenação pontua cada candidato da lista curta contra a sua consulta, e depois ordena por essa pontuação. A pergunta que o TypeSafe faz sobre cada par é se o candidato pode ser a passagem para a qual aponta a citação removida da consulta.

A célula seguinte faz o seguinte:

1. Define essa pergunta.
2. Faz a pergunta uma vez por candidato em cada lista curta, 40 consultas vezes 30 candidatos, 1 200 chamadas no total, executadas em simultâneo em vez de uma após outra.
3. Ordena cada lista curta pela pontuação que o TypeSafe devolve, produzindo o resultado reordenado.

is_cited_source = Noul(
    instructions=(
        "The query excerpt comes from a US federal court opinion and was written "
        "immediately around a citation to a precedent; the citation itself has been "
        "removed. Could the candidate passage be from that cited precedent — does it "
        "establish the specific legal proposition the query excerpt invokes at its "
        "citation point?"
    ),
    criteria=NoulCriteria(
        true=(
            "The candidate passage states or establishes the specific rule, standard, "
            "holding, or fact pattern that the query excerpt attributes to its removed "
            "citation."
        ),
        false=(
            "The candidate passage is merely on a similar topic or doctrine; it does not "
            "supply the specific proposition the query excerpt relies on."
        ),
    ),
)

@json_cache
def score_candidate(model: str, query: str, candidate: str, question_json: str) -> dict:
    """One TypeSafe call about one (query, candidate) pair: a noul, plus token usage."""
    # the SDK takes a question as its JSON dict, so the cached string decodes straight in
    question = json.loads(question_json)
    response = client.system_one(
        state={"query_excerpt": query, "candidate_passage": candidate},
        questions={"is_cited_source": question},
        model=model,
    )
    return {
        "noul": response.answers["is_cited_source"].noul,
        "input_tokens": response.usage.input_tokens or 0,
        "output_tokens": response.usage.output_tokens or 0,
    }

# Each of the 40 queries has 30 candidates, so re-ranking every shortlist means 1,200 independent
# calls — cheap enough to fire all at once with a thread pool instead of one after another.
pair_list = [(q, c) for q in queries for c in candidates[q]]
question_json = is_cited_source.model_dump_json(exclude_none=True)
with ThreadPoolExecutor(max_workers=12) as pool:
    results = pool.map(
        lambda p: score_candidate(
            TYPESAFE_MODEL, queries[p[0]], corpus[p[1]], question_json
        ),
        pair_list,
    )
pair_scores = {q: {} for q in queries}
for (q, c), result in zip(pair_list, results):
    pair_scores[q][c] = result

reranked = {
    q: sorted(candidates[q], key=lambda c: -pair_scores[q][c]["noul"]) for q in queries
}

def chart_before_after(
    runs: dict[str, dict[str, list[str]]], thresholds: list[int]
) -> None:
    """Grouped bar chart: how often the correct passage lands in the top N, for each run."""
    import numpy as np
    import matplotlib.pyplot as plt

    labels = list(runs)
    colors = [BLUE, GREEN]

    def share_in_top(rankings, k):
        return sum(
            gold_rank(rankings[q], golds[q]) in range(1, k + 1) for q in queries
        ) / len(queries)

    fig, ax = plt.subplots(figsize=(6.5, 3.6), facecolor=SURFACE)
    ax.set_facecolor(SURFACE)
    for side in ("top", "right"):
        ax.spines[side].set_visible(False)
    for side in ("left", "bottom"):
        ax.spines[side].set_color(AXIS)
    ax.tick_params(colors=MUTED, labelcolor=INK2, labelsize=9)
    ax.set_axisbelow(True)
    ax.grid(axis="y", color=GRID, linewidth=0.8)

    x = np.arange(len(thresholds))
    width = 0.35
    for i, (label, rankings) in enumerate(runs.items()):
        shares = [share_in_top(rankings, k) for k in thresholds]
        offset = (i - (len(labels) - 1) / 2) * width
        bars = ax.bar(x + offset, shares, width * 0.92, color=colors[i], label=label)
        ax.bar_label(
            bars,
            labels=[f"{s * 100:.0f}%" for s in shares],
            padding=3,
            color=INK2,
            fontsize=8.5,
        )

    ax.set_xticks(x, [f"top {k}" for k in thresholds])
    ax.set_ylim(0, 1)
    ax.set_yticks([0, 0.25, 0.5, 0.75, 1.0])
    ax.set_yticklabels(["0%", "25%", "50%", "75%", "100%"])
    ax.set_ylabel(f"share of {len(queries)} queries", color=INK2, fontsize=9)
    ax.set_title(
        "How often the correct passage lands near the top",
        loc="left",
        color=INK,
        fontsize=11,
    )
    ax.legend(frameon=False, labelcolor=INK2, fontsize=9, loc="upper left")
    plt.tight_layout()
    display(fig)
    plt.close(fig)

chart_before_after(
    {"Fast search": candidates, "+ TypeSafe re-rank": reranked}, [1, 5, 10]
)

calls = [pair_scores[q][c] for q in queries for c in pair_scores[q]]
input_tokens = sum(call["input_tokens"] for call in calls)
output_tokens = sum(call["output_tokens"] for call in calls)
cost = input_tokens / 1_000_000 * PRICE[0] + output_tokens / 1_000_000 * PRICE[1]
print(
    f"{len(calls)} TypeSafe calls used {input_tokens:,} input and "
    f"{output_tokens:,} output tokens, costing ${cost:.4f}."
)

1200 TypeSafe calls used 1,536,002 input and 25,200 output tokens, costing $0.0645.

A reordenação aproxima a resposta certa do topo

O gráfico compara a pesquisa rápida com a pesquisa rápida mais a reordenação, em três limiares. A reordenação aproxima a passagem correta do topo em todos eles:

• Top 1 — 5% → 18%
• Top 5 — 15% → 35%
• Top 10 — 38% → 62%

A contagem de tokens e o custo reportados cobrem todas as 1 200 chamadas ao TypeSafe usadas para reordenar as 40 listas curtas.

Cada linha do CLERC contém uma passagem correta e 20 passagens negativas. Este percurso reúne as passagens das 170 linhas num único corpus partilhado. Para cada uma das 40 consultas de avaliação, o BM25 seleciona 30 candidatos desse corpus completo, não apenas os 20 negativos fornecidos com essa linha. O TypeSafe lê então a consulta contra cada candidato selecionado e reordena essas 30 passagens.

Este percurso fez uma pergunta por par, por clareza. Uma aplicação real faria várias perguntas sobre o mesmo par numa única chamada. Vê o cookbook de perguntas em paralelo e o padrão Speculative Fan-Out para saberes como.

O que se segue

Os mesmos blocos de construção aparecem noutros pontos da documentação do TypeSafe:

• Noul, para saberes como o TypeSafe transforma uma pergunta de sim/não numa pontuação.
• Speculative Fan-Out, para fazer várias perguntas sobre um documento numa única chamada.
• Pesquisa linha a linha, para outra forma de pesquisar um corpus pelo significado em vez de por palavras-chave.