@promptbook/openai 0.36.3 → 0.37.0

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.
@@ -1,2 +1,5 @@
1
1
  import { Wizzard } from '../wizzard/Wizzard';
2
2
  export { Wizzard };
3
+ /**
4
+ * TODO: [🧙‍♂️]
5
+ */
@@ -28,7 +28,7 @@ type PromptbookLibraryOptions = {
28
28
  * @see https://github.com/webgptorg/promptbook#prompt-template-pipeline-library
29
29
  */
30
30
  export declare class PromptbookLibrary {
31
- protected readonly options: PromptbookLibraryOptions;
31
+ readonly options: PromptbookLibraryOptions;
32
32
  /**
33
33
  * Constructs Promptbook from any sources
34
34
  *
@@ -37,4 +37,5 @@ export {};
37
37
  * TODO: [🧠] When not meet expectations in PROMPT_DIALOG, make some way to tell the user
38
38
  * TODO: [👧] Strongly type the executors to avoid need of remove nullables whtn noUncheckedIndexedAccess in tsconfig.json
39
39
  * Note: CreatePromptbookExecutorOptions are just connected to PromptbookExecutor so do not extract to types folder
40
+ * TODO: [🧠][3] transparent = (report intermediate parameters) / opaque execution = (report only output parameters) progress reporting mode
40
41
  */
@@ -59,7 +59,8 @@ export interface JokerCommand {
59
59
  */
60
60
  export interface ParameterCommand {
61
61
  readonly type: 'PARAMETER';
62
- readonly isInputParameter: boolean;
62
+ readonly isInput: boolean;
63
+ readonly isOutput: boolean;
63
64
  readonly parameterName: string_name;
64
65
  readonly parameterDescription: string_markdown_text | null;
65
66
  }
@@ -11,10 +11,12 @@ export interface PromptTemplateParameterJson {
11
11
  readonly name: string_name;
12
12
  /**
13
13
  * The parameter is input of the pipeline
14
- *
15
- * Note: OUTPUT PARAMETER is every parameter including input one
16
14
  */
17
15
  readonly isInput: boolean;
16
+ /**
17
+ * The parameter is output of the pipeline
18
+ */
19
+ readonly isOutput: boolean;
18
20
  /**
19
21
  * Description of the parameter
20
22
  * - It can use simple markdown formatting like **bold**, *italic*, [link](https://example.com), ... BUT not code blocks and structure
@@ -1 +1,4 @@
1
1
  export declare const Wizzard: any;
2
+ /**
3
+ * TODO: [🧙‍♂️]
4
+ */
@@ -1,5 +1,6 @@
1
1
  export {};
2
2
  /**
3
+ * TODO: [🧙‍♂️]
3
4
  url, sources nebo folder
4
5
  * TODO: [🧠] OpenAi apiKey vs token
5
6
  */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@promptbook/openai",
3
- "version": "0.36.3",
3
+ "version": "0.37.0",
4
4
  "description": "Library to supercharge your use of large language models",
5
5
  "private": false,
6
6
  "sideEffects": false,
@@ -37,7 +37,7 @@
37
37
  "openai": "4.2.0"
38
38
  },
39
39
  "peerDependencies": {
40
- "@promptbook/core": "0.36.3"
40
+ "@promptbook/core": "0.37.0"
41
41
  },
42
42
  "main": "./umd/index.umd.js",
43
43
  "module": "./esm/index.es.js",
@@ -1,2 +1,5 @@
1
1
  import { Wizzard } from '../wizzard/Wizzard';
2
2
  export { Wizzard };
3
+ /**
4
+ * TODO: [🧙‍♂️]
5
+ */
@@ -28,7 +28,7 @@ type PromptbookLibraryOptions = {
28
28
  * @see https://github.com/webgptorg/promptbook#prompt-template-pipeline-library
29
29
  */
30
30
  export declare class PromptbookLibrary {
31
- protected readonly options: PromptbookLibraryOptions;
31
+ readonly options: PromptbookLibraryOptions;
32
32
  /**
33
33
  * Constructs Promptbook from any sources
34
34
  *
@@ -37,4 +37,5 @@ export {};
37
37
  * TODO: [🧠] When not meet expectations in PROMPT_DIALOG, make some way to tell the user
38
38
  * TODO: [👧] Strongly type the executors to avoid need of remove nullables whtn noUncheckedIndexedAccess in tsconfig.json
39
39
  * Note: CreatePromptbookExecutorOptions are just connected to PromptbookExecutor so do not extract to types folder
40
+ * TODO: [🧠][3] transparent = (report intermediate parameters) / opaque execution = (report only output parameters) progress reporting mode
40
41
  */
@@ -59,7 +59,8 @@ export interface JokerCommand {
59
59
  */
60
60
  export interface ParameterCommand {
61
61
  readonly type: 'PARAMETER';
62
- readonly isInputParameter: boolean;
62
+ readonly isInput: boolean;
63
+ readonly isOutput: boolean;
63
64
  readonly parameterName: string_name;
64
65
  readonly parameterDescription: string_markdown_text | null;
65
66
  }
@@ -11,10 +11,12 @@ export interface PromptTemplateParameterJson {
11
11
  readonly name: string_name;
12
12
  /**
13
13
  * The parameter is input of the pipeline
14
- *
15
- * Note: OUTPUT PARAMETER is every parameter including input one
16
14
  */
17
15
  readonly isInput: boolean;
16
+ /**
17
+ * The parameter is output of the pipeline
18
+ */
19
+ readonly isOutput: boolean;
18
20
  /**
19
21
  * Description of the parameter
20
22
  * - It can use simple markdown formatting like **bold**, *italic*, [link](https://example.com), ... BUT not code blocks and structure
@@ -1 +1,4 @@
1
1
  export declare const Wizzard: any;
2
+ /**
3
+ * TODO: [🧙‍♂️]
4
+ */
@@ -1,5 +1,6 @@
1
1
  export {};
2
2
  /**
3
+ * TODO: [🧙‍♂️]
3
4
  url, sources nebo folder
4
5
  * TODO: [🧠] OpenAi apiKey vs token
5
6
  */