Požadavek a odpověď

Toto je konfigurační sekce Vlastní MT. Tato sekce obsahuje základní konfiguraci pro požadavky strojového překladu.

Proměnné

• $ID

• $SOURCE_TEXT nebo $ORIGINAL_TEXT

• $TRANSLATED_TEXT

• $SOURCE_LANG

• $TARGET_LANG

Proměnné schématu lze v konfiguraci použít se syntaxí $SCHEMA_NAME.

Například:

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

---

Parametry

method: string

• "web_scraping"

• "http_get"

• "http_post"

• "web_llm"

initialUrl: string (volitelné)

Počáteční URL ke návštěvě před provedením samotného požadavku (pro web scraping).

url: string

Cílové URL koncového bodu pro službu strojového překladu.

encodeURI: boolean (volitelné)

Escapuje znaky pomocí UTF-8 kódových jednotek, přičemž každý oktet je zakódován ve formátu %XX, v případě potřeby doplněno nulou zleva. Samostatné surrogáty v UTF-16 nezkódují žádný platný znak Unicode. Odkaz: encodeURI

encodeURIComponent: boolean (volitelné)

Používá stejný kódovací algoritmus jako encodeURI. Escapuje všechny znaky kromě: A–Z a–z 0–9 - _ . ! ~ * ' ( ) Odkaz: encodeURIComponent

encodeURIExtra: string (volitelné)

Dodatečná funkce pro nahrazení URI pomocí regulárního výrazu. Například: ["%2F", "g", "\\%2F"]

userAgent: string (volitelné)

Vlastní řetězec User-Agent pro HTTP požadavek.

querySelector: string

Vrací první prvek v HTML dokumentu, který odpovídá zadanému selektoru nebo skupině selektorů. Odkaz: querySelector

querySelectorAll: string (volitelné)

Vrací statický NodeList představující seznam HTML prvků, které odpovídají zadané skupině selektorů. Odkaz: querySelectorAll

queryProperty: string

Určuje, kterou vlastnost extrahovat z vybraného HTML prvku:

• "value" - vlastnost HTMLDataElement [Reference]

• "innerText" - vlastnost HTMLElement [Reference]

• "textContent" - vlastnost Node [Reference]

• "innerHTML" - vlastnost HTMLElement [Reference]

body: objekt

Tělo požadavku pro POST požadavky. Může obsahovat proměnné jako $SOURCE_TEXT, $SOURCE_LANG, a $TARGET_LANG.

options: objekt (volitelné)

Další možnosti požadavku.

• headers - Nastavit vlastní hlavičky požadavku:

  • X-Custom-Header: string

  • Authorization: string

  • Content-Type: string

responseType: string

• "string" - nastavit typ odpovědi jako string

• "json" - nastavit typ odpovědi jako json

responseQuery: string

---

Parsování JSON odpovědí z HTTP požadavků

JSON odpovědi lze parsovat pomocí responseQuery parametru.

Tento responseQuery parametr se používá pouze pro http_get a http_post metody, když je typ odpovědi nastaven na json.

Pro navigaci skrz vnořené JSON objekty použijte tečkovou notaci (.) k oddělení názvů polí. Prvky pole lze přistupovat pomocí hranatých závorek s indexem (např., [0]).

Příklad JSON odpovědi:

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

responseQuery	Výsledek
text	Hello 1
words[0].text	Hello 2
lines.sub.text	Hello 5

---

---

Příklady

1. Metoda web scrapingu

Požadované parametry

• 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. Metoda HTTP GET

Požadované parametry

• 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. Metoda HTTP POST

Požadované parametry

• method: string ("http_post")

• url: string

• body: objekt

• options: objekt

  • headers: objekt

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