pieces os client sdk for csharp

Piezas OS Cliente SDK para C#

Introducción

El SDK del cliente del sistema operativo Pieces es un conjunto de poderosos paquetes de motor de código diseñados para escribir aplicaciones en la parte superior de Pieces OS. Facilita la comunicación con un servidor alojado localmente para habilitar características como chats de copilot, ahorro de activos y más.

Este SDK tiene 2 paquetes:

• Pieces.os.client: este es el paquete SDK central que proporciona acceso a las características de las piezas desde su aplicación C#
• Pieces.extensions.ai: esta es una implementación de Microsoft.extensions.ai usando piezas para proporcionar soporte para múltiples LLM, así como agregar contexto como fragmentos, archivos, carpetas y memoria a largo plazo en su conversación de IA.

Características

Las piezas SDK ofrecen las siguientes características clave:

1. Chats de copilot: comuníquese sin problemas con la funcionalidad de chats de copilot.
2. Gestión de activos: guardar y administrar activos y formatos de manera eficiente.
3. Interacción del servidor local: interactúe con un servidor alojado localmente para diversas funcionalidades.
4. Soporte multi-LLM: use cualquier pieza compatible con LLM para alimentar su aplicación.
5. Memoria a largo plazo de archivo, carpeta y piezas en chats de copiloto

Instalación

Para comenzar con el SDK del cliente del sistema operativo, siga estos pasos:

1. Descargar piezas del sistema operativo : Pieces OS sirve como el servicio principal de backend, que proporciona funcionalidad esencial para el SDK. Descargue la versión apropiada para su sistema operativo:

   • macosa
   • Windows
   • Linux

2. Instale el SDK : use NUGET para instalar el paquete SDK del cliente del sistema operativo Piezas:

   dotnet add package Pieces.OS.Client --prerelease

3. Instale el SDK de Extensions : si desea soporte de microsoft.extensions.ai, instale el paquete Pieces.extensions.ai:

   dotnet add package Pieces.Extensions.AI --prerelease

Proyectos

Este repositorio contiene los siguientes proyectos:

• Pieces.os.client: el cliente OS SDK
• Pieces.extensions.ai - Soporte para Microsoft.extensions.ai
• Pieces.os.core: una biblioteca interna que envuelve las piezas OS API
• Piezas.os.client.example - código de ejemplo para usar piezas.os.client SDK
• Piezas.extensions.ai.example - código de ejemplo para usar Pieces.extensions.ai SDK
• SampleApps: una selección de aplicaciones de muestra

Aplicaciones de muestra

• Recuérdame: una aplicación que te recuerda en lo que has estado trabajando en las últimas horas usando piezas de memoria a largo plazo.

Pieces.os.Client Ejemplos

Hay un proyecto de ejemplo que usa el paquete Pieces.os.client en la carpeta ./src/Client.Example . Este ejemplo es una aplicación de consola que contiene una variedad de diferentes ejemplos, cada uno comentado. Para ejecutar estos ejemplos, descomposición el que desea ejecutar, luego ejecute dotnet run desde la carpeta ./src/Client.Example .

Los detalles de este proyecto de ejemplo se proporcionan en el archivo SRC/Client/Readme.md.

Piezas. Extensiones. Ejemplos dei

Hay un proyecto de ejemplo que usa el paquete Pieces.extensions.ai en la carpeta ./src/Extensions.Example . Este ejemplo es una aplicación de consola que contiene una variedad de diferentes ejemplos, cada uno comentado. Para ejecutar estos ejemplos, descomposición el que desea ejecutar, luego ejecute dotnet run desde la carpeta ./src/Extensions.Example .

Los detalles de este proyecto de ejemplo se proporcionan en el archivo SRC/Extensions/ReadMe.md.

Publicar los paquetes

Este repositorio incluye acciones de GitHub para publicar los paquetes de piezas.os.client y piezas.extensions.ai.

El paquete Pieces.Extensions.ai depende del paquete Pieces.os.client. La forma en que esto se implementa es:

• En este repositorio, el proyecto Pieces.extensions.ai tiene una dependencia del proyecto en piezas.os.client y piezas.os.core
• En la acción para publicar, se elimina la dependencia del proyecto y se agrega una dependencia del paquete NUGET a las últimas piezas de prelgrime.os.core.

Para publicar estos paquetes, haga lo siguiente:

• Etiquete este repositorio usando una etiqueta de client-v<xyz-a> donde <xyz-a> es la cadena de versión. Por ejemplo, para liberar 0.0.10-beta , etiquetaría con client-v0.0.10-beta . Esto solo construirá y publicará el paquete Pieces.os.client.
• Una vez que el paquete Pieces.os.client ha sido validado y hecho público en Nuget, etiquete el repositorio usando una etiqueta de extensions-v<xyz-a> , por ejemplo extensions-v0.0.10-beta . Esto construirá el paquete Pieces.Extensions.ai utilizando la referencia del paquete Nuget a Pieces.os.client y publicará en Nuget.