Cloud Translation V3 Client - Class TranslateDocumentResponse (1.18.1)

Reference documentation and code samples for the Cloud Translation V3 Client class TranslateDocumentResponse.

A translated document response message.

Generated from protobuf message google.cloud.translation.v3.TranslateDocumentResponse

Namespace

Google \ Cloud \ Translate \ V3

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ document_translation Google\Cloud\Translate\V3\DocumentTranslation

Translated document.
↳ glossary_document_translation Google\Cloud\Translate\V3\DocumentTranslation

The document's translation output if a glossary is provided in the request. This can be the same as [TranslateDocumentResponse.document_translation] if no glossary terms apply.
↳ model string

Only present when 'model' is present in the request. 'model' is normalized to have a project number. For example: If the 'model' field in TranslateDocumentRequest is: projects/{project-id}/locations/{location-id}/models/general/nmt then model here would be normalized to projects/{project-number}/locations/{location-id}/models/general/nmt.
↳ glossary_config Google\Cloud\Translate\V3\TranslateTextGlossaryConfig

The glossary_config used for this translation.

getDocumentTranslation

Translated document.

Returns
Type Description
Google\Cloud\Translate\V3\DocumentTranslation|null

hasDocumentTranslation

clearDocumentTranslation

setDocumentTranslation

Translated document.

Parameter
Name Description
var Google\Cloud\Translate\V3\DocumentTranslation
Returns
Type Description
$this

getGlossaryDocumentTranslation

The document's translation output if a glossary is provided in the request.

This can be the same as [TranslateDocumentResponse.document_translation] if no glossary terms apply.

Returns
Type Description
Google\Cloud\Translate\V3\DocumentTranslation|null

hasGlossaryDocumentTranslation

clearGlossaryDocumentTranslation

setGlossaryDocumentTranslation

The document's translation output if a glossary is provided in the request.

This can be the same as [TranslateDocumentResponse.document_translation] if no glossary terms apply.

Parameter
Name Description
var Google\Cloud\Translate\V3\DocumentTranslation
Returns
Type Description
$this

getModel

Only present when 'model' is present in the request.

'model' is normalized to have a project number. For example: If the 'model' field in TranslateDocumentRequest is: projects/{project-id}/locations/{location-id}/models/general/nmt then model here would be normalized to projects/{project-number}/locations/{location-id}/models/general/nmt.

Returns
Type Description
string

setModel

Only present when 'model' is present in the request.

'model' is normalized to have a project number. For example: If the 'model' field in TranslateDocumentRequest is: projects/{project-id}/locations/{location-id}/models/general/nmt then model here would be normalized to projects/{project-number}/locations/{location-id}/models/general/nmt.

Parameter
Name Description
var string
Returns
Type Description
$this

getGlossaryConfig

The glossary_config used for this translation.

Returns
Type Description
Google\Cloud\Translate\V3\TranslateTextGlossaryConfig|null

hasGlossaryConfig

clearGlossaryConfig

setGlossaryConfig

The glossary_config used for this translation.

Parameter
Name Description
var Google\Cloud\Translate\V3\TranslateTextGlossaryConfig
Returns
Type Description
$this