@promptbook/openai 0.44.0-20 → 0.44.0-21
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 +40 -0
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -8,10 +8,34 @@ Library to supercharge your use of large language models
|
|
|
8
8
|
[](https://github.com/webgptorg/promptbook/blob/main/LICENSE)
|
|
9
9
|
[](https://snyk.io/test/github/webgptorg/promptbook)
|
|
10
10
|
[](https://github.com/webgptorg/promptbook/issues)
|
|
11
|
+
[](https://socket.dev/npm/package/@promptbook/openai)
|
|
11
12
|
|
|
12
13
|
<!--/Badges-->
|
|
13
14
|
|
|
15
|
+
## 📦 Package `@promptbook/openai`
|
|
16
|
+
|
|
17
|
+
- Promptbooks are [divided into several](#-packages) packages, all are published from [single monorepo](https://github.com/webgptorg/promptbook).
|
|
18
|
+
- This package `@promptbook/openai` is one part of the promptbook ecosystem.
|
|
19
|
+
|
|
20
|
+
To install this package, run:
|
|
21
|
+
|
|
22
|
+
```bash
|
|
23
|
+
npm i @promptbook/openai
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
Wrapper around [OpenAI's SDK](https://www.npmjs.com/package/openai) to make it easier to use inside Promptbooks.
|
|
27
|
+
|
|
28
|
+
<!--!!! Simillar wrappers-->
|
|
29
|
+
|
|
30
|
+
|
|
31
|
+
---
|
|
32
|
+
|
|
33
|
+
Rest of the documentation is common for entire promptbook ecosystem:
|
|
34
|
+
|
|
35
|
+
<!--
|
|
36
|
+
TODO: Probbably remove this section only in packages
|
|
14
37
|
> ⚠ Warning: This library is still in early development.
|
|
38
|
+
-->
|
|
15
39
|
|
|
16
40
|
## 🤍 Whitepaper
|
|
17
41
|
|
|
@@ -282,6 +306,22 @@ flowchart LR
|
|
|
282
306
|
|
|
283
307
|
_Note: We are using [postprocessing functions](#postprocessing-functions) like `unwrapResult` that can be used to postprocess the result._
|
|
284
308
|
|
|
309
|
+
## 📦 Packages
|
|
310
|
+
|
|
311
|
+
This library is divided into several packages, all are published from [single monorepo](https://github.com/webgptorg/promptbook):
|
|
312
|
+
|
|
313
|
+
<!--[🔠]-->
|
|
314
|
+
|
|
315
|
+
- **[@promptbook/core](https://www.npmjs.com/package/@promptbook/core)** - Core of the library, it contains the main logic for promptbooks
|
|
316
|
+
- **[@promptbook/utils](https://www.npmjs.com/package/@promptbook/utils)** - Utility functions used in the library but also useful for individual use in preprocessing and postprocessing LLM inputs and outputs
|
|
317
|
+
- _(Not finished)_ **[@promptbook/wizzard](https://www.npmjs.com/package/@promptbook/wizzard)** - Wizard for creating+running promptbooks in single line
|
|
318
|
+
- **[@promptbook/execute-javascript](https://www.npmjs.com/package/@promptbook/execute-javascript)** - Execution tools for javascript inside promptbooks
|
|
319
|
+
- **[@promptbook/openai](https://www.npmjs.com/package/@promptbook/openai)** - Execution tools for OpenAI API, wrapper around OpenAI SDK
|
|
320
|
+
- **[@promptbook/remote-client](https://www.npmjs.com/package/@promptbook/remote-client)** - Remote client for remote execution of promptbooks
|
|
321
|
+
- **[@promptbook/remote-server](https://www.npmjs.com/package/@promptbook/remote-server)** - Remote server for remote execution of promptbooks
|
|
322
|
+
- **[@promptbook/types](https://www.npmjs.com/package/@promptbook/types)** - Just typescript types used in the library
|
|
323
|
+
- **[@promptbook/cli](https://www.npmjs.com/package/@promptbook/cli)** - Command line interface utilities for promptbooks
|
|
324
|
+
|
|
285
325
|
## 📚 Dictionary
|
|
286
326
|
|
|
287
327
|
The following glossary is used to clarify certain basic concepts:
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@promptbook/openai",
|
|
3
|
-
"version": "0.44.0-
|
|
3
|
+
"version": "0.44.0-21",
|
|
4
4
|
"description": "Library to supercharge your use of large language models",
|
|
5
5
|
"private": false,
|
|
6
6
|
"sideEffects": false,
|
|
@@ -38,7 +38,7 @@
|
|
|
38
38
|
"openai": "4.2.0"
|
|
39
39
|
},
|
|
40
40
|
"peerDependencies": {
|
|
41
|
-
"@promptbook/core": "0.44.0-
|
|
41
|
+
"@promptbook/core": "0.44.0-21"
|
|
42
42
|
},
|
|
43
43
|
"main": "./umd/index.umd.js",
|
|
44
44
|
"module": "./esm/index.es.js",
|