Docs: Workflow

Workflow

The server tells every assistant the same order for working through a passage, and the tools are built for it. You can follow it by hand as well. Each step gives its output to the next. The examples use Titus 1:1 in English; the two article paths are samples, and a real run takes them from the index.

Want to see it first? The guided walk on Try runs these steps for any passage.

  1. Step 1

    Read the passage

    Start with the text itself: the literal and the simplified English, and the Greek or Hebrew under them. This call is cheap, so an assistant can repeat it any time it needs to read the verse again.

    get_passage · The text of Titus 1:1

    Run in Try
    {
      "name": "get_passage",
      "arguments": {
        "reference": "Titus 1:1",
        "language": "en"
      }
    }
  2. Step 2

    Get the background

    Ask once per passage for the book and chapter introductions, and for which resources exist in this language. It does not repeat the verse.

    get_passage_context · Introductions for Titus 1

    Run in Try
    {
      "name": "get_passage_context",
      "arguments": {
        "reference": "Titus 1:1",
        "language": "en"
      }
    }
  3. Step 3

    Survey the helps

    The index lists every note and key term for the passage, with the Greek words it is about and a pointer to the full text. It carries no note or article bodies.

    get_passage_index · The helps map of Titus 1:1

    Run in Try
    {
      "name": "get_passage_index",
      "arguments": {
        "reference": "Titus 1:1",
        "language": "en"
      }
    }
  4. Step 4

    Open the helps that matter

    Pick from the index. A note comes by its id, a Translation Academy lesson or a key term by the path the index gave. Search finds an article when no note points to it.

    get_note · The notes on Titus 1:1

    Run in Try
    {
      "name": "get_note",
      "arguments": {
        "reference": "Titus 1:1",
        "language": "en"
      }
    }

    get_academy_article · A Translation Academy lesson

    Run in Try
    {
      "name": "get_academy_article",
      "arguments": {
        "path": "translate/figs-metaphor",
        "language": "en"
      }
    }

    get_word_article · A key term article

    Run in Try
    {
      "name": "get_word_article",
      "arguments": {
        "path": "bible/kt/god",
        "language": "en"
      }
    }
  5. Step 5

    Check the draft

    When a translation draft exists, the questions test that it says what the passage says. An empty list means there are none for this language yet; that is not an error.

    get_questions · Questions on Titus 1:1

    Run in Try
    {
      "name": "get_questions",
      "arguments": {
        "reference": "Titus 1:1",
        "language": "en"
      }
    }

Why the index saves tokens

Notes and articles are the long part of the answer. The index is short: it names every note and key term and says which words each one explains, but holds none of the text. The assistant reads that list, chooses what the translator needs, and fetches only those items. Fetching everything for a passage would put pages of text into the conversation that nobody asked for.

The same idea explains the other two habits in the order. The passage text is cheap, so it is fetched again whenever it is needed. The questions come last because they check a draft, and a draft does not exist before the helps have been read.

Searching instead

When no note points to the article you want, search_articles finds Translation Academy lessons and Translation Words articles by topic. It can be called at any step, and gives back paths that get_academy_article and get_word_article accept.