Share via

DocumentStatusResult Class

  • Reference

Definition

Namespace:
Azure.AI.Translation.Document
Assembly:
Azure.AI.Translation.Document.dll
Package:
Azure.AI.Translation.Document v1.0.0
Package:
Azure.AI.Translation.Document v2.0.0-beta.2
Source:
DocumentStatusResult.cs
Source:
DocumentStatusResult.cs

Status information about a particular document within a translation operation.

public class DocumentStatusResult
public class DocumentStatusResult : System.ClientModel.Primitives.IJsonModel<Azure.AI.Translation.Document.DocumentStatusResult>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.Translation.Document.DocumentStatusResult>
type DocumentStatusResult = class
type DocumentStatusResult = class
    interface IJsonModel<DocumentStatusResult>
    interface IPersistableModel<DocumentStatusResult>
Public Class DocumentStatusResult
Public Class DocumentStatusResult
Implements IJsonModel(Of DocumentStatusResult), IPersistableModel(Of DocumentStatusResult)
Inheritance
Object
DocumentStatusResult
Implements
IJsonModel<DocumentStatusResult> IPersistableModel<DocumentStatusResult> IPersistableModel<T>

Properties

CharactersCharged

Characters charged for the document by the Document Translation service.
CreatedOn

The date time when the document was created.
Error

Gets the error explaining why the translation operation failed on this document. This property will have a value only when the document cannot be processed.
Id

Document Id.
LastModified

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

Location of the original document in the source container.
Status

Status of the document.
TranslatedDocumentUri

Location of the translated document in the target container.
TranslatedToLanguageCode

The language code of the language the document was translated to. This property will have a value only when the document was successfully processed.
TranslationProgressPercentage

Progress of the translation if available. Value is between [0, 100].

Explicit Interface Implementations

IJsonModel<DocumentStatusResult>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<DocumentStatusResult>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.
IPersistableModel<DocumentStatusResult>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.
IPersistableModel<DocumentStatusResult>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<DocumentStatusResult>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to