Instrukt

คำแนะนำ

Terminal AI Commander ที่ปลายนิ้วของคุณ

coding.assistant.example.mp4

ชำระเงินการสาธิตเพื่อดูตัวอย่างเพิ่มเติม

หมายเหตุ : นี่เป็นงานระหว่างดำเนินการ คาดว่าจะมีข้อบกพร่องและการเปลี่ยนแปลง API

การแนะนำ

Instrukt คือสภาพแวดล้อมบูรณาการ AI บนเทอร์มินัล มีแพลตฟอร์มที่ผู้ใช้สามารถ:

• สร้างและสั่งสอนตัวแทน AI แบบโมดูลาร์

• สร้างดัชนีเอกสารสำหรับการตอบคำถาม

• สร้างและแนบเครื่องมือกับตัวแทน

เอเจนต์เป็น แพ็คเกจ Python แบบดรอปอิน แบบง่ายที่สามารถขยาย แชร์กับผู้อื่น แนบไปกับเครื่องมือ และเพิ่มด้วยดัชนีเอกสาร

สอนพวกเขาในภาษาธรรมชาติ และเพื่อความปลอดภัย ให้เรียกใช้งานพวกเขาในคอนเทนเนอร์ที่ปลอดภัย (ปัจจุบันใช้กับ Docker) เพื่อทำงานในพื้นที่แซนด์บ็อกซ์โดยเฉพาะ ⁉️

สร้างด้วย: Langchain, ข้อความ, โครมา

บริการให้คำปรึกษา : ต้องการความช่วยเหลือเกี่ยวกับการบูรณาการ Langchain หรือ AI หรือไม่ คุณสามารถติดต่อเราได้ที่ [email protected]

สารบัญ

• การใช้งาน

• คุณสมบัติ

• แพลตฟอร์มที่รองรับ

• โมเดล LLM

• ดัชนีเอกสารและการตอบคำถาม

• แผนการทำงาน

• มีส่วนร่วม

• แพทเรียน

• ทางสังคม

• วิสัยทัศน์

• ใบอนุญาต

การใช้งาน

เริ่มต้นอย่างรวดเร็ว

• pip install instrukt[all]

• ส่งออก OPENAI_API_KEY ด้วยคีย์ OpenAI API ของคุณ

• เรียกใช้ instrukt

• หากโครงร่างสีใช้งานไม่ได้ ให้ส่งออก TERM=xterm-256color

• ไฟล์การกำหนดค่าจะถูกสร้างขึ้นที่: ~/.config/instrukt/instrukt.yml

คุณสามารถเรียกใช้คำแนะนำบนเซิร์ฟเวอร์ที่ไม่มีส่วนหัวหรือคอนเทนเนอร์นักเทียบท่าที่รองรับ CUDA

หมายเหตุ : หากคุณเริ่มต้นด้วยคอนเทนเนอร์เปล่า คุณต้องมีอย่างน้อย g++ และ libmagic

ตรวจสอบการเริ่มต้นอย่างรวดเร็วและคู่มือการติดตั้งสำหรับรายละเอียดเพิ่มเติม

จากแหล่งที่มา:

• ตรวจสอบให้แน่ใจว่าได้ติดตั้ง poetry เวอร์ชันล่าสุดแล้ว

• ตั้งค่า virtualenv ของคุณ

• โคลนพื้นที่เก็บข้อมูล

• รัน poetry install -E all --with dev,test

• สิ่งนี้จะติดตั้ง Instrukt รวมถึงเครื่องมือพิเศษสำหรับตัวแทน

ดูคู่มือการติดตั้งสำหรับรายละเอียดเพิ่มเติม

ตัวแทนเริ่มต้น:

Coding AI : ผู้ช่วยเขียนโค้ด สร้างดัชนีบนฐานโค้ดใดๆ และแนบไปกับเอเจนต์เพื่อทำ RAG (Retrieval Augmented Generation)

แชทถาม & ตอบ : ตัวแทนการสนทนาที่เรียบง่าย

คุณสมบัติ

อินเทอร์เฟซเทอร์มินัลคีย์บอร์ดและเมาส์:

• อินเทอร์เฟซที่ใช้เทอร์มินัลสำหรับผู้ใช้คีย์บอร์ดไฟฟ้าเพื่อสั่งงานตัวแทน AI โดยไม่ต้องออกจากคีย์บอร์ด

• เอเจนต์เอเจนต์สีสันสดใสพร้อมการรองรับมาร์กดาวน์และซอร์สโค้ดด้วยไลบรารี Textual TUI

• เรียกใช้ Instrukt บน Bare Metal หรือ Docker Container ที่รองรับ CUDA

• การเข้าถึงระยะไกลด้วย SSH และเทอร์มินัลมัลติเพล็กเซอร์

ตัวแทน AI แบบกำหนดเอง:

• ออกแบบตัวแทนและเครื่องมือแบบกำหนดเอง

• เอเจนต์เป็นแพ็คเกจ Python ธรรมดาที่ผู้ใช้รายอื่นสามารถแชร์และโหลดได้

แชทด้วยรหัสและเอกสาร:

• จัดทำดัชนีข้อมูลของคุณและให้ตัวแทนดึงข้อมูลมาเพื่อตอบคำถาม

• สร้างและจัดระเบียบดัชนีของคุณด้วย UI ที่ใช้งานง่าย

• การสร้างดัชนีจะ ตรวจจับภาษาการเขียนโปรแกรมโดยอัตโนมัติ และปรับกลยุทธ์การแยก/การแบ่งส่วนให้เหมาะสม

• เอกสารต้นฉบับ Fuzzy Select (fzf, dmenu ...) ที่ใช้สำหรับการดึงข้อมูล ctrl+p

เครื่องมือ:

• ใช้ชุดเครื่องมือที่กำหนดไว้ล่วงหน้าหรือออกแบบเครื่องมือของคุณเอง

• ติดหรือถอดเครื่องมือเข้ากับเจ้าหน้าที่ได้ทุกที่ทุกเวลา เพื่อปรับแต่งเวิร์กโฟลว์ AI ของคุณให้ตรงกับความต้องการของคุณ

คอนโซลพร้อมต์:

• REPL-Prompt แบบบูรณาการเพื่อการโต้ตอบอย่างรวดเร็วกับตัวแทน และลูปผลตอบรับที่รวดเร็วสำหรับการพัฒนาและการทดสอบ

• ทำงานที่ซ้ำกันโดยอัตโนมัติด้วยคำสั่งที่กำหนดเอง

• ประวัติพรอมต์ / แชทในตัว

• ใช้ vim , emacs หรือ $EDITOR ภายนอกเพื่อแก้ไขข้อความ

แลงเชน:

• ใช้ประโยชน์จากระบบนิเวศของ LangChain เพื่อทำให้ทุกอย่างเป็นอัตโนมัติ

• WIP: Extensible API สำหรับการผสานรวมกับเฟรมเวิร์กอื่นๆ

คอนเทนเนอร์ที่ปลอดภัย:

• เรียกใช้ตัวแทนภายในคอนเทนเนอร์นักเทียบท่าที่ปลอดภัยเพื่อความปลอดภัยและความเป็นส่วนตัว

• ใช้รันไทม์ gVisor เพื่อแยก Agent โดยสมบูรณ์

หมายเหตุ : Docker Agent พร้อมให้บริการสำหรับผู้สนับสนุน Patreon ในรูปแบบตัวอย่างเบื้องต้นเท่านั้น

คอนโซลนักพัฒนาซอฟต์แวร์:

ดีบักและวิปัสสนาเอเจนต์โดยใช้คอนโซล IPython ในตัว ctrl+d

ดัชนีเอกสารและการตอบคำถาม

• คุณสามารถสร้างดัชนีได้โดยใช้ OpenAI หรือโมเดลการฝังในเครื่อง

• Chroma สำหรับจัดการดัชนี

• สร้างและจัดการดัชนีโดยใช้ UI การจัดการดัชนี (กด I )

• การทำดัชนีไดเร็กทอรีจะตรวจจับภาษาการเขียนโปรแกรมโดยอัตโนมัติ และใช้กลยุทธ์การแยกที่เหมาะสมซึ่งปรับให้เหมาะกับภาษาเป้าหมาย

• คุณสามารถแนบดัชนีกับตัวแทนใดๆ เป็นเครื่องมือ ในการดึงข้อมูลได้ โดยใช้เมนู index ที่ด้านบนของหน้าต่างของตัวแทน

• ตัวแทนสามารถใช้ดัชนีที่แนบมาเพื่อตอบคำถามได้

แพลตฟอร์มที่รองรับ:

• ลินุกซ์/แมค

• Windows ทดสอบภายใต้ WSL2

โมเดล LLM

• ปัจจุบันรองรับ OpenAI เท่านั้น

• การใช้โมเดลท้องถิ่นแบบส่วนตัวถือเป็น เหตุการณ์สำคัญครั้งต่อไป

แผนการทำงาน

• โมเดล LLM ท้องถิ่นส่วนตัว

• HF SetenceTransformers รองรับการฝัง

• การฝังตัวของผู้สอน

• การฝังในท้องถิ่น

• ใช้ API การสร้างข้อความ Webui

• จำลอง PrivateGPT

• ใช้ go-skynet/LocalAI ที่โฮสต์เอง

• การจัดทำดัชนีและการฝัง

• ไดเรกทอรีดัชนีและตรวจจับเนื้อหาอัตโนมัติ (ดู AutoDirLoader )

• ตรวจจับภาษาการเขียนโปรแกรมและใช้ตัวแยกสัญญาณที่เหมาะสม

• โหลดที่เก็บ git จาก URL

• โหลดหน้าเว็บ/เว็บไซต์ใดก็ได้

• เอกสารประกอบ

• การสร้างตัวแทน

• การสร้างเครื่องมือ

• การจัดทำดัชนีและสนทนากับเอกสารและซอร์สโค้ด

• ตัวอย่างการใช้งาน

• บทช่วยสอน

มีส่วนร่วม

ยินดีต้อนรับการมีส่วนร่วมข้อเสนอแนะและการประชาสัมพันธ์!

คุณสามารถช่วยในเรื่อง:

• การทดสอบและสร้างปัญหาสำหรับจุดบกพร่องหรือคุณสมบัติที่จะเป็นประโยชน์

• หากคุณมีทักษะทางเทคนิค คุณสามารถสร้าง PR ได้

• หากคุณไม่มีทักษะทางเทคนิค คุณสามารถช่วยเหลือในเรื่องเอกสาร เพิ่มตัวอย่างและบทช่วยสอน หรือสร้างเรื่องราวของผู้ใช้ใหม่

แพทเรียน

เมื่อเป็นผู้อุปถัมภ์ คุณจะช่วยให้ฉันทุ่มเทเวลาให้กับการพัฒนา Instrukt ต่อไปและทำให้คุณสมบัติที่วางแผนไว้ทั้งหมดกลับมามีชีวิตอีกครั้ง ตรวจสอบหน้า Patreon เพื่อดูรายละเอียดเพิ่มเติมเกี่ยวกับรางวัลสำหรับผู้สนับสนุนในช่วงแรก

ทางสังคม

เข้าร่วมเซิร์ฟเวอร์ Discord เพื่อติดตามความคืบหน้าหรือขอความช่วยเหลือ

วิสัยทัศน์

ทุกคนควรเข้าถึง AI ไม่ใช่สวนที่มีกำแพงล้อมรอบสำหรับองค์กรขนาดใหญ่และบริการ SaaS

Instrukt มีส่วนช่วยเล็กน้อยในการสร้างเครื่องมือที่ให้อำนาจแก่ผู้ใช้โดยไม่กระทบต่อเสรีภาพของพวกเขา เป้าหมายระยะสั้นคือการทำให้สามารถใช้งานได้โดยอาศัย API และบริการภายนอกน้อยที่สุด ทำให้ผู้ใช้มีตัวเลือกในการเลือกรุ่นในพื้นที่และบริการที่โฮสต์เอง

ใบอนุญาต

ลิขสิทธิ์ (c) 2023 ชากิบ เบน เซียน สงวนลิขสิทธิ์.

Instrukt ได้รับใบอนุญาตด้วยใบอนุญาต AGPL กล่าวโดยสรุปก็คือ ทุกคนสามารถนำไปใช้เพื่อวัตถุประสงค์ใดก็ได้ อย่างไรก็ตาม หากคุณตัดสินใจที่จะสร้างอินสแตนซ์ที่เปิดเผยต่อสาธารณะ ผู้ใช้ของคุณมีสิทธิ์ได้รับสำเนาของซอร์สโค้ด รวมถึงการแก้ไขทั้งหมดที่คุณทำ (ซึ่งจำเป็นต้องพร้อมใช้งานผ่านอินเทอร์เฟซ เช่น ปุ่มบนเว็บไซต์ของคุณ) คุณยังอาจ ไม่แจกจ่ายโปรเจ็กต์นี้ในรูปแบบที่ไม่มีซอร์สโค้ด (เช่น การคอมไพล์/เข้ารหัสโค้ดและการแจกจ่ายเวอร์ชันนี้โดยไม่ต้องแจกจ่ายซอร์สโค้ดที่รวมการเปลี่ยนแปลงที่คุณทำไว้ด้วย คุณสามารถแจกจ่ายสิ่งนี้ในรูปแบบปิดได้ ถ้าคุณด้วย จัดให้มีไฟล์เก็บถาวรแยกต่างหากพร้อมซอร์สโค้ด)