hebrewForms[].letters[].glyph required | string | The Hebrew letter as it stands in the string. Data, identical in every language. |
hebrewForms[].letters[].letterId required | string | Machine identifier of the letter, always English romanization so it stays safe to compare against in code. |
hebrewForms[].letters[].name required | string | Display name of the letter, in the requested language. Branch on letterId, never on this. |
hebrewForms[].letters[].isFinal required | boolean | True when the glyph is the word final form. Under the finals-500-900 reading the same letter scores differently in final position, which is why this is on the row. |
hebrewForms[].letters[].value required | number | What this letter contributed under the standard reading, or under the finals reading when one applies. |
chosen required | object | |
chosen.hebrew required | string | The spelling the values and matches on this response were taken from. |
chosen.rule required | string | Why this spelling was chosen over the others. |
values required | array of object | Every requested cipher applied to the chosen spelling, in catalogue order, each named as the catalogue names it. Only computed ciphers appear, so every row carries a number. |
values[].id required | string | Machine identifier of the cipher. Call the ciphers endpoint for the definition, the tradition and the sources behind each one. |
values[].value required | number | The number this cipher gives for the string. Always a number: the one catalogued cipher this API does not compute is absent from this array rather than present without a value, so no row here has to be guarded. Its catalogue entry carries computed false and says why. |
values[].alternateValues | array of number | Other published totals for the same string, ascending. Present only where the cipher is not single valued: letter names have several accepted spellings, so several totals are equally published. Absent otherwise, so a caller can branch on presence. |
values[].tradition required | string | Provenance class of the cipher, one of rabbinic, renaissance-latin, golden-dawn-transliterated or modern. Always English, so it stays safe to compare against in code. |
values[].source required | string | The first published source this cipher was taken from. |
values[].name required | string | Display name of the cipher in the requested language, the same string the ciphers catalogue serves for this id. Present so a caller holding one response can label a row without humanizing the identifier or fetching the catalogue. Switch on id, never on this. |
transformations required | array of object | The two substitution transformations applied to the chosen spelling. Each exchanges letters and returns a new word, so the interesting output is often the string rather than the number. |
transformations[].id required | string | Machine identifier of the transformation. |
transformations[].name required | string | Display name of the transformation as the catalogue names it, in the requested language. |
transformations[].output | string | The substituted Hebrew string. Absent when atbashOutput asked for the value alone. |
transformations[].outputRomanization | string | Latin transcription of the substituted string, from the same mechanical letter map. |
transformations[].value | number | Standard value of the substituted string. Absent when atbashOutput asked for the string alone. |
transformations[].tradition required | string | Provenance class of the transformation. |
transformations[].source required | string | The first published source the substitution table was taken from. |
latinValues | array of object | The Latin alphabet ciphers applied to the Latin text. Present only when latinCiphers was set and a Latin text was sent. |
latinValues[].id required | string | Machine identifier of the Latin cipher. |
latinValues[].value required | number | The number this cipher gives for the Latin text as sent. |
latinValues[].tradition required | string | Provenance class. None of these is rabbinic, whatever a consumer calculator calls them. |
latinValues[].lineage required | string | Where the cipher comes from, stated so it cannot be misattributed. |
matches required | array of object | Curated words whose standard value equals the chosen spelling. Matching is on the standard reading only, because that is the relation the classical method works with. Empty when nothing matches, which is the ordinary case. |
matches[].id required | string | Machine identifier of the entry, an ASCII romanization. |
matches[].hebrew required | string | The word in Hebrew. Data, identical in every language. |
matches[].romanization required | string | Latin transcription of the Hebrew beside it, from the same mechanical letter map. |
matches[].meaning required | string | What the word means, in the requested language. |
matches[].value required | number | Its value under the standard reading, which is why it matched. |
matches[].note required | string | What the tradition says about the equality, in the requested language. |
matches[].sources required | array of string | Where the value is attested. Every entry in the lexicon carries at least two independent sources, which is why the list is short rather than long. |
conventions required | object | |
conventions.transliteration | string | The Latin to Hebrew scheme applied. Absent when the caller sent Hebrew directly. |
conventions.misparGadol required | string | Which of the two published methods the name mispar gadol was read as. |
conventions.atbashOutput required | string | What the substitution transformations returned. |