|
| 1 | +### YamlMime:PythonClass |
| 2 | +uid: azure.ai.translation.document.DocumentStatus |
| 3 | +name: DocumentStatus |
| 4 | +fullName: azure.ai.translation.document.DocumentStatus |
| 5 | +module: azure.ai.translation.document |
| 6 | +inheritances: |
| 7 | +- builtins.object |
| 8 | +summary: Status information about a particular document within a translation operation. |
| 9 | +constructor: |
| 10 | + syntax: 'DocumentStatus(**kwargs: Any)' |
| 11 | +variables: |
| 12 | +- description: 'Location of the source document in the source |
| 13 | +
|
| 14 | + container. Note that any SAS tokens are removed from this path.' |
| 15 | + name: source_document_url |
| 16 | + types: |
| 17 | + - <xref:str> |
| 18 | +- description: 'Location of the translated document in the target |
| 19 | +
|
| 20 | + container. Note that any SAS tokens are removed from this path.' |
| 21 | + name: translated_document_url |
| 22 | + types: |
| 23 | + - <xref:str> |
| 24 | +- description: The date time when the document was created. |
| 25 | + name: created_on |
| 26 | + types: |
| 27 | + - <xref:datetime.datetime> |
| 28 | +- description: The date time when the document's status was last updated. |
| 29 | + name: last_updated_on |
| 30 | + types: |
| 31 | + - <xref:datetime.datetime> |
| 32 | +- description: "Status for a document.\n\n* *NotStarted* - the document has not been\ |
| 33 | + \ translated yet. \n\n* *Running* - translation is in progress for document \n\ |
| 34 | + \n* *Succeeded* - translation succeeded for the document \n\n* *Failed* - the\ |
| 35 | + \ document failed to translate. Check the error property. \n\n* *Canceled* - the\ |
| 36 | + \ operation was canceled, the document was not translated. \n\n* *Canceling* -\ |
| 37 | + \ the operation is canceling, the document will not be translated." |
| 38 | + name: status |
| 39 | + types: |
| 40 | + - <xref:str> |
| 41 | +- description: 'The language code of the language the document was translated to, |
| 42 | +
|
| 43 | + if successful.' |
| 44 | + name: translated_to |
| 45 | + types: |
| 46 | + - <xref:str> |
| 47 | +- description: 'Returned if there is an error with the particular document. |
| 48 | +
|
| 49 | + Includes error code, message, target.' |
| 50 | + name: error |
| 51 | + types: |
| 52 | + - <xref:azure.ai.translation.document.DocumentTranslationError> |
| 53 | +- description: 'Progress of the translation if available. |
| 54 | +
|
| 55 | + Value is between [0.0, 1.0].' |
| 56 | + name: translation_progress |
| 57 | + types: |
| 58 | + - <xref:float> |
| 59 | +- description: Document Id. |
| 60 | + name: id |
| 61 | + types: |
| 62 | + - <xref:str> |
| 63 | +- description: Characters charged for the document. |
| 64 | + name: characters_charged |
| 65 | + types: |
| 66 | + - <xref:int> |
0 commit comments