@promptbook/openai 0.92.0-26 → 0.92.0-28

package/esm/typings/src/execution/createPipelineExecutor/40-executeAttempts.d.ts

@@ -7,55 +7,61 @@ import type { TODO_string } from '../../utils/organization/TODO_string';
 import type { ExecutionReportJson } from '../execution-report/ExecutionReportJson';
 import type { CreatePipelineExecutorOptions } from './00-CreatePipelineExecutorOptions';
 /**
- * @@@
+ * Options for executing attempts of a pipeline task, including configuration for jokers, priority,
+ * maximum attempts, prepared content, parameters, the task itself, the prepared pipeline, execution report,
+ * and pipeline identification. Used internally by the pipeline executor.
  *
  * @private internal type of `executeAttempts`
  */
 export type ExecuteAttemptsOptions = Required<Omit<CreatePipelineExecutorOptions, 'pipeline'>> & {
     /**
-     * @@@
+     * Names of parameters that act as jokers, which can be used to bypass normal execution if their value meets requirements.
      */
     readonly jokerParameterNames: Readonly<ReadonlyArray<string_parameter_name>>;
     /**
-     * @@@
+     * Priority of the current execution attempt, used to influence UI or execution order.
      */
     readonly priority: number;
     /**
-     * @@@
-     *
+     * Maximum number of attempts allowed for this task, including retries and joker attempts.
      * Note: [💂] There are two distinct variabiles
-     * 1) `maxExecutionAttempts` - the amount of attempts LLM model
-     * 2) `maxAttempts` - the amount of attempts for any task - LLM, SCRIPT, DIALOG, etc.
+     * 1) `maxExecutionAttempts` - attempts for LLM model
+     * 2) `maxAttempts` - attempts for any task (LLM, SCRIPT, DIALOG, etc.)
      */
     readonly maxAttempts: number;
     /**
-     * @@@
+     * The content prepared for execution, with parameters already substituted.
      */
     readonly preparedContent: TODO_string;
     /**
-     * @@@
+     * The parameters provided for this execution attempt.
      */
     readonly parameters: Readonly<Parameters>;
     /**
-     * @@@
+     * The task being executed, as a deeply immutable TaskJson object.
+     * Note: Naming should be unified between `task` and `currentTask`.
      */
     readonly task: ReadonlyDeep<TaskJson>;
     /**
-     * @@@
+     * The pipeline structure prepared for execution, as a deeply immutable PipelineJson object.
      */
     readonly preparedPipeline: ReadonlyDeep<PipelineJson>;
     /**
-     * @@@
+     * The execution report object, which is updated during execution.
      */
     readonly $executionReport: WritableDeep<ExecutionReportJson>;
     /**
-     * @@@
+     * String identifier for the pipeline, used for logging and error reporting.
      */
     readonly pipelineIdentification: string;
 };
 /**
- * @@@
+ * Executes a pipeline task with multiple attempts, including joker and retry logic. Handles different task types
+ * (prompt, script, dialog, etc.), applies postprocessing, checks expectations, and updates the execution report.
+ * Throws errors if execution fails after all attempts.
  *
+ * @param options - The options for execution, including task, parameters, pipeline, and configuration.
+ * @returns The result string of the executed task.
  * @private internal utility of `createPipelineExecutor`
  */
 export declare function executeAttempts(options: ExecuteAttemptsOptions): Promise<TODO_string>;

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/execution/utils/uncertainNumber.d.ts

@@ -2,8 +2,9 @@ import type { UncertainNumber } from '../UncertainNumber';
 /**
  * Make UncertainNumber
  *
- * @param value
+ * @param value value of the uncertain number, if `NaN` or `undefined`, it will be set to 0 and `isUncertain=true`
+ * @param isUncertain if `true`, the value is uncertain, otherwise depends on the value
  *
  * @private utility for initializating UncertainNumber
  */
-export declare function uncertainNumber(value?: number | typeof NaN | undefined | null): UncertainNumber;
+export declare function uncertainNumber(value?: number | typeof NaN | undefined | null, isUncertain?: boolean): UncertainNumber;

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/_common/AbstractFormfactorDefinition.d.ts

@@ -4,34 +4,43 @@ import type { string_name } from '../../types/typeAliases';
 import type { string_promptbook_documentation_url } from '../../types/typeAliases';
 import type { string_SCREAMING_CASE } from '../../utils/normalization/normalizeTo_SCREAMING_CASE';
 /**
- * @@@
+ * AbstractFormfactorDefinition provides the base structure for all form factor implementations
+ * in the Promptbook system. It defines common properties and interfaces that must be
+ * implemented by specific form factors.
  *
  * Note: [🚉] This is fully serializable as JSON
  * @see https://github.com/webgptorg/promptbook/discussions/172
  */
 export type AbstractFormfactorDefinition = {
     /**
-     * @@@
+     * Unique identifier for the form factor in SCREAMING_CASE format
+     * Used for programmatic identification and reference
      */
     readonly name: string_name & string_SCREAMING_CASE;
     /**
-     * @@@
+     * Alternative names that can be used to reference this form factor
+     * Also in SCREAMING_CASE format for consistency
      */
     readonly aliasNames?: ReadonlyArray<string_name & string_SCREAMING_CASE>;
     /**
-     * @@@
+     * Previous names that were used for this form factor but are now deprecated
+     * These are maintained for backward compatibility purposes
      */
     readonly deprecatedNames?: ReadonlyArray<string_name & string_SCREAMING_CASE>;
     /**
-     * @@@
+     * Human-readable description of the form factor in markdown format
+     * Explains the purpose, functionality, and use cases of this form factor
      */
     readonly description: string_markdown_text;
     /**
-     * @@@
+     * URL pointing to detailed documentation for this form factor
+     * Provides additional resources and guidance for implementation and usage
      */
     readonly documentationUrl: string_promptbook_documentation_url;
     /**
-     * @@@
+     * Defines the interface structure for this form factor's pipeline
+     * Specifies how inputs and outputs are handled, processed, and formatted
+     * Required for properly configuring and executing the form factor's functionality
      */
     readonly pipelineInterface: PipelineInterface;
 };

package/esm/typings/src/formfactors/_common/FormfactorDefinition.d.ts

@@ -1,6 +1,8 @@
 import { FORMFACTOR_DEFINITIONS } from '../index';
 /**
- * @@@
+ * FormfactorDefinition is a type that defines the structure and capabilities of a specific
+ * application form factor in the Promptbook system. It encapsulates all properties needed
+ * to represent how a particular interface handles inputs, outputs, and behaviors.
  *
  * Note: [🚉] This is fully serializable as JSON
  * @see https://github.com/webgptorg/promptbook/discussions/172

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 [{
@@ -52,7 +52,7 @@ export declare const FORMFACTOR_DEFINITIONS: readonly [{
     };
 }, {
     readonly name: "TRANSLATOR";
-    readonly description: "@@@";
+    readonly description: "A text transformation system that converts input content into different forms,\n    including language translations, paraphrasing, style conversions, and tone adjustments.\n    This form factor takes one input and produces one transformed output.";
     readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/175";
     readonly pipelineInterface: {
         readonly inputParameters: readonly [{
@@ -89,7 +89,7 @@ export declare const FORMFACTOR_DEFINITIONS: readonly [{
     };
 }, {
     readonly name: "EXPERIMENTAL_MATCHER";
-    readonly description: "@@@";
+    readonly description: "An evaluation system that determines whether content meets specific criteria or patterns.\n    Used for content validation, quality assessment, and intelligent filtering tasks. Currently in experimental phase.";
     readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/177";
     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/formfactors/matcher/MatcherFormfactorDefinition.d.ts

@@ -1,11 +1,13 @@
 /**
- * Matcher is form of app that @@@
+ * Matcher is form of app that evaluates (spreadsheet) content against defined criteria or patterns,
+ * determining if it matches or meets specific requirements. Used for classification,
+ * validation, filtering, and quality assessment of inputs.
  *
  * @public exported from `@promptbook/core`
  */
 export declare const MatcherFormfactorDefinition: {
     readonly name: "EXPERIMENTAL_MATCHER";
-    readonly description: "@@@";
+    readonly description: "An evaluation system that determines whether content meets specific criteria or patterns.\n    Used for content validation, quality assessment, and intelligent filtering tasks. Currently in experimental phase.";
     readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/177";
     readonly pipelineInterface: {
         readonly inputParameters: readonly [{

package/esm/typings/src/formfactors/translator/TranslatorFormfactorDefinition.d.ts

@@ -1,11 +1,12 @@
 /**
- * Translator is form of app that @@@
+ * Translator is form of app that transforms input text from one form to another,
+ * such as language translation, style conversion, tone modification, or other text transformations.
  *
  * @public exported from `@promptbook/core`
  */
 export declare const TranslatorFormfactorDefinition: {
     readonly name: "TRANSLATOR";
-    readonly description: "@@@";
+    readonly description: "A text transformation system that converts input content into different forms,\n    including language translations, paraphrasing, style conversions, and tone adjustments.\n    This form factor takes one input and produces one transformed output.";
     readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/175";
     readonly pipelineInterface: {
         readonly inputParameters: readonly [{

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

@@ -3,7 +3,8 @@ import type { LlmExecutionToolsWithTotalUsage } from '../utils/count-total-usage
 import type { CreateLlmToolsFromConfigurationOptions } from './createLlmToolsFromConfiguration';
 type GetLlmToolsForTestingAndScriptsAndPlaygroundOptions = CreateLlmToolsFromConfigurationOptions & {
     /**
-     * @@@
+     * Flag indicating whether the cache should be reloaded or reused
+     * When set to true, the existing cache will not be used but thinks will be still saved to the cache
      *
      * @default false
      */
@@ -22,5 +23,5 @@ export {};
  * Note: [⚪] This should never be in any released package
  * TODO: [👷‍♂️] @@@ Manual about construction of llmTools
  * TODO: This should be maybe not under `_common` but under `utils-internal` / `utils/internal`
- * TODO: [®] DRY Register logic
- */
+ * TODO: [®] DRY Register logi
+ */ 

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

@@ -1,11 +1,14 @@
 import { MultipleLlmExecutionTools } from '../../multiple/MultipleLlmExecutionTools';
 import type { CreateLlmToolsFromConfigurationOptions } from './createLlmToolsFromConfiguration';
 /**
- * @@@
+ * Automatically configures LLM tools from environment variables in Node.js
+ *
+ * This utility function detects available LLM providers based on environment variables
+ * and creates properly configured LLM execution tools for each detected provider.
  *
  * Note: This function is not cached, every call creates new instance of `MultipleLlmExecutionTools`
  *
- * @@@ .env
+ * Supports environment variables from .env files when dotenv is configured
  * Note: `$` is used to indicate that this function is not a pure function - it uses filesystem to access `.env` file
  *
  * It looks for environment variables:
@@ -13,12 +16,22 @@ import type { CreateLlmToolsFromConfigurationOptions } from './createLlmToolsFro
  * - `process.env.ANTHROPIC_CLAUDE_API_KEY`
  * - ...
  *
- * @returns @@@
+ * @param options Configuration options for the LLM tools
+ * @returns A unified interface containing all detected and configured LLM tools
  * @public exported from `@promptbook/node`
  */
 export declare function $provideLlmToolsFromEnv(options?: CreateLlmToolsFromConfigurationOptions): Promise<MultipleLlmExecutionTools>;
 /**
- * TODO: @@@ write `$provideLlmToolsFromEnv` vs `$provideLlmToolsConfigurationFromEnv` vs `createLlmToolsFromConfiguration`
+ * TODO: The architecture for LLM tools configuration consists of three key functions:
+ * 1. `$provideLlmToolsFromEnv` - High-level function that detects available providers from env vars and returns ready-to-use LLM tools
+ * 2. `$provideLlmToolsConfigurationFromEnv` - Middle layer that extracts configuration objects from environment variables
+ * 3. `createLlmToolsFromConfiguration` - Low-level function that instantiates LLM tools from explicit configuration
+ *
+ * This layered approach allows flexibility in how tools are configured:
+ * - Use $provideLlmToolsFromEnv for automatic detection and setup in Node.js environments
+ * - Use $provideLlmToolsConfigurationFromEnv to extract config objects for modification before instantiation
+ * - Use createLlmToolsFromConfiguration for explicit control over tool configurations
+ *
  * TODO: [🧠][🍛] Which name is better `$provideLlmToolsFromEnv` or `$provideLlmToolsFromEnvironment`?
  * TODO: [🧠] Is there some meaningfull way how to test this util
  * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment

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

@@ -2,17 +2,24 @@ import type { string_title } from '../../../types/typeAliases';
 import type { Registered } from '../../../utils/$Register';
 import type { LlmToolsOptions } from './LlmToolsOptions';
 /**
- * @@@
+ * Configuration definition for LLM execution tools, containing provider-specific settings
+ * that can be passed during runtime to instantiate and configure LLM tools properly.
  *
- * @@@ `LlmToolsMetadata` vs `LlmToolsConfiguration` vs `LlmToolsOptions` (vs `Registered`)
+ * The Promptbook LLM tools architecture involves several related types:
+ * - `LlmToolsMetadata`: Contains static metadata about the tool, such as name, version, and capabilities
+ * - `LlmToolsConfiguration`: Runtime configuration from environment variables or settings
+ * - `LlmToolsOptions`: Provider-specific options for instantiating tools
+ * - `Registered`: The record of a registered tool in the global registry
  */
 export type LlmToolsConfiguration = ReadonlyArray<Registered & {
     /**
-     * @@@
+     * Human-readable name for this specific provider configuration
+     * Used in UI components and logs for identifying this particular configuration
      */
     readonly title: string_title;
     /**
-     * @@@
+     * Provider-specific configuration options used for instantiating and configuring LLM tools
+     * Contains values like API keys, model preferences, endpoint URLs, and other settings
      */
     readonly options: LlmToolsOptions;
 }>;

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

@@ -1,61 +1,34 @@
+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?
+ * Metadata definition for LLM execution tools that provides information about a provider's capabilities,
+ * configuration options, and relationships within the registry system.
  *
- * @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;
-};
-/**
- * @@@
- *
- * @@@ `LlmToolsMetadata` vs `LlmToolsConfiguration` vs `LlmToolsOptions` (vs `Registered`)
+ * The Promptbook LLM tools architecture involves several related types:
+ * - `LlmToolsMetadata`: Contains static metadata about the tool, such as name, version, and capabilities
+ * - `LlmToolsConfiguration`: Runtime configuration from environment variables or settings
+ * - `LlmToolsOptions`: Provider-specific options for instantiating tools
+ * - `Registered`: The record of a registered tool in the global registry
  */
 export type LlmToolsMetadata = Registered & {
     /**
-     * @@@
+     * Human-readable display name for the LLM provider
+     * Used in UI components and documentation references
      */
     readonly title: string_title;
     /**
      * 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
      *
@@ -64,11 +37,17 @@ export type LlmToolsMetadata = Registered & {
      */
     readonly envVariables: ReadonlyArray<string_name & string_SCREAMING_CASE> | null;
     /**
-     * @@@
+     * Provides a default configuration template for this LLM provider
+     * Used to generate example configurations or as fallback when no specific configuration is provided
+     * @returns A standardized configuration object for this LLM provider
      */
     getBoilerplateConfiguration(): LlmToolsConfiguration[number];
     /**
-     * @@@
+     * Creates a provider-specific configuration object from environment variables
+     * Used to automatically configure LLM tools based on available environment settings
+     *
+     * @param env Dictionary of environment variables (key-value pairs)
+     * @returns Configuration object for this LLM provider if required variables are present, or null if configuration is not possible
      */
     createConfigurationFromEnv(env: Record<string_name, string>): LlmToolsConfiguration[number] | null;
 };

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

@@ -5,7 +5,11 @@ import type { TODO_object } from '../../../utils/organization/TODO_object';
  * This type is used to pass provider-specific options to LLM execution tools.
  *
  *
- * @@@ `LlmToolsMetadata` vs `LlmToolsConfiguration` vs `LlmToolsOptions` (vs `Registered`)
+ * The Promptbook LLM tools architecture involves several related types:
+ * - `LlmToolsMetadata`: Contains static metadata about the tool, such as name, version, and capabilities
+ * - `LlmToolsConfiguration`: Runtime configuration from environment variables or settings
+ * - `LlmToolsOptions`: Provider-specific options for instantiating tools
+ * - `Registered`: The record of a registered tool in the global registry
  */
 export type LlmToolsOptions = TODO_object;
 /**