Solicitação e Resposta

Esta é uma seção de configuração de MT Personalizado. Esta seção contém a configuração central para solicitações de Tradução Automática.

Variáveis

• $ID

• $SOURCE_TEXT ou $ORIGINAL_TEXT

• $TRANSLATED_TEXT

• $SOURCE_LANG

• $TARGET_LANG

Variáveis de esquema podem ser usadas na configuração com a sintaxe $SCHEMA_NAME.

Por exemplo:

{
    "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

method: string

• "web_scraping"

• "http_get"

• "http_post"

• "web_llm"

initialUrl: string (opcional)

A URL inicial a ser visitada antes de fazer a solicitação real (para web scraping).

url: string

A URL do endpoint para o serviço de Tradução Automática.

encodeURI: booleano (opcional)

Escapa caracteres usando unidades de código UTF-8, com cada octeto codificado no formato %XX, preenchido à esquerda com 0 se necessário. Substitutos isolados em UTF-16 não codificam nenhum caractere Unicode válido. Referência: encodeURI

encodeURIComponent: booleano (opcional)

Usa o mesmo algoritmo de codificação que encodeURI. Escapa todos os caracteres exceto: A–Z a–z 0–9 - _ . ! ~ * ' ( ) Referência: encodeURIComponent

encodeURIExtra: string (opcional)

Função adicional para substituir a URI usando uma expressão regular. Por exemplo: ["%2F", "g", "\\%2F"]

userAgent: string (opcional)

String User-Agent personalizada para a requisição HTTP.

querySelector: string

Retorna o primeiro elemento dentro do documento HTML que corresponde ao seletor especificado ou grupo de seletores. Referência: querySelector

querySelectorAll: string (opcional)

Retorna uma NodeList estática representando uma lista de elementos HTML que correspondem ao grupo especificado de seletores. Referência: querySelectorAll

queryProperty: string

Especifica qual propriedade extrair do elemento HTML selecionado:

• "value" - propriedade do HTMLDataElement [Referência]

• "innerText" - propriedade do HTMLElement [Referência]

• "textContent" - propriedade do Node [Referência]

• "innerHTML" - propriedade do HTMLElement [Referência]

body: objeto

O corpo da requisição para pedidos POST. Pode conter variáveis como $SOURCE_TEXT, $SOURCE_LANG, e $TARGET_LANG.

options: objeto (opcional)

Opções adicionais da requisição.

• headers - Defina cabeçalhos de requisição personalizados:

  • X-Custom-Header: string

  • Authorization: string

  • Content-Type: string

responseType: string

• "string" - define o tipo de resposta como string

• "json" - define o tipo de resposta como json

responseQuery: string

---

Analisando respostas JSON de requisições HTTP

Respostas JSON podem ser analisadas usando o responseQuery parâmetro.

O responseQuery o parâmetro é usado apenas para http_get e http_post métodos quando o tipo de resposta está definido como json.

Para navegar por objetos JSON aninhados, use a notação de ponto (.) para separar nomes de campos. Elementos de array podem ser acessados usando a notação de colchetes com um índice (por exemplo, [0]).

Exemplo de Resposta 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

---

---

Exemplos

1. Método de Web Scraping

Parâmetros Obrigatórios

• method: string ("web_scraping")

• url: string

• querySelector: string

• queryProperty: string

{
    "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 Obrigatórios

• method: string ("http_get")

• url: string

• responseType: string

• responseQuery: string

{
    "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 Obrigatórios

• method: string ("http_post")

• url: string

• body: objeto

• options: objeto

  • headers: objeto

    • X-Custom-Header: string

    • Authorization: string

    • Content-Type: string

• responseType: string

• responseQuery: string

{
    "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"
    }
}