@promptbook/pdf 0.92.0-27 → 0.92.0-28

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 (38) hide show
  1. package/esm/index.es.js +17 -9
  2. package/esm/index.es.js.map +1 -1
  3. package/esm/typings/src/_packages/core.index.d.ts +4 -4
  4. package/esm/typings/src/commands/FOREACH/foreachCommandParser.d.ts +0 -2
  5. package/esm/typings/src/constants.d.ts +35 -0
  6. package/esm/typings/src/executables/$provideExecutablesForNode.d.ts +1 -1
  7. package/esm/typings/src/executables/apps/locateLibreoffice.d.ts +2 -1
  8. package/esm/typings/src/executables/apps/locatePandoc.d.ts +2 -1
  9. package/esm/typings/src/executables/platforms/locateAppOnLinux.d.ts +2 -1
  10. package/esm/typings/src/executables/platforms/locateAppOnMacOs.d.ts +2 -1
  11. package/esm/typings/src/executables/platforms/locateAppOnWindows.d.ts +2 -1
  12. package/esm/typings/src/execution/AbstractTaskResult.d.ts +1 -1
  13. package/esm/typings/src/execution/LlmExecutionToolsConstructor.d.ts +2 -1
  14. package/esm/typings/src/execution/PipelineExecutorResult.d.ts +1 -1
  15. package/esm/typings/src/execution/createPipelineExecutor/$OngoingTaskResult.d.ts +12 -9
  16. package/esm/typings/src/execution/createPipelineExecutor/40-executeAttempts.d.ts +20 -14
  17. package/esm/typings/src/execution/createPipelineExecutor/filterJustOutputParameters.d.ts +7 -6
  18. package/esm/typings/src/execution/createPipelineExecutor/getContextForTask.d.ts +5 -1
  19. package/esm/typings/src/execution/createPipelineExecutor/getExamplesForTask.d.ts +1 -1
  20. package/esm/typings/src/execution/createPipelineExecutor/getKnowledgeForTask.d.ts +8 -11
  21. package/esm/typings/src/execution/translation/automatic-translate/automatic-translators/LindatAutomaticTranslator.d.ts +4 -4
  22. package/esm/typings/src/formats/csv/CsvSettings.d.ts +2 -2
  23. package/esm/typings/src/formfactors/chatbot/ChatbotFormfactorDefinition.d.ts +2 -2
  24. package/esm/typings/src/formfactors/completion/CompletionFormfactorDefinition.d.ts +1 -1
  25. package/esm/typings/src/formfactors/generator/GeneratorFormfactorDefinition.d.ts +2 -1
  26. package/esm/typings/src/formfactors/generic/GenericFormfactorDefinition.d.ts +2 -2
  27. package/esm/typings/src/formfactors/index.d.ts +3 -3
  28. package/esm/typings/src/llm-providers/_common/register/LlmToolsMetadata.d.ts +4 -37
  29. package/esm/typings/src/llm-providers/anthropic-claude/anthropic-claude-models.d.ts +1 -1
  30. package/esm/typings/src/llm-providers/deepseek/deepseek-models.d.ts +1 -1
  31. package/esm/typings/src/llm-providers/google/google-models.d.ts +1 -1
  32. package/esm/typings/src/llm-providers/openai/openai-models.d.ts +1 -1
  33. package/esm/typings/src/llm-providers/openai/register-configuration.d.ts +2 -2
  34. package/esm/typings/src/llm-providers/openai/register-constructor.d.ts +2 -2
  35. package/esm/typings/src/version.d.ts +1 -1
  36. package/package.json +2 -2
  37. package/umd/index.umd.js +17 -9
  38. package/umd/index.umd.js.map +1 -1
@@ -10,9 +10,9 @@ import type { Registration } from '../../utils/$Register';
10
10
  */
11
11
  export declare const _OpenAiMetadataRegistration: Registration;
12
12
  /**
13
- * @@@ registration1 of default configuration for Open AI
13
+ * Registration of the OpenAI Assistant metadata
14
14
  *
15
- * Note: [🏐] Configurations registrations are done in @@@ BUT constructor @@@
15
+ * Note: [🏐] Configurations registrations are done in the metadata registration section, but the constructor registration is handled separately.
16
16
  *
17
17
  * @public exported from `@promptbook/core`
18
18
  * @public exported from `@promptbook/wizzard`
@@ -10,9 +10,9 @@ import type { Registration } from '../../utils/$Register';
10
10
  */
11
11
  export declare const _OpenAiRegistration: Registration;
12
12
  /**
13
- * @@@ registration2
13
+ * Registration of the OpenAI Assistant provider
14
14
  *
15
- * Note: [🏐] Configurations registrations are done in @@@ BUT constructor @@@
15
+ * Note: [🏐] Configurations registrations are done in register-constructor.ts BUT constructor register-constructor.ts
16
16
  *
17
17
  * @public exported from `@promptbook/openai`
18
18
  * @public exported from `@promptbook/wizzard`
@@ -15,7 +15,7 @@ export declare const BOOK_LANGUAGE_VERSION: string_semantic_version;
15
15
  export declare const PROMPTBOOK_ENGINE_VERSION: string_promptbook_version;
16
16
  /**
17
17
  * Represents the version string of the Promptbook engine.
18
- * It follows semantic versioning (e.g., `0.92.0-26`).
18
+ * It follows semantic versioning (e.g., `0.92.0-27`).
19
19
  *
20
20
  * @generated
21
21
  */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@promptbook/pdf",
3
- "version": "0.92.0-27",
3
+ "version": "0.92.0-28",
4
4
  "description": "It's time for a paradigm shift. The future of software in plain English, French or Latin",
5
5
  "private": false,
6
6
  "sideEffects": false,
@@ -51,7 +51,7 @@
51
51
  "module": "./esm/index.es.js",
52
52
  "typings": "./esm/typings/src/_packages/pdf.index.d.ts",
53
53
  "peerDependencies": {
54
- "@promptbook/core": "0.92.0-27"
54
+ "@promptbook/core": "0.92.0-28"
55
55
  },
56
56
  "dependencies": {
57
57
  "crypto": "1.0.1",
package/umd/index.umd.js CHANGED
@@ -25,7 +25,7 @@
25
25
  * @generated
26
26
  * @see https://github.com/webgptorg/promptbook
27
27
  */
28
- const PROMPTBOOK_ENGINE_VERSION = '0.92.0-27';
28
+ const PROMPTBOOK_ENGINE_VERSION = '0.92.0-28';
29
29
  /**
30
30
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
31
31
  * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -4106,7 +4106,7 @@
4106
4106
  }
4107
4107
 
4108
4108
  /**
4109
- * @@@
4109
+ * Contains configuration options for parsing and generating CSV files, such as delimiters and quoting rules.
4110
4110
  *
4111
4111
  * @public exported from `@promptbook/core`
4112
4112
  */
@@ -4804,8 +4804,12 @@
4804
4804
  */
4805
4805
 
4806
4806
  /**
4807
- * @@@
4807
+ * Executes a pipeline task with multiple attempts, including joker and retry logic. Handles different task types
4808
+ * (prompt, script, dialog, etc.), applies postprocessing, checks expectations, and updates the execution report.
4809
+ * Throws errors if execution fails after all attempts.
4808
4810
  *
4811
+ * @param options - The options for execution, including task, parameters, pipeline, and configuration.
4812
+ * @returns The result string of the executed task.
4809
4813
  * @private internal utility of `createPipelineExecutor`
4810
4814
  */
4811
4815
  async function executeAttempts(options) {
@@ -5263,8 +5267,12 @@
5263
5267
  }
5264
5268
 
5265
5269
  /**
5266
- * @@@
5270
+ * Returns the context for a given task, typically used to provide additional information or variables
5271
+ * required for the execution of the task within a pipeline. The context is returned as a string value
5272
+ * that may include markdown formatting.
5267
5273
  *
5274
+ * @param task - The task for which the context is being generated. This should be a deeply immutable TaskJson object.
5275
+ * @returns The context as a string, formatted as markdown and parameter value.
5268
5276
  * @private internal utility of `createPipelineExecutor`
5269
5277
  */
5270
5278
  async function getContextForTask(task) {
@@ -5272,7 +5280,7 @@
5272
5280
  }
5273
5281
 
5274
5282
  /**
5275
- * @@@
5283
+ * Retrieves example values or templates for a given task, used to guide or validate pipeline execution.
5276
5284
  *
5277
5285
  * @private internal utility of `createPipelineExecutor`
5278
5286
  */
@@ -5319,9 +5327,8 @@
5319
5327
  }
5320
5328
 
5321
5329
  /**
5322
- * @@@
5323
- *
5324
- * Here is the place where RAG (retrieval-augmented generation) happens
5330
+ * Retrieves the most relevant knowledge pieces for a given task using embedding-based similarity search.
5331
+ * This is where retrieval-augmented generation (RAG) is performed to enhance the task with external knowledge.
5325
5332
  *
5326
5333
  * @private internal utility of `createPipelineExecutor`
5327
5334
  */
@@ -5540,7 +5547,8 @@
5540
5547
  */
5541
5548
 
5542
5549
  /**
5543
- * @@@
5550
+ * Filters and returns only the output parameters from the provided pipeline execution options.
5551
+ * Adds warnings for any expected output parameters that are missing.
5544
5552
  *
5545
5553
  * @private internal utility of `createPipelineExecutor`
5546
5554
  */