@promptbook/browser 0.92.0-9 → 0.93.0

package/esm/typings/src/scrapers/_boilerplate/createBoilerplateScraper.d.ts

@@ -11,7 +11,7 @@ export declare const createBoilerplateScraper: ((tools: Pick<ExecutionTools, 'll
     packageName: string;
     className: string;
     mimeTypes: string[];
-    documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@@";
+    documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
     isAvilableInBrowser: false;
     requiredExecutables: never[];
 }>;

package/esm/typings/src/scrapers/_boilerplate/register-metadata.d.ts

@@ -9,7 +9,7 @@ export declare const boilerplateScraperMetadata: import("type-fest/source/readon
     packageName: string;
     className: string;
     mimeTypes: string[];
-    documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@@";
+    documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
     isAvilableInBrowser: false;
     requiredExecutables: never[];
 }>;

package/esm/typings/src/scrapers/_common/Converter.d.ts

@@ -2,7 +2,9 @@ import type { ScraperAndConverterMetadata } from './register/ScraperAndConverter
 import type { ScraperSourceHandler } from './Scraper';
 import type { ScraperIntermediateSource } from './ScraperIntermediateSource';
 /**
- * @@@
+ * Interface defining the requirements for converter implementations.
+ * Converters transform scraped content from one format to another,
+ * optimizing it for knowledge extraction and processing.
  *
  * Note: [🌏] Converters are not usable in browser because they produce a files
  */

package/esm/typings/src/scrapers/_common/Scraper.d.ts

@@ -6,7 +6,8 @@ import type { string_mime_type } from '../../types/typeAliases';
 import type { string_url } from '../../types/typeAliases';
 import type { ScraperAndConverterMetadata } from './register/ScraperAndConverterMetadata';
 /**
- * @@@
+ * Interface defining the requirements for scraper implementations.
+ * Scrapers are responsible for extracting structured content from various knowledge sources.
  */
 export type Scraper = {
     /**
@@ -19,7 +20,8 @@ export type Scraper = {
     scrape(source: ScraperSourceHandler): Promisable<ReadonlyArray<Omit<KnowledgePiecePreparedJson, 'sources' | 'preparationIds'>> | null>;
 };
 /**
- * @@@
+ * Handler for accessing and processing content from diverse knowledge sources.
+ * Provides standardized methods to interact with files, URLs and raw text sources.
  */
 export type ScraperSourceHandler = {
     /**
@@ -54,6 +56,5 @@ export type ScraperSourceHandler = {
 /**
  * TODO: [🧠] Maybe split `ScraperSourceHandler` into `ScraperWebsiteSourceHandler` + `ScraperFileSourceHandler`
  * TODO: [🥽] Add ` asBlob(): Promisable<Blob>;` or asFile
- * TODO: [🐝] @@@ Annotate all
  * TODO: [🔼] Export via types
  */

package/esm/typings/src/scrapers/_common/ScraperIntermediateSource.d.ts

@@ -1,11 +1,13 @@
 import type { IDestroyable } from 'destroyable';
 import type { string_absolute_filename } from '../../types/typeAliases';
 /**
- * @@@
+ * Interface representing an intermediate storage location for scraper results.
+ * Provides functionality for caching and managing temporary data during scraping operations.
  */
 export type ScraperIntermediateSource = IDestroyable & {
     /**
-     * @@@
+     * The absolute path to the file where intermediate data is stored.
+     * This file serves as a cache for scraped content to avoid redundant processing.
      */
     readonly filename: string_absolute_filename;
 };

package/esm/typings/src/scrapers/_common/prepareKnowledgePieces.d.ts

@@ -3,7 +3,7 @@ import type { KnowledgeSourceJson } from '../../pipeline/PipelineJson/KnowledgeS
 import type { PrepareAndScrapeOptions } from '../../prepare/PrepareAndScrapeOptions';
 import type { ExecutionTools } from '../../execution/ExecutionTools';
 /**
- * Prepares the knowle
+ * Prepares the knowledge pieces
  *
  * @see https://github.com/webgptorg/promptbook/discussions/41
  * @public exported from `@promptbook/core`
@@ -13,7 +13,7 @@ export declare function prepareKnowledgePieces(knowledgeSources: ReadonlyArray<K
  * TODO: [🧊] In future one preparation can take data from previous preparation and save tokens and time
  *       Put `knowledgePieces` into `PrepareKnowledgeOptions`
  * TODO: [🪂] More than max things can run in parallel by acident [1,[2a,2b,_],[3a,3b,_]]
- * TODO: [🧠][❎] Do here propper M:N mapping
+ * TODO: [🧠][❎] Do here proper M:N mapping
  *       [x] One source can make multiple pieces
  *       [ ] One piece can have multiple sources
  */

package/esm/typings/src/scrapers/_common/register/$provideFilesystemForNode.d.ts

@@ -1,7 +1,8 @@
 import type { FilesystemTools } from '../../../execution/FilesystemTools';
 import type { PrepareAndScrapeOptions } from '../../../prepare/PrepareAndScrapeOptions';
 /**
- * @@@
+ * Provides filesystem access (for example for Node.js-based scrapers)
+ * Creates a standardized filesystem interface that scrapers can use for file operations.
  *
  * @public exported from `@promptbook/node`
  */

package/esm/typings/src/scrapers/_common/register/$provideScrapersForBrowser.d.ts

@@ -2,10 +2,13 @@ import type { ExecutionTools } from '../../../execution/ExecutionTools';
 import type { PrepareAndScrapeOptions } from '../../../prepare/PrepareAndScrapeOptions';
 import type { Scraper } from '../Scraper';
 /**
- * @@@
+ * Provides a collection of scrapers optimized for browser environments.
+ * Only includes scrapers that can safely run in a browser context.
  *
- * 1) @@@
- * 2) @@@
+ * Note: Browser scrapers have limitations compared to Node.js scrapers.
+ *
+ * 1) `provideScrapersForNode` use as default
+ * 2) `provideScrapersForBrowser` use in limited browser environment
  *
  * @public exported from `@promptbook/browser`
  */

package/esm/typings/src/scrapers/_common/register/$provideScrapersForNode.d.ts

@@ -2,11 +2,9 @@ import type { ExecutionTools } from '../../../execution/ExecutionTools';
 import type { PrepareAndScrapeOptions } from '../../../prepare/PrepareAndScrapeOptions';
 import type { Scraper } from '../Scraper';
 /**
- * @@@
- *
- * 1) @@@
- * 2) @@@
- *
+ * Provides a collection of scrapers optimized for Node.js environment.
+ * 1) `provideScrapersForNode` use as default
+ * 2) `provideScrapersForBrowser` use in limited browser environment *
  * @public exported from `@promptbook/node`
  */
 export declare function $provideScrapersForNode(tools: Pick<ExecutionTools, 'fs' | 'llm' | 'executables'>, options?: PrepareAndScrapeOptions): Promise<ReadonlyArray<Scraper>>;

package/esm/typings/src/scrapers/_common/register/$scrapersMetadataRegister.d.ts

@@ -1,10 +1,10 @@
 import { $Register } from '../../../utils/$Register';
 import type { ScraperAndConverterMetadata } from './ScraperAndConverterMetadata';
 /**
- * @@@
+ * Global registry for storing metadata about all available scrapers and converters.
  *
- * Note: `$` is used to indicate that this interacts with the global scope
- * @singleton Only one instance of each register is created per build, but thare can be more @@@
+ * Note: `$` is used to indicate that this interacts with the global scope.
+ * @singleton Only one instance of each register is created per build, but there can be more in different contexts (e.g., tests).
  * @public exported from `@promptbook/core`
  */
 export declare const $scrapersMetadataRegister: $Register<ScraperAndConverterMetadata>;

package/esm/typings/src/scrapers/_common/register/$scrapersRegister.d.ts

@@ -1,10 +1,11 @@
 import { $Register } from '../../../utils/$Register';
 import type { ScraperConstructor } from './ScraperConstructor';
 /**
- * @@@
+ * Registry for all available scrapers in the system.
+ * Central point for registering and accessing different types of content scrapers.
  *
  * Note: `$` is used to indicate that this interacts with the global scope
- * @singleton Only one instance of each register is created per build, but thare can be more @@@
+ * @singleton Only one instance of each register is created per build, but there can be more than one in different build modules
  * @public exported from `@promptbook/core`
  */
 export declare const $scrapersRegister: $Register<ScraperConstructor>;

package/esm/typings/src/scrapers/_common/register/ScraperAndConverterMetadata.d.ts

@@ -4,9 +4,9 @@ import type { string_promptbook_documentation_url } from '../../../types/typeAli
 import type { string_title } from '../../../types/typeAliases';
 import type { Registered } from '../../../utils/$Register';
 /**
- * @@@
+ * Metadata interface for scrapers and converters in the system.
+ * Contains information about the capabilities and requirements of a scraper or converter.
  *
- * @@@
  * x) `Scraper`
  * x) `Converter`
  * x) `ScraperConstructor`
@@ -19,7 +19,8 @@ import type { Registered } from '../../../utils/$Register';
  */
 export type ScraperAndConverterMetadata = Registered & {
     /**
-     * @@@
+     * Human-readable title of the scraper or converter.
+     * Used for display purposes in logs and interfaces.
      */
     readonly title: string_title;
     /**
@@ -27,13 +28,15 @@ export type ScraperAndConverterMetadata = Registered & {
      */
     readonly mimeTypes: ReadonlyArray<string_mime_type>;
     /**
-     * @@@
+     * Flag indicating whether this scraper or converter can run in a browser environment.
+     * Some scrapers require Node.js capabilities and cannot run client-side.
      *
      * Note: [🌏] Only `MarkdownScraper` makes sense to be available in the browser, for scraping non-markdown sources in the browser use a remote server
      */
     readonly isAvilableInBrowser: boolean;
     /**
-     * @@@
+     * List of executables required by this scraper or converter to function properly.
+     * For example, PDF scrapers may require 'pandoc' to be installed on the system.
      */
     readonly requiredExecutables: ReadonlyArray<Capitalize<keyof Executables extends `${infer N}Path` ? N : never>>;
     /**

package/esm/typings/src/scrapers/_common/register/ScraperConstructor.d.ts

@@ -4,7 +4,8 @@ import type { Registered } from '../../../utils/$Register';
 import type { Scraper } from '../Scraper';
 import type { ScraperAndConverterMetadata } from './ScraperAndConverterMetadata';
 /**
- * @@@
+ * Type definition for a constructor function that creates a Scraper instance.
+ * Used for registering scrapers in the system to handle different content types.
  */
 export type ScraperConstructor = Registered & ScraperAndConverterMetadata & ((tools: Pick<ExecutionTools, 'llm'>, options: PrepareAndScrapeOptions) => Scraper);
 /**

package/esm/typings/src/scrapers/_common/utils/getScraperIntermediateSource.d.ts

@@ -3,13 +3,15 @@ import type { string_file_extension } from '../../../types/typeAliases';
 import type { ScraperSourceHandler } from '../Scraper';
 import type { ScraperIntermediateSource } from '../ScraperIntermediateSource';
 /**
- * @@@
+ * Type representing source information for generating intermediate storage.
+ * Contains essential file and URL information needed to create a deterministic storage path.
  *
  * @private internal utility of `getScraperIntermediateSource`
  */
 type GetScraperIntermediateSourceSource = Pick<ScraperSourceHandler, 'filename' | 'url'>;
 /**
- * @@@
+ * Options for intermediate source generation and management.
+ * Configures how intermediate files are named, stored, and cleaned up.
  *
  * @private internal utility of `getScraperIntermediateSource`
  */
@@ -17,9 +19,8 @@ type GetScraperIntermediateSourceHandler = Required<Pick<PrepareAndScrapeOptions
     readonly extension: string_file_extension;
 };
 /**
- * Create a filename for intermediate cache for scrapers
- *
- * Note: It also checks if directory exists and creates it if not
+ * Retrieves an intermediate source for a scraper based on the knowledge source.
+ * Manages the caching and retrieval of intermediate scraper results for optimized performance.
  *
  * @private as internal utility for scrapers
  */

package/esm/typings/src/scrapers/_common/utils/makeKnowledgeSourceHandler.d.ts

@@ -4,7 +4,9 @@ import type { KnowledgeSourceJson } from '../../../pipeline/PipelineJson/Knowled
 import type { PrepareAndScrapeOptions } from '../../../prepare/PrepareAndScrapeOptions';
 import type { ScraperSourceHandler } from '../Scraper';
 /**
- * @@@
+ * Factory function that creates a handler for processing knowledge sources.
+ * Provides standardized processing of different types of knowledge sources
+ * across various scraper implementations.
  *
  * @public exported from `@promptbook/core`
  */

package/esm/typings/src/scrapers/document/createDocumentScraper.d.ts

@@ -2,7 +2,7 @@ import type { ExecutionTools } from '../../execution/ExecutionTools';
 import type { PrepareAndScrapeOptions } from '../../prepare/PrepareAndScrapeOptions';
 import { DocumentScraper } from './DocumentScraper';
 /**
- * @@@
+ * Creates a scraper for document content.
  *
  * @public exported from `@promptbook/documents`
  */

package/esm/typings/src/scrapers/document-legacy/createLegacyDocumentScraper.d.ts

@@ -2,7 +2,8 @@ import type { ExecutionTools } from '../../execution/ExecutionTools';
 import type { PrepareAndScrapeOptions } from '../../prepare/PrepareAndScrapeOptions';
 import { LegacyDocumentScraper } from './LegacyDocumentScraper';
 /**
- * @@@
+ * Creates a scraper for legacy document formats (.doc, .rtf, etc).
+ * Uses LibreOffice for conversion to extract content from older document formats.
  *
  * @public exported from `@promptbook/legacy-documents`
  */

package/esm/typings/src/scrapers/markdown/createMarkdownScraper.d.ts

@@ -2,7 +2,7 @@ import type { ExecutionTools } from '../../execution/ExecutionTools';
 import type { PrepareAndScrapeOptions } from '../../prepare/PrepareAndScrapeOptions';
 import { MarkdownScraper } from './MarkdownScraper';
 /**
- * @@@
+ * Creates a scraper for markdown content.
  *
  * @public exported from `@promptbook/markdown-utils`
  */
@@ -13,6 +13,9 @@ export declare const createMarkdownScraper: ((tools: Pick<ExecutionTools, 'llm'>
     mimeTypes: string[];
     documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
     isAvilableInBrowser: true;
+    /**
+     * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
+     */
     requiredExecutables: never[];
 }>;
 /**

package/esm/typings/src/scrapers/markitdown/MarkitdownScraper.d.ts

@@ -37,7 +37,7 @@ export declare class MarkitdownScraper implements Converter, Scraper {
      */
     $convert(source: ScraperSourceHandler): Promise<ScraperIntermediateSource>;
     /**
-     * Scrapes the docx file and returns the knowledge pieces or `null` if it can't scrape it
+     * Scrapes the source document (PDF, DOCX, etc.) and returns the knowledge pieces or `null` if it can't scrape it.
      */
     scrape(source: ScraperSourceHandler): Promise<ReadonlyArray<Omit<KnowledgePiecePreparedJson, 'sources' | 'preparationIds'>> | null>;
 }

package/esm/typings/src/scrapers/pdf/createPdfScraper.d.ts

@@ -2,7 +2,8 @@ import type { ExecutionTools } from '../../execution/ExecutionTools';
 import type { PrepareAndScrapeOptions } from '../../prepare/PrepareAndScrapeOptions';
 import { PdfScraper } from './PdfScraper';
 /**
- * @@@
+ * Factory function to create an instance of PdfScraper.
+ * It bundles the scraper class with its metadata.
  *
  * @public exported from `@promptbook/pdf`
  */

package/esm/typings/src/scrapers/website/createWebsiteScraper.d.ts

@@ -2,7 +2,8 @@ import type { ExecutionTools } from '../../execution/ExecutionTools';
 import type { PrepareAndScrapeOptions } from '../../prepare/PrepareAndScrapeOptions';
 import { WebsiteScraper } from './WebsiteScraper';
 /**
- * @@@
+ * Factory function to create an instance of WebsiteScraper.
+ * It bundles the scraper class with its metadata.
  *
  * @public exported from `@promptbook/website-crawler`
  */
@@ -12,9 +13,7 @@ export declare const createWebsiteScraper: ((tools: Pick<ExecutionTools, 'llm'>,
     className: string;
     mimeTypes: string[];
     documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
-    isAvilableInBrowser: false; /**
-     * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
-     */
+    isAvilableInBrowser: false;
     requiredExecutables: never[];
 }>;
 /**

package/esm/typings/src/scripting/javascript/JavascriptExecutionTools.d.ts

@@ -1,6 +1,6 @@
 import { JavascriptEvalExecutionTools } from './JavascriptEvalExecutionTools';
 /**
- * Placeholder for better implementation of JavascriptExecutionTools - some propper sandboxing
+ * Placeholder for better implementation of JavascriptExecutionTools - some proper sandboxing
  *
  * @alias JavascriptExecutionTools
  * @public exported from `@promptbook/javascript`

package/esm/typings/src/scripting/javascript/postprocessing-functions.d.ts

@@ -18,7 +18,11 @@ import { trimCodeBlock } from '../../utils/trimCodeBlock';
 import { trimEndOfCodeBlock } from '../../utils/trimEndOfCodeBlock';
 import { unwrapResult } from '../../utils/unwrapResult';
 /**
- * @@@
+ * Collection of utility functions that can be used for post-processing model outputs.
+ * These functions help transform, extract, or format the raw model responses.
+ *
+ * These utilities range from simple string manipulations to markdown processing
+ * and formatting functions for specific types of output.
  *
  * @public exported from `@promptbook/javascript`
  */

package/esm/typings/src/scripting/javascript/utils/preserve.d.ts

@@ -9,6 +9,6 @@ import type { really_any } from '../../../utils/organization/really_any';
  */
 export declare function preserve(func: (...params: ReadonlyArray<really_any>) => unknown): void;
 /**
- * TODO: Probbably remove in favour of `keepImported`
+ * TODO: Probably remove in favour of `keepImported`
  * TODO: [1] This maybe does memory leak
  */

package/esm/typings/src/storage/_common/PromptbookStorage.d.ts

@@ -3,7 +3,7 @@ import type { Promisable } from 'type-fest';
  * Storage of objects with asynchronous API
  *
  * Note: Naming `PromptbookStorage` not `Storage` to avoid name collision with global `Storage` interface.
- * Note: This is simmilar to Web Storage API interface but everything is asynchronous and can store JSON objects.
+ * Note: This is similar to Web Storage API interface but everything is asynchronous and can store JSON objects.
  */
 export type PromptbookStorage<TItem> = {
     /**

package/esm/typings/src/storage/file-cache-storage/FileCacheStorage.d.ts

@@ -2,7 +2,10 @@ import type { ExecutionTools } from '../../execution/ExecutionTools';
 import type { PromptbookStorage } from '../_common/PromptbookStorage';
 import type { FileCacheStorageOptions } from './FileCacheStorageOptions';
 /**
- * @@@
+ * A storage implementation that caches data in files organized in a directory structure.
+ * Provides methods for retrieving, storing, and managing cached data on the filesystem.
+ *
+ * This class implements the PromptbookStorage interface for filesystem-based caching.
  *
  * @public exported from `@promptbook/node`
  */
@@ -11,19 +14,23 @@ export declare class FileCacheStorage<TItem> implements PromptbookStorage<TItem>
     private readonly options;
     constructor(tools: Required<Pick<ExecutionTools, 'fs'>>, options: FileCacheStorageOptions);
     /**
-     * @@@
+     * Converts a storage key to a filesystem path where the data should be stored.
+     * Creates a consistent, deterministic file path based on the key string.
      */
     private getFilenameForKey;
     /**
-     * @@@ Returns the current value associated with the given key, or null if the given key does not exist in the list associated with the object.
+     * Returns the current value associated with the given key, or null if the given key does not exist.
+     * Retrieves the cached data from the file system storage.
      */
     getItem(key: string): Promise<TItem | null>;
     /**
-     * @@@ Sets the value of the pair identified by key to value, creating a new key/value pair if none existed for key previously.
+     * Sets the value of the pair identified by key to value, creating a new key/value pair if none existed for key previously.
+     * Persists data to the file system, creating necessary directory structure if it doesn't exist.
      */
     setItem(key: string, value: TItem): Promise<void>;
     /**
-     * @@@ Removes the key/value pair with the given key from the list associated with the object, if a key/value pair with the given key exists.
+     * Removes the key/value pair with the given key from the storage, if a key/value pair with the given key exists.
+     * Deletes the corresponding file from the filesystem.
      */
     removeItem(key: string): Promise<void>;
 }

package/esm/typings/src/storage/file-cache-storage/FileCacheStorageOptions.d.ts

@@ -1,10 +1,12 @@
 import type { string_dirname } from '../../types/typeAliases';
 /**
- * @@@
+ * Configuration options for the FileCacheStorage implementation.
+ * Defines how and where file cache data should be stored and managed.
  */
 export type FileCacheStorageOptions = {
     /**
-     * @@@
+     * The absolute path to the root directory where cache files will be stored.
+     * This directory must exist and be writable by the application.
      */
     rootFolderPath: string_dirname;
 };

package/esm/typings/src/storage/file-cache-storage/utils/nameToSubfolderPath.d.ts

@@ -1,6 +1,7 @@
 import type { string_name } from '../../../types/typeAliases';
 /**
- * @@@
+ * Converts a name to a properly formatted subfolder path for cache storage.
+ * Handles normalization and path formatting to create consistent cache directory structures.
  *
  * @private for `FileCacheStorage`
  */

package/esm/typings/src/storage/local-storage/getIndexedDbStorage.d.ts

@@ -0,0 +1,11 @@
+import type { PromptbookStorage } from '../_common/PromptbookStorage';
+import type { IndexedDbStorageOptions } from './utils/IndexedDbStorageOptions';
+/**
+ * Gets wrapper around IndexedDB which can be used as PromptbookStorage
+ *
+ * @public exported from `@promptbook/browser`
+ */
+export declare function getIndexedDbStorage<TItem>(options: IndexedDbStorageOptions): PromptbookStorage<TItem>;
+/**
+ * Note: [🔵] Code in this file should never be published outside of `@promptbook/browser`
+ */

package/esm/typings/src/storage/local-storage/utils/IndexedDbStorageOptions.d.ts

@@ -0,0 +1,14 @@
+import type { string_name } from '../../../types/typeAliases';
+/**
+ * Options for IndexedDB storage
+ */
+export type IndexedDbStorageOptions = {
+    /**
+     * Name of the database
+     */
+    databaseName: string_name;
+    /**
+     * Name of the object store (table) in the database
+     */
+    storeName: string_name;
+};

package/esm/typings/src/storage/local-storage/utils/makePromptbookStorageFromIndexedDb.d.ts

@@ -0,0 +1,8 @@
+import type { PromptbookStorage } from '../../_common/PromptbookStorage';
+import type { IndexedDbStorageOptions } from './IndexedDbStorageOptions';
+/**
+ * Creates a PromptbookStorage backed by IndexedDB.
+ * Uses a single object store named 'promptbook'.
+ * @private for `getIndexedDbStorage`
+ */
+export declare function makePromptbookStorageFromIndexedDb<TValue>(options: IndexedDbStorageOptions): PromptbookStorage<TValue>;

package/esm/typings/src/storage/local-storage/utils/makePromptbookStorageFromWebStorage.d.ts

@@ -1,6 +1,7 @@
 import type { PromptbookStorage } from '../../_common/PromptbookStorage';
 /**
- * @@@
+ * Creates a Promptbook storage interface from a web storage object.
+ * Facilitates using Web Storage (localStorage/sessionStorage) as a storage backend.
  *
  * @private for `getLocalStorage` and `getSessionStorage`
  */

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

@@ -1,5 +1,6 @@
 /**
- * @@@
+ * Defines strategies for handling intermediate files during pipeline execution.
+ * Controls how temporary or intermediate files are managed throughout processing.
  */
 export type IntermediateFilesStrategy = 'HIDE_AND_CLEAN' | 'HIDE_AND_KEEP';
 /**

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

@@ -93,9 +93,9 @@ export type CommonModelRequirements = {
     readonly maxTokens?: number;
 };
 /**
- * TODO: [🧠][🈁] `seed` should maybe be somewhere else (not in `ModelRequirements`) (simmilar that `user` identification is not here)
+ * TODO: [🧠][🈁] `seed` should maybe be somewhere else (not in `ModelRequirements`) (similar that `user` identification is not here)
  * TODO: [🧠][💱] Add more model options: `stop_token`, `logit_bias`, `logprobs` (`top_logprobs`), `top_k`, `top_p`, `presence_penalty`, `frequency_penalty`, `bestOf`, `logitBias`, `logitBiasType`,...
- *       [💱] Probbably keep using just `temperature` in Promptbook (not `top_k` and `top_p`)
+ *       [💱] Probably keep using just `temperature` in Promptbook (not `top_k` and `top_p`)
  * TODO: [🛠] Actions, instruments (and maybe knowledge) => Functions and tools
  * TODO: Maybe figure out better word than "variant"
  * TODO: Add here more requirement options like max context size, max tokens, etc.

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

@@ -2,14 +2,14 @@ import type { TupleToUnion } from 'type-fest';
 /**
  * Model variant describes the very general type of the model
  *
- * There are two variants:
- * - **COMPLETION** - model that takes prompt and writes the rest of the text
- * - **CHAT** - model that takes prompt and previous messages and returns response
+ * There are these supported model variants:
+ * - `COMPLETION` - Model that takes prompt and writes the rest of the text
+ * - `CHAT` - Model that takes prompt and previous messages and returns response
+ * - `EMBEDDING` - Model that convert text into vector representations
  */
 export type ModelVariant = TupleToUnion<typeof MODEL_VARIANTS>;
 /**
- * @@@
- *
+ * @see {@link ModelVariant}
  * @public exported from `@promptbook/core`
  */
 export declare const MODEL_VARIANTS: readonly ["COMPLETION", "CHAT", "EMBEDDING"];