@promptbook/remote-server 0.69.0-15 → 0.69.0-17

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.
Files changed (25) hide show
  1. package/README.md +5 -0
  2. package/esm/index.es.js +7 -7
  3. package/esm/typings/promptbook-collection/index.d.ts +0 -3
  4. package/esm/typings/src/cli/cli-commands/make.d.ts +1 -1
  5. package/esm/typings/src/collection/constructors/createCollectionFromUrl.d.ts +1 -1
  6. package/esm/typings/src/config.d.ts +2 -2
  7. package/esm/typings/src/conversion/pipelineStringToJsonSync.d.ts +1 -1
  8. package/esm/typings/src/conversion/validation/validatePipeline.d.ts +5 -5
  9. package/esm/typings/src/knowledge/prepare-knowledge/markdown/prepareKnowledgeFromMarkdown.d.ts +1 -1
  10. package/esm/typings/src/knowledge/prepare-knowledge/pdf/prepareKnowledgeFromPdf.d.ts +1 -1
  11. package/esm/typings/src/llm-providers/_common/utils/cache/CacheItem.d.ts +1 -1
  12. package/esm/typings/src/llm-providers/anthropic-claude/anthropic-claude-models.d.ts +1 -1
  13. package/esm/typings/src/llm-providers/anthropic-claude/createAnthropicClaudeExecutionTools.d.ts +2 -2
  14. package/esm/typings/src/llm-providers/anthropic-claude/playground/playground.d.ts +2 -2
  15. package/esm/typings/src/llm-providers/openai/playground/playground.d.ts +1 -1
  16. package/esm/typings/src/personas/preparePersona.d.ts +1 -1
  17. package/esm/typings/src/prepare/isPipelinePrepared.d.ts +1 -1
  18. package/esm/typings/src/prepare/prepareTemplates.d.ts +1 -1
  19. package/esm/typings/src/types/PipelineJson/PipelineJson.d.ts +1 -1
  20. package/esm/typings/src/types/typeAliases.d.ts +1 -1
  21. package/esm/typings/src/utils/serialization/checkSerializableAsJson.d.ts +1 -1
  22. package/esm/typings/src/utils/serialization/isSerializableAsJson.d.ts +1 -1
  23. package/package.json +2 -2
  24. package/umd/index.umd.js +7 -7
  25. package/esm/typings/src/personas/preparePersona.test.d.ts +0 -1
package/README.md CHANGED
@@ -16,6 +16,10 @@ Supercharge your use of large language models
16
16
 
17
17
 
18
18
 
19
+ ## ✨ New Features
20
+
21
+ - ✨ **Support of [OpenAI o1 model](https://openai.com/o1/)**
22
+
19
23
  ## 📦 Package `@promptbook/remote-server`
20
24
 
21
25
  - Promptbooks are [divided into several](#-packages) packages, all are published from [single monorepo](https://github.com/webgptorg/promptbook).
@@ -33,6 +37,7 @@ npm install @promptbook/remote-server
33
37
 
34
38
 
35
39
 
40
+
36
41
  ---
37
42
 
38
43
  Rest of the documentation is common for **entire promptbook ecosystem**:
package/esm/index.es.js CHANGED
@@ -7,8 +7,8 @@ import spaceTrim$1, { spaceTrim } from 'spacetrim';
7
7
  /**
8
8
  * The version of the Promptbook library
9
9
  */
10
- var PROMPTBOOK_VERSION = '0.69.0-14';
11
- // TODO: !!!! List here all the versions and annotate + put into script
10
+ var PROMPTBOOK_VERSION = '0.69.0-16';
11
+ // TODO:[main] !!!! List here all the versions and annotate + put into script
12
12
 
13
13
  /*! *****************************************************************************
14
14
  Copyright (c) Microsoft Corporation.
@@ -318,7 +318,7 @@ function checkSerializableAsJson(name, value) {
318
318
  }
319
319
  /**
320
320
  * TODO: [🧠][🛣] More elegant way to tracking than passing `name`
321
- * TODO: [🧠] !!! In-memory cache of same values to prevent multiple checks
321
+ * TODO: [🧠][main] !!! In-memory cache of same values to prevent multiple checks
322
322
  * Note: [🐠] This is how `checkSerializableAsJson` + `isSerializableAsJson` together can just retun true/false or rich error message
323
323
  */
324
324
 
@@ -1159,10 +1159,10 @@ function startRemoteServer(options) {
1159
1159
  case 1:
1160
1160
  _c.trys.push([1, 14, 15, 16]);
1161
1161
  if (isAnonymous === true && !isAnonymousModeAllowed) {
1162
- throw new PipelineExecutionError("Anonymous mode is not allowed"); // <- TODO: !!! Test
1162
+ throw new PipelineExecutionError("Anonymous mode is not allowed"); // <- TODO:[main] !!! Test
1163
1163
  }
1164
1164
  if (isAnonymous === false && !isCollectionModeAllowed) {
1165
- throw new PipelineExecutionError("Collection mode is not allowed"); // <- TODO: !!! Test
1165
+ throw new PipelineExecutionError("Collection mode is not allowed"); // <- TODO:[main] !!! Test
1166
1166
  }
1167
1167
  llmExecutionTools = void 0;
1168
1168
  if (!(isAnonymous === true && llmToolsConfiguration !== null)) return [3 /*break*/, 2];
@@ -1253,10 +1253,10 @@ function startRemoteServer(options) {
1253
1253
  case 1:
1254
1254
  _b.trys.push([1, 3, 4, 5]);
1255
1255
  if (isAnonymous === true && !isAnonymousModeAllowed) {
1256
- throw new PipelineExecutionError("Anonymous mode is not allowed"); // <- TODO: !!! Test
1256
+ throw new PipelineExecutionError("Anonymous mode is not allowed"); // <- TODO:[main] !!! Test
1257
1257
  }
1258
1258
  if (isAnonymous === false && !isCollectionModeAllowed) {
1259
- throw new PipelineExecutionError("Collection mode is not allowed"); // <- TODO: !!! Test
1259
+ throw new PipelineExecutionError("Collection mode is not allowed"); // <- TODO:[main] !!! Test
1260
1260
  }
1261
1261
  llmExecutionTools = void 0;
1262
1262
  if (isAnonymous === true) {
@@ -1,7 +1,6 @@
1
1
  declare const _default: ({
2
2
  title: string;
3
3
  pipelineUrl: string;
4
- promptbookVersion: string;
5
4
  parameters: {
6
5
  name: string;
7
6
  description: string;
@@ -24,7 +23,6 @@ declare const _default: ({
24
23
  } | {
25
24
  title: string;
26
25
  pipelineUrl: string;
27
- promptbookVersion: string;
28
26
  parameters: {
29
27
  name: string;
30
28
  description: string;
@@ -53,7 +51,6 @@ declare const _default: ({
53
51
  } | {
54
52
  title: string;
55
53
  pipelineUrl: string;
56
- promptbookVersion: string;
57
54
  parameters: {
58
55
  name: string;
59
56
  description: string;
@@ -6,7 +6,7 @@ import type { Command as Program } from 'commander';
6
6
  */
7
7
  export declare function initializeMakeCommand(program: Program): void;
8
8
  /**
9
- * TODO: [🥃] !!! Allow `ptbk make` without configuring any llm tools
9
+ * TODO: [🥃][main] !!! Allow `ptbk make` without configuring any llm tools
10
10
  * TODO: Maybe remove this command - "about" command should be enough?
11
11
  * TODO: [0] DRY Javascript and typescript - Maybe make ONLY typescript and for javascript just remove types
12
12
  * Note: [🟡] This code should never be published outside of `@promptbook/cli`
@@ -25,5 +25,5 @@ type CreatePipelineCollectionFromUrlyOptions = {
25
25
  export declare function createCollectionFromUrl(url: string_url | URL, options: CreatePipelineCollectionFromUrlyOptions): Promise<PipelineCollection>;
26
26
  export {};
27
27
  /**
28
- * TODO: !!!! [🧠] Library precompilation and do not mix markdown and json promptbooks
28
+ * TODO:[main] !!!! [🧠] Library precompilation and do not mix markdown and json promptbooks
29
29
  */
@@ -69,14 +69,14 @@ export declare const MAX_EXECUTION_ATTEMPTS = 3;
69
69
  export declare const MAX_FILENAME_LENGTH = 30;
70
70
  /**
71
71
  * @@@
72
- * TODO: [🐝] !!! Use
72
+ * TODO: [🐝][main] !!! Use
73
73
  *
74
74
  * @public exported from `@promptbook/core`
75
75
  */
76
76
  export declare const MAX_KNOWLEDGE_SOURCES_SCRAPING_DEPTH = 3;
77
77
  /**
78
78
  * @@@
79
- * TODO: [🐝] !!! Use
79
+ * TODO: [🐝][main] !!! Use
80
80
  *
81
81
  * @public exported from `@promptbook/core`
82
82
  */
@@ -18,7 +18,7 @@ import type { PipelineString } from '../types/PipelineString';
18
18
  */
19
19
  export declare function pipelineStringToJsonSync(pipelineString: PipelineString): PipelineJson;
20
20
  /**
21
- * TODO: !!!! Warn if used only sync version
21
+ * TODO:[main] !!!! Warn if used only sync version
22
22
  * TODO: [🚞] Report here line/column of error
23
23
  * TODO: Use spaceTrim more effectively
24
24
  * TODO: [🧠] Parameter flags - isInput, isOutput, isInternal
@@ -32,11 +32,11 @@ export declare function validatePipelineCore(pipeline: PipelineJson): void;
32
32
  * > ex port function validatePipeline(promptbook: really_unknown): asserts promptbook is PipelineJson {
33
33
  */
34
34
  /**
35
- * TODO: [🐣] !!!! Validate that all samples match expectations
36
- * TODO: [🐣][🐝] !!!! Validate that knowledge is valid (non-void)
37
- * TODO: [🐣] !!!! Validate that persona can be used only with CHAT variant
38
- * TODO: [🐣] !!!! Validate that parameter with reserved name not used RESERVED_PARAMETER_NAMES
39
- * TODO: [🐣] !!!! Validate that reserved parameter is not used as joker
35
+ * TODO: [🐣][main] !!!! Validate that all samples match expectations
36
+ * TODO: [🐣][🐝][main] !!!! Validate that knowledge is valid (non-void)
37
+ * TODO: [🐣][main] !!!! Validate that persona can be used only with CHAT variant
38
+ * TODO: [🐣][main] !!!! Validate that parameter with reserved name not used RESERVED_PARAMETER_NAMES
39
+ * TODO: [🐣][main] !!!! Validate that reserved parameter is not used as joker
40
40
  * TODO: [🧠] Validation not only logic itself but imports around - files and websites and rerefenced pipelines exists
41
41
  * TODO: [🛠] Actions, instruments (and maybe knowledge) => Functions and tools
42
42
  */
@@ -8,7 +8,7 @@ import type { string_markdown } from '../../../types/typeAliases';
8
8
  */
9
9
  export declare function prepareKnowledgeFromMarkdown(knowledgeContent: string_markdown, options: PrepareOptions): Promise<Array<Omit<KnowledgePiecePreparedJson, 'sources' | 'preparationIds'>>>;
10
10
  /**
11
- * TODO: [🐝][🔼] !!! Export via `@promptbook/markdown`
11
+ * TODO: [🐝][🔼][main] !!! Export via `@promptbook/markdown`
12
12
  * TODO: [🪂] Do it in parallel 11:11
13
13
  * Note: No need to aggregate usage here, it is done by intercepting the llmTools
14
14
  */
@@ -8,7 +8,7 @@ import type { string_base64 } from '../../../types/typeAliases';
8
8
  */
9
9
  export declare function prepareKnowledgeFromPdf(content: string_base64, options: PrepareOptions): Promise<Array<Omit<KnowledgePiecePreparedJson, 'sources' | 'preparationIds'>>>;
10
10
  /**
11
- * TODO: [🐝][🔼] !!! Export via `@promptbook/pdf`
11
+ * TODO: [🐝][🔼][main] !!! Export via `@promptbook/pdf`
12
12
  * TODO: [🧺] In future, content can be alse File or Blob BUT for now for wider compatibility its only base64
13
13
  * @see https://stackoverflow.com/questions/14653349/node-js-cant-create-blobs
14
14
  * TODO: [🪂] Do it in parallel
@@ -13,7 +13,7 @@ export type CacheItem = {
13
13
  /**
14
14
  * @@@
15
15
  */
16
- promptbookVersion: string_promptbook_version;
16
+ promptbookVersion?: string_promptbook_version;
17
17
  /**
18
18
  * @@@
19
19
  */
@@ -16,7 +16,7 @@ export declare const ANTHROPIC_CLAUDE_MODELS: Array<AvailableModel & {
16
16
  }>;
17
17
  /**
18
18
  * Note: [🤖] Add models of new variant
19
- * TODO: [🧠] !!! Add embedding models OR Anthropic has only chat+completion models?
19
+ * TODO: [🧠][main] !!! Add embedding models OR Anthropic has only chat+completion models?
20
20
  * TODO: [🧠] Some mechanism to propagate unsureness
21
21
  * TODO: [🧠][👮‍♀️] Put here more info like description, isVision, trainingDateCutoff, languages, strengths ( Top-level performance, intelligence, fluency, and understanding), contextWindow,...
22
22
  * TODO: [🎰] Some mechanism to auto-update available models
@@ -11,8 +11,8 @@ export declare const createAnthropicClaudeExecutionTools: ((options: AnthropicCl
11
11
  className: string;
12
12
  };
13
13
  /**
14
- * TODO: [🧠] !!!! Make anonymous this with all LLM providers
15
- * TODO: [🧠][🧱] !!!! Maybe change all `new AnthropicClaudeExecutionTools` -> `createAnthropicClaudeExecutionTools` in manual
14
+ * TODO: [🧠][main] !!!! Make anonymous this with all LLM providers
15
+ * TODO: [🧠][🧱][main] !!!! Maybe change all `new AnthropicClaudeExecutionTools` -> `createAnthropicClaudeExecutionTools` in manual
16
16
  * TODO: [🧠] Maybe auto-detect usage in browser and determine default value of `isProxied`
17
17
  * TODO: [🦺] Is there some way how to put `packageName` and `className` on top and function definition on bottom?
18
18
  * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
@@ -1,6 +1,6 @@
1
1
  #!/usr/bin/env ts-node
2
2
  export {};
3
3
  /**
4
- * TODO: !!! Playground with WebGPT / Promptbook.studio anonymous server
5
- * TODO: !!! Test here that `systemMessage`, `temperature` and `seed` are working correctly
4
+ * TODO:[main] !!! Playground with WebGPT / Promptbook.studio anonymous server
5
+ * TODO:[main] !!! Test here that `systemMessage`, `temperature` and `seed` are working correctly
6
6
  */
@@ -1,5 +1,5 @@
1
1
  #!/usr/bin/env ts-node
2
2
  export {};
3
3
  /**
4
- * TODO: !!! Test here that `systemMessage`, `temperature` and `seed` are working correctly
4
+ * TODO:[main] !!! Test here that `systemMessage`, `temperature` and `seed` are working correctly
5
5
  */
@@ -9,7 +9,7 @@ import type { string_persona_description } from '../types/typeAliases';
9
9
  */
10
10
  export declare function preparePersona(personaDescription: string_persona_description, options: PrepareOptions): Promise<PersonaPreparedJson['modelRequirements']>;
11
11
  /**
12
- * TODO: [🔃] !!!!! If the persona was prepared with different version or different set of models, prepare it once again
12
+ * TODO: [🔃][main] !!!!! If the persona was prepared with different version or different set of models, prepare it once again
13
13
  * TODO: [🏢] !! Check validity of `modelName` in pipeline
14
14
  * TODO: [🏢] !! Check validity of `systemMessage` in pipeline
15
15
  * TODO: [🏢] !! Check validity of `temperature` in pipeline
@@ -6,7 +6,7 @@ import type { PipelineJson } from '../types/PipelineJson/PipelineJson';
6
6
  */
7
7
  export declare function isPipelinePrepared(pipeline: PipelineJson): boolean;
8
8
  /**
9
- * TODO: [🔃] !!!!! If the pipeline was prepared with different version or different set of models, prepare it once again
9
+ * TODO: [🔃][main] !!!!! If the pipeline was prepared with different version or different set of models, prepare it once again
10
10
  * TODO: [🐠] Maybe base this on `makeValidator`
11
11
  * TODO: [🧊] Pipeline can be partially prepared, this should return true ONLY if fully prepared
12
12
  * TODO: [🧿] Maybe do same process with same granularity and subfinctions as `preparePipeline`
@@ -23,7 +23,7 @@ export {};
23
23
  /**
24
24
  * TODO: [🧠] Add context to each template (if missing)
25
25
  * TODO: [🧠] What is better name `prepareTemplate` or `prepareTemplateAndParameters`
26
- * TODO: [♨] !!! Prepare index the samples and maybe templates
26
+ * TODO: [♨][main] !!! Prepare index the samples and maybe templates
27
27
  * TODO: Write tests for `preparePipeline`
28
28
  * TODO: [🏏] Leverage the batch API and build queues @see https://platform.openai.com/docs/guides/batch
29
29
  * TODO: [🧊] In future one preparation can take data from previous preparation and save tokens and time
@@ -42,7 +42,7 @@ export type PipelineJson = {
42
42
  /**
43
43
  * Version of the .ptbk.json file
44
44
  */
45
- readonly promptbookVersion: string_semantic_version;
45
+ readonly promptbookVersion?: string_semantic_version;
46
46
  /**
47
47
  * Description of the promptbook
48
48
  * It can use multiple paragraphs of simple markdown formatting like **bold**, *italic*, [link](https://example.com), ... BUT not code blocks and structure
@@ -592,7 +592,7 @@ export type number_megabytes = number_positive;
592
592
  export type number_gigabytes = number_positive;
593
593
  export type number_terabytes = number_positive;
594
594
  /**.
595
- * TODO: !!! Change "For example" to @example
595
+ * TODO:[main] !!! Change "For example" to @example
596
596
  * TODO: !! Change to branded types
597
597
  * TODO: Delete type aliases that are not exported or used internally
598
598
  */
@@ -22,6 +22,6 @@ import type { string_name } from '../../types/typeAliases';
22
22
  export declare function checkSerializableAsJson(name: string_name, value: unknown): void;
23
23
  /**
24
24
  * TODO: [🧠][🛣] More elegant way to tracking than passing `name`
25
- * TODO: [🧠] !!! In-memory cache of same values to prevent multiple checks
25
+ * TODO: [🧠][main] !!! In-memory cache of same values to prevent multiple checks
26
26
  * Note: [🐠] This is how `checkSerializableAsJson` + `isSerializableAsJson` together can just retun true/false or rich error message
27
27
  */
@@ -19,6 +19,6 @@
19
19
  */
20
20
  export declare function isSerializableAsJson(value: unknown): boolean;
21
21
  /**
22
- * TODO: [🧠] !!! In-memory cache of same values to prevent multiple checks
22
+ * TODO: [🧠][main] !!! In-memory cache of same values to prevent multiple checks
23
23
  * TODO: [🧠][💺] Can be done this on type-level?
24
24
  */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@promptbook/remote-server",
3
- "version": "0.69.0-15",
3
+ "version": "0.69.0-17",
4
4
  "description": "Supercharge your use of large language models",
5
5
  "private": false,
6
6
  "sideEffects": false,
@@ -47,7 +47,7 @@
47
47
  "module": "./esm/index.es.js",
48
48
  "typings": "./esm/typings/src/_packages/remote-server.index.d.ts",
49
49
  "peerDependencies": {
50
- "@promptbook/core": "0.69.0-15"
50
+ "@promptbook/core": "0.69.0-17"
51
51
  },
52
52
  "dependencies": {
53
53
  "colors": "1.4.0",
package/umd/index.umd.js CHANGED
@@ -14,8 +14,8 @@
14
14
  /**
15
15
  * The version of the Promptbook library
16
16
  */
17
- var PROMPTBOOK_VERSION = '0.69.0-14';
18
- // TODO: !!!! List here all the versions and annotate + put into script
17
+ var PROMPTBOOK_VERSION = '0.69.0-16';
18
+ // TODO:[main] !!!! List here all the versions and annotate + put into script
19
19
 
20
20
  /*! *****************************************************************************
21
21
  Copyright (c) Microsoft Corporation.
@@ -325,7 +325,7 @@
325
325
  }
326
326
  /**
327
327
  * TODO: [🧠][🛣] More elegant way to tracking than passing `name`
328
- * TODO: [🧠] !!! In-memory cache of same values to prevent multiple checks
328
+ * TODO: [🧠][main] !!! In-memory cache of same values to prevent multiple checks
329
329
  * Note: [🐠] This is how `checkSerializableAsJson` + `isSerializableAsJson` together can just retun true/false or rich error message
330
330
  */
331
331
 
@@ -1166,10 +1166,10 @@
1166
1166
  case 1:
1167
1167
  _c.trys.push([1, 14, 15, 16]);
1168
1168
  if (isAnonymous === true && !isAnonymousModeAllowed) {
1169
- throw new PipelineExecutionError("Anonymous mode is not allowed"); // <- TODO: !!! Test
1169
+ throw new PipelineExecutionError("Anonymous mode is not allowed"); // <- TODO:[main] !!! Test
1170
1170
  }
1171
1171
  if (isAnonymous === false && !isCollectionModeAllowed) {
1172
- throw new PipelineExecutionError("Collection mode is not allowed"); // <- TODO: !!! Test
1172
+ throw new PipelineExecutionError("Collection mode is not allowed"); // <- TODO:[main] !!! Test
1173
1173
  }
1174
1174
  llmExecutionTools = void 0;
1175
1175
  if (!(isAnonymous === true && llmToolsConfiguration !== null)) return [3 /*break*/, 2];
@@ -1260,10 +1260,10 @@
1260
1260
  case 1:
1261
1261
  _b.trys.push([1, 3, 4, 5]);
1262
1262
  if (isAnonymous === true && !isAnonymousModeAllowed) {
1263
- throw new PipelineExecutionError("Anonymous mode is not allowed"); // <- TODO: !!! Test
1263
+ throw new PipelineExecutionError("Anonymous mode is not allowed"); // <- TODO:[main] !!! Test
1264
1264
  }
1265
1265
  if (isAnonymous === false && !isCollectionModeAllowed) {
1266
- throw new PipelineExecutionError("Collection mode is not allowed"); // <- TODO: !!! Test
1266
+ throw new PipelineExecutionError("Collection mode is not allowed"); // <- TODO:[main] !!! Test
1267
1267
  }
1268
1268
  llmExecutionTools = void 0;
1269
1269
  if (isAnonymous === true) {
@@ -1 +0,0 @@
1
- export {};