TranslationMemoryApi
extends AbstractApi
in package
Translation Memory (TM) is a vault of translations that were previously made in other projects.
Those translations can be reused to speed up the translation process. Every translation made in the project is automatically added to the project Translation Memory. Use API to create, upload, download, or remove specific TM. Translation Memory export and import are asynchronous operations and shall be completed with sequence of API methods.
Table of Contents
Methods
- checkExportStatus() : TranslationMemoryExport|null
- Check TM Export Status
- checkImportStatus() : TranslationMemoryImport|null
- Check TM Import Status
- clear() : null
- Clear TM
- concordance() : ModelCollection|null
- Concordance search in TMs
- create() : mixed
- Add TM
- createSegment() : TranslationMemorySegment|null
- Create TM Segment
- delete() : null
- Delete TM
- deleteSegment() : null
- Delete TM Segment
- download() : DownloadFile|null
- Download TM
- export() : TranslationMemoryExport|null
- Export TM
- get() : TranslationMemory|null
- Get TM Info
- getSegment() : TranslationMemorySegment|null
- Get TM Segment
- import() : TranslationMemoryImport|null
- Import TM
- list() : ModelCollection
- List TMs
- listSegments() : ModelCollection
- List TM Segments
- update() : TranslationMemory|null
- Edit TM Info
Methods
checkExportStatus()
Check TM Export Status
public
checkExportStatus(int $translationMemoryId, string $exportId) : TranslationMemoryExport|null
Parameters
- $translationMemoryId : int
- $exportId : string
Tags
Return values
TranslationMemoryExport|nullcheckImportStatus()
Check TM Import Status
public
checkImportStatus(int $translationMemoryId, string $importId) : TranslationMemoryImport|null
Parameters
- $translationMemoryId : int
- $importId : string
Tags
Return values
TranslationMemoryImport|nullclear()
Clear TM
public
clear(int $translationMemoryId) : null
Parameters
- $translationMemoryId : int
Tags
Return values
nullconcordance()
Concordance search in TMs
public
concordance(int $projectId, array<string|int, mixed> $params) : ModelCollection|null
Parameters
- $projectId : int
- $params : array<string|int, mixed>
-
string $params[sourceLanguageId] required
string $params[targetLanguageId] required
bool $params[autoSubstitution] required Improves TM suggestions
int $params[minRelevant] required Show TM suggestions with specified minimum match (1-100)
string[] $params[expressions] required Note: Can't be used with expression in same request
string $params[expression] Deprecated Note: Can't be used with expressions in same request
Tags
Return values
ModelCollection|nullcreate()
Add TM
public
create(array<string|int, mixed> $data) : mixed
Parameters
- $data : array<string|int, mixed>
-
string $data[name]
Tags
createSegment()
Create TM Segment
public
createSegment(int $tmId, array<string|int, mixed> $data) : TranslationMemorySegment|null
Parameters
- $tmId : int
- $data : array<string|int, mixed>
-
array $data[records]
string $data[records][][languageId]
string $data[records][][text]
Tags
Return values
TranslationMemorySegment|nulldelete()
Delete TM
public
delete(int $translationMemoryId) : null
Parameters
- $translationMemoryId : int
Tags
Return values
nulldeleteSegment()
Delete TM Segment
public
deleteSegment(int $tmId, int $segmentId) : null
Parameters
- $tmId : int
- $segmentId : int
Tags
Return values
nulldownload()
Download TM
public
download(int $translationMemoryId, string $exportId) : DownloadFile|null
Parameters
- $translationMemoryId : int
- $exportId : string
Tags
Return values
DownloadFile|nullexport()
Export TM
public
export(int $translationMemoryId[, array<string|int, mixed> $params = [] ]) : TranslationMemoryExport|null
Parameters
- $translationMemoryId : int
- $params : array<string|int, mixed> = []
-
string $params[sourceLanguageId]
string $params[targetLanguageId]
string $params[format]
Tags
Return values
TranslationMemoryExport|nullget()
Get TM Info
public
get(int $translationMemoryId) : TranslationMemory|null
Parameters
- $translationMemoryId : int
Tags
Return values
TranslationMemory|nullgetSegment()
Get TM Segment
public
getSegment(int $tmId, int $segmentId) : TranslationMemorySegment|null
Parameters
- $tmId : int
- $segmentId : int
Tags
Return values
TranslationMemorySegment|nullimport()
Import TM
public
import(int $translationMemoryId, int $storageId[, bool $firstLineContainsHeader = false ][, array<string|int, mixed> $scheme = [] ]) : TranslationMemoryImport|null
Parameters
- $translationMemoryId : int
- $storageId : int
- $firstLineContainsHeader : bool = false
- $scheme : array<string|int, mixed> = []
Tags
Return values
TranslationMemoryImport|nulllist()
List TMs
public
list([array<string|int, mixed> $params = [] ]) : ModelCollection
Parameters
- $params : array<string|int, mixed> = []
-
integer $params[userId]
integer $params[groupId]
integer $params[limit]
integer $params[offset]
Tags
Return values
ModelCollectionlistSegments()
List TM Segments
public
listSegments(int $tmId[, array<string|int, mixed> $params = [] ]) : ModelCollection
Parameters
- $tmId : int
- $params : array<string|int, mixed> = []
-
string $params[orderBy]
string $params[croql]
integer $params[limit]
integer $params[offset]
Tags
Return values
ModelCollectionupdate()
Edit TM Info
public
update(TranslationMemory $translationMemory) : TranslationMemory|null
Parameters
- $translationMemory : TranslationMemory