Quickstart

curl https://api.tokenpath.ai/v1/attributions \
  -H "Content-Type: application/json" \
  -d '{
    "document": "The Oregon Duck is the mascot of the University of Oregon. It is based on Disney'\''s Donald Duck. The mascot wears a green and yellow costume and a green beanie cap. The costume was redesigned in 2002.",
    "question": "What colors does the Oregon Duck wear?",
    "answer": "The Oregon Duck wears green and yellow."
  }'

import httpx

document = (
    "The Oregon Duck is the mascot of the University of Oregon. "
    "It is based on Disney's Donald Duck. "
    "The mascot wears a green and yellow costume and a green beanie cap. "
    "The costume was redesigned in 2002."
)
question = "What colors does the Oregon Duck wear?"
answer = "The Oregon Duck wears green and yellow."

response = httpx.post(
    "https://api.tokenpath.ai/v1/attributions",
    json={
        "document": document,
        "question": question,
        "answer": answer,
        # Python slices strings by code point, so ask for code-point offsets.
        "offset_encoding": "utf-32",
    },
    timeout=90.0,
)
response.raise_for_status()
result = response.json()

const doc =
  "The Oregon Duck is the mascot of the University of Oregon. " +
  "It is based on Disney's Donald Duck. " +
  "The mascot wears a green and yellow costume and a green beanie cap. " +
  "The costume was redesigned in 2002.";
const question = "What colors does the Oregon Duck wear?";
const answer = "The Oregon Duck wears green and yellow.";

const response = await fetch("https://api.tokenpath.ai/v1/attributions", {
  method: "POST",
  credentials: "omit",
  headers: {
    "Content-Type": "application/json",
  },
  // The default offset_encoding, utf-16, matches JavaScript string indexing.
  body: JSON.stringify({ document: doc, question, answer }),
});
if (!response.ok) throw new Error(`TokenPath ${response.status}`);
const result = await response.json();

for item in result["spans"]:
    claim, source = item["answer"], item["source"]
    if source is None:
        print(f"{claim['text']!r}: no supporting text found")
        continue

    # Offsets slice the exact strings you sent.
    assert document[source["start"]:source["end"]] == source["text"]
    print(f"{claim['text']!r} -> {source['text']!r} ({source['confidence']:.2f})")

for (const { answer: claim, source } of result.spans) {
  if (source === null) {
    console.log(`${claim.text}: no supporting text found`);
    continue;
  }

  // Offsets slice the exact strings you sent.
  console.assert(doc.slice(source.start, source.end) === source.text);
  console.log(`${claim.text} -> ${source.text} (${source.confidence.toFixed(2)})`);
}