A letter's reading
get_readingThe reading of a page in the person's FamilyLore account: the transcription in its own script with the words FamilyLore was unsure of marked, the translation, notes on what it meant, how sure the reading is, and the page's link. Use it with the page id read_letter answered, to show the reading once it is done or to see whether it is still being read.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page_id | Yes | The page's id, from read_letter or FamilyLore |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| step | No | While reading: transcribing the handwriting, translating it, or checking the notes once it is translated | |
| sure | No | ||
| notes | No | What it meant: FamilyLore's notes, every one | |
| title | No | ||
| status | Yes | not_started, reading (about a minute and a half), read, failed or cancelled | |
| page_id | Yes | The page's id on FamilyLore | |
| read_on | No | The date FamilyLore read it | |
| language | No | The letter's language | |
| page_url | Yes | The page on familylore.ai | |
| elapsed_s | No | While transcribing: seconds since the reading started | |
| confidence | No | How sure the reading is, 0 to 1 | |
| expected_s | No | While transcribing: how long readings in this language usually take, in seconds | |
| sure_steps | No | How sure, in steps of 5 | |
| translation | No | ||
| unsure_words | No | How many words the reading was unsure of | |
| language_code | No | Its code, for a card to name it in the host's language | |
| right_to_left | No | ||
| transcription | No | As written, in the letter's own script | |
| unsure_word_indexes | No | The words the reading was unsure of, as positions in the transcription's words split on white space | |
| translation_language | No | ||
| translation_language_code | No |