@aigne/example-chat-bot v1.9.8

Chatbot Example

This example demonstrates how to create and run an agent-based chatbot using the AIGNE Framework and AIGNE CLI. The example now supports both one-shot and interactive chat modes, along with customizable model settings and pipeline input/output.

Prerequisites

• Node.js and npm installed on your machine
• An OpenAI API key for interacting with OpenAI's services
• Optional dependencies (if running the example from source code):
  • Pnpm for package management
  • Bun for running unit tests & examples

Quick Start (No Installation Required)

export OPENAI_API_KEY=YOUR_OPENAI_API_KEY # Set your OpenAI API key

# Run in one-shot mode (default)
npx -y @aigne/example-chat-bot

# Run in interactive chat mode
npx -y @aigne/example-chat-bot --chat

# Use pipeline input
echo "Tell me about AIGNE Framework" | npx -y @aigne/example-chat-bot

Installation

Clone the Repository

git clone https://github.com/AIGNE-io/aigne-framework

Install Dependencies

cd aigne-framework/examples/chat-bot

pnpm install

Setup Environment Variables

Setup your OpenAI API key in the .env.local file:

OPENAI_API_KEY="" # Set your OpenAI API key here

Run the Example

pnpm start # Run in one-shot mode (default)

# Run in interactive chat mode
pnpm start -- --chat

# Use pipeline input
echo "Tell me about AIGNE Framework" | pnpm start

Run Options

The example supports the following command-line parameters:

Examples

# Run in chat mode (interactive)
pnpm start -- --chat

# Set logging level
pnpm start -- --log-level DEBUG

# Use pipeline input
echo "Tell me about AIGNE Framework" | pnpm start