@promptbook/openai 0.59.0-3 → 0.59.0-31

package/{esm/typings → umd/typings/src}/_packages/core.index.d.ts

@@ -1,7 +1,7 @@
 import { prettifyPromptbookString } from '../conversion/prettify/prettifyPromptbookString';
 import { promptbookJsonToString } from '../conversion/promptbookJsonToString';
 import { promptbookStringToJson } from '../conversion/promptbookStringToJson';
-import { validatePromptbookJson } from '../conversion/validation/validatePromptbookJson';
+import { validatePromptbook } from '../conversion/validation/validatePromptbook';
 import { ExpectError } from '../errors/_ExpectError';
 import { PromptbookExecutionError } from '../errors/PromptbookExecutionError';
 import { PromptbookLibraryError } from '../errors/PromptbookLibraryError';
@@ -13,18 +13,20 @@ import { TemplateError } from '../errors/TemplateError';
 import { UnexpectedError } from '../errors/UnexpectedError';
 import { assertsExecutionSuccessful } from '../execution/assertsExecutionSuccessful';
 import { createPromptbookExecutor } from '../execution/createPromptbookExecutor';
+import { embeddingVectorToString } from '../execution/embeddingVectorToString';
 import { addUsage } from '../execution/utils/addUsage';
 import { checkExpectations, isPassingExpectations } from '../execution/utils/checkExpectations';
 import { usageToWorktime } from '../execution/utils/usageToWorktime';
 import { CallbackInterfaceTools } from '../knowledge/dialogs/callback/CallbackInterfaceTools';
 import type { CallbackInterfaceToolsOptions } from '../knowledge/dialogs/callback/CallbackInterfaceToolsOptions';
 import { SimplePromptInterfaceTools } from '../knowledge/dialogs/simple-prompt/SimplePromptInterfaceTools';
+import { prepareKnowledgeFromMarkdown } from '../knowledge/prepare-knowledge/markdown/prepareKnowledgeFromMarkdown';
+import { createLibraryFromJson } from '../library/constructors/createLibraryFromJson';
+import { createLibraryFromPromise } from '../library/constructors/createLibraryFromPromise';
+import { createLibraryFromUrl } from '../library/constructors/createLibraryFromUrl';
+import { createSublibrary } from '../library/constructors/createSublibrary';
+import { libraryToJson } from '../library/libraryToJson';
 import { MultipleLlmExecutionTools } from '../llm-providers/multiple/MultipleLlmExecutionTools';
-import { createPromptbookLibraryFromPromise } from '../promptbook-library/constructors/createPromptbookLibraryFromPromise';
-import { createPromptbookLibraryFromSources } from '../promptbook-library/constructors/createPromptbookLibraryFromSources';
-import { createPromptbookLibraryFromUrl } from '../promptbook-library/constructors/createPromptbookLibraryFromUrl';
-import { createPromptbookSublibrary } from '../promptbook-library/constructors/createPromptbookSublibrary';
-import { SimplePromptbookLibrary } from '../promptbook-library/SimplePromptbookLibrary';
 import { executionReportJsonToString } from '../types/execution-report/executionReportJsonToString';
 import type { ExecutionReportStringOptions } from '../types/execution-report/ExecutionReportStringOptions';
 import { ExecutionReportStringOptionsDefaults } from '../types/execution-report/ExecutionReportStringOptions';
@@ -32,10 +34,10 @@ import { ExecutionTypes } from '../types/ExecutionTypes';
 import { PROMPTBOOK_VERSION } from '../version';
 export { PROMPTBOOK_VERSION };
 export { ExecutionTypes };
-export { addUsage, assertsExecutionSuccessful, checkExpectations, executionReportJsonToString, ExecutionReportStringOptions, ExecutionReportStringOptionsDefaults, isPassingExpectations, prettifyPromptbookString, usageToWorktime, };
-export { createPromptbookLibraryFromPromise, createPromptbookLibraryFromSources, createPromptbookLibraryFromUrl, createPromptbookSublibrary, SimplePromptbookLibrary, };
+export { addUsage, assertsExecutionSuccessful, checkExpectations, embeddingVectorToString, executionReportJsonToString, ExecutionReportStringOptions, ExecutionReportStringOptionsDefaults, isPassingExpectations, prepareKnowledgeFromMarkdown, prettifyPromptbookString, usageToWorktime, };
+export { createLibraryFromJson, createLibraryFromPromise, createLibraryFromUrl, createSublibrary, libraryToJson };
 export { SimplePromptInterfaceTools };
-export { promptbookJsonToString, promptbookStringToJson, validatePromptbookJson };
+export { promptbookJsonToString, promptbookStringToJson, validatePromptbook };
 export { createPromptbookExecutor, MultipleLlmExecutionTools };
 export { CallbackInterfaceTools, CallbackInterfaceToolsOptions };
 export { ExpectError, PromptbookExecutionError, PromptbookLibraryError, PromptbookLogicError, PromptbookNotFoundError, PromptbookReferenceError, PromptbookSyntaxError, TemplateError, UnexpectedError, };

package/umd/typings/src/_packages/node.index.d.ts

@@ -0,0 +1,4 @@
+import { createLibraryFromDirectory } from '../library/constructors/createLibraryFromDirectory';
+import { PROMPTBOOK_VERSION } from '../version';
+export { PROMPTBOOK_VERSION };
+export { createLibraryFromDirectory };

package/{esm/typings → umd/typings/src}/_packages/types.index.d.ts

@@ -1,11 +1,12 @@
 import type { CommonExecutionToolsOptions } from '../execution/CommonExecutionToolsOptions';
+import { EmbeddingVector } from '../execution/EmbeddingVector';
 import type { ExecutionTools } from '../execution/ExecutionTools';
 import type { AvailableModel, LlmExecutionTools } from '../execution/LlmExecutionTools';
-import type { PromptChatResult, PromptCommonResult, PromptCompletionResult, PromptResult, PromptResultUsage, PromptResultUsageCounts, UncertainNumber } from '../execution/PromptResult';
+import type { PromptEmbeddingResult, PromptChatResult, PromptCommonResult, PromptCompletionResult, PromptResult, PromptResultUsage, PromptResultUsageCounts, UncertainNumber } from '../execution/PromptResult';
 import type { PromptbookExecutor } from '../execution/PromptbookExecutor';
 import type { ScriptExecutionTools, ScriptExecutionToolsExecuteOptions } from '../execution/ScriptExecutionTools';
 import type { UserInterfaceTools, UserInterfaceToolsPromptDialogOptions } from '../execution/UserInterfaceTools';
-import type { PromptbookLibrary } from '../promptbook-library/PromptbookLibrary';
+import type { PromptbookLibrary } from '../library/PromptbookLibrary';
 import type { ExecutionType } from '../types/ExecutionTypes';
 import type { ModelRequirements, ModelVariant } from '../types/ModelRequirements';
 import type { Parameters } from '../types/Parameters';
@@ -26,7 +27,7 @@ import type { FromtoItems } from '../utils/FromtoItems';
 import { PROMPTBOOK_VERSION } from '../version';
 export { PROMPTBOOK_VERSION };
 export { EXPECTATION_UNITS };
-export type { AvailableModel, client_id, CommonExecutionToolsOptions, ExecutionReportJson, ExecutionTools, ExecutionType, ExpectationAmount, Expectations, ExpectationUnit, FromtoItems, KnowledgeJson, LlmExecutionTools, LlmTemplateJson, MaterialKnowledgePieceJson, ModelRequirements, ModelVariant, Parameters, Prompt, PromptbookExecutor, PromptbookJson, PromptbookLibrary, PromptbookString, PromptChatResult, PromptCommonResult, PromptCompletionResult, PromptDialogJson, PromptResult, PromptResultUsage, PromptResultUsageCounts, PromptTemplateJson, PromptTemplateParameterJson, ScriptExecutionTools, ScriptExecutionToolsExecuteOptions, ScriptJson, ScriptLanguage, SimpleTemplateJson, string_char, string_char_emoji, string_chat_prompt, string_completion_prompt, string_data_url, string_domain, string_email, string_file_absolute_path, string_file_extension, string_file_path, string_file_relative_path, string_filename, string_folder_absolute_path, string_folder_path, string_folder_relative_path, string_host, string_hostname, string_href, string_html, string_javascript, string_javascript_name, string_license, string_markdown, string_markdown_text, string_mime_type, string_mime_type_with_wildcard, string_model_name, string_name, string_person_fullname, string_prompt, string_promptbook_url, string_promptbook_url_with_hashtemplate, string_script, string_sha256, string_tdl, string_template, string_text_prompt, string_title, string_token, string_translate_language, string_uri, string_uri_part, string_url, string_url_image, string_version, TaskProgress, UncertainNumber, UserInterfaceTools, UserInterfaceToolsPromptDialogOptions, };
+export type { AvailableModel, client_id, CommonExecutionToolsOptions, ExecutionReportJson, ExecutionTools, ExecutionType, ExpectationAmount, Expectations, ExpectationUnit, FromtoItems, KnowledgeJson, LlmExecutionTools, LlmTemplateJson, MaterialKnowledgePieceJson, ModelRequirements, ModelVariant, Parameters, Prompt, PromptbookExecutor, PromptbookJson, PromptbookLibrary, PromptbookString, PromptChatResult, PromptEmbeddingResult, EmbeddingVector, PromptCommonResult, PromptCompletionResult, PromptDialogJson, PromptResult, PromptResultUsage, PromptResultUsageCounts, PromptTemplateJson, PromptTemplateParameterJson, ScriptExecutionTools, ScriptExecutionToolsExecuteOptions, ScriptJson, ScriptLanguage, SimpleTemplateJson, string_char, string_char_emoji, string_chat_prompt, string_completion_prompt, string_data_url, string_domain, string_email, string_file_absolute_path, string_file_extension, string_file_path, string_file_relative_path, string_filename, string_folder_absolute_path, string_folder_path, string_folder_relative_path, string_host, string_hostname, string_href, string_html, string_javascript, string_javascript_name, string_license, string_markdown, string_markdown_text, string_mime_type, string_mime_type_with_wildcard, string_model_name, string_name, string_person_fullname, string_prompt, string_promptbook_url, string_promptbook_url_with_hashtemplate, string_script, string_sha256, string_tdl, string_template, string_text_prompt, string_title, string_token, string_translate_language, string_uri, string_uri_part, string_url, string_url_image, string_version, TaskProgress, UncertainNumber, UserInterfaceTools, UserInterfaceToolsPromptDialogOptions, };
 /**
  * TODO: Delete type aliases (from ../types/typeAliases) that are not exported here
  */

package/umd/typings/src/cli/actions/hello.d.ts

@@ -0,0 +1,7 @@
+import type { Command } from 'commander';
+/**
+ * Initializes testing `hello` command for Promptbook CLI utilities
+ *
+ * @private part of `promptbookCli`
+ */
+export declare function initializeHello(program: Command): void;

package/umd/typings/src/cli/actions/make.d.ts

@@ -0,0 +1,7 @@
+import type { Command } from 'commander';
+/**
+ * Initializes `make` command for Promptbook CLI utilities
+ *
+ * @private part of `promptbookCli`
+ */
+export declare function initializeMake(program: Command): void;

package/umd/typings/src/cli/actions/prettify.d.ts

@@ -0,0 +1,7 @@
+import type { Command } from 'commander';
+/**
+ * Initializes `prettify` command for Promptbook CLI utilities
+ *
+ * @private part of `promptbookCli`
+ */
+export declare function initializePrettify(program: Command): void;

package/umd/typings/{conversion/prettify/prettifyPromptbookStringCli.d.ts → src/cli/promptbookCli.d.ts}

@@ -1,7 +1,7 @@
 /**
- * Runs CLI script for prettifying promptbooks
+ * Runs CLI utilities of Promptbook package
  */
-export declare function prettifyPromptbookStringCli(): Promise<void>;
+export declare function promptbookCli(): Promise<void>;
 /**
  * TODO: [🥠] Do not export to utils directly, its just for CLI script
  * TODO: [🕌] When more functionalities, rename

package/umd/typings/{config.d.ts → src/config.d.ts}

@@ -6,3 +6,7 @@ export declare const LOOP_LIMIT = 1000;
  * The maximum number of iterations for a loops which adds characters one by one
  */
 export declare const CHARACTER_LOOP_LIMIT = 100000;
+/**
+ * The name of the builded promptbook library made by CLI `promptbook make` and for lookup in `createLibraryFromDirectory`
+ */
+export declare const PROMPTBOOK_MAKED_BASE_FILENAME = "index";

package/{esm/typings/conversion/validation/validatePromptbookJson.d.ts → umd/typings/src/conversion/validation/validatePromptbook.d.ts}

@@ -13,7 +13,7 @@ import type { PromptbookJson } from '../../types/PromptbookJson/PromptbookJson';
  * @returns the same promptbook if it is logically valid
  * @throws {PromptbookLogicError} on logical error in the promptbook
  */
-export declare function validatePromptbookJson(promptbook: PromptbookJson): PromptbookJson;
+export declare function validatePromptbook(promptbook: PromptbookJson): PromptbookJson;
 /**
  * TODO: [🧠] Work with promptbookVersion
  * TODO: Use here some json-schema, Zod or something similar and change it to:
@@ -23,5 +23,5 @@ export declare function validatePromptbookJson(promptbook: PromptbookJson): Prom
  *     >  * It checks:
  *     >  * -   it has a valid structure
  *     >  * -   ...
- *     >  ex port function validatePromptbookJson(promptbook: unknown): asserts promptbook is PromptbookJson {
+ *     >  ex port function validatePromptbook(promptbook: unknown): asserts promptbook is PromptbookJson {
  */

package/umd/typings/src/execution/EmbeddingVector.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Represents a vector in an latent space of the embedding model
+ */
+export type EmbeddingVector = Array<number>;
+/**
+ * TODO: Figure out how to use library xyzt
+ *       Not using IVectorData due to HUGE dimensionality
+ */

package/umd/typings/{execution → src/execution}/PromptResult.d.ts

@@ -4,6 +4,7 @@ import type { number_positive } from '../types/typeAliases';
 import type { number_usd } from '../types/typeAliases';
 import type { string_date_iso8601 } from '../types/typeAliases';
 import type { string_model_name } from '../types/typeAliases';
+import type { EmbeddingVector } from './EmbeddingVector';
 /**
  * Prompt result is the simplest concept of execution.
  * It is the result of executing one prompt _(NOT a template)_.
@@ -20,6 +21,16 @@ export type PromptCompletionResult = PromptCommonResult;
  * Prompt chat result
  */
 export type PromptChatResult = PromptCommonResult & {};
+/**
+ * Prompt embedding result
+ * It contains only the following text NOT the whole completion
+ */
+export type PromptEmbeddingResult = Omit<PromptCommonResult, 'content'> & {
+    /**
+     * The response from the model
+     */
+    content: EmbeddingVector;
+};
 export type PromptCommonResult = {
     /**
      * Exact text response from the model

package/umd/typings/src/execution/embeddingVectorToString.d.ts

@@ -0,0 +1,5 @@
+import type { EmbeddingVector } from './EmbeddingVector';
+/**
+ * Pretty print an embedding vector for logging
+ */
+export declare function embeddingVectorToString(embeddingVector: EmbeddingVector): string;

package/umd/typings/src/knowledge/prepare-knowledge/markdown/prepareKnowledgeFromMarkdown.d.ts

@@ -0,0 +1,21 @@
+import type { LlmExecutionTools } from '../../../execution/LlmExecutionTools';
+import type { KnowledgeJson } from '../../../types/PromptbookJson/KnowledgeJson';
+import type { string_markdown } from '../../../types/typeAliases';
+type PrepareKnowledgeFromMarkdownOptions = {
+    /**
+     * The source of the knowledge in markdown format
+     */
+    content: string_markdown;
+    /**
+     * The LLM tools to use for the conversion and extraction of knowledge
+     */
+    llmTools: LlmExecutionTools;
+    /**
+     * If true, the preaparation of knowledge logs additional information
+     *
+     * @default false
+     */
+    isVerbose?: boolean;
+};
+export declare function prepareKnowledgeFromMarkdown(options: PrepareKnowledgeFromMarkdownOptions): Promise<KnowledgeJson>;
+export {};

package/{esm/typings → umd/typings/src}/knowledge/prepare-knowledge/pdf/prepareKnowledgeFromPdf.d.ts

@@ -6,6 +6,9 @@ type PrepareKnowledgeFromPdfOptions = {
      * The source of the knowledge in PDF format
      */
     content: string_base64;
+    /**
+     * The LLM tools to use for the conversion and extraction of knowledge
+     */
     llmTools: LlmExecutionTools;
 };
 export declare function prepareKnowledgeFromPdf(options: PrepareKnowledgeFromPdfOptions): Promise<KnowledgeJson>;

package/umd/typings/{promptbook-library → src/library}/SimplePromptbookLibrary.d.ts

@@ -6,6 +6,7 @@ import type { PromptbookLibrary } from './PromptbookLibrary';
  * Library of promptbooks that groups together promptbooks for an application.
  * This implementation is a very thin wrapper around the Array / Map of promptbooks.
  *
+ * @private use `createLibraryFromJson` instead
  * @see https://github.com/webgptorg/promptbook#promptbook-library
  */
 export declare class SimplePromptbookLibrary implements PromptbookLibrary {
@@ -15,8 +16,9 @@ export declare class SimplePromptbookLibrary implements PromptbookLibrary {
      *
      * @param promptbooks !!!
      *
+     * @private Use instead `createLibraryFromJson`
      * Note: During the construction logic of all promptbooks are validated
-     * Note: It is not recommended to use this constructor directly, use `createPromptbookLibraryFromSources` *(or other variant)* instead
+     * Note: It is not recommended to use this constructor directly, use `createLibraryFromJson` *(or other variant)* instead
      */
     constructor(...promptbooks: Array<PromptbookJson>);
     /**

package/umd/typings/{promptbook-library/constructors/createPromptbookLibraryFromDirectory.d.ts → src/library/constructors/createLibraryFromDirectory.d.ts}

@@ -1,7 +1,7 @@
 import type { string_folder_path } from '../../types/typeAliases';
 import type { PromptbookLibrary } from '../PromptbookLibrary';
 /**
- * Options for `createPromptbookLibraryFromDirectory` function
+ * Options for `createLibraryFromDirectory` function
  */
 type CreatePromptbookLibraryFromDirectoryOptions = {
     /**
@@ -39,7 +39,7 @@ type CreatePromptbookLibraryFromDirectoryOptions = {
  * @param options - Misc options for the library
  * @returns PromptbookLibrary
  */
-export declare function createPromptbookLibraryFromDirectory(path: string_folder_path, options?: CreatePromptbookLibraryFromDirectoryOptions): Promise<PromptbookLibrary>;
+export declare function createLibraryFromDirectory(path: string_folder_path, options?: CreatePromptbookLibraryFromDirectoryOptions): Promise<PromptbookLibrary>;
 export {};
 /**
  * TODO: !!!! [🧠] Library precompilation and do not mix markdown and json promptbooks

package/umd/typings/src/library/constructors/createLibraryFromJson.d.ts

@@ -0,0 +1,12 @@
+import type { PromptbookJson } from '../../types/PromptbookJson/PromptbookJson';
+import type { PromptbookLibrary } from '../PromptbookLibrary';
+/**
+ * Creates PromptbookLibrary from array of PromptbookJson or PromptbookString
+ *
+ * Note: Functions `libraryToJson` and `createLibraryFromJson` are complementary
+ * Note: During the construction syntax and logic of all sources are validated
+ *
+ * @param promptbookSources
+ * @returns PromptbookLibrary
+ */
+export declare function createLibraryFromJson(...promptbooks: Array<PromptbookJson>): PromptbookLibrary;

package/umd/typings/{promptbook-library/constructors/createPromptbookLibraryFromPromise.d.ts → src/library/constructors/createLibraryFromPromise.d.ts}

@@ -1,5 +1,4 @@
 import type { PromptbookJson } from '../../types/PromptbookJson/PromptbookJson';
-import type { PromptbookString } from '../../types/PromptbookString';
 import type { PromptbookLibrary } from '../PromptbookLibrary';
 /**
  * Constructs Promptbook from async sources
@@ -8,19 +7,16 @@ import type { PromptbookLibrary } from '../PromptbookLibrary';
  * - Factory function that returns Promise of array of PromptbookJson or PromptbookString
  *
  * Note: This is useful as internal tool for other constructor functions like
- *       `createPromptbookLibraryFromUrl` or `createPromptbookLibraryFromDirectory`
+ *       `createLibraryFromUrl` or `createLibraryFromDirectory`
  *       Consider using those functions instead of this one
  *
  * Note: The function does NOT return promise it returns the library directly which waits for the sources to be resolved
  *       when error occurs in given promise or factory function, it is thrown during `listPromptbooks` or `getPromptbookByUrl` call
  *
- * Note: Consider using  `createPromptbookLibraryFromDirectory` or `createPromptbookLibraryFromUrl`
+ * Note: Consider using  `createLibraryFromDirectory` or `createLibraryFromUrl`
  *
  * @param promptbookSourcesPromiseOrFactory
  * @returns PromptbookLibrary
  * @deprecated Do not use, it will became internal tool for other constructor functions
  */
-export declare function createPromptbookLibraryFromPromise(promptbookSourcesPromiseOrFactory: Promise<Array<PromptbookJson | PromptbookString>> | (() => Promise<Array<PromptbookJson | PromptbookString>>)): PromptbookLibrary;
-/**
- * TODO: !!!! [🧠] Library precompilation and do not mix markdown and json promptbooks
- */ 
+export declare function createLibraryFromPromise(promptbookSourcesPromiseOrFactory: Promise<Array<PromptbookJson>> | (() => Promise<Array<PromptbookJson>>)): PromptbookLibrary;

package/{esm/typings/promptbook-library/constructors/createPromptbookLibraryFromUrl.d.ts → umd/typings/src/library/constructors/createLibraryFromUrl.d.ts}

@@ -1,7 +1,7 @@
 import type { string_url } from '../../types/typeAliases';
 import type { PromptbookLibrary } from '../PromptbookLibrary';
 /**
- * Options for `createPromptbookLibraryFromDirectory` function
+ * Options for `createLibraryFromDirectory` function
  */
 type CreatePromptbookLibraryFromUrlyOptions = {
     /**
@@ -22,7 +22,7 @@ type CreatePromptbookLibraryFromUrlyOptions = {
 
  * @returns PromptbookLibrary
  */
-export declare function createPromptbookLibraryFromUrl(url: string_url | URL, options: CreatePromptbookLibraryFromUrlyOptions): Promise<PromptbookLibrary>;
+export declare function createLibraryFromUrl(url: string_url | URL, options: CreatePromptbookLibraryFromUrlyOptions): Promise<PromptbookLibrary>;
 export {};
 /**
  * TODO: !!!! [🧠] Library precompilation and do not mix markdown and json promptbooks

package/umd/typings/{promptbook-library/constructors/createPromptbookSublibrary.d.ts → src/library/constructors/createSublibrary.d.ts}

@@ -9,4 +9,4 @@ import type { PromptbookLibrary } from '../PromptbookLibrary';
  * @param promptbookSources
  * @returns PromptbookLibrary
  */
-export declare function createPromptbookSublibrary(library: PromptbookLibrary, predicate: (url: string_promptbook_url) => boolean): PromptbookLibrary;
+export declare function createSublibrary(library: PromptbookLibrary, predicate: (url: string_promptbook_url) => boolean): PromptbookLibrary;

package/umd/typings/src/library/libraryToJson.d.ts

@@ -0,0 +1,8 @@
+import type { PromptbookJson } from '../types/PromptbookJson/PromptbookJson';
+import type { PromptbookLibrary } from './PromptbookLibrary';
+/**
+ * Converts PromptbookLibrary to serialized JSON
+ *
+ * Note: Functions `libraryToJson` and `createLibraryFromJson` are complementary
+ */
+export declare function libraryToJson(library: PromptbookLibrary): Promise<Array<PromptbookJson>>;

package/umd/typings/{llm-providers → src/llm-providers}/anthropic-claude/anthropic-claude-models.d.ts

@@ -14,6 +14,7 @@ export declare const ANTHROPIC_CLAUDE_MODELS: Array<AvailableModel & {
     };
 }>;
 /**
+ * TODO: !!!! Add embedding models OR Anthropic has only chat+completion models?
  * TODO: [🧠] Some mechanism to propagate unsureness
  * TODO: [🧠][👮‍♀️] Put here more info like description, isVision, trainingDateCutoff, languages, strengths (	Top-level performance, intelligence, fluency, and understanding), contextWindow,...
  * TODO: [🕚] Make this list dynamic - dynamically can be listed modelNames but not modelVariant, legacy status, context length and pricing

package/{esm/typings → umd/typings/src}/llm-providers/mocked/MockedEchoLlmExecutionTools.d.ts

@@ -24,5 +24,6 @@ export declare class MockedEchoLlmExecutionTools implements LlmExecutionTools {
     listModels(): Array<AvailableModel>;
 }
 /**
+ * TODO: [🕵️‍♀️] Maybe just remove
  * TODO: Allow in spaceTrim: nesting with > ${block(prompt.request)}, same as replace params
  */

package/{esm/typings → umd/typings/src}/llm-providers/mocked/MockedFackedLlmExecutionTools.d.ts

@@ -23,3 +23,6 @@ export declare class MockedFackedLlmExecutionTools implements LlmExecutionTools
      */
     listModels(): Array<AvailableModel>;
 }
+/**
+ * TODO: [🕵️‍♀️] Maybe just remove
+ */ 

package/{esm/typings → umd/typings/src}/llm-providers/openai/OpenAiExecutionTools.d.ts

@@ -2,6 +2,7 @@ import type { AvailableModel } from '../../execution/LlmExecutionTools';
 import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
 import type { PromptChatResult } from '../../execution/PromptResult';
 import type { PromptCompletionResult } from '../../execution/PromptResult';
+import type { PromptEmbeddingResult } from '../../execution/PromptResult';
 import type { Prompt } from '../../types/Prompt';
 import type { OpenAiExecutionToolsOptions } from './OpenAiExecutionToolsOptions';
 /**
@@ -27,6 +28,10 @@ export declare class OpenAiExecutionTools implements LlmExecutionTools {
      * Calls OpenAI API to use a complete model.
      */
     gptComplete(prompt: Pick<Prompt, 'content' | 'modelRequirements'>): Promise<PromptCompletionResult>;
+    /**
+     * Calls OpenAI API to use a embedding model
+     */
+    embed(prompt: Pick<Prompt, 'content' | 'modelRequirements'>): Promise<PromptEmbeddingResult>;
     /**
      * Default model for chat variant.
      */
@@ -35,6 +40,10 @@ export declare class OpenAiExecutionTools implements LlmExecutionTools {
      * Default model for completion variant.
      */
     private getDefaultCompletionModel;
+    /**
+     * Default model for completion variant.
+     */
+    private getDefaultEmbeddingModel;
     /**
      * List all available OpenAI models that can be used
      */

package/{esm/typings → umd/typings/src}/llm-providers/openai/computeOpenaiUsage.d.ts

@@ -1,12 +1,14 @@
 import type OpenAI from 'openai';
-import type { PromptResult } from '../../execution/PromptResult';
 import type { PromptResultUsage } from '../../execution/PromptResult';
 import type { Prompt } from '../../types/Prompt';
 /**
  * Computes the usage of the OpenAI API based on the response from OpenAI
  *
+ * @param promptContent The content of the prompt
+ * @param resultContent The content of the result (for embedding prompts or failed prompts pass empty string)
+ * @param rawResponse The raw response from OpenAI API
  * @throws {PromptbookExecutionError} If the usage is not defined in the response from OpenAI
  * @private internal util of `OpenAiExecutionTools`
  */
 export declare function computeOpenaiUsage(promptContent: Prompt['content'], // <- Note: Intentionally using [] to access type properties to bring jsdoc from Prompt/PromptResult to consumer
-resultContent: PromptResult['content'], rawResponse: Pick<OpenAI.Chat.Completions.ChatCompletion | OpenAI.Completions.Completion, 'model' | 'usage'>): PromptResultUsage;
+resultContent: string, rawResponse: Pick<OpenAI.Chat.Completions.ChatCompletion | OpenAI.Completions.Completion | OpenAI.Embeddings.CreateEmbeddingResponse, 'model' | 'usage'>): PromptResultUsage;

package/{esm/typings → umd/typings/src}/llm-providers/openai/openai-models.d.ts

@@ -15,6 +15,7 @@ export declare const OPENAI_MODELS: Array<AvailableModel & {
     };
 }>;
 /**
+ * TODO: !!!! Add embedding models
  * TODO: [🧠] Some mechanism to propagate unsureness
  * TODO: [🕚][👮‍♀️] Make this list dynamic - dynamically can be listed modelNames but not modelVariant, legacy status, context length and pricing
  * TODO: [🧠][👮‍♀️] Put here more info like description, isVision, trainingDateCutoff, languages, strengths (	Top-level performance, intelligence, fluency, and understanding), contextWindow,...

package/{esm/typings → umd/typings/src}/llm-providers/remote/interfaces/RemoteServerOptions.d.ts

@@ -1,6 +1,6 @@
 import type { CommonExecutionToolsOptions } from '../../../execution/CommonExecutionToolsOptions';
 import type { LlmExecutionTools } from '../../../execution/LlmExecutionTools';
-import type { PromptbookLibrary } from '../../../promptbook-library/PromptbookLibrary';
+import type { PromptbookLibrary } from '../../../library/PromptbookLibrary';
 import type { client_id } from '../../../types/typeAliases';
 import type { string_uri } from '../../../types/typeAliases';
 export type RemoteServerOptions = CommonExecutionToolsOptions & {

package/umd/typings/{llm-providers → src/llm-providers}/remote/startRemoteServer.d.ts

@@ -10,7 +10,7 @@ import type { RemoteServerOptions } from './interfaces/RemoteServerOptions';
  */
 export declare function startRemoteServer(options: RemoteServerOptions): IDestroyable;
 /**
- * TODO: [⚖] Expose the library to be able to connect to same library via createPromptbookLibraryFromUrl
+ * TODO: [⚖] Expose the library to be able to connect to same library via createLibraryFromUrl
  * TODO: Handle progress - support streaming
  * TODO: [🤹‍♂️] Do not hang up immediately but wait until client closes OR timeout
  * TODO: [🤹‍♂️] Timeout on chat to free up resources

package/{esm/typings → umd/typings/src}/types/ModelRequirements.d.ts

@@ -1,5 +1,5 @@
 import type { string_model_name } from './typeAliases';
-export declare const MODEL_VARIANTS: readonly ["COMPLETION", "CHAT"];
+export declare const MODEL_VARIANTS: readonly ["COMPLETION", "CHAT", "EMBEDDING"];
 /**
  * Model variant describes the very general type of the model
  *

package/umd/typings/{types → src/types}/PromptbookJson/MaterialKnowledgePieceJson.d.ts

@@ -1,4 +1,4 @@
-import { IVectorData } from 'xyzt';
+import type { EmbeddingVector } from '../../execution/EmbeddingVector';
 import type { string_keyword } from '../../utils/normalization/IKeywords';
 import type { string_href } from '../typeAliases';
 import type { string_markdown } from '../typeAliases';
@@ -12,7 +12,7 @@ export type MaterialKnowledgePieceJson = {
     readonly keywords: Array<string_keyword>;
     readonly index: Array<{
         modelName: string_model_name;
-        position: IVectorData;
+        position: EmbeddingVector;
     }>;
     readonly sources: Array<{
         title: string_markdown_text;
@@ -20,6 +20,7 @@ export type MaterialKnowledgePieceJson = {
     }>;
 };
 /**
+ * TODO: !!! Use or uninstall xyzt
  * !!!! Annotate
  * TODO: [🧠][🦪] Maybe allow internal linkes between (Material)KnowledgePieces withing the KnowledgeJson and maybe require to explicitelly reference the source of the knowledge
  * TODO: [🧠] Make some non-material sources like external search engine or dialog to user

package/umd/typings/src/utils/unwrapResult.test.d.ts

@@ -0,0 +1 @@
+export {};

package/umd/typings/src/utils/validators/url/isValidUrl.test.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -1,10 +0,0 @@
-import { prettifyPromptbookStringCli } from '../conversion/prettify/prettifyPromptbookStringCli';
-import { PROMPTBOOK_VERSION } from '../version';
-export { PROMPTBOOK_VERSION };
-/**
- * Hidden utilities which should not be used by external consumers.
- */
-declare const __: {
-    prettifyPromptbookStringCli: typeof prettifyPromptbookStringCli;
-};
-export { __ };

package/esm/typings/_packages/node.index.d.ts

@@ -1,4 +0,0 @@
-import { createPromptbookLibraryFromDirectory } from '../promptbook-library/constructors/createPromptbookLibraryFromDirectory';
-import { PROMPTBOOK_VERSION } from '../version';
-export { PROMPTBOOK_VERSION };
-export { createPromptbookLibraryFromDirectory };

package/esm/typings/knowledge/prepare-knowledge/markdown/prepareKnowledgeFromMarkdown.d.ts

@@ -1,7 +0,0 @@
-import type { LlmExecutionTools } from '../../../execution/LlmExecutionTools';
-import type { KnowledgeJson } from '../../../types/PromptbookJson/KnowledgeJson';
-import type { string_markdown } from '../../../types/typeAliases';
-export declare function prepareKnowledgeFromMarkdown(options: {
-    content: string_markdown;
-    llmTools: LlmExecutionTools;
-}): Promise<KnowledgeJson>;

package/esm/typings/promptbook-library/constructors/createPromptbookLibraryFromSources.d.ts

@@ -1,16 +0,0 @@
-import type { PromptbookJson } from '../../types/PromptbookJson/PromptbookJson';
-import type { PromptbookString } from '../../types/PromptbookString';
-import { SimplePromptbookLibrary } from '../SimplePromptbookLibrary';
-/**
- * Creates PromptbookLibrary from array of PromptbookJson or PromptbookString
- *
- * Note: You can combine `PromptbookString` (`.ptbk.md`) with `PromptbookJson` BUT it is not recommended
- * Note: During the construction syntax and logic of all sources are validated
- *
- * @param promptbookSources
- * @returns PromptbookLibrary
- */
-export declare function createPromptbookLibraryFromSources(...promptbookSources: Array<PromptbookJson | PromptbookString>): Promise<SimplePromptbookLibrary>;
-/**
- * TODO: !!!! [🧠] Library precompilation and do not mix markdown and json promptbooks
- */ 

package/umd/typings/_packages/cli.index.d.ts

@@ -1,10 +0,0 @@
-import { prettifyPromptbookStringCli } from '../conversion/prettify/prettifyPromptbookStringCli';
-import { PROMPTBOOK_VERSION } from '../version';
-export { PROMPTBOOK_VERSION };
-/**
- * Hidden utilities which should not be used by external consumers.
- */
-declare const __: {
-    prettifyPromptbookStringCli: typeof prettifyPromptbookStringCli;
-};
-export { __ };

package/umd/typings/_packages/node.index.d.ts

@@ -1,4 +0,0 @@
-import { createPromptbookLibraryFromDirectory } from '../promptbook-library/constructors/createPromptbookLibraryFromDirectory';
-import { PROMPTBOOK_VERSION } from '../version';
-export { PROMPTBOOK_VERSION };
-export { createPromptbookLibraryFromDirectory };

package/umd/typings/knowledge/prepare-knowledge/markdown/prepareKnowledgeFromMarkdown.d.ts

@@ -1,7 +0,0 @@
-import type { LlmExecutionTools } from '../../../execution/LlmExecutionTools';
-import type { KnowledgeJson } from '../../../types/PromptbookJson/KnowledgeJson';
-import type { string_markdown } from '../../../types/typeAliases';
-export declare function prepareKnowledgeFromMarkdown(options: {
-    content: string_markdown;
-    llmTools: LlmExecutionTools;
-}): Promise<KnowledgeJson>;

package/umd/typings/promptbook-library/constructors/createPromptbookLibraryFromSources.d.ts

@@ -1,16 +0,0 @@
-import type { PromptbookJson } from '../../types/PromptbookJson/PromptbookJson';
-import type { PromptbookString } from '../../types/PromptbookString';
-import { SimplePromptbookLibrary } from '../SimplePromptbookLibrary';
-/**
- * Creates PromptbookLibrary from array of PromptbookJson or PromptbookString
- *
- * Note: You can combine `PromptbookString` (`.ptbk.md`) with `PromptbookJson` BUT it is not recommended
- * Note: During the construction syntax and logic of all sources are validated
- *
- * @param promptbookSources
- * @returns PromptbookLibrary
- */
-export declare function createPromptbookLibraryFromSources(...promptbookSources: Array<PromptbookJson | PromptbookString>): Promise<SimplePromptbookLibrary>;
-/**
- * TODO: !!!! [🧠] Library precompilation and do not mix markdown and json promptbooks
- */