Skip to content

Latest commit

 

History

History
67 lines (49 loc) · 2.99 KB

README.md

File metadata and controls

67 lines (49 loc) · 2.99 KB
Raw

Suppress.js 🤖🚀

Easily and responsibly integrate AI into your applications!

Documentation Status npm GitHub Repo stars join

Demo

Why Suppress.js? 🤔

Whether you're a beginner looking to dive into AI or an expert developer seeking a quick and clean way to incorporate AI into your projects, Suppress.js is the go-to library for seamless AI integration.

Features ✨

  • Beginner-friendly: Get started with AI easily, no prior experience needed
  • Responsible AI: Designed with ethics and responsibility in mind
  • Extensible: Compatible with a wide range of AI models and platforms
  • Lightweight: Small library size ensures minimal impact on your application's performance

Quickstart 🏁

  1. Install Suppress.js: npm install ai.suppress.js
  2. Import the library: const { SuppresServer, DataGenerator, OpenAILLM } = require("ai.suppress.js");
  3. Initialize and use AI models:
const server = new SuppresServer();
const llm = new OpenAILLM("OPENAI_API_KEY");
  1. Enjoy seamless AI integration!
server.createEndpoint(
    "/hello/:name/:country",
    "GET",
    new DataGenerator(
        "Write a greeting for {name}. Create a brief description of {country}, in which the user lives.",
        JSON.stringify({"greeting":"string", "description":"string"}),
        llm
        )
    );

Documentation 📚

For detailed usage instructions, examples, and customization options, visit our documentation.

Get Involved 💡

We're always looking for collaborators! If you're interested in joining the team and contributing to the project, get in touch!

🚨 Responsibility & Security 🚨

When building apps which rely on AI, it is important to consider many factors. Here are some tools to help you build responsibly.

Models

Suppress.js on it own supports OpenAI models for now. However, you can use any model that is supported by HuggingFace Transformers, if you also install mix.suppress.js package.

Key Features

  • Gives structure to data produced by LLMs
  • Allows for effortless integration of AI into existing projects
  • You send the data, suppress handles it. You want the data? Suppress gets it.