@promptbook/openai 0.27.0-0 → 0.27.0-1

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.
@@ -3,7 +3,7 @@ import type { string_name } from '.././types/typeAliases';
3
3
  import type { TaskProgress } from '../types/TaskProgress';
4
4
  import type { ExecutionReportJson } from '../types/execution-report/ExecutionReportJson';
5
5
  /**
6
- * Executor is a simple async function that takes input parameters and returns result parameters _(along with all intermediate parameters and input parameters = it extends input object)_.
6
+ * Executor is a simple async function that takes INPUT PARAMETERs and returns result parameters _(along with all intermediate parameters and INPUT PARAMETERs = it extends input object)_.
7
7
  * Executor is made by combining execution tools and prompt template pipeline library.
8
8
  *
9
9
  * It can be done in two ways:
@@ -1,7 +1,7 @@
1
1
  import { string_name, string_script } from '.././types/typeAliases';
2
2
  import { ScriptLanguage } from '../types/ScriptLanguage';
3
3
  /**
4
- * Represents all the tools needed to execute scripts
4
+ * Represents all the tools needed to EXECUTE SCRIPTs
5
5
  *
6
6
  * @see https://github.com/webgptorg/promptbook#script-execution-tools
7
7
  */
@@ -46,7 +46,7 @@ export interface ModelCommand {
46
46
  /**
47
47
  * Parameter command describes one parameter of the prompt template
48
48
  *
49
- * - It can tell if it is input or output parameter
49
+ * - It can tell if it is input or OUTPUT PARAMETER
50
50
  * - It can have description
51
51
  * - In description it can have simple formatting BUT not markdown structure or reference to other parameters
52
52
  */
@@ -58,7 +58,7 @@ export interface ParameterCommand {
58
58
  }
59
59
  /**
60
60
  * Postprocess command describes which function to use for postprocessing
61
- * This will be created as separate execute script block bellow
61
+ * This will be created as separate EXECUTE SCRIPT block bellow
62
62
  */
63
63
  export interface PostprocessCommand {
64
64
  readonly type: 'POSTPROCESS';
@@ -2,9 +2,9 @@
2
2
  * Parameters of the prompt template (pipeline)
3
3
  *
4
4
  * There are three types of parameters:
5
- * - **Input parameters** are required to execute the prompt template pipeline.
5
+ * - **INPUT PARAMETERs** are required to execute the prompt template pipeline.
6
6
  * - **Intermediate parameters** are used internally in the prompt template pipeline.
7
- * - **Output parameters** are not used internally in the prompt template pipeline, but are returned as the result of the prompt template pipeline execution.
7
+ * - **OUTPUT PARAMETERs** are not used internally in the prompt template pipeline, but are returned as the result of the prompt template pipeline execution.
8
8
  *
9
9
  * @see https://github.com/webgptorg/promptbook#parameters
10
10
  */
@@ -12,7 +12,7 @@ export interface PromptTemplateParameterJson {
12
12
  /**
13
13
  * The parameter is input of the pipeline
14
14
  *
15
- * Note: Output parameter is every parameter including input one
15
+ * Note: OUTPUT PARAMETER is every parameter including input one
16
16
  */
17
17
  readonly isInput: boolean;
18
18
  /**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@promptbook/openai",
3
- "version": "0.27.0-0",
3
+ "version": "0.27.0-1",
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.27.0-0"
40
+ "@promptbook/core": "0.27.0-1"
41
41
  },
42
42
  "main": "./umd/index.umd.js",
43
43
  "module": "./esm/index.es.js",
@@ -3,7 +3,7 @@ import type { string_name } from '.././types/typeAliases';
3
3
  import type { TaskProgress } from '../types/TaskProgress';
4
4
  import type { ExecutionReportJson } from '../types/execution-report/ExecutionReportJson';
5
5
  /**
6
- * Executor is a simple async function that takes input parameters and returns result parameters _(along with all intermediate parameters and input parameters = it extends input object)_.
6
+ * Executor is a simple async function that takes INPUT PARAMETERs and returns result parameters _(along with all intermediate parameters and INPUT PARAMETERs = it extends input object)_.
7
7
  * Executor is made by combining execution tools and prompt template pipeline library.
8
8
  *
9
9
  * It can be done in two ways:
@@ -1,7 +1,7 @@
1
1
  import { string_name, string_script } from '.././types/typeAliases';
2
2
  import { ScriptLanguage } from '../types/ScriptLanguage';
3
3
  /**
4
- * Represents all the tools needed to execute scripts
4
+ * Represents all the tools needed to EXECUTE SCRIPTs
5
5
  *
6
6
  * @see https://github.com/webgptorg/promptbook#script-execution-tools
7
7
  */
@@ -46,7 +46,7 @@ export interface ModelCommand {
46
46
  /**
47
47
  * Parameter command describes one parameter of the prompt template
48
48
  *
49
- * - It can tell if it is input or output parameter
49
+ * - It can tell if it is input or OUTPUT PARAMETER
50
50
  * - It can have description
51
51
  * - In description it can have simple formatting BUT not markdown structure or reference to other parameters
52
52
  */
@@ -58,7 +58,7 @@ export interface ParameterCommand {
58
58
  }
59
59
  /**
60
60
  * Postprocess command describes which function to use for postprocessing
61
- * This will be created as separate execute script block bellow
61
+ * This will be created as separate EXECUTE SCRIPT block bellow
62
62
  */
63
63
  export interface PostprocessCommand {
64
64
  readonly type: 'POSTPROCESS';
@@ -2,9 +2,9 @@
2
2
  * Parameters of the prompt template (pipeline)
3
3
  *
4
4
  * There are three types of parameters:
5
- * - **Input parameters** are required to execute the prompt template pipeline.
5
+ * - **INPUT PARAMETERs** are required to execute the prompt template pipeline.
6
6
  * - **Intermediate parameters** are used internally in the prompt template pipeline.
7
- * - **Output parameters** are not used internally in the prompt template pipeline, but are returned as the result of the prompt template pipeline execution.
7
+ * - **OUTPUT PARAMETERs** are not used internally in the prompt template pipeline, but are returned as the result of the prompt template pipeline execution.
8
8
  *
9
9
  * @see https://github.com/webgptorg/promptbook#parameters
10
10
  */
@@ -12,7 +12,7 @@ export interface PromptTemplateParameterJson {
12
12
  /**
13
13
  * The parameter is input of the pipeline
14
14
  *
15
- * Note: Output parameter is every parameter including input one
15
+ * Note: OUTPUT PARAMETER is every parameter including input one
16
16
  */
17
17
  readonly isInput: boolean;
18
18
  /**