Документация

Извлечение предварительно разобранных значений

Ищет регулярными выражениями подходящие адреса электронной почты, телефоны и суммы, затем просит TypeSafe выбрать нужный фрагмент, чтобы код нормализовал дословное значение.

Регулярное выражение находит значения-кандидаты, TypeSafe выбирает то, которое просит вопрос, а код копирует его дословно.

Пара find и pick здесь — та, что вы можете нацелить на свои документы, и три разобранных случая показывают её в деле: адрес, на который отправитель хочет получить квитанцию, номер телефона как +14155550177 и сумма счёта как 1315.50 USD, помеченная как списание.

TypeSafe выбирает один из вариантов, которые вы ему дали, поэтому кандидатов нужно сначала найти. Регулярное выражение находит их, TypeSafe выбирает один, а код копирует выбор — в три шага:

  1. Регулярное выражение находит в тексте значения-кандидаты. Настройте его на избыточный поиск.
  2. TypeSafe выбирает, какого кандидата просит вопрос, и считывает любой атрибут, нужный коду дальше (валюта, страна, кредит это или списание).
  3. Код копирует выбранное значение и нормализует его.

Поскольку TypeSafe всегда выбирает лишь среди фрагментов, найденных регулярным выражением, полученное значение — один из этих фрагментов, скопированный без изменений. Он не может выдумать значение или переставить цифру.

Обзорная схема

Регулярное выражение находит в документе значения-кандидаты, TypeSafe выбирает одно, а код ниже по потоку нормализует его и действует на его основе.

Установка

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

затем задайте 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"))

Вспомогательные функции

find выполняет регулярное выражение, настроенное на избыточный поиск, и удаляет дубликаты совпадений. pick — вопрос Choice, варианты которого и есть фрагменты, возвращаемые find, поэтому его ответ — один из этих фрагментов, скопированный точно, или none, когда ни один кандидат не подходит. classify — вопрос Choice по фиксированному набору меток, здесь используемый для валюты и страны. is_true — это Noul, здесь используемый, чтобы спросить, является ли сумма кредитом.

Каждый вызов кэшируется в json_cache.json, поэтому повторный рендеринг не делает обращений к 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
    )

Электронная почта: выбор нужного адреса по роли

Четыре адреса в заголовках. В теле письма просят отправить квитанцию на личный адрес вместо платёжного псевдонима To:, поэтому ответ зависит от прочтения тела. Здесь два вопроса: на какой адрес уйдёт квитанция и с какого адреса пришло сообщение.

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 — это личный адрес Gmail из строки Reply-To:, именно его просит тело письма; sender — адрес из строки From. Оба — копии совпадений регулярного выражения, приведённые к нижнему регистру в коде.

Телефон: выбор мобильного номера, нормализация к E.164

Три номера, ни у одного из них нет кода страны. TypeSafe выбирает мобильный и считывает страну из текста; phonenumbers объединяет эти два ответа в E.164 — международный формат, начинающийся с + и кода страны.

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

Ничто в самих цифрах не говорит, какой номер мобильный и в какой он стране; это говорят слова вокруг них. TypeSafe читает эти слова, а phonenumbers форматирует выбранный номер как +14155550177.

Деньги: выбор суммы, классификация валюты, пометка кредита или списания

Счёт с четырьмя суммами. TypeSafe выбирает итог к оплате и кредит, считывает валюту и помечает каждую выбранную сумму как списание или кредит. Код копирует каждую выбранную строку и разбирает её в 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']

Итог к оплате — $1,315.50, а кредит — $50.00, оба в USD. Вопрос-Noul «кредит или списание» отвечает 0.01 на итог и 0.99 на кредит, поэтому код знает знак каждого разбираемого Decimal.

to_decimal предполагает, что запятая разделяет тысячи, а точка — десятичный разделитель. Это верно для $1,315.50; в €1.315,50 всё наоборот. Спросите вопросом Noul, какую конвенцию использует документ, и разветвляйтесь по ней в коде.

Открыть в playground TypeSafe

Ссылка для общего доступа, открывающая почтовую переписку в браузере, с вопросом о квитанции и четырьмя адресами, найденными регулярным выражением, среди её вариантов.

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})"
    )
)
Открыть эту переписку и выбор в playground TypeSafe →

Два ограничения

  • Вопрос Choice допускает не более 255 вариантов. Если кандидатов больше, сужайте в два этапа: сначала выберите раздел, затем фрагмент внутри него.
  • Найти кандидатов — это та часть, что требует работы. Для адресов электронной почты, номеров телефонов и сумм есть регулярные выражения, которые их покрывают; для имени такого нет, поэтому его кандидаты должны прийти из уже имеющегося у вас списка, или из распознавателя именованных сущностей, или из LLM, который их предлагает. Затем TypeSafe выбирает того, которого просит вопрос.