Permintaan & Respons

Ini adalah bagian konfigurasi dari MT Kustom. Bagian ini berisi konfigurasi inti untuk permintaan Terjemahan Mesin.

Variabel

• $ID

• $SOURCE_TEXT atau $ORIGINAL_TEXT

• $TRANSLATED_TEXT

• $SOURCE_LANG

• $TARGET_LANG

Variabel skema dapat digunakan dalam konfigurasi dengan sintaks $SCHEMA_NAME.

Misalnya:

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

---

Parameter

method: string

• "web_scraping"

• "http_get"

• "http_post"

• "web_llm"

initialUrl: string (opsional)

URL awal untuk dikunjungi sebelum melakukan permintaan sebenarnya (untuk pengambilan web).

url: string

URL endpoint untuk layanan Terjemahan Mesin.

encodeURI: boolean (opsional)

Menghindari karakter menggunakan unit kode UTF-8, dengan setiap oktet dikodekan dalam format %XX, diisi di kiri dengan 0 jika diperlukan. Surrogat tunggal dalam UTF-16 tidak mengkodekan karakter Unicode yang valid. Referensi: encodeURI

encodeURIComponent: boolean (opsional)

Menggunakan algoritma pengkodean yang sama seperti encodeURI. Menghindari semua karakter kecuali: A–Z a–z 0–9 - _ . ! ~ * ' ( ) Referensi: encodeURIComponent

encodeURIExtra: string (opsional)

Fungsi tambahan untuk mengganti URI menggunakan ekspresi reguler. Misalnya: ["%2F", "g", "\\%2F"]

userAgent: string (opsional)

String User-Agent kustom untuk permintaan HTTP.

querySelector: string

Mengembalikan elemen pertama dalam dokumen HTML yang cocok dengan selector atau grup selector yang ditentukan. Referensi: querySelector

querySelectorAll: string (opsional)

Mengembalikan NodeList statis yang mewakili daftar elemen HTML yang cocok dengan grup selector yang ditentukan. Referensi: querySelectorAll

queryProperti: string

Menentukan properti mana yang akan diekstrak dari elemen HTML yang dipilih:

• "value" - properti dari HTMLDataElement [Referensi]

• "innerText" - properti dari HTMLElement [Referensi]

• "textContent" - properti dari Node [Referensi]

• "innerHTML" - properti dari HTMLElement [Referensi]

body: object

Body permintaan untuk permintaan POST. Dapat berisi variabel seperti $SOURCE_TEXT, $SOURCE_LANG, dan $TARGET_LANG.

options: object (opsional)

Opsi permintaan tambahan.

• headers - Atur header permintaan kustom:

  • X-Custom-Header: string

  • Authorization: string

  • Content-Type: string

tipeRespons: string

• "string" - atur tipe respons sebagai string

• "json" - atur tipe respons sebagai json

kueriRespons: string

---

Mengurai Respons JSON dari Permintaan HTTP

Respons JSON dapat diurai menggunakan responseQuery parameter.

Yang responseQuery parameter hanya digunakan untuk http_get dan http_post metode ketika tipe respons diatur ke json.

Untuk menavigasi melalui objek JSON bertingkat, gunakan notasi titik (.) untuk memisahkan nama field. Elemen array dapat diakses menggunakan notasi kurung dengan indeks (mis., [0]).

Contoh Respons JSON:

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

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

---

---

Contoh

1. Metode Web Scraping

Parameter yang Diperlukan

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

Parameter yang Diperlukan

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

Parameter yang Diperlukan

• method: string ("http_post")

• url: string

• body: object

• options: object

  • headers: object

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