pieces os client sdk for csharp

Pièces OS Client SDK pour C #

Introduction

Le SDK du client des pièces OS est un ensemble de packages de moteurs de code puissants conçus pour écrire des applications sur les pièces OS. Il facilite la communication avec un serveur hébergé localement pour activer des fonctionnalités telles que les chats de copilote, l'enregistrement des actifs, etc.

Ce SDK a 2 packages:

• Pièces.os.client - Il s'agit du package SDK de base qui donne accès aux fonctionnalités des pièces de votre application C #
• Piets.Extensions.ai - Il s'agit d'une implémentation de Microsoft.Extensions.ai Utilisation de pièces pour fournir une prise en charge de plusieurs LLM, ainsi que de l'ajout de contextes tels que des extraits, des fichiers, des dossiers et des pièces à long terme de la mémoire à long terme à votre conversation IA.

Caractéristiques

Le SDK des pièces propose les caractéristiques clés suivantes:

1. Copilot Chats: Communiquez parfaitement avec la fonctionnalité Copilot Chats.
2. Gestion des actifs: Économisez et gérez efficacement les actifs et les formats.
3. Interaction du serveur local: interagissez avec un serveur hébergé localement pour diverses fonctionnalités.
4. Prise en charge Multi-LLM: utilisez toutes les pièces prises en charge LLM pour alimenter votre application.
5. Fichier, dossier et pièces de mémoire à long terme dans les chats copilot

Installation

Pour commencer avec le SDK du client OS Pièces, suivez ces étapes:

1. Télécharger des pièces OS : Pièces OS sert de service backend principal, offrant des fonctionnalités essentielles pour le SDK. Téléchargez la version appropriée pour votre système d'exploitation:

   • macos
   • Fenêtre
   • Linux

2. Installez le SDK : Utilisez Nuget pour installer le package SDK des pièces OS Client:

   dotnet add package Pieces.OS.Client --prerelease

3. Installez les extensions SDK : Si vous voulez Microsoft.Extensions.ai Prise en charge, installez les pièces.Extensions.ai Package:

   dotnet add package Pieces.Extensions.AI --prerelease

Projets

Ce repo contient les projets suivants:

• Piets.os.Client - Le SDK du client OS
• Piets.Extensions.ai - Prise en charge de Microsoft.Extensions.ai
• Piets.OS.Core - Une bibliothèque interne enveloppe l'API OS PIETS
• Piets.os.client.example - Exemple de code pour l'utilisation du SDK Piets.os.Client
• Piets.Extensions.ai.example - Exemple de code pour utiliser les pièces.extensions.ai sdk
• SampleApps - Une sélection d'applications d'échantillons

Exemples d'applications

• Rappelez-moi - une application qui vous rappelle ce sur quoi vous avez travaillé au cours des dernières heures en utilisant des pièces à long terme de la mémoire.

Pièces.os.client exemples

Il existe un exemple de projet utilisant le package Piets.os.Client dans le dossier ./src/Client.Example . Cet exemple est une application de console contenant une gamme d'exemples différents, a commenté chacun. Pour exécuter ces exemples, décommentez celui que vous souhaitez exécuter, puis exécutez dotnet run le dossier ./src/Client.Example .

Les détails de cet exemple de projet sont fournis dans le fichier src / client / readme.md.

Pièces.extensions.ai exemples

Il existe un exemple de projet utilisant le package Piets.Extensions.ai dans le dossier ./src/Extensions.Example . Cet exemple est une application de console contenant une gamme d'exemples différents, a commenté chacun. Pour exécuter ces exemples, décommentez celui que vous souhaitez exécuter, puis exécutez dotnet run le dossier ./src/Extensions.Example .

Les détails de cet exemple de projet sont fournis dans le fichier SRC / Extensions / Readme.md.

Publier les packages

Ce repo comprend des actions GitHub pour publier à la fois les pièces.

Le package Piets.Extensions.ai dépend du package Pieces.os.client. La façon dont cela est mis en œuvre est:

• Dans ce dépôt, le projet Piets.Extensions.ai a une dépendance du projet sur des pièces.os.client et des pièces.os.core
• Dans l'action de publication, cette dépendance du projet est supprimée et une dépendance de package NuGet est ajoutée aux dernières pièces de pré-libération.os.core.

Pour publier ces packages, faites ce qui suit:

• Tags ce répension à l'aide d'une balise de client-v<xyz-a> où <xyz-a> est la chaîne de version. Par exemple, pour libérer 0.0.10-beta vous marqueriez avec client-v0.0.10-beta . Cela ne fera que construire et publier le package Piets.os.client.
• Une fois que le package Piets.OS.Client a été validé et rendu public sur NuGet, étiquetez le repo en utilisant une balise d' extensions-v<xyz-a> , par exemple extensions-v0.0.10-beta . Cela créera le package Piets.extensions.ai en utilisant la référence du package NuGet à des pièces.os.client et publiez sur NuGet.