🦑 Shoggoth 🦑

A powerful npm package for managing AI-powered backends, featuring a multitude of masks, tools, and models.

Table of Contents

• Features
• Installation
• Usage
• API Documentation
• Examples
• Contributing
• License

Features

• 👺 Masks -> Create a multitude of personas for your LLM, call and manage each at will.
• 🔧 Tools -> Default tool integration. Create your own custom tools and let the shoggoth sort it's uses and outputs
• 🧠 Models -> Configure different models to use on your backend, calling the right model for each job.
• 💬 Convos -> Manage the conversations history, keeping the token count inside the limits of the model API.
• 🦑 Shoggoth -> Manage all the masks, tools, models and convos. Provides a simple interface to send messages, parse answers and activate tools. Provide hooks for interactions in your backend.

Installation

Install the package using npm:

npm install shoggoth

Usage

Shoggoth provides the base objects for a simple implementation. You should extend the base classes to customize the shoggoth to your needs.

Please refer to the Github Wiki:

shoggoth docs

Examples

basic usage

Contributing

Anyone is welcome to contribute.

Please follow the guideline below:

1 - Open an issue first. Any pull request should be througly discussed before being implemented.

2 - Fork the repository.

3 - Create a new branch with the name of the feature or fix.

4 - Make your changes.

5 - Write tests for your changes.

6 - Open a pull request. The pull request will only be reviewed if it pass the the linter, prettier and tests.

License

ISC