Tradutor 3.0: BreakSentence

Artigo
09/02/2024

Identifica o posicionamento dos limites das frases em um pedaço de texto.

URL do Pedido

Envie um pedido POST para:

https://api.cognitive.microsofttranslator.com/breaksentence?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-versão	Parâmetro de consulta necessário. Versão da API solicitada pelo cliente. O valor deve ser `3.0`.
idioma	Parâmetro de consulta opcional. Marca de idioma que identifica o idioma do texto de entrada. Se um código não for especificado, a deteção automática de idioma será aplicada.
.	Parâmetro de consulta opcional. Marca de script que identifica o script usado pelo texto de entrada. Se um script não for especificado, o script padrão da linguagem será assumido.

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. Os limites da frase são calculados para o valor da Text propriedade. Um corpo de solicitação de exemplo com um pedaço de texto tem a seguinte aparência:

[
    { "Text": "How are you? I am fine. What did you do today?" }
]

Aplicam-se as seguintes limitações:

A matriz pode ter no máximo 100 elementos.
O valor de texto de um elemento de matriz não pode exceder 50.000 caracteres, incluindo espaços.
O texto inteiro incluído na solicitação não pode exceder 50.000 caracteres, incluindo espaços.
Se o language parâmetro query for especificado, todos os elementos da matriz deverão estar no mesmo idioma. Caso contrário, a deteção automática de idioma será aplicada a cada elemento da matriz de forma independente.

Corpo da resposta

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

sentLen: Uma matriz de inteiros que representa os comprimentos das frases no elemento text. O comprimento da matriz é o número de frases, e os valores são o comprimento de cada frase.
detectedLanguage: Um objeto que descreve o idioma detetado através das seguintes propriedades:
- language: Código do idioma detetado.
- score: Um valor flutuante que indica a confiança no resultado. A pontuação está entre zero (0) e um (1,0). Uma pontuação baixa (<= 0,4) indica uma baixa confiança.

A detectedLanguage propriedade só está presente no objeto de resultado quando a deteção automática de idioma é solicitada.

Um exemplo de resposta JSON é:

[
    {
        "detectedLanguage": {
            "language": "en",
            "score": 1.0
        },
        "sentLen": [
            13,
            11,
            22
        ]
    }
]

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 de resposta 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 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 obter limites de frase para uma única frase. O serviço deteta automaticamente o idioma da frase.

curl -X POST "https://api.cognitive.microsofttranslator.com/breaksentence?api-version=3.0" -H "Ocp-Apim-Subscription-Key: <client-secret>" -H "Content-Type: application/json" -d "[{'Text':'How are you? I am fine. What did you do today?'}]"

Partilhar via