Traductor 3.0: BreakSentence

Artículo
06/13/2024

Identifica el posicionamiento de los límites de las oraciones en un fragmento de texto.

URL de la solicitud

Envíe una solicitud POST a:

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

ConsulteCompatibilidad con Virtual Network para conocer la configuración y la compatibilidad de la red y el punto de conexión privado seleccionados del servicio Traductor.

Parámetros de solicitud

Los parámetros de solicitud que se pasaron en la cadena de consulta son:

Parámetro de consulta	Descripción
api-version	parámetro de consulta obligatorio. Versión de la API que el cliente solicitó. El valor debe ser `3.0`.
language	Parámetro de consulta opcional. Etiqueta de idioma que identifica el idioma del texto de entrada. Si no se especifica un código, se aplicará la detección automática del lenguaje.
script	Parámetro de consulta opcional. Etiqueta de script que identifica el script que usa el texto de entrada. Si no se especifica un script, se asumirá el script predeterminado del lenguaje.

Los encabezados de solicitud incluyen lo siguiente:

encabezados	Descripción
Encabezados de autenticación	Encabezado de solicitud obligatorio. Consulte las opciones disponibles para la autenticación.
Content-Type	Encabezado de solicitud obligatorio. Especifica el tipo de contenido de la carga. Los valores posibles son: `application/json`.
Content-Length	Opcional. Longitud del cuerpo de la solicitud.
X-ClientTraceId	Opcional. GUID generado por el cliente para identificar de forma única la solicitud. Puede omitir este encabezado si incluye el id. de seguimiento en la cadena de la consulta mediante un parámetro de consulta denominado `ClientTraceId`.

Cuerpo de la solicitud

El cuerpo de la solicitud es una matriz JSON. Cada elemento de la matriz es un objeto JSON con una propiedad de cadena denominada Text. Los límites de la oración se calculan en función del valor de la propiedad Text. Un cuerpo de la solicitud de muestra con una sola pieza de texto tiene este aspecto:

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

Se aplican las siguientes limitaciones:

La matriz puede tener como máximo 100 elementos.
El valor de texto de un elemento de la matriz no puede superar los 50 000 caracteres, incluidos los espacios.
El texto completo incluido en la solicitud no puede superar los 50 000 caracteres, incluidos los espacios.
Si se especifica el parámetro de consulta language, todos los elementos de la matriz deberán estar en el mismo idioma. De lo contrario, la autodetección del lenguaje se aplica a cada elemento de la matriz de forma independiente.

Response body

Una respuesta correcta es una matriz JSON con un resultado para cada cadena en la matriz de entrada. Un objeto del resultado incluye las siguientes propiedades:

sentLen: es una matriz de enteros que representan las longitudes de las oraciones en el elemento de texto. La longitud de la matriz es el número de oraciones y los valores son la longitud de cada oración.
detectedLanguage: objeto que describe el idioma detectado mediante las siguientes propiedades:
- language: Código del idioma detectado.
- score: valor flotante que indica la confianza en el resultado. La puntuación se encuentra entre cero (0) y uno (1.0). Una puntuación baja (<= 0,4) indica una confianza baja.

La propiedad detectedLanguage solo está presente en el objeto de resultado cuando se solicita la detección automática de idioma.

Un ejemplo de respuesta JSON es:

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

Encabezados de respuesta

encabezados	Descripción
X-RequestId	Valor generado por el servicio para identificar la solicitud y usarse con fines de solución de problemas.

Códigos de estado de respuesta

A continuación se indican los códigos de estado HTTP posibles que devuelve una solicitud.

Código de estado	Descripción
200	Correcto.
400	Uno de los parámetros de consulta falta o no es válido. Corrija los parámetros de la solicitud antes de volver a intentarlo.
401	No pudo autenticarse la solicitud. Compruebe que las credenciales que se especificaron sean correctas.
403	La solicitud no está autorizada. Compruebe los detalles del mensaje de error. Este código de respuesta suele indicar que se usan todas las traducciones gratuitas proporcionadas con una suscripción de prueba.
429	El servidor rechazó la solicitud porque el cliente superó los límites de solicitud.
500	Se ha producido un error inesperado. Si el error continúa, notifíquelo con: fecha y hora del error, identificador de la solicitud del encabezado de respuesta `X-RequestId` e identificador de cliente del encabezado de solicitud `X-ClientTraceId`.
503	Servidor no disponible temporalmente. Vuelva a intentarlo. Si el error continúa, notifíquelo con: fecha y hora del error, identificador de la solicitud del encabezado de respuesta `X-RequestId` e identificador de cliente del encabezado de solicitud `X-ClientTraceId`.

Si se produce un error, la solicitud devuelve una respuesta de error JSON. El código de error es un número de 6 dígitos que combina el código de estado HTTP de 3 dígitos y otro número de 3 dígitos que ayuda a categorizar aún más el error. En la página de referencia de Traductor v3 pueden encontrarse los códigos de error comunes.

Ejemplos

En el siguiente ejemplo se muestra cómo obtener límites de oraciones para una sola oración. El servicio detecta automáticamente el lenguaje de las oraciones.

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?'}]"

Compartir vía