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

openai-assistant-sdk

v1.0.8

Published

An easy way to access the OpenAI Assistant and show it on your website/application.

Downloads

39

Readme

openai-assistant-sdk

openai-assistant-sdk is a Node.js package designed to simplify interactions with OpenAI's Assistant API, particularly for managing conversations (threads) and processing responses with OpenAI's GPT models. This SDK handles thread creation, message sending, and response processing in a structured and easy-to-use manner.

Features

  • Easy to set up and integrate.
  • Manages conversation threads with OpenAI's API.
  • Simplifies sending messages and handling responses.

Installation

Install the package using npm:

npm install openai-assistant-sdk

Usage

Response

{
  message: "Absolutely, I'd love to help! What's the issue you're experiencing?",
  timestamp: 1705522107522,
  thread_id: 'thread_xxxxxxxxxxxxx'
}

Basic Usage

To start using the SDK, you'll need to set up your OpenAI API key in your environment variables. Then, you can create an instance of OpenAIAssistant and interact with OpenAI's API.

Here's a basic example:

const OpenAIAssistant = require("openai-assistant-sdk");
require("dotenv").config();

async function main() {
  try {
    const assistant = new OpenAIAssistant(process.env.ASSISTANT_ID);
    const reply = await assistant.addMessageToThread(
      "Can you help me with an issue?"
    );
    console.log(reply);
  } catch (error) {
    console.error("Error in main:", error);
  }
}

main();

Continuing a Conversation

If you have an existing thread and you want to continue the conversation, you can pass the thread_id as a second parameter to OpenAIAssistant.

const OpenAIAssistant = require("openai-assistant-sdk");
require("dotenv").config();

async function main() {
  try {
    const assistant = new OpenAIAssistant(process.env.ASSISTANT_ID);
    const reply = await assistant.addMessageToThread(
      "thread_xxxxxxxxxxxxxxx",
      "Remember the issue, what if we changed line 10?"
    );
    console.log(reply);
  } catch (error) {
    console.error("Error in main:", error);
  }
}

main();

Configuration

Before you start, make sure you have the following:

  • An API key from OpenAI.
  • The ASSISTANT_ID of your OpenAI model.

Store these in your environment variables for security, an example environment file has been provided.

Contributing

Contributions, issues, and feature requests are welcome! Feel free to check issues page.

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Coding Nexus - @CodingNexus