@aigne/example-chat-bot 1.4.1-6 → 1.4.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +7 -6
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -1,18 +1,19 @@
|
|
|
1
1
|
# Chatbot Example
|
|
2
2
|
|
|
3
|
-
This
|
|
3
|
+
This example demonstrates how to create and run an agent-based chatbot using the [AIGNE Framework](https://github.com/AIGNE-io/aigne-framework) and [AIGNE CLI](https://github.com/AIGNE-io/aigne-framework/blob/main/docs/cli.md).
|
|
4
4
|
|
|
5
5
|
## Prerequisites
|
|
6
6
|
|
|
7
7
|
- [Node.js](https://nodejs.org) and npm installed on your machine
|
|
8
|
-
- [
|
|
9
|
-
-
|
|
10
|
-
- [Pnpm](https://pnpm.io)
|
|
8
|
+
- An [OpenAI API key](https://platform.openai.com/api-keys) for interacting with OpenAI's services
|
|
9
|
+
- Optional dependencies (if running the example from source code):
|
|
10
|
+
- [Pnpm](https://pnpm.io) for package management
|
|
11
|
+
- [Bun](https://bun.sh) for running unit tests & examples
|
|
11
12
|
|
|
12
|
-
##
|
|
13
|
+
## Quick Start (No Installation Required)
|
|
13
14
|
|
|
14
15
|
```bash
|
|
15
|
-
export OPENAI_API_KEY=YOUR_OPENAI_API_KEY #
|
|
16
|
+
export OPENAI_API_KEY=YOUR_OPENAI_API_KEY # Set your OpenAI API key
|
|
16
17
|
|
|
17
18
|
npx -y @aigne/example-chat-bot # Run the example
|
|
18
19
|
```
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aigne/example-chat-bot",
|
|
3
|
-
"version": "1.4.1
|
|
3
|
+
"version": "1.4.1",
|
|
4
4
|
"description": "A demonstration of using AIGNE Framework to build a chat bot",
|
|
5
5
|
"author": "Arcblock <blocklet@arcblock.io> https://github.com/blocklet",
|
|
6
6
|
"homepage": "https://github.com/AIGNE-io/aigne-framework/tree/main/examples/chat-bot",
|
|
@@ -18,10 +18,10 @@
|
|
|
18
18
|
"README.md"
|
|
19
19
|
],
|
|
20
20
|
"dependencies": {
|
|
21
|
-
"@aigne/cli": "^1.5.1
|
|
21
|
+
"@aigne/cli": "^1.5.1"
|
|
22
22
|
},
|
|
23
23
|
"scripts": {
|
|
24
|
-
"start": "
|
|
24
|
+
"start": "bun run index.ts",
|
|
25
25
|
"lint": "tsc --noEmit"
|
|
26
26
|
}
|
|
27
27
|
}
|