Obter formatos de documento compatíveis
Referência
Serviço: Tradução de documentos da IA do Azure
Versão da API: v1.1
O método Obter formatos de documento com suporte retorna uma lista de formatos de documento compatíveis com o serviço Tradução de Documento. A lista inclui a extensão de arquivo comum e o tipo de conteúdo se estiver usando a API de upload.
URL da solicitação
Envie uma solicitação GET para:
GET https://<NAME-OF-YOUR-RESOURCE>.cognitiveservices.azure.com/translator/text/batch/v1.1/documents/formats
Saiba como localizar seu nome de domínio personalizado.
Importante
- Todas as solicitações de API ao serviço de Tradução de Documento exigem um ponto de extremidade de domínio personalizado.
- Não é possível usar o ponto de extremidade encontrado na página Chaves e ponto de extremidade de recursos do portal do Azure nem o ponto de extremidade do tradutor global (
api.cognitive.microsofttranslator.com) para fazer solicitações HTTP para a Tradução de Documento.
Cabeçalhos da solicitação
Os cabeçalhos de solicitação são:
| Cabeçalhos | Descrição |
|---|---|
| Ocp-Apim-Subscription-Key | Cabeçalho de solicitação necessário |
Códigos de status de resposta
Veja a seguir os possíveis códigos de status HTTP retornados por uma solicitação.
| Código de status | Descrição |
|---|---|
| 200 | OK. Retorna a lista de formatos de arquivo de documento com suporte. |
| 500 | Erro Interno do Servidor. |
| Outros códigos de status | • Excesso de pedidos • Servidor temporário indisponível |
Resposta de formato de arquivo
Resposta fileFormatListResult bem-sucedida
As informações a seguir são retornadas em uma resposta bem-sucedida.
| Nome | Tipo | Descrição |
|---|---|---|
| value | FileFormat [] | FileFormat[] contém os detalhes listados abaixo. |
| value.contentTypes | string[] | Tipos de conteúdo com suporte para este formato. |
| value.defaultVersion | string | Versão padrão se não houver nenhuma especificação. |
| value.fileExtensions | string[] | Extensão de arquivo com suporte para este formato. |
| value.format | string | Nome do formato. |
| value.versions | string [] | Versão compatível. |
Resposta de erro
| Nome | Tipo | Descrição |
|---|---|---|
| code | string | Enumerações contendo códigos de erro de alto nível. Valores possíveis: • InternalServerError • Argumento Inválido • Solicitação Inválida • RequestRateTooHigh • ResourceNotFound • ServiçoIndisponível •Desautorizado |
| message | string | Obtém uma mensagem de erro de alto nível. |
| innerError | InnerTranslationError | Novo formato de erro interno, em conformidade com as Diretrizes da API dos serviços de IA do Azure. Essa mensagem de erro contém as propriedades necessárias ErrorCode, mensagem e destino de propriedades opcionais, detalhes (par de valores de chave), erro interno (pode ser aninhado). |
| innerError.code | string | Obtém a cadeia de caracteres de erro do código. |
| innerError.message | string | Obtém uma mensagem de erro de alto nível. |
| innerError.target | string | Obtém a fonte do erro. Por exemplo, seria documents ou document id para um documento inválido. |
Exemplos
Exemplo de resposta bem-sucedida
O objeto JSON a seguir é um exemplo de uma resposta bem-sucedida.
Código de status: 200
{
"value": [
{
"format": "PlainText",
"fileExtensions": [
".txt"
],
"contentTypes": [
"text/plain"
],
"versions": []
},
{
"format": "OpenXmlWord",
"fileExtensions": [
".docx"
],
"contentTypes": [
"application/vnd.openxmlformats-officedocument.wordprocessingml.document"
],
"versions": []
},
{
"format": "OpenXmlPresentation",
"fileExtensions": [
".pptx"
],
"contentTypes": [
"application/vnd.openxmlformats-officedocument.presentationml.presentation"
],
"versions": []
},
{
"format": "OpenXmlSpreadsheet",
"fileExtensions": [
".xlsx"
],
"contentTypes": [
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet"
],
"versions": []
},
{
"format": "OutlookMailMessage",
"fileExtensions": [
".msg"
],
"contentTypes": [
"application/vnd.ms-outlook"
],
"versions": []
},
{
"format": "HtmlFile",
"fileExtensions": [
".html",
".htm"
],
"contentTypes": [
"text/html"
],
"versions": []
},
{
"format": "PortableDocumentFormat",
"fileExtensions": [
".pdf"
],
"contentTypes": [
"application/pdf"
],
"versions": []
},
{
"format": "XLIFF",
"fileExtensions": [
".xlf"
],
"contentTypes": [
"application/xliff+xml"
],
"versions": [
"1.0",
"1.1",
"1.2"
]
},
{
"format": "TSV",
"fileExtensions": [
".tsv",
".tab"
],
"contentTypes": [
"text/tab-separated-values"
],
"versions": []
},
{
"format": "CSV",
"fileExtensions": [
".csv"
],
"contentTypes": [
"text/csv"
],
"versions": []
},
{
"format": "RichTextFormat",
"fileExtensions": [
".rtf"
],
"contentTypes": [
"application/rtf"
],
"versions": []
},
{
"format": "WordDocument",
"fileExtensions": [
".doc"
],
"contentTypes": [
"application/msword"
],
"versions": []
},
{
"format": "PowerpointPresentation",
"fileExtensions": [
".ppt"
],
"contentTypes": [
"application/vnd.ms-powerpoint"
],
"versions": []
},
{
"format": "ExcelSpreadsheet",
"fileExtensions": [
".xls"
],
"contentTypes": [
"application/vnd.ms-excel"
],
"versions": []
},
{
"format": "OpenDocumentText",
"fileExtensions": [
".odt"
],
"contentTypes": [
"application/vnd.oasis.opendocument.text"
],
"versions": []
},
{
"format": "OpenDocumentPresentation",
"fileExtensions": [
".odp"
],
"contentTypes": [
"application/vnd.oasis.opendocument.presentation"
],
"versions": []
},
{
"format": "OpenDocumentSpreadsheet",
"fileExtensions": [
".ods"
],
"contentTypes": [
"application/vnd.oasis.opendocument.spreadsheet"
],
"versions": []
},
{
"format": "Markdown",
"fileExtensions": [
".markdown",
".mdown",
".mkdn",
".md",
".mkd",
".mdwn",
".mdtxt",
".mdtext",
".rmd"
],
"contentTypes": [
"text/markdown",
"text/x-markdown",
"text/plain"
],
"versions": []
},
{
"format": "Mhtml",
"fileExtensions": [
".mhtml",
".mht"
],
"contentTypes": [
"message/rfc822",
"application/x-mimearchive",
"multipart/related"
],
"versions": []
}
]
}
Exemplo de resposta com erro
O objeto JSON a seguir é um exemplo de uma resposta com erro. O esquema dos outros códigos de erro é o mesmo.
Código de status: 500
{
"error": {
"code": "InternalServerError",
"message": "Internal Server Error",
"innerError": {
"code": "InternalServerError",
"message": "Unexpected internal server error has occurred"
}
}
}
Próximas etapas
Siga nosso guia de início rápido para saber mais sobre como usar a Tradução de Documento e a biblioteca de clientes.