@loopstack/ai-module 0.20.1 → 0.20.2
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 +2 -45
- package/package.json +8 -4
package/README.md
CHANGED
|
@@ -19,52 +19,9 @@ This module is essential for workflows that need natural language processing, co
|
|
|
19
19
|
|
|
20
20
|
## Installation
|
|
21
21
|
|
|
22
|
-
|
|
22
|
+
See [SETUP.md](./SETUP.md) for installation and setup instructions.
|
|
23
23
|
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
```bash
|
|
27
|
-
loopstack add @loopstack/ai-module
|
|
28
|
-
```
|
|
29
|
-
|
|
30
|
-
This command copies the source files into your `src` directory.
|
|
31
|
-
|
|
32
|
-
- It is a great way to explore the code to learn new concepts or add own customizations
|
|
33
|
-
- It will set up the module for you, so you do not need to manually update your application
|
|
34
|
-
|
|
35
|
-
### b) Install via `npm install` (recommended)
|
|
36
|
-
|
|
37
|
-
```bash
|
|
38
|
-
npm install --save @loopstack/ai-module
|
|
39
|
-
```
|
|
40
|
-
|
|
41
|
-
Use npm install if you want to use and maintain the module as node dependency.
|
|
42
|
-
|
|
43
|
-
- Use this, if you do not need to make changes to the code or want to review the source code.
|
|
44
|
-
|
|
45
|
-
### Configure API Keys
|
|
46
|
-
|
|
47
|
-
Set your provider API keys as environment variables:
|
|
48
|
-
|
|
49
|
-
```bash
|
|
50
|
-
# OpenAI
|
|
51
|
-
OPENAI_API_KEY=sk-...
|
|
52
|
-
|
|
53
|
-
# Anthropic
|
|
54
|
-
ANTHROPIC_API_KEY=sk-ant-...
|
|
55
|
-
```
|
|
56
|
-
|
|
57
|
-
## Setup
|
|
58
|
-
|
|
59
|
-
### 1. Manual setup (optional)
|
|
60
|
-
|
|
61
|
-
> This step is automatically done for you when using the `loopstack add` command.
|
|
62
|
-
|
|
63
|
-
- Add `AiModule` to the imports of `default.module.ts` or any other custom module.
|
|
64
|
-
|
|
65
|
-
See here for more information about working with [Modules](https://loopstack.ai/docs/building-with-loopstack/creating-a-module) and [Workspaces](https://loopstack.ai/docs/building-with-loopstack/creating-workspaces)
|
|
66
|
-
|
|
67
|
-
### 2. Use in Your Workflow
|
|
24
|
+
## Usage
|
|
68
25
|
|
|
69
26
|
Inject the tools and documents in your workflow class:
|
|
70
27
|
|
package/package.json
CHANGED
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
"openai",
|
|
11
11
|
"tool"
|
|
12
12
|
],
|
|
13
|
-
"version": "0.20.
|
|
13
|
+
"version": "0.20.2",
|
|
14
14
|
"license": "Apache-2.0",
|
|
15
15
|
"author": {
|
|
16
16
|
"name": "Jakob Klippel",
|
|
@@ -34,8 +34,8 @@
|
|
|
34
34
|
"@ai-sdk/anthropic": "^3.0.23",
|
|
35
35
|
"@ai-sdk/openai": "^3.0.19",
|
|
36
36
|
"@ai-sdk/provider-utils": "^4.0.9",
|
|
37
|
-
"@loopstack/common": "^0.20.
|
|
38
|
-
"@loopstack/core-ui-module": "^0.20.
|
|
37
|
+
"@loopstack/common": "^0.20.3",
|
|
38
|
+
"@loopstack/core-ui-module": "^0.20.2",
|
|
39
39
|
"@nestjs/common": "^11.1.12",
|
|
40
40
|
"@nestjs/config": "^4.0.2",
|
|
41
41
|
"@nestjs/core": "^11.1.12",
|
|
@@ -66,6 +66,10 @@
|
|
|
66
66
|
"maxWorkers": 1
|
|
67
67
|
},
|
|
68
68
|
"loopstack": {
|
|
69
|
-
"module": "src/ai.module.ts"
|
|
69
|
+
"module": "src/ai.module.ts",
|
|
70
|
+
"installModes": [
|
|
71
|
+
"add",
|
|
72
|
+
"install"
|
|
73
|
+
]
|
|
70
74
|
}
|
|
71
75
|
}
|