Azure.AI.DocumentTranslation (stable:2024-05-01)

2025/09/05 • 8 new, 8 deleted methods

DocumentTranslationOperations_GetTranslationsStatus (new)
Description :  Returns a list of batch requests submitted and the status for each request. This list only contains batch requests submitted by the user (based on the resource). If the number of requests exceeds our paging limit, server-side paging is used. Paginated responses indicate a partial result and include a continuation token in the response. The absence of a continuation token means that no additional pages are available. top, skip and maxpagesize query parameters can be used to specify a number of results to return and an offset for the collection. top indicates the total number of records the user wants to be returned across all pages. skip indicates the number of records to skip from the list of batches based on the sorting method specified. By default, we sort by descending start time. maxpagesize is the maximum items returned in a page. If more items are requested via top (or top is not specified and there are more items to be returned), @nextLink will contain the link to the next page. orderby query parameter can be used to sort the returned list (ex "orderby=createdDateTimeUtc asc" or "orderby=createdDateTimeUtc desc"). The default sorting is descending by createdDateTimeUtc. Some query parameters can be used to filter the returned list (ex: "status=Succeeded,Cancelled") will only return succeeded and cancelled operations. createdDateTimeUtcStart and createdDateTimeUtcEnd can be used combined or separately to specify a range of datetime to filter the returned list by. The supported filtering query parameters are (status, ids, createdDateTimeUtcStart, createdDateTimeUtcEnd). The server honors the values specified by the client. However, clients must be prepared to handle responses that contain a different page size or contain a continuation token. When both top and skip are included, the server should first apply skip and then top on the collection. Note: If the server can't honor top and/or skip, the server must return an error to the client informing about it instead of just ignoring the query options. This reduces the risk of the client making assumptions about the data returned.
Reference :  Link ¶

⚼ Request

GET:  /document/batches
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
top:
{
Description: top indicates the total number of records the user wants to be returned across all pages. Clients MAY use top and skip query parameters to specify a number of results to return and an offset into the collection. When both top and skip are given by a client, the server SHOULD first apply skip and then top on the collection. Note: If the server can't honor top and/or skip, the server MUST return an error to the client informing about it instead of just ignoring the query options. ,
Format: int32 ,
Required: False ,
}
integer ,
skip:
{
Description: skip indicates the number of records to skip from the list of records held by the server based on the sorting method specified. By default, we sort by descending start time. Clients MAY use top and skip query parameters to specify a number of results to return and an offset into the collection. When both top and skip are given by a client, the server SHOULD first apply skip and then top on the collection. Note: If the server can't honor top and/or skip, the server MUST return an error to the client informing about it instead of just ignoring the query options. ,
Format: int32 ,
Required: False ,
}
integer ,
maxpagesize:
{
Description: maxpagesize is the maximum items returned in a page. If more items are requested via top (or top is not specified and there are more items to be returned), @nextLink will contain the link to the next page. Clients MAY request server-driven paging with a specific page size by specifying a maxpagesize preference. The server SHOULD honor this preference if the specified page size is smaller than the server's default page size. ,
Format: int32 ,
Required: False ,
}
integer ,
ids:
{
Description: Ids to use in filtering ,
Required: False ,
}
array ,
statuses:
{
Description: Statuses to use in filtering ,
Required: False ,
}
array ,
createdDateTimeUtcStart:
{
Description: the start datetime to get items after ,
Format: date-time ,
Required: False ,
}
string ,
createdDateTimeUtcEnd:
{
Description: the end datetime to get items before ,
Format: date-time ,
Required: False ,
}
string ,
orderby:
{
Description: the sorting query for the collection (ex: 'CreatedDateTimeUtc asc','CreatedDateTimeUtc desc') ,
Required: False ,
}
array ,
}

⚐ Response (200)

{
value:
{
Description: The summary status of individual operation ,
Required: True ,
}
[
{
id:
{
Description: Id of the translation operation. ,
Required: True ,
}
string ,
createdDateTimeUtc:
{
Description: Operation created date time ,
Format: date-time ,
Required: True ,
}
string ,
lastActionDateTimeUtc:
{
Description: Date time in which the operation's status has been updated ,
Format: date-time ,
Required: True ,
}
string ,
status:
{
Description: List of possible statuses for job or document ,
Enum:
{
NotStarted: NotStarted ,
Running: Running ,
Succeeded: Succeeded ,
Failed: Failed ,
Cancelled: Cancelled ,
Cancelling: Cancelling ,
ValidationFailed: ValidationFailed ,
}
,
Required: True ,
}
enum ,
error:
{
Description: This contains an outer error with error code, message, details, target and an inner error with more descriptive details. ,
Required: False ,
}
{
code:
{
Description: Enums containing high level error codes. ,
Enum:
{
InvalidRequest: InvalidRequest ,
InvalidArgument: InvalidArgument ,
InternalServerError: InternalServerError ,
ServiceUnavailable: ServiceUnavailable ,
ResourceNotFound: ResourceNotFound ,
Unauthorized: Unauthorized ,
RequestRateTooHigh: RequestRateTooHigh ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Gets high level error message. ,
Required: True ,
}
string ,
target:
{
Description: Gets the source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Description: New Inner Error format which conforms to Cognitive Services API Guidelines which is available at https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. This contains required properties ErrorCode, message and optional properties target, details(key value pair), inner error(this can be nested). ,
Required: False ,
}
{
code:
{
Description: Gets code error string. ,
Required: True ,
}
string ,
message:
{
Description: Gets high level error message. ,
Required: True ,
}
string ,
target:
{
Description: Gets the source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
}
,
}
,
summary:
{
Description: Status Summary ,
Required: True ,
}
{
total:
{
Description: Total count ,
Format: int32 ,
Required: True ,
}
integer ,
failed:
{
Description: Failed count ,
Format: int32 ,
Required: True ,
}
integer ,
success:
{
Description: Number of Success ,
Format: int32 ,
Required: True ,
}
integer ,
inProgress:
{
Description: Number of in progress ,
Format: int32 ,
Required: True ,
}
integer ,
notYetStarted:
{
Description: Count of not yet started ,
Format: int32 ,
Required: True ,
}
integer ,
cancelled:
{
Description: Number of cancelled ,
Format: int32 ,
Required: True ,
}
integer ,
totalCharacterCharged:
{
Description: Total characters charged by the API ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
}
,
]
,
nextLink:
{
Description: Url for the next page. Null if no more pages available ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
DocumentTranslationOperations_StartTranslation (new)
Description :  Use this API to submit a bulk (batch) translation request to the Document Translation service. Each request can contain multiple documents and must contain a source and destination container for each document. The prefix and suffix filter (if supplied) are used to filter folders. The prefix is applied to the subpath after the container name. Glossaries / Translation memory can be included in the request and are applied by the service when the document is translated. If the glossary is invalid or unreachable during translation, an error is indicated in the document status. If a file with the same name already exists at the destination, it will be overwritten. The targetUrl for each target language must be unique.
Reference :  Link ¶

⚼ Request

POST:  /document/batches
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: Translation job submission batch request ,
Required: True ,
}
{
inputs:
{
Description: The input list of documents or folders containing documents ,
Required: True ,
}
[
{
source:
{
Description: Source of the input documents ,
Required: True ,
}
{
sourceUrl:
{
Description: Location of the folder / container or single file with your documents ,
Required: True ,
}
string ,
filter:
{
Description: Document filter ,
Required: False ,
}
{
prefix:
{
Description: A case-sensitive prefix string to filter documents in the source path for translation. For example, when using a Azure storage blob Uri, use the prefix to restrict sub folders for translation. ,
Required: False ,
}
string ,
suffix:
{
Description: A case-sensitive suffix string to filter documents in the source path for translation. This is most often use for file extensions ,
Required: False ,
}
string ,
}
,
language:
{
Description: Language code If none is specified, we will perform auto detect on the document ,
Required: False ,
}
string ,
storageSource:
{
Description: Storage Source ,
Enum:
{
AzureBlob: Azure blob storage source ,
}
,
Required: False ,
}
enum ,
}
,
targets:
{
Description: Location of the destination for the output ,
Required: True ,
}
[
{
targetUrl:
{
Description: Location of the folder / container with your documents ,
Required: True ,
}
string ,
category:
{
Description: Category / custom system for translation request ,
Required: False ,
}
string ,
language:
{
Description: Target Language ,
Required: True ,
}
string ,
glossaries:
{
Description: List of Glossary ,
Required: False ,
}
[
{
glossaryUrl:
{
Description: Location of the glossary. We will use the file extension to extract the formatting if the format parameter is not supplied. If the translation language pair is not present in the glossary, it will not be applied ,
Required: True ,
}
string ,
format:
{
Description: Format ,
Required: True ,
}
string ,
version:
{
Description: Optional Version. If not specified, default is used. ,
Required: False ,
}
string ,
storageSource:
{
Description: Storage Source ,
Enum:
{
AzureBlob: Azure blob storage source ,
}
,
Required: False ,
}
enum ,
}
,
]
,
storageSource:
{
Description: Storage Source ,
Enum:
{
AzureBlob: Azure blob storage source ,
}
,
Required: False ,
}
enum ,
}
,
]
,
storageType:
{
Description: Storage type of the input documents source string ,
Enum:
{
Folder: Folder storage input type ,
File: File storage input type ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}

⚐ Response (202)

{
operation-location:
{
Description: Link to the translation operation status ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
DocumentTranslationOperations_GetTranslationStatus (new)
Description :  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.
Reference :  Link ¶

⚼ Request

GET:  /document/batches/{id}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
id:
{
Description: Format - uuid. The operation id ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Id of the translation operation. ,
Required: True ,
}
string ,
createdDateTimeUtc:
{
Description: Operation created date time ,
Format: date-time ,
Required: True ,
}
string ,
lastActionDateTimeUtc:
{
Description: Date time in which the operation's status has been updated ,
Format: date-time ,
Required: True ,
}
string ,
status:
{
Description: List of possible statuses for job or document ,
Enum:
{
NotStarted: NotStarted ,
Running: Running ,
Succeeded: Succeeded ,
Failed: Failed ,
Cancelled: Cancelled ,
Cancelling: Cancelling ,
ValidationFailed: ValidationFailed ,
}
,
Required: True ,
}
enum ,
error:
{
Description: This contains an outer error with error code, message, details, target and an inner error with more descriptive details. ,
Required: False ,
}
{
code:
{
Description: Enums containing high level error codes. ,
Enum:
{
InvalidRequest: InvalidRequest ,
InvalidArgument: InvalidArgument ,
InternalServerError: InternalServerError ,
ServiceUnavailable: ServiceUnavailable ,
ResourceNotFound: ResourceNotFound ,
Unauthorized: Unauthorized ,
RequestRateTooHigh: RequestRateTooHigh ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Gets high level error message. ,
Required: True ,
}
string ,
target:
{
Description: Gets the source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Description: New Inner Error format which conforms to Cognitive Services API Guidelines which is available at https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. This contains required properties ErrorCode, message and optional properties target, details(key value pair), inner error(this can be nested). ,
Required: False ,
}
{
code:
{
Description: Gets code error string. ,
Required: True ,
}
string ,
message:
{
Description: Gets high level error message. ,
Required: True ,
}
string ,
target:
{
Description: Gets the source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
}
,
}
,
summary:
{
Description: Status Summary ,
Required: True ,
}
{
total:
{
Description: Total count ,
Format: int32 ,
Required: True ,
}
integer ,
failed:
{
Description: Failed count ,
Format: int32 ,
Required: True ,
}
integer ,
success:
{
Description: Number of Success ,
Format: int32 ,
Required: True ,
}
integer ,
inProgress:
{
Description: Number of in progress ,
Format: int32 ,
Required: True ,
}
integer ,
notYetStarted:
{
Description: Count of not yet started ,
Format: int32 ,
Required: True ,
}
integer ,
cancelled:
{
Description: Number of cancelled ,
Format: int32 ,
Required: True ,
}
integer ,
totalCharacterCharged:
{
Description: Total characters charged by the API ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
DocumentTranslationOperations_CancelTranslation (new)
Description :  Cancel a currently processing or queued translation. A translation will not be cancelled if it is already completed or failed or cancelling. A bad request will be returned. All documents that have completed translation will not be cancelled and will be charged. All pending documents will be cancelled if possible.
Reference :  Link ¶

⚼ Request

DELETE:  /document/batches/{id}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
id:
{
Description: Format - uuid. The operation-id ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Id of the translation operation. ,
Required: True ,
}
string ,
createdDateTimeUtc:
{
Description: Operation created date time ,
Format: date-time ,
Required: True ,
}
string ,
lastActionDateTimeUtc:
{
Description: Date time in which the operation's status has been updated ,
Format: date-time ,
Required: True ,
}
string ,
status:
{
Description: List of possible statuses for job or document ,
Enum:
{
NotStarted: NotStarted ,
Running: Running ,
Succeeded: Succeeded ,
Failed: Failed ,
Cancelled: Cancelled ,
Cancelling: Cancelling ,
ValidationFailed: ValidationFailed ,
}
,
Required: True ,
}
enum ,
error:
{
Description: This contains an outer error with error code, message, details, target and an inner error with more descriptive details. ,
Required: False ,
}
{
code:
{
Description: Enums containing high level error codes. ,
Enum:
{
InvalidRequest: InvalidRequest ,
InvalidArgument: InvalidArgument ,
InternalServerError: InternalServerError ,
ServiceUnavailable: ServiceUnavailable ,
ResourceNotFound: ResourceNotFound ,
Unauthorized: Unauthorized ,
RequestRateTooHigh: RequestRateTooHigh ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Gets high level error message. ,
Required: True ,
}
string ,
target:
{
Description: Gets the source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Description: New Inner Error format which conforms to Cognitive Services API Guidelines which is available at https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. This contains required properties ErrorCode, message and optional properties target, details(key value pair), inner error(this can be nested). ,
Required: False ,
}
{
code:
{
Description: Gets code error string. ,
Required: True ,
}
string ,
message:
{
Description: Gets high level error message. ,
Required: True ,
}
string ,
target:
{
Description: Gets the source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
}
,
}
,
summary:
{
Description: Status Summary ,
Required: True ,
}
{
total:
{
Description: Total count ,
Format: int32 ,
Required: True ,
}
integer ,
failed:
{
Description: Failed count ,
Format: int32 ,
Required: True ,
}
integer ,
success:
{
Description: Number of Success ,
Format: int32 ,
Required: True ,
}
integer ,
inProgress:
{
Description: Number of in progress ,
Format: int32 ,
Required: True ,
}
integer ,
notYetStarted:
{
Description: Count of not yet started ,
Format: int32 ,
Required: True ,
}
integer ,
cancelled:
{
Description: Number of cancelled ,
Format: int32 ,
Required: True ,
}
integer ,
totalCharacterCharged:
{
Description: Total characters charged by the API ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
DocumentTranslationOperations_GetDocumentsStatus (new)
Description :  Returns the status for all documents in a batch document translation request. If the number of documents in the response exceeds our paging limit, server-side paging is used. Paginated responses indicate a partial result and include a continuation token in the response. The absence of a continuation token means that no additional pages are available. top, skip and maxpagesize query parameters can be used to specify a number of results to return and an offset for the collection. top indicates the total number of records the user wants to be returned across all pages. skip indicates the number of records to skip from the list of document status held by the server based on the sorting method specified. By default, we sort by descending start time. maxpagesize is the maximum items returned in a page. If more items are requested via top (or top is not specified and there are more items to be returned), @nextLink will contain the link to the next page. orderby query parameter can be used to sort the returned list (ex "orderby=createdDateTimeUtc asc" or "orderby=createdDateTimeUtc desc"). The default sorting is descending by createdDateTimeUtc. Some query parameters can be used to filter the returned list (ex: "status=Succeeded,Cancelled") will only return succeeded and cancelled documents. createdDateTimeUtcStart and createdDateTimeUtcEnd can be used combined or separately to specify a range of datetime to filter the returned list by. The supported filtering query parameters are (status, ids, createdDateTimeUtcStart, createdDateTimeUtcEnd). When both top and skip are included, the server should first apply skip and then top on the collection. Note: If the server can't honor top and/or skip, the server must return an error to the client informing about it instead of just ignoring the query options. This reduces the risk of the client making assumptions about the data returned.
Reference :  Link ¶

⚼ Request

GET:  /document/batches/{id}/documents
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
id:
{
Description: Format - uuid. The operation id ,
Format: uuid ,
Required: True ,
}
string ,
top:
{
Description: top indicates the total number of records the user wants to be returned across all pages. Clients MAY use top and skip query parameters to specify a number of results to return and an offset into the collection. When both top and skip are given by a client, the server SHOULD first apply skip and then top on the collection. Note: If the server can't honor top and/or skip, the server MUST return an error to the client informing about it instead of just ignoring the query options. ,
Format: int32 ,
Required: False ,
}
integer ,
skip:
{
Description: skip indicates the number of records to skip from the list of records held by the server based on the sorting method specified. By default, we sort by descending start time. Clients MAY use top and skip query parameters to specify a number of results to return and an offset into the collection. When both top and skip are given by a client, the server SHOULD first apply skip and then top on the collection. Note: If the server can't honor top and/or skip, the server MUST return an error to the client informing about it instead of just ignoring the query options. ,
Format: int32 ,
Required: False ,
}
integer ,
maxpagesize:
{
Description: maxpagesize is the maximum items returned in a page. If more items are requested via top (or top is not specified and there are more items to be returned), @nextLink will contain the link to the next page. Clients MAY request server-driven paging with a specific page size by specifying a maxpagesize preference. The server SHOULD honor this preference if the specified page size is smaller than the server's default page size. ,
Format: int32 ,
Required: False ,
}
integer ,
ids:
{
Description: Ids to use in filtering ,
Required: False ,
}
array ,
statuses:
{
Description: Statuses to use in filtering ,
Required: False ,
}
array ,
createdDateTimeUtcStart:
{
Description: the start datetime to get items after ,
Format: date-time ,
Required: False ,
}
string ,
createdDateTimeUtcEnd:
{
Description: the end datetime to get items before ,
Format: date-time ,
Required: False ,
}
string ,
orderby:
{
Description: the sorting query for the collection (ex: 'CreatedDateTimeUtc asc','CreatedDateTimeUtc desc') ,
Required: False ,
}
array ,
}

⚐ Response (200)

{
value:
{
Description: The detail status of individual documents ,
Required: True ,
}
[
{
path:
{
Description: Location of the document or folder ,
Required: False ,
}
string ,
sourcePath:
{
Description: Location of the source document ,
Required: True ,
}
string ,
createdDateTimeUtc:
{
Description: Operation created date time ,
Format: date-time ,
Required: True ,
}
string ,
lastActionDateTimeUtc:
{
Description: Date time in which the operation's status has been updated ,
Format: date-time ,
Required: True ,
}
string ,
status:
{
Description: List of possible statuses for job or document ,
Enum:
{
NotStarted: NotStarted ,
Running: Running ,
Succeeded: Succeeded ,
Failed: Failed ,
Cancelled: Cancelled ,
Cancelling: Cancelling ,
ValidationFailed: ValidationFailed ,
}
,
Required: True ,
}
enum ,
to:
{
Description: To language ,
Required: True ,
}
string ,
error:
{
Description: This contains an outer error with error code, message, details, target and an inner error with more descriptive details. ,
Required: False ,
}
{
code:
{
Description: Enums containing high level error codes. ,
Enum:
{
InvalidRequest: InvalidRequest ,
InvalidArgument: InvalidArgument ,
InternalServerError: InternalServerError ,
ServiceUnavailable: ServiceUnavailable ,
ResourceNotFound: ResourceNotFound ,
Unauthorized: Unauthorized ,
RequestRateTooHigh: RequestRateTooHigh ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Gets high level error message. ,
Required: True ,
}
string ,
target:
{
Description: Gets the source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Description: New Inner Error format which conforms to Cognitive Services API Guidelines which is available at https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. This contains required properties ErrorCode, message and optional properties target, details(key value pair), inner error(this can be nested). ,
Required: False ,
}
{
code:
{
Description: Gets code error string. ,
Required: True ,
}
string ,
message:
{
Description: Gets high level error message. ,
Required: True ,
}
string ,
target:
{
Description: Gets the source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
}
,
}
,
progress:
{
Description: Progress of the translation if available ,
Format: float ,
Required: True ,
}
number ,
id:
{
Description: Document Id ,
Format: uuid ,
Required: True ,
}
string ,
characterCharged:
{
Description: Character charged by the API ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
nextLink:
{
Description: Url for the next page. Null if no more pages available ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
DocumentTranslationOperations_GetDocumentStatus (new)
Description :  Returns the translation status for a specific document based on the request Id and document Id.
Reference :  Link ¶

⚼ Request

GET:  /document/batches/{id}/documents/{documentId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
id:
{
Description: Format - uuid. The batch id ,
Format: uuid ,
Required: True ,
}
string ,
documentId:
{
Description: Format - uuid. The document id ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
path:
{
Description: Location of the document or folder ,
Required: False ,
}
string ,
sourcePath:
{
Description: Location of the source document ,
Required: True ,
}
string ,
createdDateTimeUtc:
{
Description: Operation created date time ,
Format: date-time ,
Required: True ,
}
string ,
lastActionDateTimeUtc:
{
Description: Date time in which the operation's status has been updated ,
Format: date-time ,
Required: True ,
}
string ,
status:
{
Description: List of possible statuses for job or document ,
Enum:
{
NotStarted: NotStarted ,
Running: Running ,
Succeeded: Succeeded ,
Failed: Failed ,
Cancelled: Cancelled ,
Cancelling: Cancelling ,
ValidationFailed: ValidationFailed ,
}
,
Required: True ,
}
enum ,
to:
{
Description: To language ,
Required: True ,
}
string ,
error:
{
Description: This contains an outer error with error code, message, details, target and an inner error with more descriptive details. ,
Required: False ,
}
{
code:
{
Description: Enums containing high level error codes. ,
Enum:
{
InvalidRequest: InvalidRequest ,
InvalidArgument: InvalidArgument ,
InternalServerError: InternalServerError ,
ServiceUnavailable: ServiceUnavailable ,
ResourceNotFound: ResourceNotFound ,
Unauthorized: Unauthorized ,
RequestRateTooHigh: RequestRateTooHigh ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Gets high level error message. ,
Required: True ,
}
string ,
target:
{
Description: Gets the source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Description: New Inner Error format which conforms to Cognitive Services API Guidelines which is available at https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. This contains required properties ErrorCode, message and optional properties target, details(key value pair), inner error(this can be nested). ,
Required: False ,
}
{
code:
{
Description: Gets code error string. ,
Required: True ,
}
string ,
message:
{
Description: Gets high level error message. ,
Required: True ,
}
string ,
target:
{
Description: Gets the source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
}
,
}
,
progress:
{
Description: Progress of the translation if available ,
Format: float ,
Required: True ,
}
number ,
id:
{
Description: Document Id ,
Format: uuid ,
Required: True ,
}
string ,
characterCharged:
{
Description: Character charged by the API ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
DocumentTranslationOperations_GetSupportedFormats (new)
Description :  The list of supported formats supported by the Document Translation service. The list includes the common file extension, as well as the content-type if using the upload API.
Reference :  Link ¶

⚼ Request

GET:  /document/formats
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
type:
{
Description: the type of format like document or glossary ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: list of objects ,
Required: True ,
}
[
{
format:
{
Description: Name of the format ,
Required: True ,
}
string ,
fileExtensions:
{
Description: Supported file extension for this format ,
Required: True ,
}
[
string ,
]
,
contentTypes:
{
Description: Supported Content-Types for this format ,
Required: True ,
}
[
string ,
]
,
defaultVersion:
{
Description: Default version if none is specified ,
Required: False ,
}
string ,
versions:
{
Description: Supported Version ,
Required: False ,
}
[
string ,
]
,
type:
{
Description: Supported Type for this format ,
Enum:
{
document: Document type file format ,
glossary: Glossary type file format ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
DocumentTranslationOperations_DocumentTranslate (new)
Description :  Use this API to submit a single translation request to the Document Translation Service.
Reference :  Link ¶

⚼ Request

POST:  /document:translate
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
sourceLanguage:
{
Description: Specifies source language of the input document. If this parameter isn't specified, automatic language detection is applied to determine the source language. For example if the source document is written in English, then use sourceLanguage=en ,
Required: False ,
}
string ,
targetLanguage:
{
Description: Specifies the language of the output document. The target language must be one of the supported languages included in the translation scope. For example if you want to translate the document in German language, then use targetLanguage=de ,
Required: True ,
}
string ,
category:
{
Description: A string specifying the category (domain) of the translation. This parameter is used to get translations from a customized system built with Custom Translator. Add the Category ID from your Custom Translator project details to this parameter to use your deployed customized system. Default value is: general. ,
Required: False ,
}
string ,
allowFallback:
{
Description: Specifies that the service is allowed to fall back to a general system when a custom system doesn't exist. Possible values are: true (default) or false. ,
Required: False ,
}
boolean ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
document:
{
Description: Document to be translated in the form ,
Required: True ,
}
file ,
glossary:
{
Description: Glossary-translation memory will be used during translation in the form. ,
Required: False ,
}
array ,
}

⚐ Response (200)

{
$headers:
{
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
}
,
$schema: file ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
DocumentTranslationOperations_GetTranslationsStatus (removed)
Description :  Returns a list of batch requests submitted and the status for each request. This list only contains batch requests submitted by the user (based on the resource). If the number of requests exceeds our paging limit, server-side paging is used. Paginated responses indicate a partial result and include a continuation token in the response. The absence of a continuation token means that no additional pages are available. top, skip and maxpagesize query parameters can be used to specify a number of results to return and an offset for the collection. top indicates the total number of records the user wants to be returned across all pages. skip indicates the number of records to skip from the list of batches based on the sorting method specified. By default, we sort by descending start time. maxpagesize is the maximum items returned in a page. If more items are requested via top (or top is not specified and there are more items to be returned), @nextLink will contain the link to the next page. orderby query parameter can be used to sort the returned list (ex "orderby=createdDateTimeUtc asc" or "orderby=createdDateTimeUtc desc"). The default sorting is descending by createdDateTimeUtc. Some query parameters can be used to filter the returned list (ex: "status=Succeeded,Cancelled") will only return succeeded and cancelled operations. createdDateTimeUtcStart and createdDateTimeUtcEnd can be used combined or separately to specify a range of datetime to filter the returned list by. The supported filtering query parameters are (status, ids, createdDateTimeUtcStart, createdDateTimeUtcEnd). The server honors the values specified by the client. However, clients must be prepared to handle responses that contain a different page size or contain a continuation token. When both top and skip are included, the server should first apply skip and then top on the collection. Note: If the server can't honor top and/or skip, the server must return an error to the client informing about it instead of just ignoring the query options. This reduces the risk of the client making assumptions about the data returned.
Reference :  Link ¶

⚼ Request

GET:  /document/batches
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
top:
{
Description: top indicates the total number of records the user wants to be returned across all pages. Clients MAY use top and skip query parameters to specify a number of results to return and an offset into the collection. When both top and skip are given by a client, the server SHOULD first apply skip and then top on the collection. Note: If the server can't honor top and/or skip, the server MUST return an error to the client informing about it instead of just ignoring the query options. ,
Format: int32 ,
Required: False ,
}
integer ,
skip:
{
Description: skip indicates the number of records to skip from the list of records held by the server based on the sorting method specified. By default, we sort by descending start time. Clients MAY use top and skip query parameters to specify a number of results to return and an offset into the collection. When both top and skip are given by a client, the server SHOULD first apply skip and then top on the collection. Note: If the server can't honor top and/or skip, the server MUST return an error to the client informing about it instead of just ignoring the query options. ,
Format: int32 ,
Required: False ,
}
integer ,
maxpagesize:
{
Description: maxpagesize is the maximum items returned in a page. If more items are requested via top (or top is not specified and there are more items to be returned), @nextLink will contain the link to the next page. Clients MAY request server-driven paging with a specific page size by specifying a maxpagesize preference. The server SHOULD honor this preference if the specified page size is smaller than the server's default page size. ,
Format: int32 ,
Required: False ,
}
integer ,
ids:
{
Description: Ids to use in filtering ,
Required: False ,
}
array ,
statuses:
{
Description: Statuses to use in filtering ,
Required: False ,
}
array ,
createdDateTimeUtcStart:
{
Description: the start datetime to get items after ,
Format: date-time ,
Required: False ,
}
string ,
createdDateTimeUtcEnd:
{
Description: the end datetime to get items before ,
Format: date-time ,
Required: False ,
}
string ,
orderby:
{
Description: the sorting query for the collection (ex: 'CreatedDateTimeUtc asc','CreatedDateTimeUtc desc') ,
Required: False ,
}
array ,
}

⚐ Response (200)

{
value:
{
Description: The summary status of individual operation ,
Required: True ,
}
[
{
id:
{
Description: Id of the translation operation. ,
Required: True ,
}
string ,
createdDateTimeUtc:
{
Description: Operation created date time ,
Format: date-time ,
Required: True ,
}
string ,
lastActionDateTimeUtc:
{
Description: Date time in which the operation's status has been updated ,
Format: date-time ,
Required: True ,
}
string ,
status:
{
Description: List of possible statuses for job or document ,
Enum:
{
NotStarted: NotStarted ,
Running: Running ,
Succeeded: Succeeded ,
Failed: Failed ,
Cancelled: Cancelled ,
Cancelling: Cancelling ,
ValidationFailed: ValidationFailed ,
}
,
Required: True ,
}
enum ,
error:
{
Description: This contains an outer error with error code, message, details, target and an inner error with more descriptive details. ,
Required: False ,
}
{
code:
{
Description: Enums containing high level error codes. ,
Enum:
{
InvalidRequest: InvalidRequest ,
InvalidArgument: InvalidArgument ,
InternalServerError: InternalServerError ,
ServiceUnavailable: ServiceUnavailable ,
ResourceNotFound: ResourceNotFound ,
Unauthorized: Unauthorized ,
RequestRateTooHigh: RequestRateTooHigh ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Gets high level error message. ,
Required: True ,
}
string ,
target:
{
Description: Gets the source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Description: New Inner Error format which conforms to Cognitive Services API Guidelines which is available at https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. This contains required properties ErrorCode, message and optional properties target, details(key value pair), inner error(this can be nested). ,
Required: False ,
}
{
code:
{
Description: Gets code error string. ,
Required: True ,
}
string ,
message:
{
Description: Gets high level error message. ,
Required: True ,
}
string ,
target:
{
Description: Gets the source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
}
,
}
,
summary:
{
Description: Status Summary ,
Required: True ,
}
{
total:
{
Description: Total count ,
Format: int32 ,
Required: True ,
}
integer ,
failed:
{
Description: Failed count ,
Format: int32 ,
Required: True ,
}
integer ,
success:
{
Description: Number of Success ,
Format: int32 ,
Required: True ,
}
integer ,
inProgress:
{
Description: Number of in progress ,
Format: int32 ,
Required: True ,
}
integer ,
notYetStarted:
{
Description: Count of not yet started ,
Format: int32 ,
Required: True ,
}
integer ,
cancelled:
{
Description: Number of cancelled ,
Format: int32 ,
Required: True ,
}
integer ,
totalCharacterCharged:
{
Description: Total characters charged by the API ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
}
,
]
,
nextLink:
{
Description: Url for the next page. Null if no more pages available ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
DocumentTranslationOperations_StartTranslation (removed)
Description :  Use this API to submit a bulk (batch) translation request to the Document Translation service. Each request can contain multiple documents and must contain a source and destination container for each document. The prefix and suffix filter (if supplied) are used to filter folders. The prefix is applied to the subpath after the container name. Glossaries / Translation memory can be included in the request and are applied by the service when the document is translated. If the glossary is invalid or unreachable during translation, an error is indicated in the document status. If a file with the same name already exists at the destination, it will be overwritten. The targetUrl for each target language must be unique.
Reference :  Link ¶

⚼ Request

POST:  /document/batches
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: Translation job submission batch request ,
Required: True ,
}
{
inputs:
{
Description: The input list of documents or folders containing documents ,
Required: True ,
}
[
{
source:
{
Description: Source of the input documents ,
Required: True ,
}
{
sourceUrl:
{
Description: Location of the folder / container or single file with your documents ,
Required: True ,
}
string ,
filter:
{
Description: Document filter ,
Required: False ,
}
{
prefix:
{
Description: A case-sensitive prefix string to filter documents in the source path for translation. For example, when using a Azure storage blob Uri, use the prefix to restrict sub folders for translation. ,
Required: False ,
}
string ,
suffix:
{
Description: A case-sensitive suffix string to filter documents in the source path for translation. This is most often use for file extensions ,
Required: False ,
}
string ,
}
,
language:
{
Description: Language code If none is specified, we will perform auto detect on the document ,
Required: False ,
}
string ,
storageSource:
{
Description: Storage Source ,
Enum:
{
AzureBlob: Azure blob storage source ,
}
,
Required: False ,
}
enum ,
}
,
targets:
{
Description: Location of the destination for the output ,
Required: True ,
}
[
{
targetUrl:
{
Description: Location of the folder / container with your documents ,
Required: True ,
}
string ,
category:
{
Description: Category / custom system for translation request ,
Required: False ,
}
string ,
language:
{
Description: Target Language ,
Required: True ,
}
string ,
glossaries:
{
Description: List of Glossary ,
Required: False ,
}
[
{
glossaryUrl:
{
Description: Location of the glossary. We will use the file extension to extract the formatting if the format parameter is not supplied. If the translation language pair is not present in the glossary, it will not be applied ,
Required: True ,
}
string ,
format:
{
Description: Format ,
Required: True ,
}
string ,
version:
{
Description: Optional Version. If not specified, default is used. ,
Required: False ,
}
string ,
storageSource:
{
Description: Storage Source ,
Enum:
{
AzureBlob: Azure blob storage source ,
}
,
Required: False ,
}
enum ,
}
,
]
,
storageSource:
{
Description: Storage Source ,
Enum:
{
AzureBlob: Azure blob storage source ,
}
,
Required: False ,
}
enum ,
}
,
]
,
storageType:
{
Description: Storage type of the input documents source string ,
Enum:
{
Folder: Folder storage input type ,
File: File storage input type ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}

⚐ Response (202)

{
operation-location:
{
Description: Link to the translation operation status ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
DocumentTranslationOperations_GetTranslationStatus (removed)
Description :  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.
Reference :  Link ¶

⚼ Request

GET:  /document/batches/{id}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
id:
{
Description: Format - uuid. The operation id ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Id of the translation operation. ,
Required: True ,
}
string ,
createdDateTimeUtc:
{
Description: Operation created date time ,
Format: date-time ,
Required: True ,
}
string ,
lastActionDateTimeUtc:
{
Description: Date time in which the operation's status has been updated ,
Format: date-time ,
Required: True ,
}
string ,
status:
{
Description: List of possible statuses for job or document ,
Enum:
{
NotStarted: NotStarted ,
Running: Running ,
Succeeded: Succeeded ,
Failed: Failed ,
Cancelled: Cancelled ,
Cancelling: Cancelling ,
ValidationFailed: ValidationFailed ,
}
,
Required: True ,
}
enum ,
error:
{
Description: This contains an outer error with error code, message, details, target and an inner error with more descriptive details. ,
Required: False ,
}
{
code:
{
Description: Enums containing high level error codes. ,
Enum:
{
InvalidRequest: InvalidRequest ,
InvalidArgument: InvalidArgument ,
InternalServerError: InternalServerError ,
ServiceUnavailable: ServiceUnavailable ,
ResourceNotFound: ResourceNotFound ,
Unauthorized: Unauthorized ,
RequestRateTooHigh: RequestRateTooHigh ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Gets high level error message. ,
Required: True ,
}
string ,
target:
{
Description: Gets the source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Description: New Inner Error format which conforms to Cognitive Services API Guidelines which is available at https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. This contains required properties ErrorCode, message and optional properties target, details(key value pair), inner error(this can be nested). ,
Required: False ,
}
{
code:
{
Description: Gets code error string. ,
Required: True ,
}
string ,
message:
{
Description: Gets high level error message. ,
Required: True ,
}
string ,
target:
{
Description: Gets the source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
}
,
}
,
summary:
{
Description: Status Summary ,
Required: True ,
}
{
total:
{
Description: Total count ,
Format: int32 ,
Required: True ,
}
integer ,
failed:
{
Description: Failed count ,
Format: int32 ,
Required: True ,
}
integer ,
success:
{
Description: Number of Success ,
Format: int32 ,
Required: True ,
}
integer ,
inProgress:
{
Description: Number of in progress ,
Format: int32 ,
Required: True ,
}
integer ,
notYetStarted:
{
Description: Count of not yet started ,
Format: int32 ,
Required: True ,
}
integer ,
cancelled:
{
Description: Number of cancelled ,
Format: int32 ,
Required: True ,
}
integer ,
totalCharacterCharged:
{
Description: Total characters charged by the API ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
DocumentTranslationOperations_CancelTranslation (removed)
Description :  Cancel a currently processing or queued translation. A translation will not be cancelled if it is already completed or failed or cancelling. A bad request will be returned. All documents that have completed translation will not be cancelled and will be charged. All pending documents will be cancelled if possible.
Reference :  Link ¶

⚼ Request

DELETE:  /document/batches/{id}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
id:
{
Description: Format - uuid. The operation-id ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Id of the translation operation. ,
Required: True ,
}
string ,
createdDateTimeUtc:
{
Description: Operation created date time ,
Format: date-time ,
Required: True ,
}
string ,
lastActionDateTimeUtc:
{
Description: Date time in which the operation's status has been updated ,
Format: date-time ,
Required: True ,
}
string ,
status:
{
Description: List of possible statuses for job or document ,
Enum:
{
NotStarted: NotStarted ,
Running: Running ,
Succeeded: Succeeded ,
Failed: Failed ,
Cancelled: Cancelled ,
Cancelling: Cancelling ,
ValidationFailed: ValidationFailed ,
}
,
Required: True ,
}
enum ,
error:
{
Description: This contains an outer error with error code, message, details, target and an inner error with more descriptive details. ,
Required: False ,
}
{
code:
{
Description: Enums containing high level error codes. ,
Enum:
{
InvalidRequest: InvalidRequest ,
InvalidArgument: InvalidArgument ,
InternalServerError: InternalServerError ,
ServiceUnavailable: ServiceUnavailable ,
ResourceNotFound: ResourceNotFound ,
Unauthorized: Unauthorized ,
RequestRateTooHigh: RequestRateTooHigh ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Gets high level error message. ,
Required: True ,
}
string ,
target:
{
Description: Gets the source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Description: New Inner Error format which conforms to Cognitive Services API Guidelines which is available at https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. This contains required properties ErrorCode, message and optional properties target, details(key value pair), inner error(this can be nested). ,
Required: False ,
}
{
code:
{
Description: Gets code error string. ,
Required: True ,
}
string ,
message:
{
Description: Gets high level error message. ,
Required: True ,
}
string ,
target:
{
Description: Gets the source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
}
,
}
,
summary:
{
Description: Status Summary ,
Required: True ,
}
{
total:
{
Description: Total count ,
Format: int32 ,
Required: True ,
}
integer ,
failed:
{
Description: Failed count ,
Format: int32 ,
Required: True ,
}
integer ,
success:
{
Description: Number of Success ,
Format: int32 ,
Required: True ,
}
integer ,
inProgress:
{
Description: Number of in progress ,
Format: int32 ,
Required: True ,
}
integer ,
notYetStarted:
{
Description: Count of not yet started ,
Format: int32 ,
Required: True ,
}
integer ,
cancelled:
{
Description: Number of cancelled ,
Format: int32 ,
Required: True ,
}
integer ,
totalCharacterCharged:
{
Description: Total characters charged by the API ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
DocumentTranslationOperations_GetDocumentsStatus (removed)
Description :  Returns the status for all documents in a batch document translation request. If the number of documents in the response exceeds our paging limit, server-side paging is used. Paginated responses indicate a partial result and include a continuation token in the response. The absence of a continuation token means that no additional pages are available. top, skip and maxpagesize query parameters can be used to specify a number of results to return and an offset for the collection. top indicates the total number of records the user wants to be returned across all pages. skip indicates the number of records to skip from the list of document status held by the server based on the sorting method specified. By default, we sort by descending start time. maxpagesize is the maximum items returned in a page. If more items are requested via top (or top is not specified and there are more items to be returned), @nextLink will contain the link to the next page. orderby query parameter can be used to sort the returned list (ex "orderby=createdDateTimeUtc asc" or "orderby=createdDateTimeUtc desc"). The default sorting is descending by createdDateTimeUtc. Some query parameters can be used to filter the returned list (ex: "status=Succeeded,Cancelled") will only return succeeded and cancelled documents. createdDateTimeUtcStart and createdDateTimeUtcEnd can be used combined or separately to specify a range of datetime to filter the returned list by. The supported filtering query parameters are (status, ids, createdDateTimeUtcStart, createdDateTimeUtcEnd). When both top and skip are included, the server should first apply skip and then top on the collection. Note: If the server can't honor top and/or skip, the server must return an error to the client informing about it instead of just ignoring the query options. This reduces the risk of the client making assumptions about the data returned.
Reference :  Link ¶

⚼ Request

GET:  /document/batches/{id}/documents
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
id:
{
Description: Format - uuid. The operation id ,
Format: uuid ,
Required: True ,
}
string ,
top:
{
Description: top indicates the total number of records the user wants to be returned across all pages. Clients MAY use top and skip query parameters to specify a number of results to return and an offset into the collection. When both top and skip are given by a client, the server SHOULD first apply skip and then top on the collection. Note: If the server can't honor top and/or skip, the server MUST return an error to the client informing about it instead of just ignoring the query options. ,
Format: int32 ,
Required: False ,
}
integer ,
skip:
{
Description: skip indicates the number of records to skip from the list of records held by the server based on the sorting method specified. By default, we sort by descending start time. Clients MAY use top and skip query parameters to specify a number of results to return and an offset into the collection. When both top and skip are given by a client, the server SHOULD first apply skip and then top on the collection. Note: If the server can't honor top and/or skip, the server MUST return an error to the client informing about it instead of just ignoring the query options. ,
Format: int32 ,
Required: False ,
}
integer ,
maxpagesize:
{
Description: maxpagesize is the maximum items returned in a page. If more items are requested via top (or top is not specified and there are more items to be returned), @nextLink will contain the link to the next page. Clients MAY request server-driven paging with a specific page size by specifying a maxpagesize preference. The server SHOULD honor this preference if the specified page size is smaller than the server's default page size. ,
Format: int32 ,
Required: False ,
}
integer ,
ids:
{
Description: Ids to use in filtering ,
Required: False ,
}
array ,
statuses:
{
Description: Statuses to use in filtering ,
Required: False ,
}
array ,
createdDateTimeUtcStart:
{
Description: the start datetime to get items after ,
Format: date-time ,
Required: False ,
}
string ,
createdDateTimeUtcEnd:
{
Description: the end datetime to get items before ,
Format: date-time ,
Required: False ,
}
string ,
orderby:
{
Description: the sorting query for the collection (ex: 'CreatedDateTimeUtc asc','CreatedDateTimeUtc desc') ,
Required: False ,
}
array ,
}

⚐ Response (200)

{
value:
{
Description: The detail status of individual documents ,
Required: True ,
}
[
{
path:
{
Description: Location of the document or folder ,
Required: False ,
}
string ,
sourcePath:
{
Description: Location of the source document ,
Required: True ,
}
string ,
createdDateTimeUtc:
{
Description: Operation created date time ,
Format: date-time ,
Required: True ,
}
string ,
lastActionDateTimeUtc:
{
Description: Date time in which the operation's status has been updated ,
Format: date-time ,
Required: True ,
}
string ,
status:
{
Description: List of possible statuses for job or document ,
Enum:
{
NotStarted: NotStarted ,
Running: Running ,
Succeeded: Succeeded ,
Failed: Failed ,
Cancelled: Cancelled ,
Cancelling: Cancelling ,
ValidationFailed: ValidationFailed ,
}
,
Required: True ,
}
enum ,
to:
{
Description: To language ,
Required: True ,
}
string ,
error:
{
Description: This contains an outer error with error code, message, details, target and an inner error with more descriptive details. ,
Required: False ,
}
{
code:
{
Description: Enums containing high level error codes. ,
Enum:
{
InvalidRequest: InvalidRequest ,
InvalidArgument: InvalidArgument ,
InternalServerError: InternalServerError ,
ServiceUnavailable: ServiceUnavailable ,
ResourceNotFound: ResourceNotFound ,
Unauthorized: Unauthorized ,
RequestRateTooHigh: RequestRateTooHigh ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Gets high level error message. ,
Required: True ,
}
string ,
target:
{
Description: Gets the source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Description: New Inner Error format which conforms to Cognitive Services API Guidelines which is available at https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. This contains required properties ErrorCode, message and optional properties target, details(key value pair), inner error(this can be nested). ,
Required: False ,
}
{
code:
{
Description: Gets code error string. ,
Required: True ,
}
string ,
message:
{
Description: Gets high level error message. ,
Required: True ,
}
string ,
target:
{
Description: Gets the source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
}
,
}
,
progress:
{
Description: Progress of the translation if available ,
Format: float ,
Required: True ,
}
number ,
id:
{
Description: Document Id ,
Format: uuid ,
Required: True ,
}
string ,
characterCharged:
{
Description: Character charged by the API ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
nextLink:
{
Description: Url for the next page. Null if no more pages available ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
DocumentTranslationOperations_GetDocumentStatus (removed)
Description :  Returns the translation status for a specific document based on the request Id and document Id.
Reference :  Link ¶

⚼ Request

GET:  /document/batches/{id}/documents/{documentId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
id:
{
Description: Format - uuid. The batch id ,
Format: uuid ,
Required: True ,
}
string ,
documentId:
{
Description: Format - uuid. The document id ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
path:
{
Description: Location of the document or folder ,
Required: False ,
}
string ,
sourcePath:
{
Description: Location of the source document ,
Required: True ,
}
string ,
createdDateTimeUtc:
{
Description: Operation created date time ,
Format: date-time ,
Required: True ,
}
string ,
lastActionDateTimeUtc:
{
Description: Date time in which the operation's status has been updated ,
Format: date-time ,
Required: True ,
}
string ,
status:
{
Description: List of possible statuses for job or document ,
Enum:
{
NotStarted: NotStarted ,
Running: Running ,
Succeeded: Succeeded ,
Failed: Failed ,
Cancelled: Cancelled ,
Cancelling: Cancelling ,
ValidationFailed: ValidationFailed ,
}
,
Required: True ,
}
enum ,
to:
{
Description: To language ,
Required: True ,
}
string ,
error:
{
Description: This contains an outer error with error code, message, details, target and an inner error with more descriptive details. ,
Required: False ,
}
{
code:
{
Description: Enums containing high level error codes. ,
Enum:
{
InvalidRequest: InvalidRequest ,
InvalidArgument: InvalidArgument ,
InternalServerError: InternalServerError ,
ServiceUnavailable: ServiceUnavailable ,
ResourceNotFound: ResourceNotFound ,
Unauthorized: Unauthorized ,
RequestRateTooHigh: RequestRateTooHigh ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Gets high level error message. ,
Required: True ,
}
string ,
target:
{
Description: Gets the source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Description: New Inner Error format which conforms to Cognitive Services API Guidelines which is available at https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. This contains required properties ErrorCode, message and optional properties target, details(key value pair), inner error(this can be nested). ,
Required: False ,
}
{
code:
{
Description: Gets code error string. ,
Required: True ,
}
string ,
message:
{
Description: Gets high level error message. ,
Required: True ,
}
string ,
target:
{
Description: Gets the source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
}
,
}
,
progress:
{
Description: Progress of the translation if available ,
Format: float ,
Required: True ,
}
number ,
id:
{
Description: Document Id ,
Format: uuid ,
Required: True ,
}
string ,
characterCharged:
{
Description: Character charged by the API ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
DocumentTranslationOperations_GetSupportedFormats (removed)
Description :  The list of supported formats supported by the Document Translation service. The list includes the common file extension, as well as the content-type if using the upload API.
Reference :  Link ¶

⚼ Request

GET:  /document/formats
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
type:
{
Description: the type of format like document or glossary ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: list of objects ,
Required: True ,
}
[
{
format:
{
Description: Name of the format ,
Required: True ,
}
string ,
fileExtensions:
{
Description: Supported file extension for this format ,
Required: True ,
}
[
string ,
]
,
contentTypes:
{
Description: Supported Content-Types for this format ,
Required: True ,
}
[
string ,
]
,
defaultVersion:
{
Description: Default version if none is specified ,
Required: False ,
}
string ,
versions:
{
Description: Supported Version ,
Required: False ,
}
[
string ,
]
,
type:
{
Description: Supported Type for this format ,
Enum:
{
document: Document type file format ,
glossary: Glossary type file format ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
DocumentTranslationOperations_DocumentTranslate (removed)
Description :  Use this API to submit a single translation request to the Document Translation Service.
Reference :  Link ¶

⚼ Request

POST:  /document:translate
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
sourceLanguage:
{
Description: Specifies source language of the input document. If this parameter isn't specified, automatic language detection is applied to determine the source language. For example if the source document is written in English, then use sourceLanguage=en ,
Required: False ,
}
string ,
targetLanguage:
{
Description: Specifies the language of the output document. The target language must be one of the supported languages included in the translation scope. For example if you want to translate the document in German language, then use targetLanguage=de ,
Required: True ,
}
string ,
category:
{
Description: A string specifying the category (domain) of the translation. This parameter is used to get translations from a customized system built with Custom Translator. Add the Category ID from your Custom Translator project details to this parameter to use your deployed customized system. Default value is: general. ,
Required: False ,
}
string ,
allowFallback:
{
Description: Specifies that the service is allowed to fall back to a general system when a custom system doesn't exist. Possible values are: true (default) or false. ,
Required: False ,
}
boolean ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
document:
{
Description: Document to be translated in the form ,
Required: True ,
}
file ,
glossary:
{
Description: Glossary-translation memory will be used during translation in the form. ,
Required: False ,
}
array ,
}

⚐ Response (200)

{
$headers:
{
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
}
,
$schema: file ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}