Skip to main content

translation_status

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

Overview

Nametranslation_status
TypeResource
Idazure.ai_translation_document.translation_status

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
idstringId of the translation operation. Required.
createdDateTimeUtcstring (date-time)Operation created date time. Required.
errorobjectThis contains an outer error with error code, message, details, target and an inner error with more descriptive details.
lastActionDateTimeUtcstring (date-time)Date time in which the operation's status has been updated. Required.
statusstringList 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)
summaryobjectStatus Summary. Required.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
get_translation_statusselectid, endpointReturns the status for a document translation request. Returns the status for a document translation request. The status includes the overall request status, as well as the status for documents that are being translated as part of that request.

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.

NameDatatypeDescription
endpointstringThe service endpoint host (no scheme), e.g. myaccount.table.cosmos.azure.com:443 - value of the client endpoint parameter. (default: )
idstringFormat - uuid. The operation id. Required.

SELECT examples

Returns the status for a document translation request. Returns the status for a document translation request. The status includes the overall request status, as well as the status for documents that are being translated as part of that request.

SELECT
id,
createdDateTimeUtc,
error,
lastActionDateTimeUtc,
status,
summary
FROM azure.ai_translation_document.translation_status
WHERE id = '{{ id }}' -- required
AND endpoint = '{{ endpoint }}' -- required
;