คำขอ & การตอบกลับ

นี่คือส่วนการกำหนดค่าของ MT ที่กำหนดเอง. ส่วนนี้ประกอบด้วยการกำหนดค่าหลักสำหรับคำขอแปลภาษาด้วยเครื่อง

ตัวแปร

• $ID

• $SOURCE_TEXT หรือ $ORIGINAL_TEXT

• $TRANSLATED_TEXT

• $SOURCE_LANG

• $TARGET_LANG

ตัวแปรสคีมา (Schema) สามารถนำมาใช้ในการกำหนดค่าด้วยไวยากรณ์ $SCHEMA_NAME.

ตัวอย่างเช่น:

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

---

พารามิเตอร์

method: string

• "web_scraping"

• "http_get"

• "http_post"

• "web_llm"

URLเริ่มต้น: string (optional)

URL เริ่มต้นที่ต้องเข้าเยี่ยมชมก่อนที่จะทำการร้องขอจริง (สำหรับการเก็บข้อมูลจากเว็บ)

url: string

URL ของจุดเชื่อมต่อสำหรับบริการแปลภาษาแบบเครื่อง

encodeURI: boolean (optional)

หลีกเลี่ยงตัวอักษรโดยใช้หน่วยรหัส UTF-8 โดยแต่ละไบต์จะถูกเข้ารหัสในรูปแบบ %XX, เติมศูนย์ทางซ้ายหากจำเป็น ตัวแทนคู่เดี่ยวใน UTF-16 จะไม่เข้ารหัสเป็นอักขระ Unicode ที่ถูกต้องใด ๆ ข้อมูลอ้างอิง: encodeURI

encodeURIComponent: boolean (optional)

ใช้ алгоритм การเข้ารหัสเดียวกับ encodeURI. หลีกเลี่ยงทุกตัวอักษรยกเว้น: A–Z a–z 0–9 - _ . ! ~ * ' ( ) ข้อมูลอ้างอิง: encodeURIComponent

encodeURIExtra: string (optional)

ฟังก์ชันเพิ่มเติมเพื่อแทนที่ URI โดยใช้สํานวนปกติ (regular expression) ตัวอย่างเช่น: ["%2F", "g", "\\%2F"]

userAgent: string (optional)

สตริง User-Agent ที่กำหนดเองสำหรับคำขอ HTTP

querySelector: string

คืนองค์ประกอบแรกภายในเอกสาร HTML ที่ตรงกับตัวเลือกหรือกลุ่มตัวเลือกที่ระบุ ข้อมูลอ้างอิง: querySelector

querySelectorAll: string (optional)

คืน NodeList แบบคงตัวที่เป็นตัวแทนของรายการองค์ประกอบ HTML ที่ตรงกับกลุ่มตัวเลือกที่ระบุ ข้อมูลอ้างอิง: querySelectorAll

queryProperty: string

ระบุคุณสมบัติที่จะสกัดจากองค์ประกอบ HTML ที่เลือก:

• "value" - property of the HTMLDataElement [Reference]

• "innerText" - property of the HTMLElement [Reference]

• "textContent" - property of the Node [Reference]

• "innerHTML" - property of the HTMLElement [Reference]

body: object

ตัวเนื้อหาของคำขอสำหรับคำขอแบบ POST สามารถมีตัวแปรเช่น $SOURCE_TEXT, $SOURCE_LANG, และ $TARGET_LANG.

options: object (optional)

ตัวเลือกเพิ่มเติมสำหรับคำขอ

• headers - ตั้งค่าเฮดเดอร์คำขอแบบกำหนดเอง:

  • X-Custom-Header: string

  • Authorization: string

  • Content-Type: string

responseType: string

• "string" - ตั้งค่าประเภทการตอบสนองเป็นสตริง

• "json" - ตั้งค่าประเภทการตอบสนองเป็น json

responseQuery: string

---

การแยกวิเคราะห์การตอบสนอง JSON จากคำขอ HTTP

การตอบสนอง JSON สามารถถูกแยกวิเคราะห์โดยใช้ responseQuery พารามิเตอร์

ส่วน responseQuery พารามิเตอร์จะถูกใช้เฉพาะสำหรับ http_get และ http_post เมทอดเมื่อตั้งค่าประเภทการตอบสนองเป็น json.

ในการนำทางผ่านอ็อบเจ็กต์ JSON ที่ซ้อน ให้ใช้โนเทชันจุด (dot notation) (.) เพื่อแยกชื่อฟิลด์ องค์ประกอบของอาเรย์สามารถเข้าถึงได้โดยใช้วงเล็บพร้อมดัชนี (เช่น [0]).

ตัวอย่างการตอบสนอง JSON:

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

responseQuery	ผลลัพธ์
text	Hello 1
words[0].text	Hello 2
lines.sub.text	Hello 5

---

---

ตัวอย่าง

1. วิธีการเก็บข้อมูลจากเว็บ

พารามิเตอร์ที่จำเป็น

• 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. วิธีการ HTTP GET

พารามิเตอร์ที่จำเป็น

• 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. วิธีการ HTTP POST

พารามิเตอร์ที่จำเป็น

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