TranslationStatus Class

Status information about the translation operation.

Inheritance
builtins.object
TranslationStatus

Constructor

TranslationStatus(**kwargs: Any)

Variables

id
str

Id of the translation operation.

created_on
datetime

The date time when the translation operation was created.

last_updated_on
datetime

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

status
str

Status for a translation operation.

  • NotStarted - the operation has not begun yet.

  • Running - translation is in progress.

  • Succeeded - at least one document translated successfully within the operation.

  • Canceled - the operation was canceled.

  • Canceling - the operation is being canceled.

  • ValidationFailed - the input failed validation. E.g. there was insufficient permissions on blob containers.

  • Failed - all the documents within the operation failed.

error
DocumentTranslationError

Returned if there is an error with the translation operation. Includes error code, message, target.

documents_total_count
int

Number of translations to be made on documents in the operation.

documents_failed_count
int

Number of documents that failed translation.

documents_succeeded_count
int

Number of successful translations on documents.

documents_in_progress_count
int

Number of translations on documents in progress.

documents_not_yet_started_count
int

Number of documents that have not yet started being translated.

documents_canceled_count
int

Number of documents that were canceled for translation.

total_characters_charged
int

Total characters charged across all documents within the translation operation.