Solicitud y respuesta

Esta es una sección de configuración de MT personalizado. Esta sección contiene la configuración principal para las solicitudes de Traducción Automática.

Variables

• $ID

• $SOURCE_TEXT o $ORIGINAL_TEXT

• $TRANSLATED_TEXT

• $SOURCE_LANG

• $TARGET_LANG

Las variables del esquema pueden usarse en la configuración con la sintaxis $SCHEMA_NAME.

Por ejemplo:

{
    "schema": [
        { "type": "string", "name": "api_key", "title": "API Key", "default": "", "required": true, "message": "Required an API Key" },
    ],
    "request": {
        "method": "http_post",
        "url": "http://127.0.01/?key=$API_KEY"
        "options": {
            "headers": {
              "Authorization": "Bearer $API_KEY",
              "Content-Type": "application/json"
            }
        }        
    }
}

---

Parámetros

método: cadena

• "web_scraping"

• "http_get"

• "http_post"

• "web_llm"

initialUrl: cadena (opcional)

La URL inicial a visitar antes de realizar la solicitud real (para web scraping).

url: cadena

La URL del endpoint para el servicio de Traducción Automática.

encodeURI: booleano (opcional)

Escapa caracteres usando unidades de código UTF-8, con cada octeto codificado en el formato %XX, rellenado a la izquierda con 0 si es necesario. Los sustitutos solitarios en UTF-16 no codifican ningún carácter Unicode válido. Referencia: encodeURI

encodeURIComponent: booleano (opcional)

Usa el mismo algoritmo de codificación que encodeURI. Escapa todos los caracteres excepto: A–Z a–z 0–9 - _ . ! ~ * ' ( ) Referencia: encodeURIComponent

encodeURIExtra: cadena (opcional)

Función adicional para reemplazar la URI usando una expresión regular. Por ejemplo: ["%2F", "g", "\\%2F"]

userAgent: cadena (opcional)

Cadena User-Agent personalizada para la solicitud HTTP.

querySelector: cadena

Devuelve el primer elemento dentro del documento HTML que coincida con el selector especificado o grupo de selectores. Referencia: querySelector

querySelectorAll: cadena (opcional)

Devuelve un NodeList estático que representa una lista de elementos HTML que coinciden con el grupo de selectores especificado. Referencia: querySelectorAll

queryProperty: cadena

Especifica qué propiedad extraer del elemento HTML seleccionado:

• "value" - propiedad del HTMLDataElement [Reference]

• "innerText" - propiedad del HTMLElement [Reference]

• "textContent" - propiedad del Node [Reference]

• "innerHTML" - propiedad del HTMLElement [Reference]

body: objeto

El cuerpo de la solicitud para peticiones POST. Puede contener variables como $SOURCE_TEXT, $SOURCE_LANG, y $TARGET_LANG.

options: objeto (opcional)

Opciones adicionales de la solicitud.

• headers - Establecer encabezados personalizados de la solicitud:

  • X-Custom-Header: cadena

  • Authorization: cadena

  • Content-Type: cadena

responseType: cadena

• "string" - establecer el tipo de respuesta como cadena

• "json" - establecer el tipo de respuesta como json

responseQuery: cadena

---

Analizando respuestas JSON de solicitudes HTTP

Las respuestas JSON pueden analizarse usando el responseQuery parámetro.

El responseQuery el parámetro se usa solo para http_get y http_post métodos cuando el tipo de respuesta se establece en json.

Para navegar por objetos JSON anidados, use la notación de puntos (.) para separar nombres de campos. Los elementos de arrays pueden accederse usando la notación de corchetes con un índice (por ejemplo, [0]).

Ejemplo de respuesta JSON:

{
  "text": "Hello 1",
  "words": [
    { "text": "Hello 2" },
    { "text": "Hello 3" }
  ]
  "lines": {
    "text": "Hello 4",
    "sub": {
      "text": "Hello 5"
    }        
  }
}

responseQuery	Resultado
texto	Hello 1
words[0].text	Hello 2
lines.sub.text	Hello 5

---

---

Ejemplos

1. Método de Web Scraping

Parámetros requeridos

• método: cadena ("web_scraping")

• url: cadena

• querySelector: cadena

• queryProperty: cadena

{
    "request": {
        "method": "web_scraping",
        "encodeURI": false,
        "encodeURIComponent": true, 
        "initialUrl": "https://localhost:8080",
        "url": "https://localhost:8080/?sl=$SOURCE_LANG&tl=$TARGET_LANG&text=$SOURCE_TEXT",    
        "querySelector": "span[lang=$TARGET_LANG]",
        "queryProperty": "innerText"
    }
}

---

2. Método HTTP GET

Parámetros requeridos

• método: cadena ("http_get")

• url: cadena

• responseType: cadena

• responseQuery: cadena

{
    "request": {
        "method": "http_get",
        "encodeURI": false,
        "encodeURIComponent": false, 
        "url": "https://localhost:8080/translate?sl=$SOURCE_LANG&tl=$TARGET_LANG&text=$SOURCE_TEXT",
        "options": {},
        "responseType": "json",
        "responseQuery": "translate.result"
    }
}

---

3. Método HTTP POST

Parámetros requeridos

• método: cadena ("http_post")

• url: cadena

• cuerpo: objeto

• opciones: objeto

  • headers: objeto

    • X-Custom-Header: string

    • Authorization: string

    • Content-Type: string

• responseType: cadena

• responseQuery: cadena

{
    "request": {
        "method": "http_post",
        "encodeURI": false,
        "encodeURIComponent": false, 
        "url": "https://localhost:8080/translate",
        "body": {
            "text": "$SOURCE_TEXT",
            "source_lang": "$SOURCE_LANG",
            "target_lang": "$TARGET_LANG"
        }
        "options": {
            "headers": {
                "Authorization": "Bearer $API_KEY",
                "Content-Type": "application/json"
            }
        },
        "responseType": "json",
        "responseQuery": "translate.result"
    }
}