Tradutor 3.0: Transliterado

Artigo
09/02/2024

Converte texto em um idioma de um script para outro.

URL do Pedido

Envie um pedido POST para:

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

Consulte Suporte de rede virtual para configuração e suporte de rede selecionada e ponto final privado e de rede selecionada.

Parâmetros de solicitação

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

Parâmetro de consulta	Description
api-version	Parâmetro necessário. Versão da API solicitada pelo cliente. O valor deve ser `3.0`.
idioma	Parâmetro necessário. Especifica o idioma do texto a ser convertido de um script para outro. Os idiomas possíveis são listados no `transliteration` escopo obtido consultando o serviço para seus idiomas suportados.
fromScript	Parâmetro necessário. Especifica o script usado pelo texto de entrada. Procure idiomas suportados usando o `transliteration` escopo, para encontrar scripts de entrada disponíveis para o idioma selecionado.
toScript	Parâmetro necessário. Especifica o script de saída. Procure idiomas suportados usando o `transliteration` escopo, para encontrar scripts de saída disponíveis para a combinação selecionada de idioma de entrada e script de entrada.

Os cabeçalhos de solicitação incluem:

Cabeçalhos	Description
Cabeçalhos de autenticação	Cabeçalho de solicitação obrigatório. Consulte as 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 útil. Os valores possíveis são: `application/json`
Comprimento do conteúdo	Opcional. O comprimento do corpo do pedido.
X-ClientTraceId	Opcional. Um GUID gerado pelo cliente para identificar exclusivamente a solicitação. Você pode omitir esse cabeçalho se incluir a ID de rastreamento na cadeia de caracteres de consulta usando um parâmetro de consulta chamado `ClientTraceId`.

Corpo do pedido

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

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

Aplicam-se as seguintes limitações:

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 espaços.
O texto inteiro 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 result inclui as seguintes propriedades:

text: Uma cadeia de caracteres que resulta da conversão da cadeia de caracteres de entrada para o 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	Description
X-RequestId	Valor gerado pelo serviço para identificar a solicitação e usado para fins de solução de problemas.

Códigos de status de resposta

A seguir estão os possíveis códigos de status HTTP que uma solicitação retorna.

Código de Estado	Description
200	Êxito.
400	Um dos parâmetros de consulta está em falta ou não é válido. Corrija os parâmetros de solicitação antes de tentar novamente.
401	Não foi possível autenticar o pedido. Verifique se as credenciais são especificadas e válidas.
403	O pedido não está autorizado. Verifique a mensagem de erro de detalhes. Esse código geralmente indica que todas as traduções gratuitas fornecidas com uma assinatura de avaliação são usadas.
429	O servidor rejeitou a solicitação porque o cliente excedeu os limites de solicitação.
500	Erro inesperado. Se o erro persistir, informe-o com: data e hora da falha, identificador de solicitação do cabeçalho `X-RequestId`da resposta e identificador do cliente do cabeçalho `X-ClientTraceId`da solicitação.
503	Servidor temporariamente indisponível. Repita o pedido. Se o erro persistir, informe-o com: data e hora da falha, identificador de solicitação do cabeçalho `X-RequestId`da resposta e identificador do cliente do cabeçalho `X-ClientTraceId`da solicitação.

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. Os códigos de erro comuns 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.

A carga JSON para a solicitação neste exemplo:

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

Se você estiver usando cURL em uma janela de linha de comando que não suporta caracteres Unicode, pegue a seguinte carga JSON e salve-a em um arquivo chamado request.txt. Certifique-se de salvar o arquivo com UTF-8 codificação.

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

Partilhar via