pieces os client sdk for csharp

Pieces OS Client SDK สำหรับ C#

การแนะนำ

Pieces OS Client SDK เป็นชุดของแพ็คเกจเครื่องยนต์รหัสที่ทรงพลังที่ออกแบบมาสำหรับการเขียนแอปพลิเคชันด้านบนของชิ้นส่วน OS ช่วยอำนวยความสะดวกในการสื่อสารกับเซิร์ฟเวอร์ที่โฮสต์ในพื้นที่เพื่อเปิดใช้งานคุณสมบัติเช่นแชท Copilot การบันทึกสินทรัพย์และอื่น ๆ

SDK นี้มี 2 แพ็คเกจ:

• piece.os.client - นี่คือแพ็คเกจ Core SDK ที่ให้การเข้าถึงคุณสมบัติของชิ้นส่วนจากแอปพลิเคชัน C# ของคุณ
• pieces.extensions.ai - นี่คือการใช้งานของ microsoft.extensions.ai โดยใช้ชิ้นส่วนเพื่อให้การสนับสนุน LLM หลายรายการรวมถึงการเพิ่มบริบทเช่นตัวอย่างตัวอย่างไฟล์โฟลเดอร์และหน่วยความจำระยะยาวในการสนทนา AI ของคุณ

คุณสมบัติ

ชิ้น SDK นำเสนอคุณสมบัติสำคัญต่อไปนี้:

1. Copilot Chats: สื่อสารกับฟังก์ชั่นการแชท Copilot ได้อย่างราบรื่น
2. การจัดการสินทรัพย์: บันทึกและจัดการสินทรัพย์และรูปแบบได้อย่างมีประสิทธิภาพ
3. การโต้ตอบกับเซิร์ฟเวอร์ท้องถิ่น: โต้ตอบกับเซิร์ฟเวอร์ที่โฮสต์ในเครื่องสำหรับฟังก์ชั่นต่าง ๆ
4. การรองรับ Multi-LLM: ใช้ชิ้นส่วนใด ๆ ที่รองรับ LLM เพื่อเพิ่มพลังงานแอปของคุณ
5. ไฟล์, โฟลเดอร์และชิ้นส่วนหน่วยความจำระยะยาวในการแชท Copilot

การติดตั้ง

ในการเริ่มต้นด้วยไคลเอ็นต์ Piece OS SDK ให้ทำตามขั้นตอนเหล่านี้:

1. ดาวน์โหลด Pieces OS : Pieces OS ทำหน้าที่เป็นบริการแบ็กเอนด์หลักให้ฟังก์ชั่นที่จำเป็นสำหรับ SDK ดาวน์โหลดเวอร์ชันที่เหมาะสมสำหรับระบบปฏิบัติการของคุณ:

   • แม็กอส
   • หน้าต่าง
   • ลินเวกซ์

2. ติดตั้ง SDK : ใช้ NUGET เพื่อติดตั้งแพ็คเกจ SDK ไคลเอ็นต์ Piece OS:

   dotnet add package Pieces.OS.Client --prerelease

3. ติดตั้งส่วนขยาย SDK : หากคุณต้องการการสนับสนุน microsoft.extensions.ai ให้ติดตั้ง piece.extensions.ai แพ็คเกจ: แพ็คเกจ:

   dotnet add package Pieces.Extensions.AI --prerelease

โครงการ

repo นี้มีโครงการต่อไปนี้:

• piece.os.client - ไคลเอนต์ OS SDK
• piece.extensions.ai - รองรับ microsoft.extensions.ai
• piece.os.core - ห้องสมุดภายในห่อชิ้นส่วน OS API
• piece.os.client.example - ตัวอย่างโค้ดสำหรับการใช้ piece.os.client sdk
• piece.extensions.ai.example - ตัวอย่างโค้ดสำหรับการใช้ piece.extensions.ai sdk
• SampleApps - การเลือกแอพตัวอย่าง

ตัวอย่างแอพ

• เตือนฉัน - แอพที่เตือนคุณเกี่ยวกับสิ่งที่คุณได้ทำงานในช่วงสองสามชั่วโมงที่ผ่านมาโดยใช้หน่วยความจำระยะยาว

pieces.os.client ตัวอย่าง

มีตัวอย่างโครงการโดยใช้แพ็คเกจ piece.os.client ในโฟลเดอร์ ./src/Client.Example ตัวอย่างนี้เป็นแอพคอนโซลที่มีช่วงของตัวอย่างที่แตกต่างกันแต่ละรายการแสดงความคิดเห็น ในการเรียกใช้ตัวอย่างเหล่านี้ให้ไม่รู้สึกตัวที่คุณต้องการเรียกใช้จากนั้นเรียกใช้ dotnet run จากโฟลเดอร์ ./src/Client.Example

รายละเอียดของโครงการตัวอย่างนี้มีอยู่ในไฟล์ SRC/Client/Readme.md

pieces.extensions.ai ตัวอย่าง

มีตัวอย่างโครงการที่ใช้ piece.extensions.ai ในโฟลเดอร์ ./src/Extensions.Example ตัวอย่างนี้เป็นแอพคอนโซลที่มีช่วงของตัวอย่างที่แตกต่างกันแต่ละรายการแสดงความคิดเห็น ในการเรียกใช้ตัวอย่างเหล่านี้ให้ไม่รู้สึกถึงสิ่งที่คุณต้องการเรียกใช้จากนั้นเรียกใช้ dotnet run จากโฟลเดอร์ ./src/Extensions.Example

รายละเอียดของโครงการตัวอย่างนี้มีให้ในไฟล์ SRC/Extensions/ReadMe.md

เผยแพร่แพ็คเกจ

repo นี้รวมถึงการกระทำของ gitHub เพื่อเผยแพร่ทั้งสอง pieces.os.client และ piece.extensions.ai แพ็คเกจ

แพ็คเกจ pieces.extensions.ai ขึ้นอยู่กับแพ็คเกจ pieces.os.client วิธีที่นำไปใช้คือ:

• ใน repo นี้ Piece.extensions.ai โครงการมีการพึ่งพาโครงการใน piece.os.client และ pieces.os.core
• ในการดำเนินการในการเผยแพร่การพึ่งพาโครงการนี้จะถูกลบออกและการพึ่งพาแพ็คเกจ NUGET จะถูกเพิ่มเข้าไปในชิ้นส่วนล่าสุดที่วางจำหน่ายล่าสุด

หากต้องการเผยแพร่แพ็คเกจเหล่านี้ให้ทำสิ่งต่อไปนี้:

• แท็ก repo นี้โดยใช้แท็กของ client-v<xyz-a> โดยที่ <xyz-a> เป็นสตริงเวอร์ชัน ตัวอย่างเช่นในการปล่อย 0.0.10-beta คุณจะติดแท็กด้วย client-v0.0.10-beta สิ่งนี้จะสร้างและเผยแพร่แพ็คเกจ Piece.os.Client เท่านั้น
• เมื่อแพ็คเกจ pieces.os.Client ได้รับการตรวจสอบแล้วและเปิดเผยต่อสาธารณะใน NUGET ให้แท็ก repo โดยใช้แท็กของ extensions-v<xyz-a> ตัวอย่างเช่น extensions-v0.0.10-beta สิ่งนี้จะสร้างแพ็คเกจ pieces.extensions.ai โดยใช้แพ็คเกจ NUGET อ้างอิงเป็น piece.os.client และเผยแพร่ไปยัง NuGet