Skip to content

README.th_TH.md

Latest commit

 

History

History
258 lines (180 loc) · 13.8 KB

README.th_TH.md

File metadata and controls

258 lines (180 loc) · 13.8 KB
Raw

SearchCLI logo

SearchCLI

English | 简体中文 | 日本語 | Deutsch | 한국어 | Français | Русский | Italiano | Español | Português | Türkçe | ไทย | Bahasa Indonesia

เชื่อมต่อการค้นหาที่เสถียรและปรับแต่งได้ คำแนะนำ และการค้นคืนแบบสนทนาเข้ากับระบบ Agent หรือระบบธุรกิจของคุณ

ชุมชน · เริ่มต้นอย่างรวดเร็ว (นักพัฒนา) · ตั้งค่า AI Agent · คู่มือ Agent ฉบับเต็ม · การมีส่วนร่วม · ความปลอดภัย

SearchCLI คือ CLI แบบเปิดสำหรับ AI Search on Volcengine

หากระบบ Agent หรือระบบธุรกิจของคุณต้องการบริการกระจายข้อมูลที่เสถียรและปรับแต่งได้ SearchCLI มอบเส้นทางที่ใช้งานได้จริงในการผสานความสามารถด้านการค้นหา คำแนะนำ และการค้นคืนแบบสนทนาระดับ production เข้ากับ workflow จริง

เมื่อใช้ SearchCLI ร่วมกับ Viking skills ที่ติดตั้งได้ Agents ภายนอกสามารถ onboarding ข้อมูล สร้างและตรวจสอบ flow การค้นหาและคำแนะนำ เรียกใช้การค้นคืนแบบสนทนา ปรับแต่งการตั้งค่ากลยุทธ์ ตรวจสอบ bad cases และปรับปรุงคุณภาพ retrieval ได้อย่างเสถียรและตรวจสอบได้

ชุมชน

เข้าร่วมกลุ่มผู้ใช้ SearchCLI บน WeChat
สแกน QR code ด้านล่างด้วย WeChat เพื่อพูดคุยกับผู้ใช้และผู้ดูแลโครงการ
QR code จะได้รับการอัปเดตเป็นระยะ หากหมดอายุแล้ว โปรดกลับมาตรวจสอบเวอร์ชันล่าสุด

QR code กลุ่มผู้ใช้ SearchCLI บน WeChat

SearchCLI คืออะไร

  • พื้นผิวการผสานผ่าน command line สำหรับ AI Search on Volcengine
  • เส้นทางที่เสถียรสำหรับระบบภายนอกในการเข้าถึงความสามารถด้านการค้นหา คำแนะนำ และการค้นคืนแบบสนทนา
  • ชั้น workflow ที่เป็นมิตรกับ Agent สร้างขึ้นจาก skills ที่ติดตั้งได้และ output ของคำสั่งที่ปลอดภัยต่อ automation
  • โมเดลการทำงานที่ตรวจสอบได้ พร้อม dry-run จุดยืนยัน และการตรวจสอบแบบ read-after-write

เหมาะสำหรับใคร

  • นักพัฒนาที่ผสานการกระจายข้อมูลที่ขับเคลื่อนด้วย AI เข้ากับระบบธุรกิจ
  • ทีมที่สร้างระบบ Agent และต้องการ workflow สำหรับการค้นหา คำแนะนำ และ retrieval ที่เสถียรและกำหนดค่าได้
  • ทีม operations, delivery และ solution ที่ต้องการวิธีที่ตรวจสอบได้สำหรับ onboarding ข้อมูล กำหนดค่าแอปพลิเคชัน และตรวจสอบพฤติกรรม runtime ก่อนใช้งานจริง

สิ่งที่ทำได้

  • ค้นหา item และ catalog บนข้อมูลธุรกิจแบบมีโครงสร้าง
  • flow คำแนะนำที่เชื่อมต่อกับ scene ของแอปพลิเคชันและพฤติกรรมผู้ใช้
  • ประสบการณ์การค้นคืนแบบสนทนาที่อ้างอิงจากการค้นหาของแอปพลิเคชัน
  • workflow สำหรับ Agent ที่สามารถ onboarding ข้อมูล กำหนดค่าแอปพลิเคชัน และตรวจสอบพฤติกรรม runtime ด้วยขั้นตอน review ที่ชัดเจน

ความสามารถหลัก

  • vs item profile | plan | apply สำหรับ onboarding item แบบมีโครงสร้าง
  • vs app, vs dataset และ vs data สำหรับจัดการแอปพลิเคชันและ dataset
  • vs search run, vs recommend run และ vs chat run สำหรับตรวจสอบ runtime
  • vs search tune query-generate | plan | run | report สำหรับการประเมินและปรับแต่ง text similarity อัตโนมัติในเวอร์ชันแรก
  • Viking skills ที่ติดตั้งได้ เพื่อให้ Agents ภายนอกใช้ workflow เดียวกัน

ข้อกำหนด

  • Node.js 20 หรือใหม่กว่า
  • git
  • Volcengine AK/SK ที่มีสิทธิ์เข้าถึง AI Search

เริ่มต้นอย่างรวดเร็ว (นักพัฒนา)

1. ติดตั้ง

git clone git@github.com:volcengine/SearchCLI.git vs
cd vs
bash ./scripts/install.sh

2. ยืนยันตัวตน

หาก shell ปัจจุบันมี VIKING_AK และ VIKING_SK อยู่แล้ว:

vs auth import-env
vs auth status --json
vs doctor --json

มิฉะนั้น ให้รัน interactive login ใน terminal จริง:

vs auth login

หากคุณจะใช้การสร้าง query สำหรับ search tuning หรือการตัดสิน relevance ด้วย LLM ให้กำหนดค่า OpenAI-compatible LLM API โดยไม่ใส่ API key เป็น plain text ใน config:

vs llm login
vs llm status --json
vs search tune llm-check --live --json

หาก shell ปัจจุบันมี VIKING_LLM_BASE_URL, VIKING_LLM_API_KEY และ VIKING_LLM_MODEL อยู่แล้ว ให้ใช้ vs llm import-env แทนได้ API key จะถูกเก็บใน local secure credential store ส่วน base URL และ model จะถูกเก็บเป็น config ที่ไม่ใช่ความลับ

3. รัน onboarding flow แรก

หากผู้ใช้ต้องการสร้าง app ใหม่ พร้อม review การตั้งค่าในช่วง bind-time และตรวจสอบ runtime ให้ใช้เส้นทาง dataset+app:

vs item profile --file ./items.json --pretty
vs item plan --file ./items.json --goal "Build item search"
vs item apply --plan-dir ./.viking/item-plans/<plan> --dry-run
vs item apply --plan-dir ./.viking/item-plans/<plan> --confirm-review --wait-ready --run-trials

หากต้องการเฉพาะ dataset provisioning ให้ใช้เส้นทาง dataset-only สร้าง dataset-only plan ด้วย --skip-app แล้วหยุดหลังจาก dataset create + ingest:

vs item profile --file ./items.json --pretty
vs item plan --file ./items.json --goal "Build item search" --skip-app
vs dataset create --data @dataset-create.json
vs dataset ingest --dataset-id <dataset-id> --fields @<normalized-items-artifact>

ควรใช้ dataset-create.json เมื่อ plan สร้างไฟล์นี้ออกมา เพื่อให้การสร้าง dataset ส่ง Schema และ DataFieldConfig ไปพร้อมกัน รูปแบบ --name <dataset-name> --type item --schema @schema.json ยังคงเป็น fallback แบบ manual schema-only เมื่อไม่มี create payload แบบเต็มหรือไม่เหมาะสม

--skip-app ยังใช้ได้กับ vs item provision และ vs item apply ในฐานะ execution-time guard rail เมื่อคุณต้องบังคับขอบเขต dataset-only จาก plan ที่มีอยู่

หากต้องการ video dataset อย่าพึ่งพา type เริ่มต้น ให้ส่ง --type video อย่างชัดเจนเสมอ:

สำหรับ dataset+app:

vs item profile --file ./videos.jsonl --type video --pretty
vs item plan --file ./videos.jsonl --type video --goal "Build video search"
vs item apply --plan-dir ./.viking/item-plans/<plan> --dry-run
vs item apply --plan-dir ./.viking/item-plans/<plan> --confirm-review --wait-ready --run-trials

สำหรับ dataset-only:

vs item profile --file ./videos.jsonl --type video --pretty
vs item plan --file ./videos.jsonl --type video --goal "Build video search" --skip-app
vs dataset create --data @dataset-create.json
vs dataset ingest --dataset-id <dataset-id> --fields @<normalized-items-artifact>

สำหรับ video dataset-only provisioning ควรใช้ dataset-create.json เพื่อให้ request มี DataFieldConfig; การใช้เพียง --schema @schema.json อาจล้มเหลวด้วย MissingParameter.DefaultFieldStrategy

เริ่มต้นอย่างรวดเร็ว (AI Agents)

หาก Agent ภายนอกต้องใช้งาน AI Search ผ่าน repository นี้:

1. ติดตั้ง SearchCLI

git clone git@github.com:volcengine/SearchCLI.git vs
cd vs
bash ./scripts/install.sh

2. ติดตั้ง Viking skills

npx skills add "git@github.com:volcengine/SearchCLI.git" -y -g

public skill bundle เริ่มต้นประกอบด้วย:

  • vs-shared
  • vs-item-onboarding
  • vs-search
  • vs-search-tuning
  • vs-chat
  • vs-recommend

3. ยืนยันตัวตน

หาก shell ปัจจุบันมี VIKING_AK และ VIKING_SK อยู่แล้ว แนะนำให้ใช้:

vs auth import-env

มิฉะนั้น:

vs auth login

4. ตรวจสอบ

vs --help
vs auth status --json
vs llm status --json
vs doctor --json
vs skill list

กลุ่มคำสั่งสาธารณะ

  • vs auth
  • vs llm
  • vs doctor
  • vs skill
  • vs item
  • vs app
  • vs dataset
  • vs data
  • vs search
  • vs chat
  • vs recommend

เอกสาร

Workflow สำหรับ maintainer

หากคุณดูแล open-source repository นี้เอง local skill tooling คือ:

vs skill list
vs skill init viking-demo-skill
vs skill validate
vs skill install all

Build และรัน repository checks:

npm install
npm run validate:skills
npm run build
npm run test:acceptance:dist

การมีส่วนร่วม

ดูรายละเอียดเพิ่มเติมได้ที่ Contributing

ผู้มีส่วนร่วมภายนอกต้องทำ Contributor License Agreement (CLA) ให้เสร็จก่อน pull request จะได้รับการยอมรับ

จรรยาบรรณ

ดูรายละเอียดเพิ่มเติมได้ที่ Code of Conduct

ความปลอดภัย

หากคุณพบปัญหาด้านความปลอดภัยที่อาจเกิดขึ้นในโปรเจกต์นี้ หรือคิดว่าอาจพบปัญหาด้านความปลอดภัย โปรดแจ้ง Bytedance Security ผ่าน security center หรือ vulnerability reporting email

โปรดอย่าสร้าง public GitHub issue

License

โปรเจกต์นี้อยู่ภายใต้ Apache-2.0 License