Translator 3.0: Ejemplos de diccionario

  • Artículo

Proporciona ejemplos que muestran cómo se usan los términos del diccionario en el contexto. Esta operación se usa junto con la opción Búsqueda de diccionario.

URL de la solicitud

Envíe una solicitud POST a:

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

ConsulteCompatibilidad con redes virtuales para obtener información sobre la compatibilidad y la configuración de puntos de conexión privados y redes seleccionadas para el servicio Translator.

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 obligatorio.
Versión de la API que el cliente solicitó. El valor debe ser 3.0.
desde Parámetro obligatorio.
Especifica el idioma del texto de entrada. El idioma de origen debe ser uno de los idiomas admitidos que están incluidos en el ámbito dictionary.
to Parámetro obligatorio.
Especifica el idioma del texto de salida. El idioma de destino debe ser uno de los idiomas admitidos que están incluidos en el ámbito dictionary.

Los encabezados de solicitud incluyen lo siguiente:

encabezados Descripción
Encabezados de autenticación Encabezado de solicitud obligatorio.
Consulte Autenticación>opciones disponibles para autenticación.
Content-Type Encabezado de solicitud obligatorio.
Especifica el tipo de contenido de la carga. Los valores posibles son: application/json.
Content-Length Encabezado de solicitud obligatorio.
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 que consta de las siguientes propiedades:

  • Text: cadena que especifica el término que se va a buscar. Esta propiedad debería ser el valor de un campo normalizedText de las traducciones inversas de una solicitud de búsqueda en el diccionario anterior. También puede ser el valor del campo normalizedSource.

  • Translation: cadena que especifica el texto traducido que previamente devolvió la operación Búsqueda de diccionario. Esta propiedad debería ser el valor del campo normalizedTarget en la lista translations de la respuesta de la búsqueda en el diccionario. El servicio devuelve ejemplos para el par de palabras "origen-destino" específico.

Ejemplo:

[
    {"Text":"fly", "Translation":"volar"}
]

Se aplican las siguientes limitaciones:

  • La matriz puede tener como máximo 10 elementos.
  • El valor de texto de un elemento de matriz no puede superar los 100 caracteres, incluidos los espacios.

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:

  • normalizedSource: cadena que proporciona la forma normalizada del término de origen. En general, esta propiedad debería ser idéntica al valor del campo Text en el índice de la lista de coincidencias del cuerpo de la solicitud.

  • normalizedTarget: cadena que proporciona la forma normalizada del término de destino. En general, esta propiedad debería ser idéntica al valor del campo Translation en el índice de la lista de coincidencias del cuerpo de la solicitud.

  • examples: lista de ejemplos del par (término de origen y de destino). Cada elemento de la lista es un objeto que consta de las siguientes propiedades:

  • sourcePrefix: cadena que se va a concatenar antes del valor de sourceTerm para formar un ejemplo completo. No agregue un espacio, porque ya estará ahí cuando sea necesario. Este valor puede ser una cadena vacía.

  • sourceTerm: cadena equivalente al término real que se esta buscando. La cadena se agrega con sourcePrefix y sourceSuffix para formar el ejemplo completo. Su valor está separado, por lo que se puede marcar en una interfaz de usuario, por ejemplo, poniéndolo en negrita.

    • sourceSuffix: cadena que se va a concatenar después del valor de sourceTerm para formar un ejemplo completo. No agregue un espacio, porque ya estará ahí cuando sea necesario. Este valor puede ser una cadena vacía.

    • targetPrefix: cadena similar a sourcePrefix que se usa en el destino.

    • targetTerm: cadena similar a sourceTerm que se usa en el destino.

    • targetSuffix: cadena similar a sourceSuffix que se usa en el destino.

      Nota

      Si no hay ejemplos en el diccionario, la respuesta es 200 (OK), pero la lista examples será una lista vacía.

Ejemplos

En este ejemplo se muestra cómo buscar ejemplos de la pareja formada por el término inglés fly y su traducción al español volar.

curl -X POST "https://api.cognitive.microsofttranslator.com/dictionary/examples?api-version=3.0&from=en&to=es" -H "Ocp-Apim-Subscription-Key: <client-secret>" -H "Content-Type: application/json" -d "[{'Text':'fly', 'Translation':'volar'}]"

El cuerpo de la respuesta (abreviado para mayor claridad) es:

[
    {
        "normalizedSource":"fly",
        "normalizedTarget":"volar",
        "examples":[
            {
                "sourcePrefix":"They need machines to ",
                "sourceTerm":"fly",
                "sourceSuffix":".",
                "targetPrefix":"Necesitan máquinas para ",
                "targetTerm":"volar",
                "targetSuffix":"."
            },
            {
                "sourcePrefix":"That should really ",
                "sourceTerm":"fly",
                "sourceSuffix":".",
                "targetPrefix":"Eso realmente debe ",
                "targetTerm":"volar",
                "targetSuffix":"."
            },
            //
            // ...list abbreviated for documentation clarity
            //
        ]
    }
]