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

llms.txt

เว็บนี้ตีพิมพ์ตัวเองออกมาเป็นข้อความล้วนตามธรรมเนียม llms.txt ด้วย ถ้าคุณกำลังทำระบบเชื่อมต่อโดยมีผู้ช่วย AI นั่งอยู่ข้าง ๆ ให้ชี้มันมาที่ไฟล์พวกนี้ แทนที่จะให้ไล่คลานหน้าเว็บเอง — ได้ถ้อยคำชุดเดียวกัน โดยไม่มีเมนู ไม่มี CSS และไม่ต้องเดา

ทั้ง 3 ไฟล์เปิดสาธารณะ ไม่ต้องใช้กุญแจ

ไฟล์ ข้างในคืออะไร ขนาดคร่าว ๆ
/llms.txt สารบัญสั้น ๆ ที่บอกชื่อและลิงก์ของอีก 2 ไฟล์ ไม่ถึง 1 KB
/llms-full.txt คู่มือทุกหน้าของเว็บนี้แบบเต็ม รวมเป็น Markdown ไฟล์เดียว ~130 KB
/llms-small.txt หน้าชุดเดียวกันแต่บีบบรรทัดว่างออก — คำเท่าเดิม โทเคนน้อยลง ~115 KB

ขอบเขตที่ต้องรู้ 2 ข้อ:

  • ภาษาอังกฤษเท่านั้น — หน้าไทยใต้ /th/ ไม่ถูกรวมไว้ ⇒ ผู้ช่วยที่อ่านไฟล์พวกนี้จะไม่เห็นเนื้อหาเดียวกันซ้ำ 2 ภาษา
  • เฉพาะคู่มือ — ส่วน API Reference ที่สร้างอัตโนมัติไม่ได้อยู่ในไฟล์เหล่านี้ เพราะมันมีต้นฉบับที่เครื่องอ่านได้อยู่แล้ว คือเอกสาร OpenAPI ที่ https://api.scanfood.co/ext/v1/openapi.json ⇒ ให้ผู้ช่วยของคุณใช้ไฟล์นั้นสำหรับรูปร่างของเส้น และใช้ llms-full.txt สำหรับเรื่องอื่นทั้งหมด

https://api.scanfood.co/llms.txt คือประตูแรก · ตั้งใจให้เล็กมาก — มีแค่ชื่อ คำอธิบาย 1 บรรทัดว่า API นี้คืออะไร และลิงก์ไปยังเอกสารเต็ม 2 ไฟล์:

# ScanFood API
> Read-only HTTP API for transactions, shops and members recorded by ScanFood POS.
## Documentation Sets
- [Abridged documentation](https://api.scanfood.co/llms-small.txt): a compact version …
- [Complete documentation](https://api.scanfood.co/llms-full.txt): the full documentation …

เครื่องมือที่รองรับธรรมเนียมนี้จะอ่านไฟล์นี้ก่อนแล้วตามลิงก์ที่ต้องการเอง ถ้าคุณต่อเองด้วยมือ ข้ามไฟล์นี้ไปดึง 2 ไฟล์ข้างล่างตรง ๆ ได้เลย

ทั้งคู่มีหน้าชุดเดียวกัน เรียงลำดับเหมือนกัน และขึ้นต้นด้วยบรรทัดเดียวที่บอกโมเดลว่ากำลังอ่านอะไรอยู่

  • llms-full.txt คงรูปแบบเดิมไว้ทั้งหมด — หัวข้อ ตาราง ลิสต์ และตัวอย่างโค้ดทุกก้อน พร้อมการเว้นวรรคย่อหน้าครบ · ใช้เมื่อผู้ช่วยมีที่ว่างพอ และคุณอยากให้ข้อความอ่านลื่น
  • llms-small.txt คือเนื้อหาเดียวกันที่บีบช่องว่างออก · ใช้เมื่อกำลังวางลงในหน้าต่างบริบทที่ไม่อยากให้เต็ม — ตารางกับบล็อกโค้ดยังอยู่ครบ แค่ย่อหน้าจะติดกันไปหมด

ทั้ง 2 ไฟล์ถูกสร้างใหม่ทุกครั้งที่เว็บนี้ถูกตีพิมพ์ ⇒ ไม่มีวันเพี้ยนไปจากหน้าที่คุณกำลังอ่าน

ในผู้ช่วยเขียนโค้ดหรือ editor ที่มี AI — เพิ่ม URL เข้าไปเป็นเอกสารอ้างอิง เครื่องมือส่วนใหญ่รับลิงก์แล้วไปดึงเองได้:

https://api.scanfood.co/llms-full.txt

ในพรอมป์ต — ดึงไฟล์มาวาง หรือส่งให้ agent ทั้ง 2 แหล่งพร้อมกัน:

Terminal window
# เอกสารทั้งชุดในไฟล์เดียว
curl -s https://api.scanfood.co/llms-full.txt -o scanfood-docs.md
# ตัวย่อ ใช้ตอนบริบทเหลือน้อย
curl -s https://api.scanfood.co/llms-small.txt -o scanfood-docs-small.md
# ตัวสัญญาของเส้นเอง (สาธารณะ ไม่ต้องใช้กุญแจ)
curl -s https://api.scanfood.co/ext/v1/openapi.json -o scanfood-openapi.json

ถ้าต้องการแค่หน้าเดียว — คำถามที่เจาะเรื่องเดียวไม่ต้องใช้เอกสารทั้งชุด ทุกหน้าที่นี่มีฝาแฝดเป็น Markdown ของตัวเอง ดูที่ คัดลอกหน้า