DocumentStatus interface

Package:

@azure/ai-translation-document

Document Status Response

Properties

characterCharged	Character charged by the API
createdAt	Operation created date time
deploymentName	Deployment name of the custom translation model used for the translation
error	This contains an outer error with error code, message, details, target and an inner error with more descriptive details.
id	Document Id
imageCharacterDetected	Characters detected within images
imageCharged	Images charged by the API
lastActionAt	Date time in which the operation's status has been updated
path	Location of the document or folder
progress	Progress of the translation if available
sourcePath	Location of the source document
status	List of possible statuses for job or document
to	To language
totalImageScansFailed	Total image scans failed
totalImageScansSucceeded	Total image scans charged by the API

Property Details

characterCharged

Character charged by the API

characterCharged?: number

Property Value

number

createdAt

Operation created date time

createdAt: Date

Property Value

Date

deploymentName

Deployment name of the custom translation model used for the translation

deploymentName?: string

Property Value

string

error

This contains an outer error with error code, message, details, target and an inner error with more descriptive details.

error?: TranslationError

Property Value

TranslationError

id

Document Id

id: string

Property Value

string

imageCharacterDetected

Characters detected within images

imageCharacterDetected?: number

Property Value

number

imageCharged

Images charged by the API

imageCharged?: number

Property Value

number

lastActionAt

Date time in which the operation's status has been updated

lastActionAt: Date

Property Value

Date

path

Location of the document or folder

path?: string

Property Value

string

progress

Progress of the translation if available

progress: number

Property Value

number

sourcePath

Location of the source document

sourcePath: string

Property Value

string

status

List of possible statuses for job or document

status: Status

Property Value

Status

to

To language

to: string

Property Value

string

totalImageScansFailed

Total image scans failed

totalImageScansFailed?: number

Property Value

number

totalImageScansSucceeded

Total image scans charged by the API

totalImageScansSucceeded?: number

Property Value

number