@promptbook/openai 0.61.0-11 → 0.61.0-12

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 (141) hide show
  1. package/esm/index.es.js +6 -2
  2. package/esm/index.es.js.map +1 -1
  3. package/esm/typings/src/cli/cli-commands/hello.d.ts +3 -0
  4. package/esm/typings/src/cli/cli-commands/make.d.ts +3 -0
  5. package/esm/typings/src/cli/cli-commands/prettify.d.ts +3 -0
  6. package/esm/typings/src/cli/promptbookCli.d.ts +1 -0
  7. package/esm/typings/src/collection/PipelineCollection.d.ts +1 -1
  8. package/esm/typings/src/collection/SimplePipelineCollection.d.ts +1 -1
  9. package/esm/typings/src/collection/constructors/createCollectionFromDirectory.d.ts +1 -0
  10. package/esm/typings/src/commands/_BOILERPLATE/boilerplateCommandParser.d.ts +1 -0
  11. package/esm/typings/src/commands/_common/types/CommandParser.d.ts +1 -1
  12. package/esm/typings/src/conversion/pipelineJsonToString.d.ts +1 -1
  13. package/esm/typings/src/conversion/validation/validatePipeline.d.ts +4 -2
  14. package/esm/typings/src/execution/CommonExecutionToolsOptions.d.ts +1 -0
  15. package/esm/typings/src/formats/csv/ListFormatDefinition.d.ts +1 -0
  16. package/esm/typings/src/formats/json/JsonFormatDefinition.d.ts +1 -0
  17. package/esm/typings/src/formats/list/ListFormatDefinition.d.ts +1 -0
  18. package/esm/typings/src/formats/xml/XmlFormatDefinition.d.ts +1 -0
  19. package/esm/typings/src/knowledge/dialogs/simple-prompt/SimplePromptInterfaceTools.d.ts +3 -0
  20. package/esm/typings/src/knowledge/prepare-knowledge/_common/prepareKnowledgePieces.d.ts +1 -1
  21. package/esm/typings/src/knowledge/prepare-knowledge/markdown/prepareKnowledgeFromMarkdown.d.ts +1 -0
  22. package/esm/typings/src/knowledge/prepare-knowledge/pdf/prepareKnowledgeFromPdf.d.ts +1 -0
  23. package/esm/typings/src/llm-providers/{utils → _common}/createLlmToolsFromEnv.d.ts +3 -2
  24. package/esm/typings/src/llm-providers/_common/getLlmToolsForCli.d.ts +10 -0
  25. package/esm/typings/src/llm-providers/_common/getLlmToolsForTestingAndScriptsAndPlayground.d.ts +10 -0
  26. package/esm/typings/src/llm-providers/{utils → _common/utils}/cache/CacheItem.d.ts +4 -4
  27. package/{umd/typings/src/llm-providers → esm/typings/src/llm-providers/_common}/utils/cache/CacheLlmToolsOptions.d.ts +1 -1
  28. package/{umd/typings/src/llm-providers → esm/typings/src/llm-providers/_common}/utils/cache/cacheLlmTools.d.ts +3 -4
  29. package/esm/typings/src/llm-providers/{utils → _common/utils}/count-total-cost/LlmExecutionToolsWithTotalCost.d.ts +2 -2
  30. package/{umd/typings/src/llm-providers → esm/typings/src/llm-providers/_common}/utils/count-total-cost/countTotalCost.d.ts +2 -2
  31. package/esm/typings/src/llm-providers/anthropic-claude/AnthropicClaudeExecutionTools.d.ts +1 -0
  32. package/esm/typings/src/llm-providers/anthropic-claude/anthropic-claude-models.d.ts +1 -1
  33. package/esm/typings/src/llm-providers/azure-openai/AzureOpenAiExecutionTools.d.ts +1 -0
  34. package/esm/typings/src/llm-providers/langtail/LangtailExecutionTools.d.ts +3 -0
  35. package/esm/typings/src/llm-providers/langtail/LangtailExecutionToolsOptions.d.ts +1 -1
  36. package/esm/typings/src/llm-providers/mocked/MockedEchoLlmExecutionTools.d.ts +1 -1
  37. package/esm/typings/src/llm-providers/mocked/MockedFackedLlmExecutionTools.d.ts +1 -1
  38. package/esm/typings/src/llm-providers/openai/OpenAiExecutionTools.d.ts +1 -0
  39. package/esm/typings/src/llm-providers/openai/computeUsage.d.ts +2 -2
  40. package/esm/typings/src/personas/preparePersona.d.ts +6 -1
  41. package/esm/typings/src/prepare/preparePipeline.d.ts +2 -1
  42. package/esm/typings/src/prepare/unpreparePipeline.d.ts +1 -0
  43. package/esm/typings/src/storage/_common/PromptbookStorage.d.ts +1 -0
  44. package/esm/typings/src/storage/_common/PromptbookStorage.test-type.d.ts +1 -1
  45. package/esm/typings/src/storage/files-storage/FilesStorage.d.ts +2 -0
  46. package/esm/typings/src/storage/files-storage/FilesStorageOptions.d.ts +3 -0
  47. package/esm/typings/src/storage/local-storage/getLocalStorage.d.ts +2 -1
  48. package/esm/typings/src/storage/local-storage/getSessionStorage.d.ts +2 -1
  49. package/esm/typings/src/storage/memory/MemoryStorage.d.ts +3 -0
  50. package/esm/typings/src/storage/utils/PrefixStorage.d.ts +3 -0
  51. package/esm/typings/src/storage/utils/makePromptbookStorageFromWebStorage.d.ts +0 -1
  52. package/esm/typings/src/types/ModelRequirements.d.ts +1 -1
  53. package/esm/typings/src/types/PipelineJson/PipelineJson.d.ts +1 -1
  54. package/esm/typings/src/types/PipelineString.d.ts +1 -1
  55. package/esm/typings/src/types/execution-report/countWorkingDuration.d.ts +1 -1
  56. package/esm/typings/src/utils/emojis.d.ts +2 -2
  57. package/esm/typings/src/utils/formatNumber.d.ts +1 -1
  58. package/esm/typings/src/utils/isRunningInWhatever.d.ts +3 -0
  59. package/esm/typings/src/utils/markdown/addAutoGeneratedSection.d.ts +1 -1
  60. package/esm/typings/src/utils/markdown/createMarkdownChart.d.ts +1 -1
  61. package/esm/typings/src/utils/markdown/createMarkdownTable.d.ts +1 -1
  62. package/esm/typings/src/utils/organization/TODO.d.ts +2 -0
  63. package/esm/typings/src/utils/organization/TODO_USE.d.ts +1 -0
  64. package/esm/typings/src/utils/organization/___.d.ts +2 -0
  65. package/esm/typings/src/utils/organization/just.d.ts +1 -0
  66. package/esm/typings/src/utils/organization/keepImported.d.ts +12 -0
  67. package/esm/typings/src/utils/organization/notUsing.d.ts +1 -0
  68. package/esm/typings/src/utils/organization/really_any.d.ts +2 -0
  69. package/esm/typings/src/version.d.ts +3 -0
  70. package/package.json +2 -2
  71. package/umd/index.umd.js +6 -2
  72. package/umd/index.umd.js.map +1 -1
  73. package/umd/typings/src/cli/cli-commands/hello.d.ts +3 -0
  74. package/umd/typings/src/cli/cli-commands/make.d.ts +3 -0
  75. package/umd/typings/src/cli/cli-commands/prettify.d.ts +3 -0
  76. package/umd/typings/src/cli/promptbookCli.d.ts +1 -0
  77. package/umd/typings/src/collection/PipelineCollection.d.ts +1 -1
  78. package/umd/typings/src/collection/SimplePipelineCollection.d.ts +1 -1
  79. package/umd/typings/src/collection/constructors/createCollectionFromDirectory.d.ts +1 -0
  80. package/umd/typings/src/commands/_BOILERPLATE/boilerplateCommandParser.d.ts +1 -0
  81. package/umd/typings/src/commands/_common/types/CommandParser.d.ts +1 -1
  82. package/umd/typings/src/conversion/pipelineJsonToString.d.ts +1 -1
  83. package/umd/typings/src/conversion/validation/validatePipeline.d.ts +4 -2
  84. package/umd/typings/src/execution/CommonExecutionToolsOptions.d.ts +1 -0
  85. package/umd/typings/src/formats/csv/ListFormatDefinition.d.ts +1 -0
  86. package/umd/typings/src/formats/json/JsonFormatDefinition.d.ts +1 -0
  87. package/umd/typings/src/formats/list/ListFormatDefinition.d.ts +1 -0
  88. package/umd/typings/src/formats/xml/XmlFormatDefinition.d.ts +1 -0
  89. package/umd/typings/src/knowledge/dialogs/simple-prompt/SimplePromptInterfaceTools.d.ts +3 -0
  90. package/umd/typings/src/knowledge/prepare-knowledge/_common/prepareKnowledgePieces.d.ts +1 -1
  91. package/umd/typings/src/knowledge/prepare-knowledge/markdown/prepareKnowledgeFromMarkdown.d.ts +1 -0
  92. package/umd/typings/src/knowledge/prepare-knowledge/pdf/prepareKnowledgeFromPdf.d.ts +1 -0
  93. package/umd/typings/src/llm-providers/{utils → _common}/createLlmToolsFromEnv.d.ts +3 -2
  94. package/umd/typings/src/llm-providers/_common/getLlmToolsForCli.d.ts +10 -0
  95. package/umd/typings/src/llm-providers/_common/getLlmToolsForTestingAndScriptsAndPlayground.d.ts +10 -0
  96. package/umd/typings/src/llm-providers/{utils → _common/utils}/cache/CacheItem.d.ts +4 -4
  97. package/{esm/typings/src/llm-providers → umd/typings/src/llm-providers/_common}/utils/cache/CacheLlmToolsOptions.d.ts +1 -1
  98. package/{esm/typings/src/llm-providers → umd/typings/src/llm-providers/_common}/utils/cache/cacheLlmTools.d.ts +3 -4
  99. package/umd/typings/src/llm-providers/{utils → _common/utils}/count-total-cost/LlmExecutionToolsWithTotalCost.d.ts +2 -2
  100. package/{esm/typings/src/llm-providers → umd/typings/src/llm-providers/_common}/utils/count-total-cost/countTotalCost.d.ts +2 -2
  101. package/umd/typings/src/llm-providers/anthropic-claude/AnthropicClaudeExecutionTools.d.ts +1 -0
  102. package/umd/typings/src/llm-providers/anthropic-claude/anthropic-claude-models.d.ts +1 -1
  103. package/umd/typings/src/llm-providers/azure-openai/AzureOpenAiExecutionTools.d.ts +1 -0
  104. package/umd/typings/src/llm-providers/langtail/LangtailExecutionTools.d.ts +3 -0
  105. package/umd/typings/src/llm-providers/langtail/LangtailExecutionToolsOptions.d.ts +1 -1
  106. package/umd/typings/src/llm-providers/mocked/MockedEchoLlmExecutionTools.d.ts +1 -1
  107. package/umd/typings/src/llm-providers/mocked/MockedFackedLlmExecutionTools.d.ts +1 -1
  108. package/umd/typings/src/llm-providers/openai/OpenAiExecutionTools.d.ts +1 -0
  109. package/umd/typings/src/llm-providers/openai/computeUsage.d.ts +2 -2
  110. package/umd/typings/src/personas/preparePersona.d.ts +6 -1
  111. package/umd/typings/src/prepare/preparePipeline.d.ts +2 -1
  112. package/umd/typings/src/prepare/unpreparePipeline.d.ts +1 -0
  113. package/umd/typings/src/storage/_common/PromptbookStorage.d.ts +1 -0
  114. package/umd/typings/src/storage/_common/PromptbookStorage.test-type.d.ts +1 -1
  115. package/umd/typings/src/storage/files-storage/FilesStorage.d.ts +2 -0
  116. package/umd/typings/src/storage/files-storage/FilesStorageOptions.d.ts +3 -0
  117. package/umd/typings/src/storage/local-storage/getLocalStorage.d.ts +2 -1
  118. package/umd/typings/src/storage/local-storage/getSessionStorage.d.ts +2 -1
  119. package/umd/typings/src/storage/memory/MemoryStorage.d.ts +3 -0
  120. package/umd/typings/src/storage/utils/PrefixStorage.d.ts +3 -0
  121. package/umd/typings/src/storage/utils/makePromptbookStorageFromWebStorage.d.ts +0 -1
  122. package/umd/typings/src/types/ModelRequirements.d.ts +1 -1
  123. package/umd/typings/src/types/PipelineJson/PipelineJson.d.ts +1 -1
  124. package/umd/typings/src/types/PipelineString.d.ts +1 -1
  125. package/umd/typings/src/types/execution-report/countWorkingDuration.d.ts +1 -1
  126. package/umd/typings/src/utils/emojis.d.ts +2 -2
  127. package/umd/typings/src/utils/formatNumber.d.ts +1 -1
  128. package/umd/typings/src/utils/isRunningInWhatever.d.ts +3 -0
  129. package/umd/typings/src/utils/markdown/addAutoGeneratedSection.d.ts +1 -1
  130. package/umd/typings/src/utils/markdown/createMarkdownChart.d.ts +1 -1
  131. package/umd/typings/src/utils/markdown/createMarkdownTable.d.ts +1 -1
  132. package/umd/typings/src/utils/organization/TODO.d.ts +2 -0
  133. package/umd/typings/src/utils/organization/TODO_USE.d.ts +1 -0
  134. package/umd/typings/src/utils/organization/___.d.ts +2 -0
  135. package/umd/typings/src/utils/organization/just.d.ts +1 -0
  136. package/umd/typings/src/utils/organization/keepImported.d.ts +12 -0
  137. package/umd/typings/src/utils/organization/notUsing.d.ts +1 -0
  138. package/umd/typings/src/utils/organization/really_any.d.ts +2 -0
  139. package/umd/typings/src/version.d.ts +3 -0
  140. package/esm/typings/src/knowledge/prepare-knowledge/_common/utils/getLlmToolsForTestingAndScriptsAndPlayground.d.ts +0 -10
  141. package/umd/typings/src/knowledge/prepare-knowledge/_common/utils/getLlmToolsForTestingAndScriptsAndPlayground.d.ts +0 -10
@@ -5,5 +5,6 @@ export type CommonExecutionToolsOptions = {
5
5
  readonly isVerbose?: boolean;
6
6
  };
7
7
  /**
8
+ * TODO: [🈁] Maybe add here `isDeterministic`
8
9
  * TODO: [🧠][💙] Distinct between options passed into ExecutionTools and to ExecutionTools.execute
9
10
  */
@@ -8,4 +8,5 @@ export declare const CsvFormatDefinition: FormatDefinition<string, string, objec
8
8
  * TODO: [🍓] In `CsvFormatDefinition` implement partial `canBeValid`
9
9
  * TODO: [🍓] In `CsvFormatDefinition` implement `heal
10
10
  * TODO: [🍓] In `CsvFormatDefinition` implement `extractValues`
11
+ * TODO: [🏢] Allow to expect something inside CSV objects and other formats
11
12
  */
@@ -12,4 +12,5 @@ export declare const JsonFormatDefinition: FormatDefinition<string, string, obje
12
12
  * TODO: [🍓] In `JsonFormatDefinition` implement partial `canBeValid`
13
13
  * TODO: [🍓] In `JsonFormatDefinition` implement `heal
14
14
  * TODO: [🍓] In `JsonFormatDefinition` implement `extractValues`
15
+ * TODO: [🏢] Allow to expect something inside JSON objects and other formats
15
16
  */
@@ -10,4 +10,5 @@ export declare const ListFormatDefinition: FormatDefinition<string, string, obje
10
10
  * TODO: [🍓] In `ListFormatDefinition` implement partial `canBeValid`
11
11
  * TODO: [🍓] In `ListFormatDefinition` implement `heal
12
12
  * TODO: [🍓] In `ListFormatDefinition` implement `extractValues`
13
+ * TODO: [🏢] Allow to expect something inside each item of list and other formats
13
14
  */
@@ -12,4 +12,5 @@ export declare const XmlFormatDefinition: FormatDefinition<string, string, objec
12
12
  * TODO: [🍓] In `XmlFormatDefinition` implement partial `canBeValid`
13
13
  * TODO: [🍓] In `XmlFormatDefinition` implement `heal
14
14
  * TODO: [🍓] In `XmlFormatDefinition` implement `extractValues`
15
+ * TODO: [🏢] Allow to expect something inside XML and other formats
15
16
  */
@@ -15,3 +15,6 @@ export declare class SimplePromptInterfaceTools implements UserInterfaceTools {
15
15
  */
16
16
  promptDialog(options: UserInterfaceToolsPromptDialogOptions): Promise<string>;
17
17
  }
18
+ /**
19
+ * Note: [🔵] This code should never be published outside of `@promptbook/browser`
20
+ */
@@ -5,10 +5,10 @@ import type { KnowledgeSourceJson } from '../../../types/PipelineJson/KnowledgeS
5
5
  * Prepares the knowle
6
6
  *
7
7
  * @see https://github.com/webgptorg/promptbook/discussions/41
8
- * @private within the package
9
8
  */
10
9
  export declare function prepareKnowledgePieces(knowledgeSources: Array<KnowledgeSourceJson>, options: PrepareOptions): Promise<Array<Omit<KnowledgePiecePreparedJson, 'preparationIds'>>>;
11
10
  /**
11
+ * TODO: [🔼] !!! Export via `@promptbook/core`
12
12
  * TODO: [🧊] In future one preparation can take data from previous preparation and save tokens and time
13
13
  * Put `knowledgePieces` into `PrepareKnowledgeOptions`
14
14
  * TODO: [🪂] More than max things can run in parallel by acident [1,[2a,2b,_],[3a,3b,_]]
@@ -6,6 +6,7 @@ import type { string_markdown } from '../../../types/typeAliases';
6
6
  */
7
7
  export declare function prepareKnowledgeFromMarkdown(content: string_markdown, options: PrepareOptions): Promise<Array<Omit<KnowledgePiecePreparedJson, 'sources' | 'preparationIds'>>>;
8
8
  /**
9
+ * TODO: [🔼] !!! Export via `@promptbook/markdown`
9
10
  * TODO: [🪂] Do it in parallel 11:11
10
11
  * Note: No need to aggregate usage here, it is done by intercepting the llmTools
11
12
  */
@@ -6,6 +6,7 @@ import type { string_base64 } from '../../../types/typeAliases';
6
6
  */
7
7
  export declare function prepareKnowledgeFromPdf(content: string_base64, options: PrepareOptions): Promise<Array<Omit<KnowledgePiecePreparedJson, 'sources' | 'preparationIds'>>>;
8
8
  /**
9
+ * TODO: [🔼] !!! Export via `@promptbook/pdf`
9
10
  * TODO: [🧺] In future, content can be alse File or Blob BUT for now for wider compatibility its only base64
10
11
  * @see https://stackoverflow.com/questions/14653349/node-js-cant-create-blobs
11
12
  * TODO: [🪂] Do it in parallel
@@ -12,10 +12,11 @@ import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
12
12
  */
13
13
  export declare function createLlmToolsFromEnv(): LlmExecutionTools;
14
14
  /**
15
- * TODO: !!!!! Export this util
16
- * TODO: !!!! write discussion about this - wizzard
15
+ * TODO: [🔼] !!! Export via `@promptbook/node`
16
+ * TODO: @@@ write discussion about this - wizzard
17
17
  * TODO: Add Azure
18
18
  * TODO: [🧠] Which name is better `createLlmToolsFromEnv` or `createLlmToolsFromEnvironment`?
19
19
  * TODO: [🧠] Is there some meaningfull way how to test this util
20
20
  * TODO: [🧠] Maybe pass env as argument
21
+ * Note: [🟢] This code should never be published outside of `@promptbook/node`
21
22
  */
@@ -0,0 +1,10 @@
1
+ import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
2
+ /**
3
+ * Returns LLM tools for CLI
4
+ *
5
+ * @private within the repository - for CLI utils
6
+ */
7
+ export declare function getLlmToolsForCli(): LlmExecutionTools;
8
+ /**
9
+ * Note: [🟡] This code should never be published outside of `@promptbook/cli`
10
+ */
@@ -0,0 +1,10 @@
1
+ import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
2
+ /**
3
+ * Returns LLM tools for testing purposes
4
+ *
5
+ * @private within the repository - JUST FOR TESTS, SCRIPTS AND PLAYGROUND
6
+ */
7
+ export declare function getLlmToolsForTestingAndScriptsAndPlayground(): LlmExecutionTools;
8
+ /**
9
+ * Note: [⚪] This should never be in any released package
10
+ */
@@ -1,7 +1,7 @@
1
- import type { PromptResult } from '../../../execution/PromptResult';
2
- import type { Prompt } from '../../../types/Prompt';
3
- import type { string_date_iso8601 } from '../../../types/typeAliases';
4
- import type { string_promptbook_version } from '../../../version';
1
+ import type { PromptResult } from '../../../../execution/PromptResult';
2
+ import type { Prompt } from '../../../../types/Prompt';
3
+ import type { string_date_iso8601 } from '../../../../types/typeAliases';
4
+ import type { string_promptbook_version } from '../../../../version';
5
5
  /**
6
6
  * @@@
7
7
  */
@@ -1,4 +1,4 @@
1
- import type { PromptbookStorage } from '../../../storage/_common/PromptbookStorage';
1
+ import type { PromptbookStorage } from '../../../../storage/_common/PromptbookStorage';
2
2
  import type { CacheItem } from './CacheItem';
3
3
  export type CacheLlmToolsOptions = {
4
4
  /**
@@ -1,4 +1,4 @@
1
- import type { LlmExecutionTools } from '../../../execution/LlmExecutionTools';
1
+ import type { LlmExecutionTools } from '../../../../execution/LlmExecutionTools';
2
2
  import type { CacheLlmToolsOptions } from './CacheLlmToolsOptions';
3
3
  /**
4
4
  * Intercepts LLM tools and counts total usage of the tools
@@ -8,9 +8,8 @@ import type { CacheLlmToolsOptions } from './CacheLlmToolsOptions';
8
8
  */
9
9
  export declare function cacheLlmTools(llmTools: LlmExecutionTools, options?: Partial<CacheLlmToolsOptions>): LlmExecutionTools;
10
10
  /**
11
- * TODO: !!!!! Export this util
12
- * TODO: !!!!! Use this for tests in promptbook project itself
13
- * TODO: !!!! write discussion about this and storages
11
+ * TODO: [🔼] !!! Export via `@promptbook/core`
12
+ * TODO: @@@ write discussion about this and storages
14
13
  * write how to combine multiple interceptors
15
14
  * TODO: [🧠][💸] Maybe make some common abstraction `interceptLlmTools` and use here (or use javascript Proxy?)
16
15
  * TODO: [🧠] Is there some meaningfull way how to test this util
@@ -1,5 +1,5 @@
1
- import type { LlmExecutionTools } from '../../../execution/LlmExecutionTools';
2
- import type { PromptResultUsage } from '../../../execution/PromptResult';
1
+ import type { LlmExecutionTools } from '../../../../execution/LlmExecutionTools';
2
+ import type { PromptResultUsage } from '../../../../execution/PromptResult';
3
3
  /**
4
4
  * LLM tools with option to get total cost of the execution
5
5
  */
@@ -1,4 +1,4 @@
1
- import type { LlmExecutionTools } from '../../../execution/LlmExecutionTools';
1
+ import type { LlmExecutionTools } from '../../../../execution/LlmExecutionTools';
2
2
  import type { LlmExecutionToolsWithTotalCost } from './LlmExecutionToolsWithTotalCost';
3
3
  /**
4
4
  * Intercepts LLM tools and counts total usage of the tools
@@ -8,7 +8,7 @@ import type { LlmExecutionToolsWithTotalCost } from './LlmExecutionToolsWithTota
8
8
  */
9
9
  export declare function countTotalUsage(llmTools: LlmExecutionTools): LlmExecutionToolsWithTotalCost;
10
10
  /**
11
- * TODO: !!!!! Export this utils
11
+ * TODO: [🔼] !!! Export via `@promptbookcore/`
12
12
  * TODO: [🧠][💸] Maybe make some common abstraction `interceptLlmTools` and use here (or use javascript Proxy?)
13
13
  * TODO: [🧠] Is there some meaningfull way how to test this util
14
14
  */
@@ -45,4 +45,5 @@ export declare class AnthropicClaudeExecutionTools implements LlmExecutionTools
45
45
  * TODO: [🧠] Maybe handle errors via transformAnthropicError (like transformAzureError)
46
46
  * TODO: Maybe Create some common util for callChatModel and callCompletionModel
47
47
  * TODO: Maybe make custom OpenaiError
48
+ * TODO: [🧠][🈁] Maybe use `isDeterministic` from options
48
49
  */
@@ -15,7 +15,7 @@ export declare const ANTHROPIC_CLAUDE_MODELS: Array<AvailableModel & {
15
15
  }>;
16
16
  /**
17
17
  * Note: [🤖] Add models of new variant
18
- * TODO: !!!! Add embedding models OR Anthropic has only chat+completion models?
18
+ * TODO: [🧠] !!! Add embedding models OR Anthropic has only chat+completion models?
19
19
  * TODO: [🧠] Some mechanism to propagate unsureness
20
20
  * TODO: [🧠][👮‍♀️] Put here more info like description, isVision, trainingDateCutoff, languages, strengths ( Top-level performance, intelligence, fluency, and understanding), contextWindow,...
21
21
  * TODO: [🕚] Make this list dynamic - dynamically can be listed modelNames but not modelVariant, legacy status, context length and pricing
@@ -44,4 +44,5 @@ export declare class AzureOpenAiExecutionTools implements LlmExecutionTools {
44
44
  /**
45
45
  * TODO: Maybe Create some common util for callChatModel and callCompletionModel
46
46
  * TODO: Maybe make custom AzureOpenaiError
47
+ * TODO: [🧠][🈁] Maybe use `isDeterministic` from options
47
48
  */
@@ -10,3 +10,6 @@ export declare class LangtailExecutionTools extends OpenAiExecutionTools impleme
10
10
  get title(): string_title & string_markdown_text;
11
11
  get description(): string_markdown;
12
12
  }
13
+ /**
14
+ * TODO: [🧠][🈁] Maybe use `isDeterministic` from options
15
+ */
@@ -7,5 +7,5 @@ import type { OpenAiExecutionToolsOptions } from '../openai/OpenAiExecutionTools
7
7
  */
8
8
  export type LangtailExecutionToolsOptions = OpenAiExecutionToolsOptions;
9
9
  /**
10
- * TODO: !!! Use or remove
10
+ * TODO: !! Use or remove
11
11
  */
@@ -29,6 +29,6 @@ export declare class MockedEchoLlmExecutionTools implements LlmExecutionTools {
29
29
  listModels(): Array<AvailableModel>;
30
30
  }
31
31
  /**
32
- * TODO: !!! Use here `seed`
32
+ * TODO: [🧠][🈁] Maybe use `isDeterministic` from options
33
33
  * TODO: Allow in spaceTrim: nesting with > ${block(prompt.request)}, same as replace params
34
34
  */
@@ -34,5 +34,5 @@ export declare class MockedFackedLlmExecutionTools implements LlmExecutionTools
34
34
  listModels(): Array<AvailableModel>;
35
35
  }
36
36
  /**
37
- * TODO: !!! Use here `seed`
37
+ * TODO: [🧠][🈁] Maybe use `isDeterministic` from options
38
38
  */
@@ -62,4 +62,5 @@ export declare class OpenAiExecutionTools implements LlmExecutionTools {
62
62
  * TODO: [🧠][🧙‍♂️] Maybe there can be some wizzard for thoose who want to use just OpenAI
63
63
  * TODO: Maybe Create some common util for callChatModel and callCompletionModel
64
64
  * TODO: Maybe make custom OpenaiError
65
+ * TODO: [🧠][🈁] Maybe use `isDeterministic` from options
65
66
  */
@@ -4,13 +4,13 @@
4
4
  * @see https://openai.com/api/pricing/
5
5
  * @see https://docs.anthropic.com/en/docs/models-overview
6
6
  *
7
- * @private within the package, used only as internal helper for `OPENAI_MODELS` and `computeUsage`
7
+ * @private within the repository, used only as internal helper for `OPENAI_MODELS` and `computeUsage`
8
8
  */
9
9
  type string_model_price = `$${number}.${number} / ${number}M tokens`;
10
10
  /**
11
11
  * Function computeUsage will create price per one token based on the string value found on openai page
12
12
  *
13
- * @private within the package, used only as internal helper for `OPENAI_MODELS`
13
+ * @private within the repository, used only as internal helper for `OPENAI_MODELS`
14
14
  */
15
15
  export declare function computeUsage(value: string_model_price): number;
16
16
  export {};
@@ -5,6 +5,11 @@ import type { string_persona_description } from '../types/typeAliases';
5
5
  * Prepares the persona for the pipeline
6
6
  *
7
7
  * @see https://github.com/webgptorg/promptbook/discussions/22
8
- * @private within the package
9
8
  */
10
9
  export declare function preparePersona(personaDescription: string_persona_description, options: PrepareOptions): Promise<PersonaPreparedJson['modelRequirements']>;
10
+ /**
11
+ * TODO: [🔼] !!! Export via `@promptbook/core`
12
+ * TODO: [🏢] !! Check validity of `modelName` in pipeline
13
+ * TODO: [🏢] !! Check validity of `systemMessage` in pipeline
14
+ * TODO: [🏢] !! Check validity of `temperature` in pipeline
15
+ */
@@ -8,9 +8,10 @@ import type { PrepareOptions } from './PrepareOptions';
8
8
  */
9
9
  export declare function preparePipeline(pipeline: PipelineJson, options: PrepareOptions): Promise<PipelineJson>;
10
10
  /**
11
+ * TODO: [🔼] !!! Export via `@promptbook/core`
11
12
  * TODO: Write tests for `preparePipeline`
12
13
  * TODO: [🏏] Leverage the batch API and build queues @see https://platform.openai.com/docs/guides/batch
13
14
  * TODO: [🧊] In future one preparation can take data from previous preparation and save tokens and time
14
- * TODO: !!!!! Use here countTotalUsage
15
+ * TODO: [🎐] !!!! Use here countTotalUsage
15
16
  * TODO: [🛠] Actions, instruments (and maybe knowledge) => Functions and tools
16
17
  */
@@ -4,5 +4,6 @@ import type { PipelineJson } from '../types/PipelineJson/PipelineJson';
4
4
  */
5
5
  export declare function unpreparePipeline(pipeline: PipelineJson): PipelineJson;
6
6
  /**
7
+ * TODO: [🔼] !!! Export via `@promptbook/core`
7
8
  * TODO: Write tests for `preparePipeline`
8
9
  */
@@ -20,5 +20,6 @@ export type PromptbookStorage<TItem> = {
20
20
  removeItem(key: string): Promisable<void>;
21
21
  };
22
22
  /**
23
+ * TODO: [🔼] !!! Export via `@promptbook/types`
23
24
  * TODO: [🧠][🛫] Constrain `TItem` to JSON-serializable objects only
24
25
  */
@@ -1,5 +1,5 @@
1
1
  export {};
2
2
  /**
3
- * TODO: !!!!! Check that this files is not exported into build
3
+ * Note: [⚪] This should never be in any released package
4
4
  * TODO: Is this a good pattern to do type testing?
5
5
  */
@@ -24,5 +24,7 @@ export declare class FilesStorage<TItem> implements PromptbookStorage<TItem> {
24
24
  removeItem(key: string): Promise<void>;
25
25
  }
26
26
  /**
27
+ * TODO: [🔼] !!! Export via `@promptbook/node`
27
28
  * TODO: [🌗] Maybe some checkers, not all valid JSONs are desired and valid values
29
+ * Note: [🟢] This code should never be published outside of `@promptbook/node`
28
30
  */
@@ -8,3 +8,6 @@ export type FilesStorageOptions = {
8
8
  */
9
9
  cacheFolderPath: string_folder_path;
10
10
  };
11
+ /**
12
+ * TODO: [🔼] !!! Export via `@promptbook/types`
13
+ */
@@ -4,5 +4,6 @@ import type { PromptbookStorage } from '../_common/PromptbookStorage';
4
4
  */
5
5
  export declare function getLocalStorage<TItem>(): PromptbookStorage<TItem>;
6
6
  /**
7
- * Export through `@promptbook/browser`
7
+ * TODO: [🔼] !!! Export via `@promptbook/browser`
8
+ * Note: [🔵] This code should never be published outside of `@promptbook/browser`
8
9
  */
@@ -4,5 +4,6 @@ import type { PromptbookStorage } from '../_common/PromptbookStorage';
4
4
  */
5
5
  export declare function getSessionStorage<TItem>(): PromptbookStorage<TItem>;
6
6
  /**
7
- * Export through `@promptbook/browser`
7
+ * TODO: [🔼] !!! Export via `@promptbook/browser`
8
+ * Note: [🔵] This code should never be published outside of `@promptbook/browser`
8
9
  */
@@ -29,3 +29,6 @@ export declare class MemoryStorage<TItem> implements PromptbookStorage<TItem> {
29
29
  */
30
30
  removeItem(key: string): void;
31
31
  }
32
+ /**
33
+ * TODO: [🔼] !!! Export via `@promptbook/core`
34
+ */
@@ -21,3 +21,6 @@ export declare class PrefixStorage<TItem> implements PromptbookStorage<TItem> {
21
21
  */
22
22
  removeItem(key: string): void;
23
23
  }
24
+ /**
25
+ * TODO: [🔼] !!! Export via `@promptbook/core`
26
+ */
@@ -6,7 +6,6 @@ import type { PromptbookStorage } from '../_common/PromptbookStorage';
6
6
  */
7
7
  export declare function makePromptbookStorageFromWebStorage<TValue>(webStorage: Storage): PromptbookStorage<TValue>;
8
8
  /**
9
- * TODO: !!!! Export through `@promptbook/browser`
10
9
  * TODO: [🧠] Should this be named `makePromptbookStorageFromWebStorage` vs `createPromptbookStorageFromWebStorage`
11
10
  * TODO: [🌗] Maybe some checkers, not all valid JSONs are desired and valid values
12
11
  */
@@ -54,7 +54,7 @@ export type ModelRequirements = {
54
54
  readonly maxTokens?: number;
55
55
  };
56
56
  /**
57
- * TODO: [🈁] `seed` should maybe be somewhere else (not in `ModelRequirements`) (simmilar that `user` identification is not here)
57
+ * TODO: [🧠][🈁] `seed` should maybe be somewhere else (not in `ModelRequirements`) (simmilar that `user` identification is not here)
58
58
  * TODO: [🧠][💱] Add more model options: `stop_token`, `logit_bias`, `logprobs` (`top_logprobs`), `top_k`, `top_p`, `presence_penalty`, `frequency_penalty`, `bestOf`, `logitBias`, `logitBiasType`,...
59
59
  * [💱] Probbably keep using just `temperature` in Promptbook (not `top_k` and `top_p`)
60
60
  * TODO: [🛠] Actions, instruments (and maybe knowledge) => Functions and tools
@@ -14,7 +14,7 @@ import type { PromptTemplateParameterJson } from './PromptTemplateParameterJson'
14
14
  * Promptbook is the **core concept of this package**.
15
15
  * It represents a series of prompt templates chained together to form a pipeline / one big prompt template with input and result parameters.
16
16
  *
17
- * @see !!! https://github.com/webgptorg/promptbook#promptbook
17
+ * @see @@@ https://github.com/webgptorg/promptbook#promptbook
18
18
  */
19
19
  export type PipelineJson = {
20
20
  /**
@@ -2,7 +2,7 @@
2
2
  * Promptbook is the **core concept of this package**.
3
3
  * It represents a series of prompt templates chained together to form a pipeline / one big prompt template with input and result parameters.
4
4
  *
5
- * @see !!! https://github.com/webgptorg/promptbook#promptbook
5
+ * @see @@@ https://github.com/webgptorg/promptbook#promptbook
6
6
  */
7
7
  export type PipelineString = string & {
8
8
  readonly _type: 'Promptbook';
@@ -2,6 +2,6 @@ import type { FromtoItems } from '../../utils/FromtoItems';
2
2
  /**
3
3
  * Count the duration of working time
4
4
  *
5
- * @private within the package
5
+ * @private within the repository
6
6
  */
7
7
  export declare function countWorkingDuration(items: FromtoItems): number;
@@ -5,7 +5,7 @@ import type { string_char_emoji } from '../types/typeAliasEmoji';
5
5
  *
6
6
  * @see https://getemoji.com/
7
7
  *
8
- * @private within the package
8
+ * @private within the repository
9
9
  * @deprecated Use /\p{Extended_Pictographic}/ instead
10
10
  */
11
11
  export declare const EMOJIS_IN_CATEGORIES: Record<string, Array<string_char_emoji>>;
@@ -13,7 +13,7 @@ export declare const EMOJIS_IN_CATEGORIES: Record<string, Array<string_char_emoj
13
13
  *
14
14
  * All possible emoji chars like "🍆", "🍡", "🍤"...
15
15
  *
16
- * @private within the package
16
+ * @private within the repository
17
17
  * @deprecated Use /\p{Extended_Pictographic}/ instead
18
18
  */
19
19
  export declare const EMOJIS: Set<string_char_emoji>;
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * Format either small or big number
3
3
  *
4
- * @private within the package
4
+ * @private within the repository
5
5
  */
6
6
  export declare function formatNumber(value: number): string;
@@ -10,3 +10,6 @@ export declare const isRunningInNode: Function;
10
10
  * Detects if the code is running in a web worker
11
11
  */
12
12
  export declare const isRunningInWebWorker: Function;
13
+ /**
14
+ * TODO: [🔼] !!! Export via `@promptbook/utils`
15
+ */
@@ -3,7 +3,7 @@ import type { string_name } from '../../types/typeAliases';
3
3
  /**
4
4
  * Add or modify an auto-generated section in a markdown file
5
5
  *
6
- * @private within the package
6
+ * @private within the repository
7
7
  */
8
8
  export declare function addAutoGeneratedSection(content: string_markdown, options: {
9
9
  readonly sectionName: string_name;
@@ -28,7 +28,7 @@ type CreateMarkdownChartOptions = {
28
28
  /**
29
29
  * Function createMarkdownChart will draw a chart in markdown from ⬛+🟦 tiles
30
30
  *
31
- * @private within the package
31
+ * @private within the repository
32
32
  */
33
33
  export declare function createMarkdownChart(options: CreateMarkdownChartOptions): string_markdown;
34
34
  export {};
@@ -3,6 +3,6 @@ import type { string_markdown_text } from '../../types/typeAliases';
3
3
  /**
4
4
  * Create a markdown table from a 2D array of strings
5
5
  *
6
- * @private within the package
6
+ * @private within the repository
7
7
  */
8
8
  export declare function createMarkdownTable(table: Array<Array<string_markdown_text>>): string_markdown;
@@ -1,4 +1,6 @@
1
1
  /**
2
2
  * Organizational helper to better mark the place where the type is missing
3
+ *
4
+ * @private within the repository
3
5
  */
4
6
  export type TODO = any;
@@ -7,5 +7,6 @@ import type { really_any } from './really_any';
7
7
  *
8
8
  * @param value any values
9
9
  * @returns void
10
+ * @private within the repository
10
11
  */
11
12
  export declare function TODO_USE(...value: Array<really_any>): void;
@@ -1,4 +1,6 @@
1
1
  /**
2
2
  * Formatting helper to put void to keep longer version of prettier
3
+ *
4
+ * @private within the repository
3
5
  */
4
6
  export type ___ = never;
@@ -6,5 +6,6 @@
6
6
  *
7
7
  * @param value any values
8
8
  * @returns the same values
9
+ * @private within the repository
9
10
  */
10
11
  export declare function just<T>(value?: T): T;
@@ -0,0 +1,12 @@
1
+ import type { really_any } from './really_any';
2
+ /**
3
+ * Just says that the variable is not used but should be kept
4
+ * No side effects.
5
+ *
6
+ * Note: It can be usefull suppressing eager optimization of unused imports
7
+ *
8
+ * @param value any values
9
+ * @returns void
10
+ * @private within the repository
11
+ */
12
+ export declare function keepImported(...value: Array<really_any>): void;
@@ -7,5 +7,6 @@ import type { really_any } from './really_any';
7
7
  *
8
8
  * @param value any values
9
9
  * @returns void
10
+ * @private within the repository
10
11
  */
11
12
  export declare function notUsing(...value: Array<really_any>): void;
@@ -1,4 +1,6 @@
1
1
  /**
2
2
  * Organizational helper to mark a place where to really use any
3
+ *
4
+ * @private within the repository
3
5
  */
4
6
  export type really_any = any;
@@ -4,3 +4,6 @@ import type { string_semantic_version } from './types/typeAliases';
4
4
  */
5
5
  export declare const PROMPTBOOK_VERSION: string_promptbook_version;
6
6
  export type string_promptbook_version = string_semantic_version;
7
+ /**
8
+ * TODO: [🔼] !!! Export via `@promptbook/code`
9
+ */
@@ -1,10 +0,0 @@
1
- import type { LlmExecutionTools } from '../../../../execution/LlmExecutionTools';
2
- /**
3
- * Returns LLM tools for testing purposes
4
- *
5
- * @private within the package - JUST FOR TESTS, SCRIPTS AND PLAYGROUND
6
- */
7
- export declare function getLlmToolsForTestingAndScriptsAndPlayground(): LlmExecutionTools;
8
- /**
9
- * Note: [⚪]
10
- */
@@ -1,10 +0,0 @@
1
- import type { LlmExecutionTools } from '../../../../execution/LlmExecutionTools';
2
- /**
3
- * Returns LLM tools for testing purposes
4
- *
5
- * @private within the package - JUST FOR TESTS, SCRIPTS AND PLAYGROUND
6
- */
7
- export declare function getLlmToolsForTestingAndScriptsAndPlayground(): LlmExecutionTools;
8
- /**
9
- * Note: [⚪]
10
- */