@promptbook/openai 0.52.0-30 → 0.52.0-32

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 CHANGED
@@ -11,7 +11,6 @@ Library to supercharge your use of large language models
11
11
  [![Issues](https://img.shields.io/github/issues/webgptorg/promptbook.svg?style=flat)](https://github.com/webgptorg/promptbook/issues)
12
12
 
13
13
 
14
- [![Socket Badge](https://socket.dev/api/badge/npm/package/@promptbook/openai)](https://socket.dev/npm/package/@promptbook/openai)
15
14
 
16
15
 
17
16
 
@@ -52,6 +51,7 @@ const promptbook = await library.getPromptbookByUrl(`https://promptbook.studio/m
52
51
  // ▶ Prepare tools
53
52
  const tools = {
54
53
  llm: new OpenAiExecutionTools({
54
+ isVerbose: true,
55
55
  apiKey: process.env.OPENAI_API_KEY,
56
56
  }),
57
57
  script: [new JavascriptExecutionTools()],
@@ -97,15 +97,12 @@ const promptbook = await library.getPromptbookByUrl(`https://promptbook.studio/m
97
97
  const tools = new MultipleLlmExecutionTools(
98
98
  // Note: You can use multiple LLM providers in one Promptbook execution. The best model will be chosen automatically according to the prompt and the model's capabilities.
99
99
  new OpenAiExecutionTools({
100
- isVerbose: true,
101
100
  apiKey: process.env.OPENAI_API_KEY,
102
101
  }),
103
102
  new AnthropicClaudeExecutionTools({
104
- isVerbose: true,
105
103
  apiKey: process.env.ANTHROPIC_CLAUDE_API_KEY,
106
104
  }),
107
105
  new AzureOpenAiExecutionTools({
108
- isVerbose: true,
109
106
  resourceName: process.env.AZUREOPENAI_RESOURCE_NAME,
110
107
  deploymentName: process.env.AZUREOPENAI_DEPLOYMENT_NAME,
111
108
  apiKey: process.env.AZUREOPENAI_API_KEY,
@@ -116,7 +113,7 @@ const tools = new MultipleLlmExecutionTools(
116
113
  const promptbookExecutor = createPromptbookExecutor({ promptbook, tools });
117
114
 
118
115
  // ▶ Prepare input parameters
119
- const inputParameters = { word: 'cat' };
116
+ const inputParameters = { word: 'dog' };
120
117
 
121
118
  // 🚀▶ Execute the Promptbook
122
119
  const result = await promptbookExecutor(inputParameters);
@@ -0,0 +1,7 @@
1
+ /**
2
+ * This error indicates that the promptbook library cannot be propperly loaded
3
+ */
4
+ export declare class PromptbookLibraryError extends Error {
5
+ readonly name = "PromptbookLibraryError";
6
+ constructor(message: string);
7
+ }
@@ -10,6 +10,7 @@ import { RemoteServerOptions } from './interfaces/RemoteServerOptions';
10
10
  */
11
11
  export declare function startRemoteServer(options: RemoteServerOptions): IDestroyable;
12
12
  /**
13
+ * TODO: [⚖] Expose the library to be able to connect to same library via createPromptbookLibraryFromUrl
13
14
  * TODO: Handle progress - support streaming
14
15
  * TODO: [🤹‍♂️] Do not hang up immediately but wait until client closes OR timeout
15
16
  * TODO: [🤹‍♂️] Timeout on chat to free up resources
@@ -22,6 +22,13 @@ type CreatePromptbookLibraryFromDirectoryOptions = {
22
22
  * @default false
23
23
  */
24
24
  isLazyLoaded?: boolean;
25
+ /**
26
+ * If true, whole library creation crashes on error in any promptbook
27
+ * If true and isLazyLoaded is true, the error is thrown on first access to the promptbook
28
+ *
29
+ * @default true
30
+ */
31
+ isCrashOnError?: boolean;
25
32
  };
26
33
  /**
27
34
  * Constructs Promptbook from given directory
@@ -25,5 +25,6 @@ type CreatePromptbookLibraryFromUrlyOptions = {
25
25
  export declare function createPromptbookLibraryFromUrl(url: string_url | URL, options: CreatePromptbookLibraryFromUrlyOptions): Promise<PromptbookLibrary>;
26
26
  export {};
27
27
  /***
28
+ * TODO: [⚖] Compatible with remote server
28
29
  * TODO: [🍓][🚯] !!! Add to README and samples + maybe make `@promptbook/library` package
29
30
  */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@promptbook/openai",
3
- "version": "0.52.0-30",
3
+ "version": "0.52.0-32",
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-30"
51
+ "@promptbook/core": "0.52.0-32"
52
52
  },
53
53
  "main": "./umd/index.umd.js",
54
54
  "module": "./esm/index.es.js",
@@ -0,0 +1,7 @@
1
+ /**
2
+ * This error indicates that the promptbook library cannot be propperly loaded
3
+ */
4
+ export declare class PromptbookLibraryError extends Error {
5
+ readonly name = "PromptbookLibraryError";
6
+ constructor(message: string);
7
+ }
@@ -10,6 +10,7 @@ import { RemoteServerOptions } from './interfaces/RemoteServerOptions';
10
10
  */
11
11
  export declare function startRemoteServer(options: RemoteServerOptions): IDestroyable;
12
12
  /**
13
+ * TODO: [⚖] Expose the library to be able to connect to same library via createPromptbookLibraryFromUrl
13
14
  * TODO: Handle progress - support streaming
14
15
  * TODO: [🤹‍♂️] Do not hang up immediately but wait until client closes OR timeout
15
16
  * TODO: [🤹‍♂️] Timeout on chat to free up resources
@@ -22,6 +22,13 @@ type CreatePromptbookLibraryFromDirectoryOptions = {
22
22
  * @default false
23
23
  */
24
24
  isLazyLoaded?: boolean;
25
+ /**
26
+ * If true, whole library creation crashes on error in any promptbook
27
+ * If true and isLazyLoaded is true, the error is thrown on first access to the promptbook
28
+ *
29
+ * @default true
30
+ */
31
+ isCrashOnError?: boolean;
25
32
  };
26
33
  /**
27
34
  * Constructs Promptbook from given directory
@@ -25,5 +25,6 @@ type CreatePromptbookLibraryFromUrlyOptions = {
25
25
  export declare function createPromptbookLibraryFromUrl(url: string_url | URL, options: CreatePromptbookLibraryFromUrlyOptions): Promise<PromptbookLibrary>;
26
26
  export {};
27
27
  /***
28
+ * TODO: [⚖] Compatible with remote server
28
29
  * TODO: [🍓][🚯] !!! Add to README and samples + maybe make `@promptbook/library` package
29
30
  */