Feedback Edit

DocumentStatus Class

  • Reference

Status information about a particular document within a translation operation.

Inheritance
builtins.object
DocumentStatus

Constructor

DocumentStatus(**kwargs: Any)

Variables

source_document_url
str

Location of the source document in the source container. Note that any SAS tokens are removed from this path.

translated_document_url
str

Location of the translated document in the target container. Note that any SAS tokens are removed from this path.

created_on
datetime

The date time when the document was created.

last_updated_on
datetime

The date time when the document's status was last updated.

status
str

Status for a document.

  • NotStarted - the document has not been translated yet.

  • Running - translation is in progress for document

  • Succeeded - translation succeeded for the document

  • Failed - the document failed to translate. Check the error property.

  • Canceled - the operation was canceled, the document was not translated.

  • Canceling - the operation is canceling, the document will not be translated.

translated_to
str

The language code of the language the document was translated to, if successful.

error
DocumentTranslationError

Returned if there is an error with the particular document. Includes error code, message, target.

translation_progress
float

Progress of the translation if available. Value is between [0.0, 1.0].

id
str

Document Id.

characters_charged
int

Characters charged for the document.