pieces os client sdk for csharp

c＃for c＃for clientsdk

導入

ピースOSクライアントSDKは、OSの上にアプリケーションを作成するために設計された強力なコードエンジンパッケージのセットです。これにより、ローカルでホストされているサーバーとの通信を容易にして、Copilot Chats、Asset Savingなどの機能を有効にします。

このSDKには2つのパッケージがあります。

• feed.os.client-これは、C＃アプリケーションからのピースの機能へのアクセスを提供するコアSDKパッケージです
• feaces.extensions.ai-これは、Microsoft.extensions.aiの実装であり、ピースを使用して複数のLLMをサポートし、スニペット、ファイル、フォルダー、ピースの長期メモリなどのコンテキストをAI会話に追加します。

特徴

SDKのピースは、次の重要な機能を提供します。

1. Copilot Chats：Copilot Chats機能とシームレスに通信します。
2. 資産管理：資産とフォーマットを効率的に保存および管理します。
3. ローカルサーバーの相互作用：さまざまな機能について、ローカルホストサーバーと対話します。
4. Multi-LLMサポート：サポートされているLLMを使用して、アプリを強化します。
5. Copilot Chatsのファイル、フォルダー、およびピースの長期メモリ

インストール

OSクライアントSDKのピースを開始するには、次の手順に従ってください。

1. ピースOSをダウンロード：ピースOSは、SDKに不可欠な機能を提供するプライマリバックエンドサービスとして機能します。オペレーティングシステムに適切なバージョンをダウンロードしてください。

   • macos
   • Windows
   • Linux

2. SDKのインストール：NUGETを使用して、OSクライアントSDKパッケージをインストールします。

   dotnet add package Pieces.OS.Client --prerelease

3. 拡張機能をインストールするSDK ：microsoft.extensions.aiサポートが必要な場合は、peaces.extensions.aiパッケージをインストールします：

   dotnet add package Pieces.Extensions.AI --prerelease

プロジェクト

このリポジトリには、次のプロジェクトが含まれています。

• feed.os.client -OSクライアントSDK
• feaces.extensions.ai-マイクロソフトのサポート
• peaces.os.core-ピースを包む内部ライブラリOSAPI
• feaces.os.client.example- feaces.os.client sdkを使用するための例のコード
• feaces.extensions.ai.example- exems forees.extensions.ai sdkを使用するためのコードの例
• SampleApps-サンプルアプリの選択

サンプルアプリ

• Remind Me-長期メモリを使用して、過去数時間にわたって何に取り組んできたかを思い出させるアプリです。

cees.os.clientの例

./src/Client.Exampleフォルダーにfeaces.os.clientパッケージを使用したプロジェクトの例があります。この例は、さまざまな例を含むコンソールアプリで、それぞれがコメントしました。これらの例を実行するには、実行したい例を除外して、 ./src/Client.Exampleフォルダーからdotnet runします。

この例プロジェクトの詳細は、SRC/Client/readme.mdファイルで提供されています。

cees.extensions.aiの例

./src/Extensions.Exampleフォルダーにfeece.extensions.aiパッケージを使用したプロジェクトの例があります。この例は、さまざまな例を含むコンソールアプリで、それぞれがコメントしました。これらの例を実行するには、実行したい例を解除してから、 ./src/Extensions.Example extensions.exampleフォルダーからdotnet runします。

この例プロジェクトの詳細は、SRC/extensions/readme.mdファイルで提供されています。

パッケージを公開します

このレポは、feaces.os.clientとpeaces.extensions.aiパッケージの両方を公開するためのgithubアクションが含まれています。

feece.extensions.aiパッケージは、feaces.os.clientパッケージに依存します。これが実装される方法は次のとおりです。

• このリポジトリでは、feeps.extensions.aiプロジェクトには、peaces.os.client and peaces.os.coreにプロジェクトに依存しています。
• 公開するアクションでは、このプロジェクトの依存関係が削除され、Nugetパッケージの依存関係が最新のPre-Release feaces.os.coreに追加されます。

これらのパッケージを公開するには、次のことを行います。

• Tag this repo using a tag of client-v<xyz-a> where <xyz-a> is the version string.たとえば、 0.0.10-betaをリリースするには、 client-v0.0.10-betaでタグを付けます。これは、feaces.os.clientパッケージのみを構築および公開します。
• extensions-v0.0.10-betaなど、 extensions-v<xyz-a>のタグを使用して、nugetでfeaces.os.clientパッケージが検証され、公開されたら、タグにタグを付けます。これにより、Nugetパッケージの参照を使用してfeaces.os.clientを使用して、feaces.extensions.aiパッケージが構築され、nugetに公開されます。