@promptbook/openai 0.52.0-3 → 0.52.0-4
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 +38 -0
- package/esm/typings/execution/plugins/script-execution-tools/javascript/JavascriptEvalExecutionTools.d.ts +1 -1
- package/esm/typings/execution/plugins/script-execution-tools/javascript/JavascriptExecutionTools.d.ts +1 -1
- package/package.json +2 -2
- package/umd/typings/execution/plugins/script-execution-tools/javascript/JavascriptEvalExecutionTools.d.ts +1 -1
- package/umd/typings/execution/plugins/script-execution-tools/javascript/JavascriptExecutionTools.d.ts +1 -1
package/README.md
CHANGED
|
@@ -34,7 +34,45 @@ Wrapper around [OpenAI's SDK](https://www.npmjs.com/package/openai) to make it e
|
|
|
34
34
|
|
|
35
35
|
|
|
36
36
|
|
|
37
|
+
## Usage
|
|
37
38
|
|
|
39
|
+
```typescript
|
|
40
|
+
import { createPromptbookExecutor, createPromptbookLibraryFromDirectory } from '@promptbook/core';
|
|
41
|
+
import { JavascriptEvalExecutionTools } from '@promptbook/execute-javascript';
|
|
42
|
+
import { OpenAiExecutionTools } from '@promptbook/openai';
|
|
43
|
+
import { assertsExecutionSuccessful } from '@promptbook/utils';
|
|
44
|
+
|
|
45
|
+
// TODO: !!!!! Test that this code works
|
|
46
|
+
// TODO: !!!!! Comment
|
|
47
|
+
|
|
48
|
+
const library = createPromptbookLibraryFromDirectory('./promptbook');
|
|
49
|
+
const promptbook = library.getPromptbookByUrl(`https://promptbook.studio/my-library/write-article.ptbk.md`);
|
|
50
|
+
|
|
51
|
+
const tools = {
|
|
52
|
+
llm: new OpenAiExecutionTools({
|
|
53
|
+
apiKey: process.env.OPENAI_API_KEY,
|
|
54
|
+
}),
|
|
55
|
+
script: [new JavascriptEvalExecutionTools()],
|
|
56
|
+
};
|
|
57
|
+
|
|
58
|
+
const promptbookExecutor = createPromptbookExecutor({ promptbook, tools });
|
|
59
|
+
|
|
60
|
+
const inputParameters = { word: 'cat' };
|
|
61
|
+
const { isSuccessful, errors, outputParameters, executionReport } = await promptbookExecutor(inputParameters);
|
|
62
|
+
|
|
63
|
+
console.info(outputParameters);
|
|
64
|
+
|
|
65
|
+
assertsExecutionSuccessful({ isSuccessful, errors });
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
|
|
69
|
+
|
|
70
|
+
## Other models
|
|
71
|
+
|
|
72
|
+
See the other models available in the Promptbook package:
|
|
73
|
+
|
|
74
|
+
- [Azure OpenAI](https://www.npmjs.com/package/@promptbook/azure-openai)
|
|
75
|
+
- [Anthropic Claude](https://www.npmjs.com/package/@promptbook/anthropic-claude)
|
|
38
76
|
|
|
39
77
|
|
|
40
78
|
---
|
|
@@ -8,7 +8,7 @@ import { JavascriptExecutionToolsOptions } from './JavascriptExecutionToolsOptio
|
|
|
8
8
|
*/
|
|
9
9
|
export declare class JavascriptEvalExecutionTools implements ScriptExecutionTools {
|
|
10
10
|
private readonly options;
|
|
11
|
-
constructor(options
|
|
11
|
+
constructor(options?: JavascriptExecutionToolsOptions);
|
|
12
12
|
/**
|
|
13
13
|
* Executes a JavaScript
|
|
14
14
|
*/
|
|
@@ -7,7 +7,7 @@ import { JavascriptExecutionToolsOptions } from './JavascriptExecutionToolsOptio
|
|
|
7
7
|
*/
|
|
8
8
|
export declare class JavascriptExecutionTools implements ScriptExecutionTools {
|
|
9
9
|
private readonly options;
|
|
10
|
-
constructor(options
|
|
10
|
+
constructor(options?: JavascriptExecutionToolsOptions);
|
|
11
11
|
/**
|
|
12
12
|
* Executes a JavaScript
|
|
13
13
|
*/
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@promptbook/openai",
|
|
3
|
-
"version": "0.52.0-
|
|
3
|
+
"version": "0.52.0-4",
|
|
4
4
|
"description": "Library to supercharge your use of large language models",
|
|
5
5
|
"private": false,
|
|
6
6
|
"sideEffects": false,
|
|
@@ -48,7 +48,7 @@
|
|
|
48
48
|
}
|
|
49
49
|
],
|
|
50
50
|
"peerDependencies": {
|
|
51
|
-
"@promptbook/core": "0.52.0-
|
|
51
|
+
"@promptbook/core": "0.52.0-4"
|
|
52
52
|
},
|
|
53
53
|
"main": "./umd/index.umd.js",
|
|
54
54
|
"module": "./esm/index.es.js",
|
|
@@ -8,7 +8,7 @@ import { JavascriptExecutionToolsOptions } from './JavascriptExecutionToolsOptio
|
|
|
8
8
|
*/
|
|
9
9
|
export declare class JavascriptEvalExecutionTools implements ScriptExecutionTools {
|
|
10
10
|
private readonly options;
|
|
11
|
-
constructor(options
|
|
11
|
+
constructor(options?: JavascriptExecutionToolsOptions);
|
|
12
12
|
/**
|
|
13
13
|
* Executes a JavaScript
|
|
14
14
|
*/
|
|
@@ -7,7 +7,7 @@ import { JavascriptExecutionToolsOptions } from './JavascriptExecutionToolsOptio
|
|
|
7
7
|
*/
|
|
8
8
|
export declare class JavascriptExecutionTools implements ScriptExecutionTools {
|
|
9
9
|
private readonly options;
|
|
10
|
-
constructor(options
|
|
10
|
+
constructor(options?: JavascriptExecutionToolsOptions);
|
|
11
11
|
/**
|
|
12
12
|
* Executes a JavaScript
|
|
13
13
|
*/
|