Project Data Access
Project endpoints provide access to Lilt Projects, a high-level entity in the Lilt database.
A project is an activity that represents the process of accepting source content and preparing, translating, and reviewing it into a target language in order to return localized content.
Main components:
- One or many source files (Documents table)
- A source to target language pair
- A Lilt Memory (Memories table)
The documents in the project follow a simple workflow:
- Pre-processing: automated step to extract, segment, and apply the Memory to the source text.
- Translation: human translation activity, accepting or modifying the Memory suggestions.
- Review: human proofing activity, to verify translation quality consistency, style, tone, etc..
- Post-processing: automated step that reverses the effect of pre-processing and generates the target document.
Project Fields
|
Field name |
Data Type |
Description |
Sample value |
|
ID |
INT |
ID (unique identifier) of the project. PK |
8583 |
|
srcLang |
STRING |
2-letter ISO source language code |
fr |
|
trgLang |
STRING |
2-letter ISO target language code |
en |
|
name |
STRING |
User-visible project name |
201912181037 |
|
clientName |
STRING |
Optional: name of the customer/company |
JV GmbH |
|
due |
DATETIME |
Optional: date the project is due |
2020-10-08T22:00:00Z |
|
isComplete |
BOOLEAN |
Is the project complete? |
FALSE |
|
isArchived |
BOOLEAN |
Is the project archived? |
FALSE |
|
state |
STRING |
Enum specifying the current project status: one of inProgress, backlog, inReview, done, inQA. |
backlog |
|
archivedOn |
DATETIME |
Date the project was archived. |
2019-12-25T02:15:10Z |
|
numSourceTokens |
INT |
Number of source words in the project |
673 |
|
createdAt |
DATETIME |
Date the project was created |
2019-12-18T18:38:12Z |
|
UserId |
INT |
ID (unique identifier) of the project creator; FK to Users table |
298 |
|
MemoryId |
INT |
ID (unique identifier) of the project memory; FK to Memories table |
1839 |
|
srcLocale |
STRING |
2-letter source language code |
EN |
|
trgLocale |
STRING |
2-letter target language code |
FR |
|
sampleReviewPercentage |
INT |
User-defined percentage of the language work to review. |
15 |
|
errorRate |
DOUBLE |
Calculated percentage of the language work that required review changes. |
25 |
|
projectTMLeverage |
DECIMAL |
Number of source words where SegmentStats.InitialTMMatch >= 100 |
85 |
Document Data Access
Document endpoints provide access to Lilt Documents, a mid-level entity in the Lilt database.
A Document represents a file under localization in the context of a language pair (source > target language).
The source-language Document is the main Project input; the target-language Document is the main Project output.
A Document is a collection of source and target Segments, each of which is made up of one or more Words.
Documents Fields
|
Field name |
Data Type |
Description |
Nullable? |
Sample value |
|
ID |
INT |
The ID (unique identifier) of the document. PK |
No |
1138 |
|
name |
STRING |
The name of the file. |
No |
201901171341.docx |
|
fileFormat |
STRING |
The file format, in reality the file extension, used to map to a specific preprocessor. |
No |
docx |
|
srcLang |
STRING |
2-letter ISO source language code |
No |
en |
|
srcLocale |
STRING |
2-letter source language code |
Yes |
en |
|
trgLang |
STRING |
2-letter ISO target language code |
No |
id |
|
trgLocale |
STRING |
2-letter target language code |
Yes |
|
|
numSourceTokens |
INT |
The number of source words in the document. |
No |
931 |
|
numSegments |
INT |
The number of source segments (≈ sentences) in the document. |
No |
92 |
|
numConfirmedSegments |
INT |
The number of Segments confirmed (validated, accepted) at the Translation or Review steps. |
No |
0 |
|
numReviewedSegments |
INT |
The number of segments modified at Review. |
No |
0 |
|
timeElapsedMS |
INT |
The total time the document spent at Translation, in milliseconds. |
No |
140372116 |
|
timeElapsedReviewMS |
INT |
The total time the document spent at Review, in milliseconds. |
No |
0 |
|
createdAt |
DATETIME |
The date the document was added to the Project. |
No |
2019-01-17T14:40:18Z |
|
ProjectId |
INT |
The ID of the project the Document lives under. FK to Projects. |
No |
506 |
|
UserId |
INT |
The ID of the document creation user. FK to Users. |
No |
298 |
|
isPretranslating |
BOOLEAN |
Is the document currently in automatic MT by Lilt? |
No |
0 |
|
reviewDueDate |
DATETIME |
Optional: the date the Review task is due for the Document. |
Yes |
null |
|
translationDueDate |
DATETIME |
Optional: the date the Translation task is due for the Document. |
Yes |
null |
|
isReviewComplete |
BOOLEAN |
Is the Document at the Complete status (has it completed all localization steps)? |
No |
FALSE |
|
isTranslationComplete |
BOOLEAN |
Has the Document completed the Translation stage? |
No |
FALSE |
|
projectTMLeverage |
DECIMAL |
Number of source words were SegmentStats.InitialTM Match >= 100 |
Yes |
85 |
Segment Data Access
Segment endpoints provide access to Lilt Segments, a low-level entity in the Lilt database.
A Segment represents a localizable Source string and, after some form of translation has been applied, the Target version of the source string.
The Segments table is populated by 2 processes:
- Human confirmation: in this scenario, the Segment is a string from a localizable file that is Translated and Reviewed by a human user.
- Automated import: conversely, a Segment can be added to the table by import of external assets. In that case the Segment is a translation unit in a Translation Memory.
Irrespective of their origin, the Segments table can be used for Translation Memory leverage.
Segment Fields
|
Field name |
Data Type |
Description |
Nullable? |
Sample value |
|
ID |
INT |
The ID (unique identifier) of the segment. PK |
No |
3201162 |
|
srcLang |
STRING |
2-letter ISO source language code |
No |
en |
|
trgLang |
STRING |
2-letter ISO target language code |
No |
es |
|
source |
STRING |
The source string |
No |
A Town Mouse and A Country Mouse |
|
target |
STRING |
The equivalent target string. May be produced by Pretranslation, Translation and Review |
Yes |
Un ratón de la ciudad y un ratón de campo |
|
numSourceTokens |
INT |
Number of source words in the Segment (excludes inline tagging) |
No |
7 |
|
numSourceChars |
INT |
Number of source characters in the Segment (excludes inline tagging) |
No |
32 |
|
timeElapsedMS |
INT |
The total time the Segment spent at Translation, in milliseconds. |
No |
564002 |
|
timeElapsedReviewMS |
INT |
The total time the Segment spent at Review, in milliseconds. |
No |
0 |
|
numTargetTokens |
INT |
Number of target words in the Segment (excludes inline tagging) |
No |
10 |
|
numTargetChars |
INT |
Number of target characters in the Segment (excludes inline tagging) |
Yes |
41 |
|
docOrder |
INT |
The index of the Segment in the Document's Segments list. |
No |
0 |
|
isTargetUploaded |
BOOLEAN |
Indicates whether automated import added the target string. Note: yields to isTargetFromUser if true. |
No |
FALSE |
|
isTargetFromUser |
BOOLEAN |
Indicates whether a user or automated import added the target string. Note: takes precedence over isTargetUploaded. |
No |
TRUE |
|
timeConfirmed |
DATETIME |
The date at which the segment was confirmed by a Human user (which makes it available as Translation Memory) |
Yes |
2019-02-26T21:09:24Z |
|
isConfirmed |
BOOLEAN |
Indicates whether the segment was confirmed by a human user. |
No |
TRUE |
|
isReviewed |
BOOLEAN |
Indicates whether the segment was Reviewed. |
No |
TRUE |
|
isAutoPropagated |
BOOLEAN |
Indicates whether the segment results from auto-propagation (i.e. inherited its target string from another more recently updated Segment with the same source) |
No |
FALSE |
|
UserId |
INT |
ID of the User who originated the Segment in the table. FK to Documents. |
No |
298 |
|
ConfirmedByUserId |
INT |
ID of the user who confirmed the Segment (at Translation??) FK to Documents. |
Yes |
298 |
|
ReviewedUserId |
INT |
ID of the user who confirmed the Segment (at Review). FK to Documents. |
Yes |
null |
|
DocumentId |
INT |
ID of the Document the Segment pertains to. FK to Documents. Toggles with MemoryID: if NULL, the Segment is a TM segment. |
No |
1134 |
|
MemoryId |
INT |
ID of the Lilt Memory the Segments pertains to. FK to Memories. Toggles with DocumentID: if NULL, the Segment is a Document segment. |
Yes |
null |
User Data Access
User endpoints provide access to Lilt Users, a high-level entity in the Lilt database.
A User represents a Lilt user account, i.e. an entry in the Lilt User Management structure.
User Fields
|
Field name |
Data Type |
Description |
Nullable? |
Sample value |
|
ID |
INT |
ID (unique identifier) of a Lilt user account. |
No |
298 |
|
|
STRING |
User's email address. |
No |
milton@initech.com |
|
username |
STRING |
User login |
No |
milton@initech.com |
|
fullName |
STRING |
User complete name ()First name, Last Name) |
Yes |
milton@initech.com |
Memories Data Access
Memories endpoints provide access to Lilt Memories, a high-level entity in the Lilt database.
A Memory represents the "domain" in which a user creates a new project and from which pre-existing translations and Neural MT are applied to pre-translate content.
Memories Fields
|
Field name |
Data Type |
Description |
Nullable? |
Sample value |
|
ID |
INT |
ID (unique identifier) of a Lilt memory. |
No |
14799 |
|
srcLang |
STRING |
TM Source Language |
No |
en |
|
trgLang |
STRING |
TM Target Language |
No |
pt |
|
name |
STRING |
User-specified name of the Lilt Memory |
No |
Test - English-Portuguese CustomTM |
|
numSegments |
INT |
Number of segments in Memory |
Yes |
3001456 |