@promptbook/node 0.68.0-0 → 0.68.0-3

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 (87) hide show
  1. package/README.md +4 -4
  2. package/esm/index.es.js +1213 -637
  3. package/esm/index.es.js.map +1 -1
  4. package/esm/typings/promptbook-collection/index.d.ts +7 -16
  5. package/esm/typings/src/_packages/core.index.d.ts +2 -2
  6. package/esm/typings/src/_packages/types.index.d.ts +20 -24
  7. package/esm/typings/src/_packages/utils.index.d.ts +2 -2
  8. package/esm/typings/src/commands/BLOCK/BlockTypes.d.ts +1 -1
  9. package/esm/typings/src/commands/BLOCK/blockCommandParser.d.ts +2 -2
  10. package/esm/typings/src/commands/EXPECT/ExpectCommand.d.ts +14 -6
  11. package/esm/typings/src/commands/EXPECT/expectCommandParser.d.ts +2 -2
  12. package/esm/typings/src/commands/FOREACH/ForeachCommand.d.ts +9 -0
  13. package/esm/typings/src/commands/FOREACH/foreachCommandParser.d.ts +14 -0
  14. package/esm/typings/src/commands/{EXPECT/ExpectFormatCommand.d.ts → FORMAT/FormatCommand.d.ts} +2 -2
  15. package/esm/typings/src/commands/FORMAT/formatCommand.test.d.ts +1 -0
  16. package/esm/typings/src/commands/FORMAT/formatCommandParser.d.ts +9 -0
  17. package/esm/typings/src/commands/JOKER/jokerCommandParser.d.ts +2 -2
  18. package/esm/typings/src/commands/KNOWLEDGE/knowledgeCommandParser.d.ts +2 -2
  19. package/esm/typings/src/commands/MODEL/modelCommandParser.d.ts +2 -2
  20. package/esm/typings/src/commands/PARAMETER/parameterCommandParser.d.ts +2 -2
  21. package/esm/typings/src/commands/PERSONA/personaCommandParser.d.ts +2 -2
  22. package/esm/typings/src/commands/POSTPROCESS/postprocessCommandParser.d.ts +2 -2
  23. package/esm/typings/src/commands/PROMPTBOOK_VERSION/promptbookVersionCommandParser.d.ts +2 -2
  24. package/esm/typings/src/commands/URL/urlCommandParser.d.ts +2 -2
  25. package/esm/typings/src/commands/X_ACTION/actionCommandParser.d.ts +2 -2
  26. package/esm/typings/src/commands/X_INSTRUMENT/instrumentCommandParser.d.ts +2 -2
  27. package/esm/typings/src/commands/_BOILERPLATE/boilerplateCommandParser.d.ts +6 -4
  28. package/esm/typings/src/commands/_common/parseCommand.d.ts +1 -1
  29. package/esm/typings/src/commands/_common/types/Command.d.ts +1 -1
  30. package/esm/typings/src/commands/_common/types/CommandParser.d.ts +137 -30
  31. package/esm/typings/src/commands/index.d.ts +1 -1
  32. package/esm/typings/src/conversion/pipelineJsonToString.d.ts +1 -1
  33. package/esm/typings/src/conversion/pipelineStringToJson.d.ts +1 -1
  34. package/esm/typings/src/conversion/pipelineStringToJsonSync.d.ts +2 -2
  35. package/esm/typings/src/conversion/prettify/renderPipelineMermaidOptions.d.ts +3 -3
  36. package/esm/typings/src/conversion/utils/extractParameterNamesFromTemplate.d.ts +14 -0
  37. package/esm/typings/src/conversion/utils/extractParameterNamesFromTemplate.test.d.ts +1 -0
  38. package/esm/typings/src/conversion/utils/extractVariables.d.ts +1 -1
  39. package/esm/typings/src/conversion/utils/renameParameter.d.ts +2 -2
  40. package/esm/typings/src/conversion/utils/stringifyPipelineJson.d.ts +1 -1
  41. package/esm/typings/src/conversion/validation/_importPipeline.d.ts +1 -1
  42. package/esm/typings/src/errors/{ParsingError.d.ts → ParseError.d.ts} +5 -2
  43. package/esm/typings/src/errors/index.d.ts +2 -2
  44. package/esm/typings/src/execution/CommonExecutionToolsOptions.d.ts +5 -0
  45. package/esm/typings/src/execution/PromptResult.d.ts +2 -0
  46. package/esm/typings/src/execution/PromptResultUsage.d.ts +1 -1
  47. package/esm/typings/src/execution/createPipelineExecutor.d.ts +1 -1
  48. package/esm/typings/src/knowledge/dialogs/simple-prompt/SimplePromptInterfaceTools.d.ts +1 -1
  49. package/esm/typings/src/llm-providers/openai/OpenAiExecutionTools.d.ts +1 -1
  50. package/esm/typings/src/postprocessing/utils/extractBlock.d.ts +2 -2
  51. package/esm/typings/src/postprocessing/utils/extractJsonBlock.d.ts +3 -3
  52. package/esm/typings/src/prepare/prepareTemplates.d.ts +4 -5
  53. package/esm/typings/src/prepare/unpreparePipeline.d.ts +1 -1
  54. package/esm/typings/src/storage/_common/PromptbookStorage.d.ts +1 -1
  55. package/esm/typings/src/storage/utils/PrefixStorage.d.ts +1 -1
  56. package/esm/typings/src/types/ModelRequirements.d.ts +2 -0
  57. package/esm/typings/src/types/PipelineJson/DialogTemplateJson.d.ts +13 -0
  58. package/esm/typings/src/types/PipelineJson/Expectations.d.ts +1 -1
  59. package/esm/typings/src/types/PipelineJson/KnowledgePieceJson.d.ts +1 -1
  60. package/esm/typings/src/types/PipelineJson/KnowledgeSourceJson.d.ts +1 -1
  61. package/esm/typings/src/types/PipelineJson/{PromptTemplateParameterJson.d.ts → ParameterJson.d.ts} +2 -2
  62. package/esm/typings/src/types/PipelineJson/PersonaJson.d.ts +1 -1
  63. package/esm/typings/src/types/PipelineJson/PipelineJson.d.ts +13 -8
  64. package/esm/typings/src/types/PipelineJson/PreparationJson.d.ts +1 -1
  65. package/esm/typings/src/types/PipelineJson/PromptTemplateJson.d.ts +20 -9
  66. package/esm/typings/src/types/PipelineJson/{ScriptJson.d.ts → ScriptTemplateJson.d.ts} +4 -4
  67. package/esm/typings/src/types/PipelineJson/SimpleTemplateJson.d.ts +3 -3
  68. package/esm/typings/src/types/PipelineJson/TemplateJson.d.ts +11 -0
  69. package/esm/typings/src/types/PipelineJson/{PromptTemplateJsonCommon.d.ts → TemplateJsonCommon.d.ts} +12 -13
  70. package/esm/typings/src/types/PipelineString.d.ts +1 -1
  71. package/esm/typings/src/types/Prompt.d.ts +4 -2
  72. package/esm/typings/src/types/execution-report/ExecutionReportJson.d.ts +1 -1
  73. package/esm/typings/src/utils/markdown/addAutoGeneratedSection.d.ts +1 -0
  74. package/esm/typings/src/utils/markdown/extractAllBlocksFromMarkdown.d.ts +1 -1
  75. package/esm/typings/src/utils/markdown/extractOneBlockFromMarkdown.d.ts +2 -2
  76. package/esm/typings/src/utils/organization/___and___.d.ts +7 -0
  77. package/esm/typings/src/utils/organization/{___.d.ts → ___or___.d.ts} +1 -1
  78. package/esm/typings/src/utils/parseNumber.d.ts +1 -1
  79. package/esm/typings/src/utils/serialization/clonePipeline.d.ts +1 -1
  80. package/package.json +2 -2
  81. package/umd/index.umd.js +1213 -637
  82. package/umd/index.umd.js.map +1 -1
  83. package/esm/typings/src/commands/EXPECT/ExpectAmountCommand.d.ts +0 -17
  84. package/esm/typings/src/conversion/utils/extractParameterNamesFromPromptTemplate.d.ts +0 -14
  85. package/esm/typings/src/types/PipelineJson/LlmTemplateJson.d.ts +0 -27
  86. package/esm/typings/src/types/PipelineJson/PromptDialogJson.d.ts +0 -14
  87. /package/esm/typings/src/{conversion/utils/extractParameterNamesFromPromptTemplate.test.d.ts → commands/FOREACH/foreachCommand.test.d.ts} +0 -0
package/README.md CHANGED
@@ -94,7 +94,7 @@ File `write-website-content.ptbk.md`:
94
94
  >
95
95
  > What is your web about?
96
96
  >
97
- > - PROMPT DIALOG
97
+ > - DIALOG BLOCK
98
98
  >
99
99
  > ```
100
100
  > {rawAssigment}
@@ -128,7 +128,7 @@ File `write-website-content.ptbk.md`:
128
128
  >
129
129
  > Is the title for your website okay?
130
130
  >
131
- > - PROMPT DIALOG
131
+ > - DIALOG BLOCK
132
132
  >
133
133
  > ```
134
134
  > {enhancedTitle}
@@ -289,7 +289,7 @@ flowchart LR
289
289
  end;
290
290
  ```
291
291
 
292
- - [More template samples](./samples/templates/)
292
+ - [More template samples](./samples/pipelines/)
293
293
  - [Read more about `.ptbk.md` file format here](https://github.com/webgptorg/promptbook/discussions/categories/concepts?discussions_q=is%3Aopen+label%3A.ptbk.md+category%3AConcepts)
294
294
 
295
295
  _Note: We are using [postprocessing functions](#postprocessing-functions) like `unwrapResult` that can be used to postprocess the result._
@@ -406,7 +406,7 @@ If you have a question [start a discussion](https://github.com/webgptorg/promptb
406
406
 
407
407
  ### Why not just use the OpenAI SDK / Anthropic Claude SDK / ...?
408
408
 
409
- Different levels of abstraction. OpenAI library is for direct use of OpenAI API. This library is for a higher level of abstraction. It is for creating prompt templates and promptbooks that are independent of the underlying library, LLM model, or even LLM provider.
409
+ Different levels of abstraction. OpenAI library is for direct use of OpenAI API. This library is for a higher level of abstraction. It define pipelines that are independent of the underlying library, LLM model, or even LLM provider.
410
410
 
411
411
  ### How is it different from the Langchain library?
412
412