@promptbook/types 0.68.0-4 → 0.68.0-5

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.
@@ -14,6 +14,7 @@ import type { PrettifyOptions } from '../conversion/prettify/PrettifyOptions';
14
14
  import type { renderPipelineMermaidOptions } from '../conversion/prettify/renderPipelineMermaidOptions';
15
15
  import type { ErrorJson } from '../errors/utils/ErrorJson';
16
16
  import type { AvailableModel } from '../execution/AvailableModel';
17
+ import type { CommonExecutionToolsOptions } from '../execution/CommonExecutionToolsOptions';
17
18
  import type { EmbeddingVector } from '../execution/EmbeddingVector';
18
19
  import type { ExecutionTools } from '../execution/ExecutionTools';
19
20
  import type { LlmExecutionTools } from '../execution/LlmExecutionTools';
@@ -238,6 +239,7 @@ export type { PrettifyOptions };
238
239
  export type { renderPipelineMermaidOptions };
239
240
  export type { ErrorJson };
240
241
  export type { AvailableModel };
242
+ export type { CommonExecutionToolsOptions };
241
243
  export type { EmbeddingVector };
242
244
  export type { ExecutionTools };
243
245
  export type { LlmExecutionTools };
@@ -8,5 +8,13 @@ import type { TemplateCommand } from './TemplateCommand';
8
8
  */
9
9
  export declare const templateCommandParser: PipelineTemplateCommandParser<TemplateCommand>;
10
10
  /**
11
- * Note: [⛱] There are two types of KNOWLEDGE, ACTION and INSTRUMENT commands @@@!!!!!!
11
+ * Note: [⛱] There are two types of KNOWLEDGE, ACTION and INSTRUMENT commands:
12
+ * 1) There are commands `KNOWLEDGE`, `ACTION` and `INSTRUMENT` used in the pipeline head, they just define the knowledge, action or instrument as single line after the command
13
+ * - KNOWLEDGE Look at https://en.wikipedia.org/wiki/Artificial_intelligence
14
+ * 2) `KNOWLEDGE TEMPLATE` which has short form `KNOWLEDGE` is used in the template, does not refer the line itself, but the content of the template
15
+ * - KNOWLEDGE TEMPLATE
16
+ *
17
+ * ```
18
+ * Look at https://en.wikipedia.org/wiki/Artificial_intelligence
19
+ * ```
12
20
  */
@@ -9,6 +9,3 @@ import type { BoilerplateCommand } from './BoilerplateCommand';
9
9
  * @private within the commands folder
10
10
  */
11
11
  export declare const boilerplateCommandParser: PipelineBothCommandParser<BoilerplateCommand>;
12
- /**
13
- * TODO: !!!!!! Make .ptbk.md file with examples of the BOILERPLATE command and fail
14
- */
@@ -1,7 +1,7 @@
1
1
  /**
2
2
  * @@@
3
3
  *
4
- * @private just abstract the common properties for the execution tools
4
+ * Note: Keep it public to allow people to make their own execution tools
5
5
  */
6
6
  export type CommonExecutionToolsOptions = {
7
7
  /**
@@ -86,6 +86,7 @@ export type PipelineJson = {
86
86
  readonly preparations: Array<PreparationJson>;
87
87
  };
88
88
  /**
89
+ * TODO: [🛳] Default PERSONA for the pipeline `defaultPersonaName` (same as `defaultModelRequirements`)
89
90
  * TODO: [🍙] Make some standard order of json properties
90
91
  * TODO: [🧠] Maybe wrap all {parameterNames} in brackets for example { "resultingParameterName": "{foo}" }
91
92
  * Note: [💼] There was a proposal for multiple types of promptbook objects 78816ff33e2705ee1a187aa2eb8affd976d4ea1a
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@promptbook/types",
3
- "version": "0.68.0-4",
3
+ "version": "0.68.0-5",
4
4
  "description": "Supercharge your use of large language models",
5
5
  "private": false,
6
6
  "sideEffects": false,
@@ -45,6 +45,6 @@
45
45
  ],
46
46
  "typings": "./esm/typings/src/_packages/types.index.d.ts",
47
47
  "peerDependencies": {
48
- "@promptbook/core": "0.68.0-4"
48
+ "@promptbook/core": "0.68.0-5"
49
49
  }
50
50
  }