Tradutor 3.0: Transliterate

  • Artigo

Converte texto em um idioma de um script em outro script.

URL da solicitação

Envie uma solicitação POST para:

https://api.cognitive.microsofttranslator.com/transliterate?api-version=3.0

ConfiraSuporte à Rede Virtual para ver a configuração e o suporte de ponto de extremidade privado e de rede selecionado do serviço de Tradução.

Parâmetros da solicitação

Os parâmetros de solicitação passados na cadeia de caracteres de consulta são:

Parâmetro de consulta Descrição
api-version Parâmetro obrigatório.
Versão da API solicitada pelo cliente. O valor precisa ser 3.0.
Linguagem Parâmetro obrigatório.
Especifica o idioma do texto a converter de um script para outro. Idiomas possíveis estão listados no escopo de transliteration obtido consultando o serviço para os seus idiomas compatíveis.
fromScript Parâmetro obrigatório.
Especifica o script usado pelo texto de entrada. Pesquisa linguagens compatíveis usando o escopo transliteration para localizar os scripts de entrada disponíveis para a linguagem selecionada.
toScript Parâmetro obrigatório.
Especifica o script de saída. Pesquisa linguagens compatíveis usando o escopo transliteration para localizar os scripts de saída disponíveis para a combinação selecionada de linguagem de entrada e script de entrada.

Os cabeçalhos de solicitação incluem:

Cabeçalhos Descrição
Cabeçalhos de autenticação Cabeçalho de solicitação obrigatório.
Veja Opções disponíveis para autenticação.
Tipo de conteúdo Cabeçalho de solicitação obrigatório.
Especifica o tipo de conteúdo da carga. Os valores possíveis são os seguintes: application/json
Content-Length Cabeçalho de solicitação obrigatório.
O tamanho do corpo da solicitação.
X-ClientTraceId Opcional.
Um GUID gerado pelo cliente para identificar exclusivamente a solicitação. É possível omitir esse cabeçalho se incluir a ID de rastreamento na cadeia de caracteres de consulta usando um parâmetro de consulta nomeado ClientTraceId.

Corpo da solicitação

O corpo da solicitação é uma matriz JSON. Cada elemento da matriz é um objeto JSON com uma propriedade de cadeia de caracteres denominada Text, que representa a cadeia de caracteres a converter.

[
    {"Text":"こんにちは"},
    {"Text":"さようなら"}
]

As seguintes limitações se aplicam:

  • A matriz pode ter no máximo 10 elementos.
  • O valor de texto de um elemento de matriz não pode exceder 1.000 caracteres, incluindo os espaços.
  • Todo o texto incluído na solicitação não pode exceder 5.000 caracteres, incluindo espaços.

Corpo da resposta

Uma resposta bem-sucedida é uma matriz JSON com um resultado para cada elemento na matriz de entrada. Um objeto de resultado inclui as seguintes propriedades:

  • text: uma cadeia de caracteres que resulta da conversão da cadeia de caracteres de entrada no script de saída.

  • script: uma cadeia de caracteres especificando o script usado na saída.

Um exemplo de resposta JSON é:

[
    {"text":"konnnichiha","script":"Latn"},
    {"text":"sayounara","script":"Latn"}
]

Cabeçalhos de resposta

Cabeçalhos Descrição
X-RequestId Valor gerado pelo serviço para identificar a solicitação. É usado para fins de solução de problemas.

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 Êxito.
400 Um dos parâmetros de consulta está ausente ou não é válido. Corrija os parâmetros de solicitação antes de tentar novamente.
401 A solicitação não pôde ser autenticada. Verifique se as credenciais estão especificadas e são válidas.
403 A solicitação não está autorizada. Verifique os detalhes da mensagem de erro. Esse código geralmente indica que todas as traduções gratuitas fornecidas com uma assinatura de avaliação foram usadas.
429 O servidor rejeitou a solicitação porque o cliente excedeu os limites de solicitação.
500 Erro inesperado. Se o erro persistir, relate-o com: data e hora da falha, identificador da solicitação do cabeçalho de resposta X-RequestId e identificador do cliente do cabeçalho de solicitação X-ClientTraceId.
503 Servidor temporariamente não disponível. Tente novamente a solicitação. Se o erro persistir, relate-o com: data e hora da falha, identificador da solicitação do cabeçalho de resposta X-RequestId e identificador do cliente do cabeçalho de solicitação X-ClientTraceId.

Se ocorrer um erro, a solicitação também retornará uma resposta de erro JSON. O código de erro é um número de 6 dígitos que combina o código de status HTTP de 3 dígitos seguido por um número de 3 dígitos para categorizar ainda mais o erro. Códigos de erros comuns que podem ser encontrados na página de referência do Tradutor v3.

Exemplos

O exemplo a seguir mostra como converter duas cadeias de caracteres japonesas em japonês romanizado.

O conteúdo JSON para a solicitação neste exemplo:

[{"text":"こんにちは","script":"jpan"},{"text":"さようなら","script":"jpan"}]

Se você estiver usando cURL em uma janela da linha de comando que não seja compatível com os caracteres Unicode, pegue o seguinte conteúdo JSON e salve-o em um arquivo denominado request.txt. Salve o arquivo com a codificação UTF-8.

curl -X POST "https://api.cognitive.microsofttranslator.com/transliterate?api-version=3.0&language=ja&fromScript=Jpan&toScript=Latn" -H "X-ClientTraceId: 875030C7-5380-40B8-8A03-63DACCF69C11" -H "Ocp-Apim-Subscription-Key: <client-secret>" -H "Content-Type: application/json" -d @request.txt