jevlaya
Português (Brasil)
Documentação

Extração de valores pré-analisados

Usa regexes para encontrar e-mails, telefones e valores candidatos, e depois faz o TypeSafe selecionar o trecho pedido para que o código normalize um valor literal.

Uma regex encontra os valores candidatos, o TypeSafe escolhe o que a pergunta pede, e o código o copia literalmente.

O par find e pick aqui é um que você pode apontar para os seus próprios documentos, e três casos trabalhados mostram seu uso: o endereço para o qual um remetente quer que o recibo seja enviado, um número de telefone como +14155550177 e um total de fatura como 1315.50 USD marcado como cobrança.

O TypeSafe escolhe uma das opções que você entrega, então os candidatos precisam ser encontrados primeiro. Uma regex os encontra, o TypeSafe escolhe um, e o código copia a escolha, em três passos:

  1. Uma regex encontra os valores candidatos no texto. Ajuste-a para encontrar em excesso.
  2. O TypeSafe escolhe qual candidato a pergunta está pedindo e lê qualquer atributo de que o código precise adiante (moeda, país, se um valor é um crédito ou uma cobrança).
  3. O código copia o valor escolhido e o normaliza.

Como o TypeSafe só escolhe entre os trechos que a regex encontrou, o valor que você recebe de volta é um desses trechos, copiado sem alteração. Ele não pode inventar um valor nem trocar um dígito de lugar.

Diagrama geral

A regex encontra valores candidatos no documento, o TypeSafe escolhe um, e o código adiante o normaliza e age sobre ele.

Configuração

pip install ipython phonenumbers 'cooksafe>=0.2.0,<0.3.0'

depois defina TYPESAFE_API_KEY.

import os
import re
from decimal import Decimal
from pathlib import Path

import phonenumbers
from cooksafe import JsonCache, make_playground_link
from IPython.display import Markdown, display
from typesafe_sdk import Choice, Noul, TypeSafeClient

TYPESAFE_MODEL = "jev-1.12"
NONE = "none"  # the escape hatch on every selection: "none of the candidates fits"

# base_url defaults to https://api.typesafe.ai/ ; the env override points at another deployment.
ts = TypeSafeClient(
    api_key=os.environ.get(
        "TYPESAFE_API_KEY", "cache-only"
    ),  # cached re-renders need no key
    base_url=os.environ.get("TYPESAFE_BASE_URL"),
    timeout=30.0,
)
json_cache = JsonCache(Path("json_cache.json"))

Auxiliares

find executa uma regex ajustada para encontrar em excesso e remove duplicatas das correspondências. pick é uma pergunta Choice cujas opções são os trechos que o find devolve, então sua resposta é um desses trechos copiado exatamente, ou none quando nenhum candidato serve. classify é uma pergunta Choice sobre um conjunto fixo de rótulos, usada aqui para a moeda e o país. is_true é um Noul, usado aqui para perguntar se um valor é um crédito.

Toda chamada é armazenada em cache em json_cache.json, então re-renderizar não faz nenhuma chamada à API.

EMAIL_RE = re.compile(r"[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\.[A-Za-z]{2,}")
PHONE_RE = re.compile(r"\(?\+?\d[\d\s()\-.]{6,}\d")
MONEY_RE = re.compile(r"[$€£¥]\s?\d[\d,]*(?:\.\d{2})?")

def find(pattern: re.Pattern, text: str) -> list[str]:
    """Code-side candidate finder: recall-tuned regex, deduped, in document order."""
    seen: set[str] = set()
    out: list[str] = []
    for match in pattern.findall(text):
        span = match.strip()
        if span and span not in seen:
            seen.add(span)
            out.append(span)
    return out

@json_cache
def pick(document: str, candidates: list[str], question: str) -> dict:
    """TypeSafe selects which found span plays the role. Returns {choice, confidence}.

    The options ARE the candidate spans, so ``choice`` is a verbatim copy of one of them (or the
    ``none`` hatch) - the model chooses, code owns the string."""
    criteria = {c: None for c in candidates} | {
        NONE: "None of these is the requested value."
    }
    answer = ts.system_one(
        state=document,
        questions={"pick": Choice(instructions=question, criteria=criteria)},
        model=TYPESAFE_MODEL,
    ).answers["pick"]
    return {"choice": answer.choice, "confidence": answer.confidence}

@json_cache
def classify(document: str, question: str, options: list[str]) -> dict:
    """A small Choice over a fixed label set (currency, country, ...). Returns {choice, confidence}."""
    answer = ts.system_one(
        state=document,
        questions={
            "q": Choice(instructions=question, criteria={o: None for o in options})
        },
        model=TYPESAFE_MODEL,
    ).answers["q"]
    return {"choice": answer.choice, "confidence": answer.confidence}

@json_cache
def is_true(document: str, question: str) -> float:
    """A yes/no Noul. Returns P(yes)."""
    return (
        ts.system_one(
            state=document,
            questions={"q": Noul(instructions=question)},
            model=TYPESAFE_MODEL,
        )
        .answers["q"]
        .noul
    )

E-mail: escolha o endereço certo pelo papel

Quatro endereços nos cabeçalhos. O corpo pede que o recibo vá para um endereço pessoal em vez do alias de cobrança To:, então a resposta depende de ler o corpo. Duas perguntas aqui: qual endereço recebe o recibo e qual enviou a mensagem.

EMAIL_DOC = """From: Dana Whit <dana.whit@acme-corp.com>
To: billing@acme-corp.com
Cc: orders@acme-corp.com
Reply-To: dana.personal@gmail.com

Hi team - please don't use the billing alias for this one. Send my receipt to my
personal address instead. Thanks, Dana."""

emails = find(EMAIL_RE, EMAIL_DOC)
receipt = pick(
    EMAIL_DOC, emails, "Which email address does the sender want their receipt sent to?"
)
sender = pick(
    EMAIL_DOC, emails, "Which email address did this message come from (the From line)?"
)

print("candidates :", emails)
# code copies the picked value verbatim and normalizes (lowercase); it never re-types it
print(
    f"receipt -> : {receipt['choice'].lower():<28} (conf {receipt['confidence']:.2f})"
)
print(f"sender  -> : {sender['choice'].lower():<28} (conf {sender['confidence']:.2f})")
candidates : ['dana.whit@acme-corp.com', 'billing@acme-corp.com', 'orders@acme-corp.com', 'dana.personal@gmail.com']
receipt -> : dana.personal@gmail.com      (conf 0.98)
sender  -> : dana.whit@acme-corp.com      (conf 1.00)

receipt é o endereço pessoal do Gmail na linha Reply-To:, que é o que o corpo pede; sender é o que está na linha From. Ambos são cópias de correspondências da regex, convertidas para minúsculas no código.

Telefone: escolha o celular e normalize para E.164

Três números, nenhum deles com código de país. O TypeSafe escolhe o celular e lê o país a partir do texto; phonenumbers combina essas duas respostas em E.164, o formato internacional que começa com um + e o código do país.

PHONE_DOC = """Reach our San Francisco office at these numbers: main desk (415) 555-0199,
billing fax (415) 555-0142, and my direct cell (415) 555-0177. Call the cell if it's urgent."""

phones = find(PHONE_RE, PHONE_DOC)
mobile = pick(PHONE_DOC, phones, "Which of these is the direct mobile / cell number?")
region = classify(
    PHONE_DOC,
    "In what country is this office located?",
    ["US", "GB", "DE", "FR", "CA", "AU"],
)

# code copies the picked value and normalizes it with the model-supplied country
parsed = phonenumbers.parse(mobile["choice"], region["choice"])
e164 = phonenumbers.format_number(parsed, phonenumbers.PhoneNumberFormat.E164)

print("candidates :", phones)
print(f"mobile  -> : {mobile['choice']}  (conf {mobile['confidence']:.2f})")
print(f"country -> : {region['choice']}  (conf {region['confidence']:.2f})")
print(f"E.164   -> : {e164}")
candidates : ['(415) 555-0199', '(415) 555-0142', '(415) 555-0177']
mobile  -> : (415) 555-0177  (conf 1.00)
country -> : US  (conf 0.90)
E.164   -> : +14155550177

Nada nos dígitos diz qual número é o celular ou em que país ele está; as palavras ao redor dizem. O TypeSafe lê essas palavras, e phonenumbers formata o número escolhido como +14155550177.

Dinheiro: escolha o valor, classifique a moeda e marque crédito vs cobrança

Uma fatura com quatro valores. O TypeSafe escolhe o total devido e o crédito, lê a moeda e marca cada valor escolhido como cobrança ou crédito. O código copia cada string escolhida e a analisa em um Decimal.

MONEY_DOC = """Invoice INV-2087.
Subtotal: $1,200.00
Sales tax: $115.50
Total due: $1,315.50
A $50.00 courtesy credit from last month has already been applied."""

amounts = find(MONEY_RE, MONEY_DOC)
currency = classify(
    MONEY_DOC,
    "What currency are these amounts in?",
    ["USD", "EUR", "GBP", "JPY", "CAD"],
)
total = pick(MONEY_DOC, amounts, "Which amount is the total the customer must pay?")
credit = pick(
    MONEY_DOC, amounts, "Which amount is the courtesy credit that was applied?"
)

def to_decimal(value: str) -> Decimal:
    """Copy the picked value and parse the number in code (US grouping/decimal here)."""
    return Decimal(re.sub(r"[^\d.]", "", value))

for label, chosen in [("total due", total), ("credit", credit)]:
    is_credit = is_true(
        MONEY_DOC,
        f"Is the amount {chosen['choice']} a credit or refund to the customer, not a charge?",
    )
    kind = "credit" if is_credit > 0.5 else "charge"
    print(
        f"{label:<10}: {chosen['choice']:<10} -> {to_decimal(chosen['choice'])} {currency['choice']} "
        f"({kind}, P(credit)={is_credit:.2f})"
    )
print("\ncandidates :", amounts)
total due : $1,315.50  -> 1315.50 USD (charge, P(credit)=0.01)
credit    : $50.00     -> 50.00 USD (credit, P(credit)=0.99)

candidates : ['$1,200.00', '$115.50', '$1,315.50', '$50.00']

O total devido é $1,315.50 e o crédito é $50.00, ambos em USD. O Noul de crédito ou cobrança responde 0.01 no total e 0.99 no crédito, então o código sabe o sinal de cada Decimal que analisa.

to_decimal assume que a vírgula agrupa milhares e o ponto é o separador decimal. Isso vale para $1,315.50; em €1.315,50 é o contrário. Pergunte a um Noul qual convenção o documento usa e ramifique no código de acordo com isso.

Abra no playground do TypeSafe

Um link de compartilhamento que abre a conversa de e-mail no navegador, com a pergunta do recibo e os quatro endereços que a regex encontrou entre suas opções.

receipt_criteria = {e: None for e in emails} | {
    NONE: "None of these is the requested value."
}
playground_link = make_playground_link(
    EMAIL_DOC,
    {
        "receipt": Choice(
            instructions="Which email address does the sender want their receipt sent to?",
            criteria=receipt_criteria,
        )
    },
    models=[TYPESAFE_MODEL],
)
display(
    Markdown(
        f"🔗 [Open this thread + selection in the TypeSafe playground]({playground_link})"
    )
)
Abra esta conversa + seleção no playground do TypeSafe →

Dois limites

  • Uma pergunta Choice permite no máximo 255 opções. Com mais candidatos que isso, restrinja em dois estágios: escolha a seção primeiro, depois o trecho dentro dela.
  • Encontrar os candidatos é a parte que dá trabalho. E-mails, telefones e valores têm regexes que os cobrem; um nome não tem, então seus candidatos precisam vir de uma lista que você já tenha, ou de um reconhecedor de entidades nomeadas ou de um LLM que os proponha. O TypeSafe então escolhe o que a pergunta pede.