pieces os client sdk for csharp

Stücke OS Client SDK für C#

Einführung

Das STICE OS -Client -SDK ist eine Reihe leistungsstarker Code -Engine -Pakete, die für das Schreiben von Anwendungen auf dem Betriebssystem für die Stücke entwickelt wurden. Es erleichtert die Kommunikation mit einem lokal gehosteten Server, um Funktionen wie Copilot -Chats, Asset -Speichern und mehr zu ermöglichen.

Dieser SDK hat 2 Pakete:

• Poies.os.client - Dies ist das Kern -SDK
• Poies.extensions.ai - Dies ist eine Implementierung von microsoft.extensions.ai, deren Stücke verwendet werden, um mehrere LLMs zu unterstützen sowie Kontext wie Snippets, Dateien, Ordner und Teile für das Langzeitgedächtnis zu Ihrer KI -Konversation hinzuzufügen.

Merkmale

Die Stücke SDK bietet die folgenden Schlüsselmerkmale:

1. Copilot -Chats: Nahtlos mit Copilot -Chats -Funktionen kommunizieren.
2. Asset Management: Sparen und verwalten Sie effizient und Formate.
3. Lokale Serverinteraktion: Interagieren Sie mit einem lokal gehosteten Server für verschiedene Funktionen.
4. Multi-Llm-Unterstützung: Verwenden Sie alle unterstützten Stücke, die LLM unterstützt, um Ihre App mit Strom zu versorgen.
5. Datei, Ordner und Teile Langzeitspeicher in Copilot-Chats

Installation

Befolgen Sie die folgenden Schritte, um mit dem Stücke OS -Client -SDK zu beginnen:

1. Download Pieces OS : Pieces OS dient als primärer Backend -Service und bietet wesentliche Funktionen für die SDK. Laden Sie die entsprechende Version für Ihr Betriebssystem herunter:

   • macos
   • Fenster
   • Linux

2. Installieren Sie das SDK : Verwenden Sie Nuget, um das SDK -Paket für Teile des Betriebssystems zu installieren:

   dotnet add package Pieces.OS.Client --prerelease

3. Installieren Sie die Erweiterungen SDK : Wenn Sie Microsoft.EXTENSIONS.AI -Unterstützung wünschen, installieren Sie die Stücke.EXTENSSS.AI -Pakete:

   dotnet add package Pieces.Extensions.AI --prerelease

Projekte

Dieses Repo enthält die folgenden Projekte:

• Poies.os.client - Der OS -Client SDK
• Poies.extensions.ai - Unterstützung für microsoft.extensions.ai
• Poies.os.core - Eine interne Bibliothek, die die Stücke OS -API einwickelt
• Poies.os.client.example - Beispielcode für die Verwendung der stücke.os.client sdk
• Poies.extensions.ai.example - Beispielcode für die Verwendung der poies.extensions.ai sdk
• SampleApps - Eine Auswahl von Beispiel -Apps

Beispiel -Apps

• Erinnern Sie mich an - eine App, die Sie daran erinnert, woran Sie in den letzten Stunden mit Teilen mit Langzeitgedächtnis gearbeitet haben.

Poies.os.client Beispiele

Es gibt ein Beispielprojekt, das das Paket von Pieces.OS.Client im Ordner ./src/Client.Example verwendet. Dieses Beispiel ist eine Konsolen -App, die eine Reihe verschiedener Beispiele enthält, die jeweils kommentiert werden. Um diese Beispiele auszuführen, wenden Sie sich an die, die Sie ausführen möchten, und führen Sie dotnet run aus dem Ordner ./src/Client.Example aus.

Einzelheiten zu diesem Beispielprojekt finden Sie in der Datei SRC/Client/Readme.md.

Pieft.extensions.ai Beispiele

Es gibt ein Beispielprojekt, das das Paket von Pities.Extensions.ai im Ordner ./src/Extensions.Example unter Verwendung von ./Src/extensions.example gibt. Dieses Beispiel ist eine Konsolen -App, die eine Reihe verschiedener Beispiele enthält, die jeweils kommentiert werden. Um diese Beispiele auszuführen, wenden Sie sich an die, die Sie ausführen möchten, und führen Sie dotnet run aus dem Ordner ./src/Extensions.Example aus.

Einzelheiten zu diesem Beispielprojekt finden Sie in der Datei SRC/Extensions/Readme.md.

Veröffentlichen Sie die Pakete

Dieses Repo enthält GitHub -Aktionen, um sowohl die Pakete.os.os.client und poies.extensions.ai -Pakete zu veröffentlichen.

Das Paket von Pieces.Extensions.AI ist von der Paket für die Stücke abhängig. Die Art und Weise, wie dies implementiert wird, ist:

• In diesem Repo hat das Projekt The Pieces.Extensions.AI eine Projektabhängigkeit von poies.os.client und poies.os.core
• Bei der Veröffentlichung der Aktion wird diese Projektabhängigkeit entfernt und eine Nuget-Paketabhängigkeit zu den neuesten Pre-Release-Stücken hinzugefügt.OS.CORE.

Um diese Pakete zu veröffentlichen, machen Sie Folgendes:

• Tag mit einem Tag von client-v<xyz-a> wobei <xyz-a> die Versionszeichenfolge ist. Zum Beispiel, um 0.0.10-beta zu veröffentlichen, werden Sie mit client-v0.0.10-beta markiert. Dadurch wird nur das Paket für Pities.OS.Client erstellt und veröffentlicht.
• extensions-v<xyz-a> das Paket extensions-v0.0.10-beta Stücke. Dadurch wird das Paket für stücke. EXTERSISSSS.AIs mit dem Nuget -Paket -Verweis auf poies.os.client und veröffentlichen bei Nuget.