npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

nestjs-assistant-tool

v0.0.1

Published

A NestJS package designed to generate OpenAI-compatible tools from named controllers and providers. This package simplifies the integration of AI functionalities into your existing or new NestJS applications.

Downloads

143

Readme

NestJS Assistant Tool

A NestJS package designed to generate OpenAI-compatible tools from named controllers and providers. This package simplifies the integration of AI functionalities into your existing or new NestJS applications.

Installation

To install the package, run:

npm install nestjs-assistant-tool

Usage

To use the package, import it in your NestJS module and configure it as needed.

The package provides the following decorators:

AssistantTool: Used to mark a controller or provider method as an assistant tool. AssistantToolParameter: Used to mark a parameter in a method as an assistant tool parameter.

Example

Here's a basic example of how to set up the package in your NestJS application.

In your module file, import the AssistantToolModule and add it to the imports array.

app.module.ts

import { Module } from "@nestjs/common";
import { AssistantToolModule } from "nestjs-assistant-tool";
import { AppController } from "./app.controller";
import { AppService } from "./app.service";
import OpenAI from "openai";

@Module({
  imports: [
    AssistantToolModule.register({
      openAIClient: new OpenAI({
        apiKey: process.env.OPENAI_API_KEY,
        baseURL: process.env.OPENAI_BASE_URL,
      }),
    }),
  ],
  controllers: [AppController],
  providers: [AppService],
})
export class AppModule {}

app.service.ts

@Injectable()
export class AppService {
  constructor(private readonly assistantToolService: AssistantToolService) {}

  @AssistantTool({
    description:
      "returns the user information, including their name, languages they speak, and the registered country.",
  })
  async getUser(
    @AssistantToolParameter({
      description:
        "the user's name. if name does not exist, user should provide one",
    })
    name: string
  ) {
    return {
      name: "the-wunmi",
      languages: ["en", "sw"],
      country: "NGA",
    };
  }
}
@Injectable()
export class ChatService {
  constructor(private readonly assistantToolService: AssistantToolService) {}

  async message(text: string) {
    const response = await assistantToolService.completeChat({
      messages: [
        {
          role: "user",
          content: text,
        },
      ],
      model: "gpt-4",
    });
    return response;
  }
}