Phrase Bring Your Own (BYO) Engine integration

This page explains how to configure Companion as a Bring Your Own (BYO) Engine in Phrase Language AI.

Overview 

Companion implements the Phrase BYO Engine API so it can be connected as an engine in a Phrase Language AI MT profile.

Not supported yet 

MT glossary handling 

MT glossaries are configured in Phrase Language AI (MT glossaries tab) and then attached to the selected engine profile on the Phrase Language AI page.

In this BYO implementation, glossary terms managed in Phrase are not applied by Companion yet through the BYO flow.

If your MT provider supports glossary configuration natively, configure glossary on the provider side (for example, in Language Weaver provider configuration, or in another provider-specific glossary/custom model configuration).

Companion BYO Engine configuration in Phrase 

Use the following values when adding the engine in Phrase:

Phrase BYO engine configuration example — Example of BYO engine setup in Phrase Language AI.

Credentials and connection 

Parameter	Value / guidance
Base engine URL	`https://companion.languageweaver.com/api/PhraseMT/v4`
Authentication method	`Client credentials (OAuth 2.0)`
Token URL	`https://companion.languageweaver.com/api/PhraseMT/v4/token`
Client ID / Client secret	Use the Azure AD application credentials assigned to your environment.
Use translation cache	`Yes` (recommended default).

Custom labels (metadata)

Companion consumes the following custom labels:

Label key	Required	Description
`CompanionAlias`	Yes	MT engine configuration alias used by Companion.
`CompanionLabels`	No	Comma-separated labels forwarded to Companion processing.

CompanionLabels format:

labelTag
labelName=labelValue
Multiple labels are comma-separated: label1,label2,name=value

Phrase dynamic metadata placeholders can be used in custom labels, for example {project_uid}, {job_uid}, {idm_organization_uid}.

Migration guide (legacy engine -> BYO)

Legacy MT engine configuration example — Figure: Legacy MT engine configuration (migration reference).

Use the following mapping when moving from legacy engine configuration to Phrase BYO Engine configuration.

Legacy configuration	BYO configuration
`Azure AD client Id`	`Client ID`
`Azure AD client Secret`	`Client secret`
`Configuration alias`	Custom label key `CompanionAlias` with alias value

Additional BYO-only values must be added:

Base engine URL: https://companion.languageweaver.com/api/PhraseMT/v4
Authentication method: Client credentials (OAuth 2.0)
Token endpoint URL: https://companion.languageweaver.com/api/PhraseMT/v4/token
Use translation cache: Yes

Recommended MT profile setup (exclusive Companion BYO)

For full MT profile setup details, follow the Phrase Language AI guide and BYO Engine guide in the references below.

To use Companion BYO exclusively after migration:

Create a new Phrase Language AI MT profile (or update a dedicated profile for this use case).
Add the BYO engine configuration for Companion.
Disable all other MT providers/engines in that profile.

This ensures translation requests routed through that profile use only the Companion BYO engine.

References 

Phrase Language AI: https://support.phrase.com/hc/en-us/articles/5709660879516-Phrase-Language-AI#bring-your-own-engine-0-19
Phrase Bring Your Own Engine: https://support.phrase.com/hc/en-us/articles/28559223255836-Bring-Your-Own-Engine#UUID-8682b51d-5108-97bd-790f-ee28bf9b3ef9
Phrase dynamic metadata labels: https://developers.phrase.com/en/guides/byo-engine/introduction#dynamic-metadata
Phrase Language AI page: https://cloud.memsource.com/tms/language-ai
Phrase MT Glossaries: https://support.phrase.com/hc/en-us/articles/5709675486876-MT-Glossaries