Obter formatos de glossário compatíveis

Artigo
09/02/2024

Recurso de referência
: Azure AI Translator → Versão da API de Tradução de Documentos
: 2024-05-01
Método HTTP: GET

Esse método retorna uma lista de formatos de glossário compatíveis com o recurso Tradução de Documentos. A lista inclui as extensões de arquivo comuns.

URL de solicitação

Importante

Todas as solicitações de API para o recurso de Tradução de Documento exigem um ponto de extremidade de domínio personalizado localizado na página de visão geral do recurso no portal do Azure.

curl -i -X GET "{document-translation-endpoint}/translator/document/formats?api-version={date}&type=glossary"

Cabeçalhos da solicitação

Os cabeçalhos de solicitação são:

Cabeçalhos	Descrição	Condição
Ocp-Apim-Subscription-Key	Sua chave de API do serviço Tradutor do portal do Azure.	Obrigatório
Ocp-Apim-Subscription-Region	A região em que o recurso foi criado.	Necessário ao usar um recurso regional (geográfico) como o Oeste dos EUA. &bullet.
Content-Type	O tipo de conteúdo da carga. Os valores aceitos são application/json ou charset=UTF-8.	Obrigató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 glossário com suporte.
500	Erro Interno do Servidor.
Outros códigos de status	• Muitos pedidos • Servidor temporariamente indisponível

Resposta do Obter formatos de glossário compatíveis

Tipo base para o retorno de lista na API Obter formatos de glossário compatíveis.

Resposta com sucesso do Obter formatos de glossário compatíveis

Tipo base para o retorno de lista na API Obter formatos de glossário compatíveis.

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: • Erro de servidor interno • 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. Esta mensagem de erro contém as propriedades necessárias ErrorCode, mensagem e propriedades opcionais target, details(par de valores-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` se houvesse um documento inválido.

Exemplos

Exemplo de resposta bem-sucedida

O objeto JSON a seguir é um exemplo de uma resposta bem-sucedida.

{
    "value": [
        {
            "format": "XLIFF",
            "fileExtensions": [
                ".xlf"
            ],
            "contentTypes": [
                "application/xliff+xml"
            ],
            "defaultVersion": "1.2",
            "versions": [
                "1.0",
                "1.1",
                "1.2"
            ]
        },
        {
            "format": "TSV",
            "fileExtensions": [
                ".tsv",
                ".tab"
            ],
            "contentTypes": [
                "text/tab-separated-values"
            ]
        },
        {
            "format": "CSV",
            "fileExtensions": [
                ".csv"
            ],
            "contentTypes": [
                "text/csv"
            ]
        }
    ]
}

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.

Introdução à Tradução de Documento

Compartilhar via