@promptbook/vercel 0.103.0-32 → 0.103.0-34

package/esm/index.es.js

@@ -16,7 +16,7 @@ const BOOK_LANGUAGE_VERSION = '1.0.0';
  * @generated
  * @see https://github.com/webgptorg/promptbook
  */
-const PROMPTBOOK_ENGINE_VERSION = '0.103.0-32';
+const PROMPTBOOK_ENGINE_VERSION = '0.103.0-34';
 /**
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
  * Note: [💞] Ignore a discrepancy between file name and entity name

package/esm/typings/src/_packages/cli.index.d.ts

@@ -30,7 +30,6 @@ import { _PdfScraperRegistration } from '../scrapers/pdf/register-constructor';
 import { _PdfScraperMetadataRegistration } from '../scrapers/pdf/register-metadata';
 import { _WebsiteScraperRegistration } from '../scrapers/website/register-constructor';
 import { _WebsiteScraperMetadataRegistration } from '../scrapers/website/register-metadata';
-import { _LangchainTranspilerRegistration } from '../transpilers/langchain/register';
 import { _OpenAiSdkTranspilerRegistration } from '../transpilers/openai/register';
 export { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION };
 export { _CLI };
@@ -64,5 +63,4 @@ export { _PdfScraperRegistration };
 export { _PdfScraperMetadataRegistration };
 export { _WebsiteScraperRegistration };
 export { _WebsiteScraperMetadataRegistration };
-export { _LangchainTranspilerRegistration };
 export { _OpenAiSdkTranspilerRegistration };

package/esm/typings/src/_packages/core.index.d.ts

@@ -172,6 +172,7 @@ import { BlackholeStorage } from '../storage/blackhole/BlackholeStorage';
 import { MemoryStorage } from '../storage/memory/MemoryStorage';
 import { PrefixStorage } from '../storage/utils/PrefixStorage';
 import { $bookTranspilersRegister } from '../transpilers/_common/register/$bookTranspilersRegister';
+import { OpenAiSdkTranspiler } from '../transpilers/openai/OpenAiSdkTranspiler';
 import { MODEL_VARIANTS } from '../types/ModelVariant';
 import { NonTaskSectionTypes } from '../types/SectionType';
 import { SectionTypes } from '../types/SectionType';
@@ -352,6 +353,7 @@ export { BlackholeStorage };
 export { MemoryStorage };
 export { PrefixStorage };
 export { $bookTranspilersRegister };
+export { OpenAiSdkTranspiler };
 export { MODEL_VARIANTS };
 export { NonTaskSectionTypes };
 export { SectionTypes };

package/esm/typings/src/_packages/types.index.d.ts

@@ -168,9 +168,9 @@ import type { PromptbookStorage } from '../storage/_common/PromptbookStorage';
 import type { FileCacheStorageOptions } from '../storage/file-cache-storage/FileCacheStorageOptions';
 import type { IndexedDbStorageOptions } from '../storage/local-storage/utils/IndexedDbStorageOptions';
 import type { BookTranspiler } from '../transpilers/_common/BookTranspiler';
-import type { BookTranspilerDefinition } from '../transpilers/_common/BookTranspilerDefinition';
 import type { BookTranspilerOptions } from '../transpilers/_common/BookTranspilerOptions';
 import type { IntermediateFilesStrategy } from '../types/IntermediateFilesStrategy';
+import type { LlmCall } from '../types/LlmCall';
 import type { ModelRequirements } from '../types/ModelRequirements';
 import type { CompletionModelRequirements } from '../types/ModelRequirements';
 import type { ChatModelRequirements } from '../types/ModelRequirements';
@@ -506,9 +506,9 @@ export type { PromptbookStorage };
 export type { FileCacheStorageOptions };
 export type { IndexedDbStorageOptions };
 export type { BookTranspiler };
-export type { BookTranspilerDefinition };
 export type { BookTranspilerOptions };
 export type { IntermediateFilesStrategy };
+export type { LlmCall };
 export type { ModelRequirements };
 export type { CompletionModelRequirements };
 export type { ChatModelRequirements };

package/esm/typings/src/_packages/wizard.index.d.ts

@@ -29,7 +29,6 @@ import { _PdfScraperRegistration } from '../scrapers/pdf/register-constructor';
 import { _PdfScraperMetadataRegistration } from '../scrapers/pdf/register-metadata';
 import { _WebsiteScraperRegistration } from '../scrapers/website/register-constructor';
 import { _WebsiteScraperMetadataRegistration } from '../scrapers/website/register-metadata';
-import { _LangchainTranspilerRegistration } from '../transpilers/langchain/register';
 import { _OpenAiSdkTranspilerRegistration } from '../transpilers/openai/register';
 import { wizard } from '../wizard/wizard';
 export { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION };
@@ -63,6 +62,5 @@ export { _PdfScraperRegistration };
 export { _PdfScraperMetadataRegistration };
 export { _WebsiteScraperRegistration };
 export { _WebsiteScraperMetadataRegistration };
-export { _LangchainTranspilerRegistration };
 export { _OpenAiSdkTranspilerRegistration };
 export { wizard };

package/esm/typings/src/book-2.0/agent-source/padBook.d.ts

@@ -4,7 +4,7 @@ import { string_book } from './string_book';
  *
  * @public exported from `@promptbook/core`
  */
-export declare const PADDING_LINES = 4;
+export declare const PADDING_LINES = 11;
 /**
  * A function that adds padding to the book content
  *

package/esm/typings/src/execution/ExecutionTask.d.ts

@@ -1,8 +1,9 @@
 import type { Observable } from 'rxjs';
 import { PartialDeep } from 'type-fest';
-import type { number_percent } from '../types/typeAliases';
-import type { task_id } from '../types/typeAliases';
+import type { LlmCall } from '../types/LlmCall';
+import type { number_percent, task_id } from '../types/typeAliases';
 import type { string_SCREAMING_CASE } from '../utils/normalization/normalizeTo_SCREAMING_CASE';
+import type { really_any } from '../utils/organization/really_any';
 import type { string_promptbook_version } from '../version';
 import type { AbstractTaskResult } from './AbstractTaskResult';
 import type { PipelineExecutorResult } from './PipelineExecutorResult';
@@ -32,7 +33,7 @@ type CreateTaskOptions<TTaskResult extends AbstractTaskResult> = {
     }) => void, updateTldr: (tldrInfo: {
         readonly percent: number_percent;
         readonly message: string;
-    }) => void): Promise<TTaskResult>;
+    }) => void, logLlmCall: (llmCall: LlmCall) => void): Promise<TTaskResult>;
 };
 /**
  * Helper to create a new task
@@ -136,6 +137,14 @@ export type AbstractTask<TTaskResult extends AbstractTaskResult> = {
      * List of warnings that occurred during the task processing
      */
     readonly warnings: Array<Error>;
+    /**
+     * List of LLM calls that occurred during the task processing
+     */
+    readonly llmCalls: Array<LlmCall>;
+    /**
+     * Optional nonce to correlate logs with version of the Promptbook engine
+     */
+    readonly ptbkNonce?: really_any;
 };
 export type Task = ExecutionTask | PreparationTask;
 export {};

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

@@ -2,6 +2,7 @@ import type { PartialDeep, Promisable, ReadonlyDeep } from 'type-fest';
 import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
 import type { InputParameters } from '../../types/typeAliases';
 import type { PipelineExecutorResult } from '../PipelineExecutorResult';
+import type { LlmCall } from '../../types/LlmCall';
 import type { CreatePipelineExecutorOptions } from './00-CreatePipelineExecutorOptions';
 /**
  * Options for executing an entire pipeline, including input parameters, pipeline context, and progress callbacks.
@@ -17,6 +18,10 @@ type ExecutePipelineOptions = Required<CreatePipelineExecutorOptions> & {
      * Optional callback invoked with partial results as the pipeline execution progresses.
      */
     onProgress?(newOngoingResult: PartialDeep<PipelineExecutorResult>): Promisable<void>;
+    /**
+     * Optional callback invoked with each LLM call.
+     */
+    logLlmCall?(llmCall: LlmCall): Promisable<void>;
     /**
      * The pipeline definition to execute.
      */

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

@@ -2,6 +2,7 @@ import type { PartialDeep, Promisable, ReadonlyDeep, WritableDeep } from 'type-f
 import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
 import type { TaskJson } from '../../pipeline/PipelineJson/TaskJson';
 import type { Parameters } from '../../types/typeAliases';
+import type { LlmCall } from '../../types/LlmCall';
 import type { ExecutionReportJson } from '../execution-report/ExecutionReportJson';
 import type { PipelineExecutorResult } from '../PipelineExecutorResult';
 import type { CreatePipelineExecutorOptions } from './00-CreatePipelineExecutorOptions';
@@ -27,6 +28,10 @@ type executeSingleTaskOptions = Required<CreatePipelineExecutorOptions> & {
      * Callback invoked with partial results as the execution progresses.
      */
     onProgress(newOngoingResult: PartialDeep<PipelineExecutorResult>): Promisable<void>;
+    /**
+     * Optional callback invoked with each LLM call.
+     */
+    logLlmCall?(llmCall: LlmCall): Promisable<void>;
     /**
      * Mutable execution report object for tracking execution details.
      */

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

@@ -1,5 +1,6 @@
 import type { PartialDeep, Promisable } from 'type-fest';
 import type { TODO_any } from '../../utils/organization/TODO_any';
+import type { LlmCall } from '../../types/LlmCall';
 import type { PipelineExecutorResult } from '../PipelineExecutorResult';
 import type { ExecuteAttemptsOptions } from './40-executeAttempts';
 /**
@@ -13,6 +14,10 @@ type ExecuteFormatCellsOptions = ExecuteAttemptsOptions & {
      * Callback invoked with partial results as the execution progresses.
      */
     onProgress(newOngoingResult: PartialDeep<PipelineExecutorResult>): Promisable<void>;
+    /**
+     * Optional callback invoked with each LLM call.
+     */
+    logLlmCall?(llmCall: LlmCall): Promisable<void>;
 };
 /**
  * Executes a pipeline task that requires mapping or iterating over subvalues of a parameter (such as rows in a CSV).

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

@@ -3,6 +3,7 @@ import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
 import type { TaskJson } from '../../pipeline/PipelineJson/TaskJson';
 import type { Parameters, string_parameter_name } from '../../types/typeAliases';
 import type { TODO_string } from '../../utils/organization/TODO_string';
+import type { LlmCall } from '../../types/LlmCall';
 import type { ExecutionReportJson } from '../execution-report/ExecutionReportJson';
 import type { PipelineExecutorResult } from '../PipelineExecutorResult';
 import type { CreatePipelineExecutorOptions } from './00-CreatePipelineExecutorOptions';
@@ -50,6 +51,10 @@ export type ExecuteAttemptsOptions = Required<Omit<CreatePipelineExecutorOptions
      * Callback invoked with partial results as the execution progresses.
      */
     onProgress(newOngoingResult: PartialDeep<PipelineExecutorResult>): Promisable<void>;
+    /**
+     * Optional callback invoked with each LLM call.
+     */
+    logLlmCall?(llmCall: LlmCall): Promisable<void>;
     /**
      * The execution report object, which is updated during execution.
      */

package/esm/typings/src/execution/utils/logLlmCall.d.ts

@@ -0,0 +1,8 @@
+import type { LlmCall } from '../../types/LlmCall';
+import type { ExecutionPromptReportJson } from '../execution-report/ExecutionPromptReportJson';
+/**
+ * Logs an LLM call with the given report.
+ *
+ * @private internal utility of `createPipelineExecutor`
+ */
+export declare function logLlmCall(logLlmCall: (llmCall: LlmCall) => void, report: ExecutionPromptReportJson): void;

package/esm/typings/src/transpilers/_common/BookTranspiler.d.ts

@@ -1,19 +1,28 @@
-import type { BookTranspilerOptions } from './BookTranspilerOptions';
+import { BookTranspilerOptions, ExecutionTools, Registered, string_book, string_name, string_script, string_title } from '../../_packages/types.index';
 /**
- * Transpiler takes a book and transpiles it into another format.
- */
-export type BookTranspiler = 
-/**
- * Transpiles a book.
- *
- * @param book book to transpile
- * @param options additional options for the transpiler
- * @returns transpiled book
- */
-(book: string, options: BookTranspilerOptions) => Promise<string>;
-/**
- * TODO: [🧠] Should there be a BookTranspiler class or just a function?
- *       Maybe a class with a constructor that takes ExecutionTools.
- *       Then the instance would be a function.
- *       @see LlmExecutionTools
+ * Transpiler takes a book and transpiles it into another format (e.g., Langchain).
  */
+export type BookTranspiler = Registered & {
+    /**
+     * The name of the transpiler.
+     * It is used to identify the transpiler in the register.
+     *
+     * @example 'python-langchain'
+     */
+    readonly name: string_name;
+    /**
+     * The title of the transpiler.
+     * It is used to display the transpiler in the UI.
+     *
+     * @example 'Python Langchain'
+     */
+    readonly title: string_title;
+    /**
+     * Transpiles a book.
+     *
+     * @param book book to transpile
+     * @param options additional options for the transpiler
+     * @returns transpiled book
+     */
+    transpileBook(book: string_book, tools: ExecutionTools, options?: BookTranspilerOptions): Promise<string_script>;
+};

package/esm/typings/src/transpilers/_common/BookTranspilerOptions.d.ts

@@ -1,9 +1,8 @@
+import { CommonToolsOptions } from '../../execution/CommonToolsOptions';
 /**
  * Options for the BookTranspiler.
- *
- * @see https://github.com/webgptorg/promptbook/issues/249
  */
-export type BookTranspilerOptions = {
+export type BookTranspilerOptions = Omit<CommonToolsOptions, 'maxRequestsPerMinute'> & {
     /**
      * If true, the transpiler will log verbose information to the console.
      *

package/esm/typings/src/transpilers/_common/register/$bookTranspilersRegister.d.ts

@@ -1,5 +1,5 @@
 import { $Register } from '../../../utils/misc/$Register';
-import type { BookTranspilerDefinition } from '../BookTranspilerDefinition';
+import { BookTranspiler } from '../BookTranspiler';
 /**
  * Register for book transpilers.
  *
@@ -9,7 +9,7 @@ import type { BookTranspilerDefinition } from '../BookTranspilerDefinition';
  *
  * @public exported from `@promptbook/core`
  */
-export declare const $bookTranspilersRegister: $Register<BookTranspilerDefinition>;
+export declare const $bookTranspilersRegister: $Register<BookTranspiler>;
 /**
  * TODO: [®] DRY Register logic
  */

package/esm/typings/src/transpilers/openai/OpenAiSdkTranspiler.d.ts

@@ -1,13 +1,13 @@
-import type { BookTranspilerDefinition } from '../_common/BookTranspilerDefinition';
+import { BookTranspilerOptions, ExecutionTools, string_book, string_script } from '../../_packages/types.index';
 /**
  * Transpiler to Javascript code using OpenAI SDK.
  *
- * @private TODO: !!!! Which package should export this?
- */
-export declare const OpenAiSdkTranspiler: BookTranspilerDefinition;
-/**
- * TODO: [🧠] What should be the scope of the transpiled code?
- * - Just a single function?
- * - A class?
- * - A whole package?
+ * @public exported from `@promptbook/core`
  */
+export declare const OpenAiSdkTranspiler: {
+    readonly name: "openai-sdk";
+    readonly title: "OpenAI SDK";
+    readonly packageName: "@promptbook/core";
+    readonly className: "OpenAiSdkTranspiler";
+    readonly transpileBook: (book: string_book, tools: ExecutionTools, options?: BookTranspilerOptions) => Promise<string_script>;
+};

package/esm/typings/src/types/LlmCall.d.ts

@@ -0,0 +1,20 @@
+import type { ExecutionPromptReportJson } from '../execution/execution-report/ExecutionPromptReportJson';
+import type { string_model_name } from './typeAliases';
+/**
+ * Represents a single LLM call with its report.
+ *
+ * @see https://github.com/webgptorg/promptbook/issues/24
+ */
+export type LlmCall = {
+    /**
+     * The name of the model used for the call.
+     */
+    readonly modelName: string_model_name;
+    /**
+     * The report of the LLM execution.
+     */
+    readonly report: ExecutionPromptReportJson;
+};
+/**
+ * TODO: !!! Maybe different shape of LlmCall
+ */

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.103.0-31`).
+ * It follows semantic versioning (e.g., `0.103.0-33`).
  *
  * @generated
  */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/vercel",
-    "version": "0.103.0-32",
+    "version": "0.103.0-34",
     "description": "Promptbook: Turn your company's scattered knowledge into AI ready books",
     "private": false,
     "sideEffects": false,
@@ -94,7 +94,7 @@
     "module": "./esm/index.es.js",
     "typings": "./esm/typings/src/_packages/vercel.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.103.0-32"
+        "@promptbook/core": "0.103.0-34"
     },
     "dependencies": {
         "colors": "^1.4.0",

package/umd/index.umd.js

@@ -23,7 +23,7 @@
      * @generated
      * @see https://github.com/webgptorg/promptbook
      */
-    const PROMPTBOOK_ENGINE_VERSION = '0.103.0-32';
+    const PROMPTBOOK_ENGINE_VERSION = '0.103.0-34';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name

package/esm/typings/src/transpilers/_common/BookTranspilerDefinition.d.ts

@@ -1,37 +0,0 @@
-import type { ExecutionTools } from '../../execution/ExecutionTools';
-import type { string_name, string_title } from '../../types/typeAliases';
-import type { Registered } from '../../utils/misc/$Register';
-import type { BookTranspiler } from './BookTranspiler';
-/**
- * Definition of a book transpiler.
- *
- * @see https://github.com/webgptorg/promptbook/issues/249
- */
-export type BookTranspilerDefinition = Registered & {
-    /**
-     * The name of the transpiler.
-     * It is used to identify the transpiler in the register.
-     *
-     * @example 'python-langchain'
-     */
-    readonly name: string_name;
-    /**
-     * The title of the transpiler.
-     * It is used to display the transpiler in the UI.
-     *
-     * @example 'Python Langchain'
-     */
-    readonly title: string_title;
-    /**
-     * The factory function to create a transpiler instance.
-     * It can be async.
-     *
-     * @param tools the execution tools that can be used by the transpiler
-     * @returns the transpiler instance
-     */
-    readonly new: (tools: ExecutionTools) => BookTranspiler | Promise<BookTranspiler>;
-};
-/**
- * TODO: [🧠] What other information should be in the public profile of the transpiler?
- *      - input format, output format, version, description, icon, etc.
- */

package/esm/typings/src/transpilers/langchain/LangchainTranspiler.d.ts

@@ -1,7 +0,0 @@
-import type { BookTranspilerDefinition } from '../_common/BookTranspilerDefinition';
-/**
- * Transpiler to Python code using LangChain library.
- *
- * @private TODO: !!!! Which package should export this?
- */
-export declare const LangchainTranspiler: BookTranspilerDefinition;

package/esm/typings/src/transpilers/langchain/register.d.ts

@@ -1,15 +0,0 @@
-import { Registration } from '../../_packages/types.index';
-/**
- * Registration of LLM provider
- *
- * Warning: This is not useful for the end user, it is just a side effect of the mechanism that handles all available LLM tools
- *
- * @public exported from `@promptbook/wizard`
- * @public exported from `@promptbook/cli`
- *
- * TODO: !!!! Which package should export this? - `@promptbook/core` vs `@promptbook/transpilers` vs `@promptbook/langchain`
- */
-export declare const _LangchainTranspilerRegistration: Registration;
-/**
- * Note: [💞] Ignore a discrepancy between file name and entity name
- */