ข้ามไปยังเนื้อหาหลัก

การให้บริการ Custom Method ในรูปแบบ API

api method ของ champollion ช่วยให้คุณชี้คู่ภาษาใดก็ได้ไปยัง HTTP endpoint ภายนอก นี่คือวิธีที่คุณสามารถผสานรวม pipeline ที่ซับซ้อนเกินกว่าจะใช้ LLM prompt เดียว ไม่ว่าจะเป็น morphological analyzer, finite-state transducer (FST), multi-step LLM chain หรือ custom research method ที่คุณสร้างขึ้นเอง

เหตุใดจึงใช้ API Service?​

translation pipeline บางประเภทไม่สามารถทำงานภายใน prompt-response cycle แบบง่ายได้:

ขั้นตอนใน Pipelineตัวอย่าง
Morphological decompositionแยกคำ polysynthetic ออกเป็น morpheme ก่อนแปล
FST validationปฏิเสธผลลัพธ์ที่ละเมิดกฎ phonological หรือ morphological
Multi-step LLM chainsวงจร Generate → verify → correct โดยใช้ model ต่างกัน
Dictionary lookupอ้างอิงพจนานุกรมสองภาษาที่คัดสรรแล้วระหว่าง pipeline
Human-in-the-loopจัดคิวการแปลที่ไม่แน่ใจเพื่อให้ผู้เชี่ยวชาญตรวจสอบ

api method จะมอง pipeline ของคุณเป็น black box — champollion ส่ง source string มา แล้ว service ของคุณส่งคืนการแปล สิ่งที่เกิดขึ้นภายในขึ้นอยู่กับคุณทั้งหมด

สถาปัตยกรรม​

การตั้งค่า Service ของคุณ​

API service ของคุณต้องมี endpoint เดียวที่รับและส่งคืน JSON:

รูปแบบ Request​

champollion ส่ง JSON body นี้ (ดู api.js):

POST /translate
Content-Type: application/json
Authorization: Bearer <CHAMPOLLION_API_KEY>

{
  "source_locale": "en",
  "target_locale": "crk",
  "method": "crk-coached-v1",
  "keys": {
    "greeting": "Hello, welcome to our app",
    "farewell": "Goodbye and thanks"
  }
}
FieldTypeคำอธิบาย
source_localestringBCP 47 source language code
target_localestringBCP 47 target language code
methodstringชื่อ plugin หรือ "default"
keysobjectMap ของ key → source string ที่ต้องการแปล

### Response Format

Your service must return a `translations` object. An optional `meta` object can include cost and diagnostic info:

```json
{
  "translations": {
    "greeting": "tânisi, pê-kîwêw ôta",
    "farewell": "ekosi mâka, kinanâskomitin"
  },
  "meta": {
    "model": "my-custom-pipeline/v1",
    "cost_usd": 0.0042,
    "method": "decompose-translate-validate"
  }
}
FieldTypeRequiredDescription
translationsobject✅Map of key → translated string
metaobject—Optional metadata
meta.cost_usdnumber—If present, displayed in champollion's output
errorsobject—For partial success (HTTP 207): map of key → { message }

Minimal Express Server​

import express from 'express';

const app = express();
app.use(express.json());

/**
 * champollion API contract:
 *
 * Request:  { source_locale, target_locale, method, keys: { "key": "source" } }
 * Response: { translations: { "key": "translated" }, meta: { ... } }
 */
app.post('/translate', async (req, res) => {
  const { source_locale, target_locale, method, keys } = req.body;

  const translations = {};

  for (const [key, source] of Object.entries(keys)) {
    // --- Your pipeline goes here ---
    // Step 1: Morphological decomposition
    const morphemes = await decompose(source, source_locale);

    // Step 2: LLM translation with context
    const draft = await llmTranslate(morphemes, target_locale);

    // Step 3: FST validation
    const validated = await fstValidate(draft, target_locale);

    // Step 4: Post-processing (orthography normalization, etc.)
    translations[key] = await postProcess(validated);
  }

  res.json({
    translations,
    meta: {
      model: 'my-custom-pipeline/v1',
      method: 'decompose-translate-validate',
    },
  });
});

app.listen(3001, () => {
  console.log('Translation API running on http://localhost:3001');
});

Configuring champollion​

Point a translation pair at your running service in champollion.config.json:

{
  "inputLocale": "en",
  "pairs": {
    "en:crk": {
      "method": "api",
      "endpoint": "http://localhost:3001/translate",
      "register": "Formal Plains Cree. Use SRO orthography."
    }
  }
}

Then run sync as usual:

npx champollion sync

champollion will POST your source strings to the endpoint and write the returned translations to crk.json.

Case Study: Plains Cree Pipeline​

:::info Under Development The Plains Cree pipeline described below is under active development and is not yet running in production. Details here reflect the current design direction and may change as the project evolves. :::

The arena project demonstrates this pattern. Its Plains Cree pipeline uses:

  1. Morphological decomposition — Break polysynthetic Cree words into translatable morpheme chains
  2. LLM translation — Context-enriched GPT-4o translation with coaching data (SRO orthography rules, register instructions)
  3. FST validation — Finite-state transducer checks that outputs conform to Cree phonological rules
  4. Confidence scoring — Each translation gets a confidence score based on FST pass rate and dictionary coverage

The entire pipeline runs as a single HTTP endpoint that champollion calls via the api method.

Running Evaluations​

After translating, you can evaluate output quality using the harness directly:

# Clone the harness
git clone https://github.com/gamedaysuits/arena.git
cd arena
pip install -e .

# Run the evaluation against your method's output
mt-eval run --corpus data/edtekla-dev-v1.json --submit

This produces structured evaluation records with chrF++, BLEU, and exact match scores that can be used as regression baselines.

Authentication​

If your API requires authentication, set the apiKey field or use an environment variable:

{
  "pairs": {
    "en:crk": {
      "method": "api",
      "endpoint": "https://my-mt-service.example.com/translate",
      "apiKey": "${CRK_API_KEY}"
    }
  }
}

Data Sovereignty & OCAP Principles​

The api method is particularly important for Indigenous language communities. By self-hosting the translation pipeline, a community keeps full control over:

  • Proprietary coaching data — register instructions, orthography rules, and domain glossaries never leave community infrastructure.
  • Linguistic resources — curated dictionaries, FST grammars, and elder-verified translations remain under community ownership.
  • Access policies — the community decides who can call the endpoint and under what terms.

This aligns with OCAP® principles (Ownership, Control, Access, Possession), ensuring that sensitive language data is governed by the community rather than a third-party platform.

เคล็ดลับ

Combine the api method with a private deployment (e.g., a community-hosted VM or on-prem server) for the strongest data-sovereignty posture. See Support a Low-Resource Language for a full walkthrough.

Cost Estimation​

The api method returns null for cost estimation by default — your service controls pricing. If you want to provide cost transparency, have your API return a cost field in the metadata:

{
  "translations": { "...": "..." },
  "metadata": {
    "cost": {
      "estimatedCost": 0.0042,
      "currency": "USD",
      "source": "my-service-pricing"
    }
  }
}

แนวปฏิบัติที่ดี​

  1. ส่งคืน empty string เมื่อเกิดข้อผิดพลาด — อย่าส่งคืน source string เป็น "การแปล" ให้ส่งคืน "" แทน แล้ว quality gate ของ champollion จะตรวจจับได้ key นั้นจะถูกข้ามและลองใหม่ใน sync ครั้งถัดไป
  2. ใส่ confidence score — หาก pipeline ของคุณสามารถประเมินคุณภาพได้ ให้ส่งคืนค่านั้นใน metadata ซึ่งช่วยในการตรวจสอบคุณภาพ
  3. ติดตั้ง health check — เพิ่ม endpoint GET /health เพื่อให้ champollion ตรวจสอบการเชื่อมต่อก่อนเริ่ม sync ขนาดใหญ่
  4. จัดการ rate limit อย่างเหมาะสม — หาก pipeline ของคุณมีข้อจำกัดด้าน throughput ให้ส่งคืน status code 429 ระบบ batch ของ champollion จะลดความเร็วลงเอง
  5. บันทึก log ทุกอย่าง — pipeline หลายขั้นตอนอาจล้มเหลวโดยไม่มีสัญญาณเตือน ให้บันทึก input/output ของแต่ละขั้นตอนเพื่อการ debug

การอนุญาตสิทธิ์​

รูปแบบ api method เปิดให้ใช้งานได้อย่างเต็มที่ — ไม่มีข้อจำกัดด้านสิทธิ์ในการ wrap translation pipeline ของคุณเองเป็น HTTP service arena เผยแพร่ภายใต้สัญญาอนุญาต MIT สำหรับ reference implementation

ดูเพิ่มเติม​

  • Translation Methods — ภาพรวมของทุก built-in method (openai, google, api และอื่นๆ)
  • Plugin Specification — schema ฉบับสมบูรณ์สำหรับ champollion.config.json รวมถึง field ของ api method
  • Support a Low-Resource Language — คู่มือครบวงจรสำหรับภาษาที่มีทรัพยากรน้อย รวมถึงหลักการ OCAP
  • Architecture — วิธีที่ sync loop, batching และ method dispatch ของ champollion ทำงาน
  • MT Evaluation — methodology การประเมิน, metrics และกระบวนการส่งผลงานเข้า leaderboard
  • Method Leaderboard — การจัดอันดับคุณภาพแบบ real-time ตาม method และคู่ภาษา