@promptbook/openai 0.92.0-27 → 0.92.0-28

package/esm/typings/src/execution/createPipelineExecutor/filterJustOutputParameters.d.ts

@@ -3,30 +3,31 @@ import { PipelineExecutionError } from '../../errors/PipelineExecutionError';
 import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
 import type { Parameters } from '../../types/typeAliases';
 /**
- * @@@
+ * Options for filtering and extracting only output parameters from a pipeline execution.
  *
  * @private internal type of `createPipelineExecutor`
  */
 type FilterJustOutputParametersOptions = {
     /**
-     * @@@
+     * The fully prepared pipeline containing parameter definitions.
      */
     readonly preparedPipeline: ReadonlyDeep<PipelineJson>;
     /**
-     * @@@
+     * The parameters passed to the pipeline, including both input and output values.
      */
     readonly parametersToPass: Readonly<Parameters>;
     /**
-     * @@@
+     * Array to collect warnings encountered during parameter extraction.
      */
     readonly $warnings: PipelineExecutionError[];
     /**
-     * @@@
+     * String identifier for the pipeline, used in warning messages.
      */
     readonly pipelineIdentification: string;
 };
 /**
- * @@@
+ * Filters and returns only the output parameters from the provided pipeline execution options.
+ * Adds warnings for any expected output parameters that are missing.
  *
  * @private internal utility of `createPipelineExecutor`
  */

package/esm/typings/src/execution/createPipelineExecutor/getContextForTask.d.ts

@@ -3,8 +3,12 @@ import type { TaskJson } from '../../pipeline/PipelineJson/TaskJson';
 import type { string_markdown } from '../../types/typeAliases';
 import type { string_parameter_value } from '../../types/typeAliases';
 /**
- * @@@
+ * Returns the context for a given task, typically used to provide additional information or variables
+ * required for the execution of the task within a pipeline. The context is returned as a string value
+ * that may include markdown formatting.
  *
+ * @param task - The task for which the context is being generated. This should be a deeply immutable TaskJson object.
+ * @returns The context as a string, formatted as markdown and parameter value.
  * @private internal utility of `createPipelineExecutor`
  */
 export declare function getContextForTask(task: ReadonlyDeep<TaskJson>): Promise<string_parameter_value & string_markdown>;

package/esm/typings/src/execution/createPipelineExecutor/getExamplesForTask.d.ts

@@ -3,7 +3,7 @@ import type { TaskJson } from '../../pipeline/PipelineJson/TaskJson';
 import type { string_markdown } from '../../types/typeAliases';
 import type { string_parameter_value } from '../../types/typeAliases';
 /**
- * @@@
+ * Retrieves example values or templates for a given task, used to guide or validate pipeline execution.
  *
  * @private internal utility of `createPipelineExecutor`
  */

package/esm/typings/src/execution/createPipelineExecutor/getKnowledgeForTask.d.ts

@@ -6,34 +6,31 @@ import type { string_markdown } from '../../types/typeAliases';
 import type { string_parameter_value } from '../../types/typeAliases';
 import type { ExecutionTools } from '../ExecutionTools';
 /**
- * @@@
+ * Options for retrieving relevant knowledge for a specific task during pipeline execution.
  *
- * @private internal type of `getKnowledgeFoTask`
+ * @private internal type of `getKnowledgeForTask`
  */
 type GetKnowledgeForTaskOptions = {
     /**
-     * The execution tools to be used during the execution of the pipeline
+     * The execution tools to be used during the execution of the pipeline.
      */
     readonly tools: ExecutionTools;
     /**
-     * @@@
+     * The fully prepared pipeline containing all tasks and knowledge pieces.
      */
     readonly preparedPipeline: ReadonlyDeep<PipelineJson>;
     /**
-     * @@@
+     * The current task for which knowledge is being retrieved.
      */
     readonly task: ReadonlyDeep<TaskJson>;
     /**
-     * @@@
-     *
-     * Parameters to complete the content of the task for embedding
+     * Parameters used to complete the content of the task for embedding and knowledge retrieval.
      */
     readonly parameters: Readonly<Parameters>;
 };
 /**
- * @@@
- *
- * Here is the place where RAG (retrieval-augmented generation) happens
+ * Retrieves the most relevant knowledge pieces for a given task using embedding-based similarity search.
+ * This is where retrieval-augmented generation (RAG) is performed to enhance the task with external knowledge.
  *
  * @private internal utility of `createPipelineExecutor`
  */

package/esm/typings/src/execution/translation/automatic-translate/automatic-translators/LindatAutomaticTranslator.d.ts

@@ -1,18 +1,18 @@
 import type { AutomaticTranslator } from './AutomaticTranslator';
 import type { TranslatorOptions } from './TranslatorOptions';
 /**
- * @@@
+ * Options for configuring the Lindat automatic translator, including API URL and language settings.
  */
 type LindatAutomaticTranslatorOptions = TranslatorOptions & {
     /**
-     * @@@
+     * Optional URL of the Lindat translation API endpoint.
      */
     readonly apiUrl?: URL;
 };
 /**
- * @@@
+ * Automatic translator implementation using the Lindat translation API.
  *
- * @private still in development [🏳]
+ * @private still in development [🏳️]
  */
 export declare class LindatAutomaticTranslator implements AutomaticTranslator {
     protected readonly options: LindatAutomaticTranslatorOptions;

package/esm/typings/src/formats/csv/CsvSettings.d.ts

@@ -1,10 +1,10 @@
 import type { ParseConfig, UnparseConfig } from 'papaparse';
 /**
- * @@@
+ * Settings and configuration options for CSV format handling within the application.
  */
 export type CsvSettings = Pick<ParseConfig & UnparseConfig, 'delimiter' | 'quoteChar' | 'newline' | 'skipEmptyLines'>;
 /**
- * @@@
+ * Contains configuration options for parsing and generating CSV files, such as delimiters and quoting rules.
  *
  * @public exported from `@promptbook/core`
  */

package/esm/typings/src/formfactors/chatbot/ChatbotFormfactorDefinition.d.ts

@@ -1,12 +1,12 @@
 /**
- * @@@
+ * Chatbot form factor definition for conversational interfaces that interact with users in a chat-like manner.
  *
  * @public exported from `@promptbook/core`
  */
 export declare const ChatbotFormfactorDefinition: {
     readonly name: "CHATBOT";
     readonly aliasNames: readonly ["CHAT"];
-    readonly description: "@@@";
+    readonly description: "A chatbot form factor for conversational user interfaces.";
     readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/174";
     readonly pipelineInterface: {
         readonly inputParameters: readonly [{

package/esm/typings/src/formfactors/completion/CompletionFormfactorDefinition.d.ts

@@ -5,7 +5,7 @@
  */
 export declare const CompletionFormfactorDefinition: {
     readonly name: "COMPLETION";
-    readonly description: "@@@";
+    readonly description: "Completion is formfactor that emulates completion models";
     readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
     readonly pipelineInterface: {
         readonly inputParameters: readonly [{

package/esm/typings/src/formfactors/generator/GeneratorFormfactorDefinition.d.ts

@@ -1,5 +1,6 @@
 /**
- * Generator is form of app that @@@
+ * Generator form factor represents an application that generates content or data based on user input or predefined rules.
+ * This form factor is used for apps that produce outputs, such as text, images, or other media, based on provided input.
  *
  * @public exported from `@promptbook/core`
  */

package/esm/typings/src/formfactors/generic/GenericFormfactorDefinition.d.ts

@@ -1,11 +1,11 @@
 /**
- * @@@
+ * A generic pipeline
  *
  * @public exported from `@promptbook/core`
  */
 export declare const GenericFormfactorDefinition: {
     readonly name: "GENERIC";
-    readonly description: "@@@";
+    readonly description: "A generic pipeline";
     readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/173";
     readonly pipelineInterface: {
         readonly inputParameters: readonly [];

package/esm/typings/src/formfactors/index.d.ts

@@ -5,7 +5,7 @@
  */
 export declare const FORMFACTOR_DEFINITIONS: readonly [{
     readonly name: "GENERIC";
-    readonly description: "@@@";
+    readonly description: "A generic pipeline";
     readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/173";
     readonly pipelineInterface: {
         readonly inputParameters: readonly [];
@@ -14,7 +14,7 @@ export declare const FORMFACTOR_DEFINITIONS: readonly [{
 }, {
     readonly name: "CHATBOT";
     readonly aliasNames: readonly ["CHAT"];
-    readonly description: "@@@";
+    readonly description: "A chatbot form factor for conversational user interfaces.";
     readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/174";
     readonly pipelineInterface: {
         readonly inputParameters: readonly [{
@@ -143,7 +143,7 @@ export declare const FORMFACTOR_DEFINITIONS: readonly [{
     };
 }, {
     readonly name: "COMPLETION";
-    readonly description: "@@@";
+    readonly description: "Completion is formfactor that emulates completion models";
     readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
     readonly pipelineInterface: {
         readonly inputParameters: readonly [{

package/esm/typings/src/llm-providers/_common/register/LlmToolsMetadata.d.ts

@@ -1,43 +1,10 @@
+import { MODEL_ORDERS } from '../../../constants';
+import { MODEL_TRUST_LEVELS } from '../../../constants';
 import type { string_name } from '../../../types/typeAliases';
 import type { string_title } from '../../../types/typeAliases';
 import type { Registered } from '../../../utils/$Register';
 import type { string_SCREAMING_CASE } from '../../../utils/normalization/normalizeTo_SCREAMING_CASE';
 import type { LlmToolsConfiguration } from './LlmToolsConfiguration';
-/**
- * How is the model provider trusted?
- *
- * @public exported from `@promptbook/core`
- */
-export declare const MODEL_TRUST_LEVEL: {
-    readonly FULL: "Model is running on the local machine, training data and model weights are known, data are ethically sourced";
-    readonly OPEN: "Model is open source, training data and model weights are known";
-    readonly PARTIALLY_OPEN: "Model is open source, but training data and model weights are not (fully) known";
-    readonly CLOSED_LOCAL: "Model can be run locally, but it is not open source";
-    readonly CLOSED_FREE: "Model is behind API gateway but free to use";
-    readonly CLOSED_BUSINESS: "Model is behind API gateway and paid but has good SLA, TOS, privacy policy and in general is a good to use in business applications";
-    readonly CLOSED: "Model is behind API gateway and paid";
-    readonly UNTRUSTED: "Model has questions about the training data and ethics, but it is not known if it is a problem or not";
-    readonly VURNABLE: "Model has some known serious vulnerabilities, leaks, ethical problems, etc.";
-};
-/**
- * How is the model provider important?
- *
- * @public exported from `@promptbook/core`
- */
-export declare const MODEL_ORDER: {
-    /**
-     * Top-tier models, e.g. OpenAI, Anthropic,...
-     */
-    readonly TOP_TIER: 333;
-    /**
-     * Mid-tier models, e.g. Llama, Mistral, etc.
-     */
-    readonly NORMAL: 100;
-    /**
-     * Low-tier models, e.g. Phi, Tiny, etc.
-     */
-    readonly LOW_TIER: 0;
-};
 /**
  * Metadata definition for LLM execution tools that provides information about a provider's capabilities,
  * configuration options, and relationships within the registry system.
@@ -57,11 +24,11 @@ export type LlmToolsMetadata = Registered & {
     /**
      * How is the model is trusted?
      */
-    readonly trustLevel: keyof typeof MODEL_TRUST_LEVEL;
+    readonly trustLevel: keyof typeof MODEL_TRUST_LEVELS;
     /**
      * How is the model provider important and should be sorted in the list of available providers?
      */
-    readonly order: typeof MODEL_ORDER[keyof typeof MODEL_ORDER] | number;
+    readonly order: typeof MODEL_ORDERS[keyof typeof MODEL_ORDERS] | number;
     /**
      * List of environment variables that can be used to configure the provider
      *

package/esm/typings/src/llm-providers/anthropic-claude/anthropic-claude-models.d.ts

@@ -3,7 +3,7 @@ import type { number_usd } from '../../types/typeAliases';
 /**
  * List of available Anthropic Claude models with pricing
  *
- * Note: Done at 2024-08-16
+ * Note: Done at 2025-05-06
  *
  * @see https://docs.anthropic.com/en/docs/models-overview
  * @public exported from `@promptbook/anthropic-claude`

package/esm/typings/src/llm-providers/deepseek/deepseek-models.d.ts

@@ -3,7 +3,7 @@ import type { number_usd } from '../../types/typeAliases';
 /**
  * List of available Deepseek models with descriptions
  *
- * Note: Done at 2025-04-22
+ * Note: Done at 2025-05-06
  *
  * @see https://www.deepseek.com/models
  * @public exported from `@promptbook/deepseek`

package/esm/typings/src/llm-providers/google/google-models.d.ts

@@ -3,7 +3,7 @@ import type { number_usd } from '../../types/typeAliases';
 /**
  * List of available Google models with descriptions
  *
- * Note: Done at 2025-04-22
+ * Note: Done at 2025-05-06
  *
  * @see https://ai.google.dev/models/gemini
  * @public exported from `@promptbook/google`

package/esm/typings/src/llm-providers/openai/openai-models.d.ts

@@ -3,7 +3,7 @@ import type { number_usd } from '../../types/typeAliases';
 /**
  * List of available OpenAI models with pricing
  *
- * Note: Done at 2024-05-20
+ * Note: Done at 2025-05-06
  *
  * @see https://platform.openai.com/docs/models/
  * @see https://openai.com/api/pricing/

package/esm/typings/src/llm-providers/openai/register-configuration.d.ts

@@ -10,9 +10,9 @@ import type { Registration } from '../../utils/$Register';
  */
 export declare const _OpenAiMetadataRegistration: Registration;
 /**
- * @@@ registration1 of default configuration for Open AI
+ * Registration of the OpenAI Assistant metadata
  *
- * Note: [🏐] Configurations registrations are done in @@@ BUT constructor @@@
+ * Note: [🏐] Configurations registrations are done in the metadata registration section, but the constructor registration is handled separately.
  *
  * @public exported from `@promptbook/core`
  * @public exported from `@promptbook/wizzard`

package/esm/typings/src/llm-providers/openai/register-constructor.d.ts

@@ -10,9 +10,9 @@ import type { Registration } from '../../utils/$Register';
  */
 export declare const _OpenAiRegistration: Registration;
 /**
- * @@@ registration2
+ * Registration of the OpenAI Assistant provider
  *
- * Note: [🏐] Configurations registrations are done in @@@ BUT constructor @@@
+ * Note: [🏐] Configurations registrations are done in register-constructor.ts BUT constructor register-constructor.ts
  *
  * @public exported from `@promptbook/openai`
  * @public exported from `@promptbook/wizzard`

package/esm/typings/src/version.d.ts

@@ -15,7 +15,7 @@ export declare const BOOK_LANGUAGE_VERSION: string_semantic_version;
 export declare const PROMPTBOOK_ENGINE_VERSION: string_promptbook_version;
 /**
  * Represents the version string of the Promptbook engine.
- * It follows semantic versioning (e.g., `0.92.0-26`).
+ * It follows semantic versioning (e.g., `0.92.0-27`).
  *
  * @generated
  */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/openai",
-    "version": "0.92.0-27",
+    "version": "0.92.0-28",
     "description": "It's time for a paradigm shift. The future of software in plain English, French or Latin",
     "private": false,
     "sideEffects": false,
@@ -51,7 +51,7 @@
     "module": "./esm/index.es.js",
     "typings": "./esm/typings/src/_packages/openai.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.92.0-27"
+        "@promptbook/core": "0.92.0-28"
     },
     "dependencies": {
         "bottleneck": "^2.19.5",

package/umd/index.umd.js

@@ -25,7 +25,7 @@
      * @generated
      * @see https://github.com/webgptorg/promptbook
      */
-    const PROMPTBOOK_ENGINE_VERSION = '0.92.0-27';
+    const PROMPTBOOK_ENGINE_VERSION = '0.92.0-28';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -1278,7 +1278,7 @@
     /**
      * List of available OpenAI models with pricing
      *
-     * Note: Done at 2024-05-20
+     * Note: Done at 2025-05-06
      *
      * @see https://platform.openai.com/docs/models/
      * @see https://openai.com/api/pricing/
@@ -1539,7 +1539,7 @@
                 modelName: 'text-embedding-3-large',
                 modelDescription: "OpenAI's most capable text embedding model designed for high-quality embeddings for complex similarity tasks and information retrieval.",
                 pricing: {
-                    prompt: computeUsage(`$0.13  / 1M tokens`),
+                    prompt: computeUsage(`$0.13 / 1M tokens`),
                     // TODO: [🏏] Leverage the batch API @see https://platform.openai.com/docs/guides/batch
                     output: 0, // <- Note: [🆖] In Embedding models you dont pay for output
                 },
@@ -1632,8 +1632,8 @@
                 modelName: 'gpt-4o-mini',
                 modelDescription: 'Smaller, more cost-effective version of GPT-4o with good performance across text, vision, and audio tasks at reduced complexity.',
                 pricing: {
-                    prompt: computeUsage(`$3.00 / 1M tokens`),
-                    output: computeUsage(`$9.00 / 1M tokens`),
+                    prompt: computeUsage(`$0.15 / 1M tokens`),
+                    output: computeUsage(`$0.60 / 1M tokens`),
                 },
             },
             /**/
@@ -2515,9 +2515,9 @@
      */
     const _OpenAiRegistration = $llmToolsRegister.register(createOpenAiExecutionTools);
     /**
-     * @@@ registration2
+     * Registration of the OpenAI Assistant provider
      *
-     * Note: [🏐] Configurations registrations are done in @@@ BUT constructor @@@
+     * Note: [🏐] Configurations registrations are done in register-constructor.ts BUT constructor register-constructor.ts
      *
      * @public exported from `@promptbook/openai`
      * @public exported from `@promptbook/wizzard`