@promptbook/openai 0.61.0-17 → 0.61.0-18

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/esm/index.es.js CHANGED
@@ -1322,7 +1322,7 @@ var OpenAiExecutionTools = /** @class */ (function () {
1322
1322
  /**
1323
1323
  * The version of the Promptbook library
1324
1324
  */
1325
- var PROMPTBOOK_VERSION = '0.61.0-16';
1325
+ var PROMPTBOOK_VERSION = '0.61.0-17';
1326
1326
  // TODO: !!!! List here all the versions and annotate + put into script
1327
1327
 
1328
1328
  export { OPENAI_MODELS, OpenAiExecutionTools, PROMPTBOOK_VERSION };
@@ -3,36 +3,36 @@ import type { Prompt } from '../types/Prompt';
3
3
  import type { string_pipeline_url } from '../types/typeAliases';
4
4
  import type { PipelineCollection } from './PipelineCollection';
5
5
  /**
6
- * Library of promptbooks that groups together promptbooks for an application.
7
- * This implementation is a very thin wrapper around the Array / Map of promptbooks.
6
+ * Library of pipelines that groups together pipelines for an application.
7
+ * This implementation is a very thin wrapper around the Array / Map of pipelines.
8
8
  *
9
9
  * @private use `createCollectionFromJson` instead
10
- * @see https://github.com/webgptorg/promptbook#promptbook-collection
10
+ * @see https://github.com/webgptorg/pipeline#pipeline-collection
11
11
  */
12
12
  export declare class SimplePipelineCollection implements PipelineCollection {
13
13
  private collection;
14
14
  /**
15
- * Constructs a pipeline collection from promptbooks
15
+ * Constructs a pipeline collection from pipelines
16
16
  *
17
- * @param promptbooks @@@
17
+ * @param pipelines @@@
18
18
  *
19
19
  * @private Use instead `createCollectionFromJson`
20
- * Note: During the construction logic of all promptbooks are validated
20
+ * Note: During the construction logic of all pipelines are validated
21
21
  * Note: It is not recommended to use this constructor directly, use `createCollectionFromJson` *(or other variant)* instead
22
22
  */
23
- constructor(...promptbooks: Array<PipelineJson>);
23
+ constructor(...pipelines: Array<PipelineJson>);
24
24
  /**
25
- * Gets all promptbooks in the collection
25
+ * Gets all pipelines in the collection
26
26
  */
27
27
  listPipelines(): Array<string_pipeline_url>;
28
28
  /**
29
- * Gets promptbook by its URL
29
+ * Gets pipeline by its URL
30
30
  *
31
31
  * Note: This is not a direct fetching from the URL, but a lookup in the collection
32
32
  */
33
33
  getPipelineByUrl(url: string_pipeline_url): PipelineJson;
34
34
  /**
35
- * Checks whether given prompt was defined in any promptbook in the collection
35
+ * Checks whether given prompt was defined in any pipeline in the collection
36
36
  */
37
37
  isResponsibleForPrompt(prompt: Prompt): boolean;
38
38
  }
@@ -6,7 +6,7 @@ import type { PipelineCollection } from '../PipelineCollection';
6
6
  */
7
7
  type CreatePipelineCollectionFromDirectoryOptions = PipelineStringToJsonOptions & {
8
8
  /**
9
- * If true, the directory is searched recursively for promptbooks
9
+ * If true, the directory is searched recursively for pipelines
10
10
  *
11
11
  * @default true
12
12
  */
@@ -24,25 +24,25 @@ type CreatePipelineCollectionFromDirectoryOptions = PipelineStringToJsonOptions
24
24
  */
25
25
  isLazyLoaded?: boolean;
26
26
  /**
27
- * If true, whole collection creation crashes on error in any promptbook
28
- * If true and isLazyLoaded is true, the error is thrown on first access to the promptbook
27
+ * If true, whole collection creation crashes on error in any pipeline
28
+ * If true and isLazyLoaded is true, the error is thrown on first access to the pipeline
29
29
  *
30
30
  * @default true
31
31
  */
32
32
  isCrashedOnError?: boolean;
33
33
  };
34
34
  /**
35
- * Constructs Promptbook from given directory
35
+ * Constructs Pipeline from given directory
36
36
  *
37
37
  * Note: Works only in Node.js environment because it reads the file system
38
38
  *
39
- * @param path - path to the directory with promptbooks
39
+ * @param path - path to the directory with pipelines
40
40
  * @param options - Misc options for the collection
41
41
  * @returns PipelineCollection
42
42
  */
43
43
  export declare function createCollectionFromDirectory(path: string_folder_path, options?: CreatePipelineCollectionFromDirectoryOptions): Promise<PipelineCollection>;
44
44
  export {};
45
45
  /**
46
- * TODO: !!!! [🧠] Library precompilation and do not mix markdown and json promptbooks
47
- * Note: [🟢] This code should never be published outside of `@promptbook/node`
46
+ * TODO: !!!! [🧠] Library precompilation and do not mix markdown and json pipelines
47
+ * Note: [🟢] This code should never be published outside of `@pipeline/node`
48
48
  */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@promptbook/openai",
3
- "version": "0.61.0-17",
3
+ "version": "0.61.0-18",
4
4
  "description": "Supercharge your use of large language models",
5
5
  "private": false,
6
6
  "sideEffects": false,
@@ -49,7 +49,7 @@
49
49
  }
50
50
  ],
51
51
  "peerDependencies": {
52
- "@promptbook/core": "0.61.0-17"
52
+ "@promptbook/core": "0.61.0-18"
53
53
  },
54
54
  "main": "./umd/index.umd.js",
55
55
  "module": "./esm/index.es.js",
package/umd/index.umd.js CHANGED
@@ -1330,7 +1330,7 @@
1330
1330
  /**
1331
1331
  * The version of the Promptbook library
1332
1332
  */
1333
- var PROMPTBOOK_VERSION = '0.61.0-16';
1333
+ var PROMPTBOOK_VERSION = '0.61.0-17';
1334
1334
  // TODO: !!!! List here all the versions and annotate + put into script
1335
1335
 
1336
1336
  exports.OPENAI_MODELS = OPENAI_MODELS;
@@ -3,36 +3,36 @@ import type { Prompt } from '../types/Prompt';
3
3
  import type { string_pipeline_url } from '../types/typeAliases';
4
4
  import type { PipelineCollection } from './PipelineCollection';
5
5
  /**
6
- * Library of promptbooks that groups together promptbooks for an application.
7
- * This implementation is a very thin wrapper around the Array / Map of promptbooks.
6
+ * Library of pipelines that groups together pipelines for an application.
7
+ * This implementation is a very thin wrapper around the Array / Map of pipelines.
8
8
  *
9
9
  * @private use `createCollectionFromJson` instead
10
- * @see https://github.com/webgptorg/promptbook#promptbook-collection
10
+ * @see https://github.com/webgptorg/pipeline#pipeline-collection
11
11
  */
12
12
  export declare class SimplePipelineCollection implements PipelineCollection {
13
13
  private collection;
14
14
  /**
15
- * Constructs a pipeline collection from promptbooks
15
+ * Constructs a pipeline collection from pipelines
16
16
  *
17
- * @param promptbooks @@@
17
+ * @param pipelines @@@
18
18
  *
19
19
  * @private Use instead `createCollectionFromJson`
20
- * Note: During the construction logic of all promptbooks are validated
20
+ * Note: During the construction logic of all pipelines are validated
21
21
  * Note: It is not recommended to use this constructor directly, use `createCollectionFromJson` *(or other variant)* instead
22
22
  */
23
- constructor(...promptbooks: Array<PipelineJson>);
23
+ constructor(...pipelines: Array<PipelineJson>);
24
24
  /**
25
- * Gets all promptbooks in the collection
25
+ * Gets all pipelines in the collection
26
26
  */
27
27
  listPipelines(): Array<string_pipeline_url>;
28
28
  /**
29
- * Gets promptbook by its URL
29
+ * Gets pipeline by its URL
30
30
  *
31
31
  * Note: This is not a direct fetching from the URL, but a lookup in the collection
32
32
  */
33
33
  getPipelineByUrl(url: string_pipeline_url): PipelineJson;
34
34
  /**
35
- * Checks whether given prompt was defined in any promptbook in the collection
35
+ * Checks whether given prompt was defined in any pipeline in the collection
36
36
  */
37
37
  isResponsibleForPrompt(prompt: Prompt): boolean;
38
38
  }
@@ -6,7 +6,7 @@ import type { PipelineCollection } from '../PipelineCollection';
6
6
  */
7
7
  type CreatePipelineCollectionFromDirectoryOptions = PipelineStringToJsonOptions & {
8
8
  /**
9
- * If true, the directory is searched recursively for promptbooks
9
+ * If true, the directory is searched recursively for pipelines
10
10
  *
11
11
  * @default true
12
12
  */
@@ -24,25 +24,25 @@ type CreatePipelineCollectionFromDirectoryOptions = PipelineStringToJsonOptions
24
24
  */
25
25
  isLazyLoaded?: boolean;
26
26
  /**
27
- * If true, whole collection creation crashes on error in any promptbook
28
- * If true and isLazyLoaded is true, the error is thrown on first access to the promptbook
27
+ * If true, whole collection creation crashes on error in any pipeline
28
+ * If true and isLazyLoaded is true, the error is thrown on first access to the pipeline
29
29
  *
30
30
  * @default true
31
31
  */
32
32
  isCrashedOnError?: boolean;
33
33
  };
34
34
  /**
35
- * Constructs Promptbook from given directory
35
+ * Constructs Pipeline from given directory
36
36
  *
37
37
  * Note: Works only in Node.js environment because it reads the file system
38
38
  *
39
- * @param path - path to the directory with promptbooks
39
+ * @param path - path to the directory with pipelines
40
40
  * @param options - Misc options for the collection
41
41
  * @returns PipelineCollection
42
42
  */
43
43
  export declare function createCollectionFromDirectory(path: string_folder_path, options?: CreatePipelineCollectionFromDirectoryOptions): Promise<PipelineCollection>;
44
44
  export {};
45
45
  /**
46
- * TODO: !!!! [🧠] Library precompilation and do not mix markdown and json promptbooks
47
- * Note: [🟢] This code should never be published outside of `@promptbook/node`
46
+ * TODO: !!!! [🧠] Library precompilation and do not mix markdown and json pipelines
47
+ * Note: [🟢] This code should never be published outside of `@pipeline/node`
48
48
  */