@promptbook/azure-openai 0.92.0-9 → 0.93.0

package/esm/typings/src/execution/createPipelineExecutor/$OngoingTaskResult.d.ts

@@ -5,41 +5,44 @@ import type { CompletionPromptResult } from '../PromptResult';
 import type { EmbeddingPromptResult } from '../PromptResult';
 import type { PromptResult } from '../PromptResult';
 /**
- * @@@
+ * Represents the ongoing result of a pipeline task execution
+ *
+ * Used internally by the pipeline executor to track state during execution attempts
  *
  * @private internal utility of `createPipelineExecutor`
  */
 export type $OngoingTaskResult = {
     /**
-     * @@@
+     * The prompt object used for the current execution attempt, if applicable.
      */
     $prompt?: Prompt;
     /**
-     * @@@
+     * The result of a chat model execution, if applicable.
      */
     $chatResult?: ChatPromptResult;
     /**
-     * @@@
+     * The result of a completion model execution, if applicable.
      */
     $completionResult?: CompletionPromptResult;
     /**
-     * @@@
+     * The result of an embedding model execution, if applicable.
+     * Note: [🤖] Embedding results are less common in standard pipelines.
      */
     $embeddingResult?: EmbeddingPromptResult;
     /**
-     * @@@
+     * The final result object for the task, or null if not yet available.
      */
     $result: PromptResult | null;
     /**
-     * @@@
+     * The result string produced by the task, or null if not yet available.
      */
     $resultString: string | null;
     /**
-     * @@@
+     * The last expectation error encountered, or null if none.
      */
     $expectError: ExpectError | null;
     /**
-     * @@@
+     * List of errors encountered during script postprocessing or execution.
      */
     $scriptPipelineExecutionErrors: Array<Error>;
 };

package/esm/typings/src/execution/createPipelineExecutor/10-executePipeline.d.ts

@@ -4,40 +4,43 @@ import type { InputParameters } from '../../types/typeAliases';
 import type { PipelineExecutorResult } from '../PipelineExecutorResult';
 import type { CreatePipelineExecutorOptions } from './00-CreatePipelineExecutorOptions';
 /**
- * @@@
+ * Options for executing an entire pipeline, including input parameters, pipeline context, and progress callbacks.
  *
  * @private internal type of `executePipeline`
  */
 type ExecutePipelineOptions = Required<CreatePipelineExecutorOptions> & {
     /**
-     * @@@
+     * The input parameters provided by the user for pipeline execution.
      */
     readonly inputParameters: Readonly<InputParameters>;
     /**
-     * @@@
+     * Optional callback invoked with partial results as the pipeline execution progresses.
      */
     onProgress?(newOngoingResult: PartialDeep<PipelineExecutorResult>): Promisable<void>;
     /**
-     * @@@
+     * The pipeline definition to execute.
      */
     readonly pipeline: PipelineJson;
     /**
-     * @@@
+     * The prepared and validated pipeline, ready for execution.
      */
     readonly preparedPipeline: ReadonlyDeep<PipelineJson>;
     /**
-     * @@@
+     * Callback to update the prepared pipeline reference after preparation.
      */
-    readonly setPreparedPipeline: (preparedPipeline: ReadonlyDeep<PipelineJson>) => void;
+    setPreparedPipeline(preparedPipeline: ReadonlyDeep<PipelineJson>): void;
     /**
-     * @@@
+     * String identifier for the pipeline, used in error messages and reporting.
      */
     readonly pipelineIdentification: string;
 };
 /**
- * @@@
+ * Executes an entire pipeline, resolving tasks in dependency order, handling errors, and reporting progress.
  *
- * Note: This is not a `PipelineExecutor` (which is binded with one exact pipeline), but a utility function of `createPipelineExecutor` which creates `PipelineExecutor`
+ * Note: This is not a `PipelineExecutor` (which is bound to a single pipeline), but a utility function used by `createPipelineExecutor` to create a `PipelineExecutor`.
+ *
+ * @param options - Options for execution, including input parameters, pipeline, and callbacks.
+ * @returns The result of the pipeline execution, including output parameters, errors, and usage statistics.
  *
  * @private internal utility of `createPipelineExecutor`
  */

package/esm/typings/src/execution/createPipelineExecutor/20-executeTask.d.ts

@@ -6,38 +6,41 @@ import type { ExecutionReportJson } from '../execution-report/ExecutionReportJso
 import type { PipelineExecutorResult } from '../PipelineExecutorResult';
 import type { CreatePipelineExecutorOptions } from './00-CreatePipelineExecutorOptions';
 /**
- * @@@
+ * Options for executing a single pipeline task, including task details, pipeline context, parameters, and callbacks.
  *
  * @private internal type of `executeTask`
  */
 type executeSingleTaskOptions = Required<CreatePipelineExecutorOptions> & {
     /**
-     * @@@
+     * The task to be executed.
      */
     readonly currentTask: ReadonlyDeep<TaskJson>;
     /**
-     * @@@
+     * The pipeline in which the task resides, fully prepared and validated.
      */
     readonly preparedPipeline: ReadonlyDeep<PipelineJson>;
     /**
-     * @@@
+     * The parameters to pass to the task execution.
      */
     readonly parametersToPass: Readonly<Parameters>;
     /**
-     * @@@
+     * Callback invoked with partial results as the execution progresses.
      */
-    readonly onProgress: (newOngoingResult: PartialDeep<PipelineExecutorResult>) => Promisable<void>;
+    onProgress(newOngoingResult: PartialDeep<PipelineExecutorResult>): Promisable<void>;
     /**
-     * @@@
+     * Mutable execution report object for tracking execution details.
      */
     readonly $executionReport: WritableDeep<ExecutionReportJson>;
     /**
-     * @@@
+     * String identifier for the pipeline, used in error messages and reporting.
      */
     readonly pipelineIdentification: string;
 };
 /**
- * @@@
+ * Executes a single task within a pipeline, handling parameter validation, error checking, and progress reporting.
+ *
+ * @param options - Options for execution, including the task, pipeline, parameters, and callbacks.
+ * @returns The output parameters produced by the task.
  *
  * @private internal utility of `createPipelineExecutor`
  */

package/esm/typings/src/execution/createPipelineExecutor/30-executeFormatSubvalues.d.ts

@@ -1,13 +1,25 @@
+import type { PartialDeep, Promisable } from 'type-fest';
 import type { TODO_any } from '../../utils/organization/TODO_any';
+import type { PipelineExecutorResult } from '../PipelineExecutorResult';
 import type { ExecuteAttemptsOptions } from './40-executeAttempts';
 /**
- * @@@
+ * Options for executing a pipeline task that involves formatting subvalues (e.g., iterating over CSV rows).
+ * Extends ExecuteAttemptsOptions with a progress callback.
  *
  * @private internal type of `executeFormatSubvalues`
  */
-type ExecuteFormatCellsOptions = ExecuteAttemptsOptions;
+type ExecuteFormatCellsOptions = ExecuteAttemptsOptions & {
+    /**
+     * Callback invoked with partial results as the execution progresses.
+     */
+    onProgress(newOngoingResult: PartialDeep<PipelineExecutorResult>): Promisable<void>;
+};
 /**
- * @@@
+ * Executes a pipeline task that requires mapping or iterating over subvalues of a parameter (such as rows in a CSV).
+ * Handles format and subformat resolution, error handling, and progress reporting.
+ *
+ * @param options - Options for execution, including task details and progress callback.
+ * @returns The result of the subvalue mapping or execution attempts.
  *
  * @private internal utility of `createPipelineExecutor`
  */

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;
     /**
-     * @@@
-     *
-     * 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.
+     * Maximum number of attempts allowed for this task, including retries and joker attempts.
+     * Note: [💂] There are two distinct variables
+     * 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/computeCosineSimilarity.d.ts

@@ -0,0 +1,13 @@
+import type { EmbeddingVector } from '../EmbeddingVector';
+/**
+ * Computes the cosine similarity between two embedding vectors
+ *
+ * Note: This is helping function for RAG (retrieval-augmented generation)
+ *
+ * @param embeddingVector1
+ * @param embeddingVector2
+ * @returns Cosine similarity between the two vectors
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare function computeCosineSimilarity(embeddingVector1: EmbeddingVector, embeddingVector2: EmbeddingVector): number;

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

@@ -1,39 +1,42 @@
 import type { ReadonlyDeep } from 'type-fest';
 import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
 import type { TaskJson } from '../../pipeline/PipelineJson/TaskJson';
+import type { Parameters } from '../../types/typeAliases';
 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 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`
  */
 export declare function getKnowledgeForTask(options: GetKnowledgeForTaskOptions): Promise<string_parameter_value & string_markdown>;
 export {};
 /**
- * TODO: !!!! Verify if this is working
  * TODO: [♨] Implement Better - use keyword search
  * TODO: [♨] Examples of values
  */

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

@@ -1,10 +1,11 @@
 import type { ReadonlyDeep } from 'type-fest';
 import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
 import type { TaskJson } from '../../pipeline/PipelineJson/TaskJson';
+import type { Parameters } from '../../types/typeAliases';
 import type { ReservedParameters } from '../../types/typeAliases';
 import type { ExecutionTools } from '../ExecutionTools';
 /**
- * @@@
+ * Options for retrieving reserved parameters for a pipeline task, including context, pipeline, and identification.
  *
  * @private internal type of `getReservedParametersForTask`
  */
@@ -14,20 +15,32 @@ type GetReservedParametersForTaskOptions = {
      */
     readonly tools: ExecutionTools;
     /**
-     * @@@
+     * The prepared and validated pipeline in which the task resides.
      */
     readonly preparedPipeline: ReadonlyDeep<PipelineJson>;
     /**
-     * @@@
+     * The task for which reserved parameters are being retrieved.
      */
     readonly task: ReadonlyDeep<TaskJson>;
     /**
-     * @@@
+     * Parameters to complete the content of the task for embedding and context.
+     */
+    readonly parameters: Readonly<Parameters>;
+    /**
+     * String identifier for the pipeline, used in error messages and reporting.
      */
     readonly pipelineIdentification: string;
+    /**
+     * If true, the preparation logs the reserved parameters for debugging purposes.
+     */
+    readonly isVerbose?: boolean;
 };
 /**
- * @@@
+ * Retrieves all reserved parameters for a given pipeline task, including context, knowledge, examples, and metadata.
+ * Ensures all reserved parameters are defined and throws if any are missing.
+ *
+ * @param options - Options including tools, pipeline, task, and context.
+ * @returns An object containing all reserved parameters for the task.
  *
  * @private internal utility of `createPipelineExecutor`
  */

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

@@ -0,0 +1,9 @@
+import type { KnowledgePiecePreparedJson } from '../../pipeline/PipelineJson/KnowledgePieceJson';
+/**
+ *
+ * @param knowledgePieces
+ * @returns
+ *
+ * @private internal utility of `createPipelineExecutor`
+ */
+export declare function knowledgePiecesToString(knowledgePieces: ReadonlyArray<Pick<KnowledgePiecePreparedJson, 'content'>>): string;

package/esm/typings/src/execution/execution-report/ExecutionReportJson.d.ts

@@ -4,7 +4,7 @@ import type { string_semantic_version } from '../../types/typeAliases';
 import type { ExecutionPromptReportJson } from './ExecutionPromptReportJson';
 /**
  * ExecutionReport is result of executing one promptbook
- * It is kind of a variant of the promptbook usefull for debugging, logging and transparency for users.
+ * It is kind of a variant of the promptbook useful for debugging, logging and transparency for users.
  *
  * It can have 2 formats:
  * -   **.md file** created from the **JSON** format

package/esm/typings/src/execution/execution-report/ExecutionReportString.d.ts

@@ -1,6 +1,6 @@
 /**
  * ExecutionReport is result of executing one promptbook
- * It is kind of a variant of the promptbook usefull for debugging, logging and transparency for users.
+ * It is kind of a variant of the promptbook useful for debugging, logging and transparency for users.
  *
  * It can have 2 formats:
  * -   _(this)_ **.md file** created from the **JSON** format

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

@@ -2,7 +2,7 @@ import type { Expectations } from '../../pipeline/PipelineJson/Expectations';
 /**
  * Function checkExpectations will check if the expectations on given value are met
  *
- * Note: There are two simmilar functions:
+ * Note: There are two similar functions:
  * - `checkExpectations` which throws an error if the expectations are not met
  * - `isPassingExpectations` which returns a boolean
  *
@@ -14,7 +14,7 @@ export declare function checkExpectations(expectations: Expectations, value: str
 /**
  * Function checkExpectations will check if the expectations on given value are met
  *
- * Note: There are two simmilar functions:
+ * Note: There are two similar functions:
  * - `checkExpectations` which throws an error if the expectations are not met
  * - `isPassingExpectations` which returns a boolean
  *
@@ -24,6 +24,6 @@ export declare function checkExpectations(expectations: Expectations, value: str
 export declare function isPassingExpectations(expectations: Expectations, value: string): boolean;
 /**
  * TODO: [💝] Unite object for expecting amount and format
- * TODO: [🧠][🤠] This should be part of `TextFormatDefinition`
+ * TODO: [🧠][🤠] This should be part of `TextFormatParser`
  * Note: [💝] and [🤠] are interconnected together
  */

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

@@ -10,7 +10,7 @@ type PartialUsage = Pick<Usage, 'input' | 'output'> & {
 /**
  * Function usageToWorktime will take usage and estimate saved worktime in hours of reading / writing
  *
- * Note: This is an estimate based of theese sources:
+ * Note: This is an estimate based of these sources:
  * - https://jecas.cz/doba-cteni
  * - https://www.originalnitonery.cz/blog/psani-vsemi-deseti-se-muzete-naucit-i-sami-doma
  *

package/esm/typings/src/formats/_common/{FormatDefinition.d.ts → FormatParser.d.ts}

@@ -2,16 +2,18 @@ import type { string_mime_type } from '../../types/typeAliases';
 import type { string_name } from '../../types/typeAliases';
 import type { string_SCREAMING_CASE } from '../../utils/normalization/normalizeTo_SCREAMING_CASE';
 import type { empty_object } from '../../utils/organization/empty_object';
-import type { FormatSubvalueDefinition } from './FormatSubvalueDefinition';
+import type { FormatSubvalueParser } from './FormatSubvalueParser';
 /**
- * A format definition is a set of functions that define how to validate, heal and convert response from LLM
+ * A format definition is a set of functions that define how to validate, heal and convert response from LLM.
  *
- * @@@ Describe setting vs schema
+ * @remarks
+ * - "settings" are runtime options that affect parsing (e.g., delimiter for CSV).
+ * - "schema" is a structural definition or contract for the data (e.g., expected fields in JSON).
  *
  * @see https://github.com/webgptorg/promptbook/discussions/36
  * @private still in development [🏢]
  */
-export type FormatDefinition<TValue extends TPartialValue, TPartialValue extends string, TSettings extends empty_object, TSchema extends empty_object> = {
+export type FormatParser<TValue extends TPartialValue, TPartialValue extends string, TSettings extends empty_object, TSchema extends empty_object> = {
     /**
      * The name of the format used in .book.md files
      *
@@ -56,9 +58,9 @@ export type FormatDefinition<TValue extends TPartialValue, TPartialValue extends
      */
     heal(value: string, settings?: TSettings, scheme?: TSchema): TValue;
     /**
-     * @@@
+     * Parsers for extracting or mapping subvalues from the main value (e.g., rows from CSV, items from JSON array).
      */
-    readonly subvalueDefinitions: ReadonlyArray<FormatSubvalueDefinition<TValue, TSettings>>;
+    readonly subvalueParsers: ReadonlyArray<FormatSubvalueParser<TValue, TSettings>>;
 };
 /**
  * TODO: [♏] Add some prepare hook to modify prompt according to the format