Document Translation - Get Supported Document Formats

Service:: Azure AI Services

API Version:: v1.0

Returns a list of supported document formats
The list of supported document 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.

GET {endpoint}/translator/text/batch/v1.0/documents/formats

URI Parameters

Name	In	Required	Type	Description
endpoint	path	True	string	Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com).

Request Header

Name	Required	Type	Description
Ocp-Apim-Subscription-Key	True	string	Provide your cognitive services subscription key here.

Responses

Name	Type	Description
200 OK	SupportedFileFormats	Returns the list of supported document file formats Headers Retry-After: integer
429 Too Many Requests	TranslationErrorResponse	Too many requests
500 Internal Server Error	TranslationErrorResponse	Internal Server Error
Other Status Codes	TranslationErrorResponse	Server temporary unavailable

Security

Ocp-Apim-Subscription-Key

Provide your cognitive services subscription key here.

Type: apiKey
In: header

Examples

Get Document Formats

Sample request

HTTP

GET {endpoint}/translator/text/batch/v1.0/documents/formats

Sample response

Status code:: 429

{
  "error": {
    "code": "RequestRateTooHigh",
    "message": "User's request rate is too high",
    "innerError": {
      "code": "RateTooHigh",
      "message": "Request rate is too high"
    }
  }
}

Status code:: 500

{
  "error": {
    "code": "InternalServerError",
    "message": "Internal Server Error",
    "innerError": {
      "code": "InternalServerError",
      "message": "Unexpected internal server error has occurred"
    }
  }
}

Status code:: 503

{
  "error": {
    "code": "ServiceUnavailable",
    "message": "Service is temporary unavailable",
    "innerError": {
      "code": "ServiceTemporaryUnavailable",
      "message": "Service is currently unavailable.  Please try again later"
    }
  }
}

Status code:: 200

retry-after: 30
ETag: 686897696a7c876b7e

{
  "value": [
    {
      "format": "PlainText",
      "fileExtensions": [
        ".txt"
      ],
      "contentTypes": [
        "text/plain"
      ]
    },
    {
      "format": "PortableDocumentFormat",
      "fileExtensions": [
        ".pdf"
      ],
      "contentTypes": [
        "application/pdf"
      ]
    },
    {
      "format": "OpenXmlWord",
      "fileExtensions": [
        ".docx"
      ],
      "contentTypes": [
        "application/vnd.openxmlformats-officedocument.wordprocessingml.document"
      ]
    },
    {
      "format": "OpenXmlPresentation",
      "fileExtensions": [
        ".pptx"
      ],
      "contentTypes": [
        "application/vnd.openxmlformats-officedocument.presentationml.presentation"
      ]
    },
    {
      "format": "OpenXmlSpreadsheet",
      "fileExtensions": [
        ".xlsx"
      ],
      "contentTypes": [
        "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet"
      ]
    },
    {
      "format": "HtmlFile",
      "fileExtensions": [
        ".html",
        ".htm"
      ],
      "contentTypes": [
        "text/html"
      ]
    }
  ]
}

Definitions

Name	Description
FileFormat
InnerTranslationError	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).
SupportedFileFormats	Base type for List return in our api
TranslationError	This contains an outer error with error code, message, details, target and an inner error with more descriptive details.
TranslationErrorCode	Enums containing high level error codes.
TranslationErrorResponse	Contains unified error information used for HTTP responses across any Cognitive Service. Instances can be created either through Microsoft.CloudAI.Containers.HttpStatusExceptionV2 or by returning it directly from a controller.

FileFormat

Object

Name	Type	Description
contentTypes	string[]	Supported Content-Types for this format
defaultVersion	string	Default version if none is specified
fileExtensions	string[]	Supported file extension for this format
format	string	Name of the format
versions	string[]	Supported Version

InnerTranslationError

Object

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).

Name	Type	Description
code	string	Gets code error string.
innerError	InnerTranslationError	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).
message	string	Gets high level error message.
target	string	Gets the source of the error. For example it would be "documents" or "document id" in case of invalid document.

SupportedFileFormats

Object

Base type for List return in our api

Name	Type	Description
value	FileFormat[]	list of objects

TranslationError

Object

This contains an outer error with error code, message, details, target and an inner error with more descriptive details.

Name	Type	Description
code	TranslationErrorCode	Enums containing high level error codes.
innerError	InnerTranslationError	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).
message	string	Gets high level error message.
target	string	Gets the source of the error. For example it would be "documents" or "document id" in case of invalid document.

TranslationErrorCode

Enumeration

Enums containing high level error codes.

Value	Description
InvalidRequest
InvalidArgument
InternalServerError
ServiceUnavailable
ResourceNotFound
Unauthorized
RequestRateTooHigh

TranslationErrorResponse

Object

Contains unified error information used for HTTP responses across any Cognitive Service. Instances can be created either through Microsoft.CloudAI.Containers.HttpStatusExceptionV2 or by returning it directly from a controller.

Name	Type	Description
error	TranslationError	This contains an outer error with error code, message, details, target and an inner error with more descriptive details.

Share via

Document Translation - Get Supported Document Formats

URI Parameters

Request Header

Responses

Security

Ocp-Apim-Subscription-Key

Examples

Get Document Formats

Sample request

Sample response

Definitions

FileFormat

InnerTranslationError

SupportedFileFormats

TranslationError

TranslationErrorCode

TranslationErrorResponse