Action result - Phrase Developer Hub

Authorizations

Authorization

string

header

required

Provide Authorization header with token obtained through Login operation.

Headers

Accept

string

required

Media type which caller expects as a response.

Path Parameters

uid

string

required

UID of the operation. See File translations endpoint.

actionType

enum<string>

required

File associated with the specified action type will be returned, if the action was completed.

Available options:

CONVERTER_IMPORT,

FILE_IMPORT,

MT_GENERIC_PRETRANSLATE,

QUALITY_ESTIMATION

Example:

"MT_GENERIC_PRETRANSLATE"

language

string

required

Requested language of the file. Please note different actions have different languages available.

Response

Action result has been successfully returned.

metadata

object

required

Show child attributes

metadata.sourceLang

object

required

Show child attributes

metadata.sourceLang.code

string

required

Language code, using a two-letter language code from ISO 639-1, e.g., cs. Optionally, a region subtag based on a two-letter country code from ISO 3166-1 alpha-2, e.g., cs_cz, or a three-digit code from UN M.49, e.g., es_419, separated by an underscore. Both the two-letter language code and the two-letter country code need to be lower case. Note that the Phrase Language AI setup dictates whether the region subtag is optional or not. If the only models deployed to a profile explicitly specify or are customized with a target locale, then a region subtag is mandatory.

Example:

"cs"

metadata.targetLangs

object[]

required

Minimum array length: 1

Show child attributes

metadata.targetLangs.code

string

required

Language code, using a two-letter language code from ISO 639-1, e.g., cs. Optionally, a region subtag based on a two-letter country code from ISO 3166-1 alpha-2, e.g., cs_cz, or a three-digit code from UN M.49, e.g., es_419, separated by an underscore. Both the two-letter language code and the two-letter country code need to be lower case. Note that the Phrase Language AI setup dictates whether the region subtag is optional or not. If the only models deployed to a profile explicitly specify or are customized with a target locale, then a region subtag is mandatory.

Example:

"cs"

metadata.actionTypes

enum<string>[]

required

Minimum array length: 1

Available options:

CONVERTER_IMPORT,

FILE_IMPORT,

MT_GENERIC_PRETRANSLATE,

QUALITY_ESTIMATION

metadata.callbackUrl

string<uri>

URI in RFC 2396 format.

metadata.mtSettings

object

Show child attributes

metadata.mtSettings.usePhraseMTSettings

boolean

default:false

Use Language AI to apply Machine Translation

Example:

true

metadata.mtSettings.profile

object

Show child attributes

metadata.mtSettings.profile.uid

string

required

UID for the translation profile

Example:

"CFUki8ptanoz1WAIYoXSH4"

metadata.transMemoriesConfig

object[]

Show child attributes

metadata.transMemoriesConfig.targetLang

object

Show child attributes

metadata.transMemoriesConfig.targetLang.code

string

required

Language code, using a two-letter language code from ISO 639-1, e.g., cs. Optionally, a region subtag based on a two-letter country code from ISO 3166-1 alpha-2, e.g., cs_cz, or a three-digit code from UN M.49, e.g., es_419, separated by an underscore. Both the two-letter language code and the two-letter country code need to be lower case. Note that the Phrase Language AI setup dictates whether the region subtag is optional or not. If the only models deployed to a profile explicitly specify or are customized with a target locale, then a region subtag is mandatory.

Example:

"cs"

metadata.transMemoriesConfig.transMemories

object[]

Show child attributes

metadata.transMemoriesConfig.transMemories.transMemory

object

Show child attributes

metadata.transMemoriesConfig.transMemories.transMemory.uid

string

Unique identifier of the translation memory

metadata.transMemoriesConfig.transMemories.tmSourceLocale

object

Show child attributes

metadata.transMemoriesConfig.transMemories.tmSourceLocale.code

string

required

Language code, using a two-letter language code from ISO 639-1, e.g., cs. Optionally, a region subtag based on a two-letter country code from ISO 3166-1 alpha-2, e.g., cs_cz, or a three-digit code from UN M.49, e.g., es_419, separated by an underscore. Both the two-letter language code and the two-letter country code need to be lower case. Note that the Phrase Language AI setup dictates whether the region subtag is optional or not. If the only models deployed to a profile explicitly specify or are customized with a target locale, then a region subtag is mandatory.

Example:

"cs"

metadata.transMemoriesConfig.transMemories.tmTargetLocale

object

Show child attributes

metadata.transMemoriesConfig.transMemories.tmTargetLocale.code

string

required

Language code, using a two-letter language code from ISO 639-1, e.g., cs. Optionally, a region subtag based on a two-letter country code from ISO 3166-1 alpha-2, e.g., cs_cz, or a three-digit code from UN M.49, e.g., es_419, separated by an underscore. Both the two-letter language code and the two-letter country code need to be lower case. Note that the Phrase Language AI setup dictates whether the region subtag is optional or not. If the only models deployed to a profile explicitly specify or are customized with a target locale, then a region subtag is mandatory.

Example:

"cs"

file

required

The file data.

API Documentation

Authorizations

Headers

Path Parameters

Response