document_status

Creates, updates, deletes, gets or lists a document_status resource.

Overview

Name	document_status
Type	Resource
Id	azure.ai_translation_document.document_status

Fields

The following fields are returned by SELECT queries:

get_document_status

Name	Datatype	Description
id	string	Document Id. Required.
characterCharged	integer	Character charged by the API.
createdDateTimeUtc	string (date-time)	Operation created date time. Required.
error	object	This contains an outer error with error code, message, details, target and an inner error with more descriptive details.
lastActionDateTimeUtc	string (date-time)	Date time in which the operation's status has been updated. Required.
path	string	Location of the document or folder.
progress	number	Progress of the translation if available. Required.
sourcePath	string	Location of the source document. Required.
status	string	List of possible statuses for job or document. Required. Known values are: "NotStarted", "Running", "Succeeded", "Failed", "Cancelled", "Cancelling", and "ValidationFailed". (NotStarted, Running, Succeeded, Failed, Cancelled, Cancelling, ValidationFailed)
to	string	To language. Required.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_document_status	select	id, document_id, endpoint		Returns the status for a specific document. Returns the translation status for a specific document based on the request Id and document Id.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
document_id	string	Format - uuid. The document id. Required.
endpoint	string	The service endpoint host (no scheme), e.g. myaccount.table.cosmos.azure.com:443 - value of the client endpoint parameter. (default: )
id	string	Format - uuid. The batch id. Required.

SELECT examples

get_document_status

Returns the status for a specific document. Returns the translation status for a specific document based on the request Id and document Id.

SELECT
id,
characterCharged,
createdDateTimeUtc,
error,
lastActionDateTimeUtc,
path,
progress,
sourcePath,
status,
to
FROM azure.ai_translation_document.document_status
WHERE id = '{{ id }}' -- required
AND document_id = '{{ document_id }}' -- required
AND endpoint = '{{ endpoint }}' -- required
;