Tradutor 3.0: detectar

Artigo
09/02/2024

Identifica o idioma de uma parte do texto.

URL da solicitação

Envie uma solicitação POST para:

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

Consulte Suporte de Rede Virtual para configuração e suporte de rede e ponto de extremidade privado selecionados do serviço Translator.

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

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: `application/json`.
Content-Length	Opcional. 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 chamada Text. A detecção de idioma é aplicada ao valor da propriedade Text. A detecção automática de idioma funciona melhor com texto de entrada mais longo. Um corpo de solicitação de exemplo é semelhante a:

[
    { "Text": "Ich würde wirklich gerne Ihr Auto ein paar Mal um den Block fahren." }
]

As seguintes limitações se aplicam:

A matriz pode ter no máximo 100 elementos.
Todo o texto incluído na solicitação não pode exceder 50 mil caracteres, incluindo espaços.

Corpo da resposta

Uma resposta com êxito é uma matriz JSON com um resultado para cada cadeia de caracteres na matriz de entrada. Um objeto de resultado inclui as seguintes propriedades:

language: o código do idioma detectado.
score: um valor flutuante indicando a confiança no resultado. A pontuação é entre zero e um, e uma pontuação baixa indica uma baixa confiança.
isTranslationSupported: um valor booliano que será verdadeiro, se o idioma detectado for um dos idiomas com suporte para tradução de texto.
isTransliterationSupported: um valor booliano que será verdadeiro, se o idioma detectado for um dos idiomas com suporte para transliteração.
alternatives: uma matriz de outros idiomas possíveis. Cada elemento da matriz é outro objeto com as seguintes propriedades: language, score, isTranslationSupportede isTransliterationSupported.

Um exemplo de resposta JSON é:

[

    {

        "language": "de",

        "score": 1.0,

        "isTranslationSupported": true,

        "isTransliterationSupported": false

    }

]

Cabeçalhos de resposta

Cabeçalhos	Descrição
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

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 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, 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 recuperar os idiomas compatíveis para a tradução de texto.

curl -X POST "https://api.cognitive.microsofttranslator.com/detect?api-version=3.0" -H "Ocp-Apim-Subscription-Key: <client-secret>" -H "Content-Type: application/json" -d "[{'Text':'What language is this text written in?'}]"

Compartilhar via