@promptbook/legacy-documents 0.105.0-3 → 0.105.0-30

package/esm/typings/src/constants.d.ts

@@ -71,6 +71,135 @@ export declare const RESERVED_PARAMETER_RESTRICTED: string;
  * @public exported from `@promptbook/core`
  */
 export declare const RESERVED_PARAMETER_NAMES: readonly ["content", "context", "knowledge", "examples", "modelName", "currentDate"];
+/**
+ * Limits for IDs, names, and other strings
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const LIMITS: {
+    /**
+     * Minimum length of a name (e.g. agent name, persona name)
+     */
+    readonly NAME_MIN_LENGTH: 3;
+    /**
+     * Recommended maximum length of a name
+     */
+    readonly NAME_MAX_LENGTH: 20;
+    /**
+     * Maximum length of a short description or a hash
+     */
+    readonly SHORT_TEXT_MAX_LENGTH: 30;
+    /**
+     * Gone
+     */
+    readonly GONE: 410;
+    /**
+     * Gateway timeout
+     */
+    readonly GATEWAY_TIMEOUT: 504;
+    /**
+     * Too many requests
+     */
+    readonly TOO_MANY_REQUESTS: 429;
+    /**
+     * Maximum length of a file path segment
+     */
+    readonly FILE_PATH_SEGMENT_MAX_LENGTH: 8;
+    /**
+     * Default length of a short name (e.g. for default agent names)
+     */
+    readonly SHORT_NAME_LENGTH: 6;
+};
+/**
+ * Common time intervals in milliseconds
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const TIME_INTERVALS: {
+    /**
+         * Hundred milliseconds
+         */
+    readonly HUNDRED_MILLISECONDS: 100;
+    /**
+     * One second in milliseconds
+     */
+    readonly SECOND: 1000;
+    /**
+     * Two seconds in milliseconds
+     */
+    readonly TWO_SECONDS: 2000;
+    /**
+     * One minute in milliseconds
+     */
+    readonly MINUTE: 60000;
+    /**
+     * Thirty seconds in milliseconds
+     */
+    readonly THIRTY_SECONDS: 30000;
+    /**
+     * Five seconds in milliseconds
+     */
+    readonly FIVE_SECONDS: 5000;
+};
+/**
+ * Common ports and network limits
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const NETWORK_LIMITS: {
+    /**
+     * Maximum valid port number
+     */
+    readonly MAX_PORT: 65535;
+};
+/**
+ * Common color and image constants
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const COLOR_CONSTANTS: {
+    /**
+     * Maximum value for a color channel (0-255)
+     */
+    readonly MAX_CHANNEL_VALUE: 255;
+    /**
+     * Number of possible colors in 24-bit color (0xFFFFFF)
+     */
+    readonly MAX_24BIT_COLOR: 16777215;
+    /**
+     * Base for hexadecimal strings
+     */
+    readonly HEX_BASE: 16;
+    /**
+     * Length of a hex color without alpha (e.g. "FF0000")
+     */
+    readonly HEX_COLOR_LENGTH: 6;
+    /**
+     * Full circle in degrees
+     */
+    readonly FULL_CIRCLE_DEGREES: 360;
+    /**
+     * Half circle in degrees
+     */
+    readonly HALF_CIRCLE_DEGREES: 180;
+};
+/**
+ * HTTP Status Codes
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const HTTP_STATUS_CODES: {
+    readonly OK: 200;
+    readonly CREATED: 201;
+    readonly BAD_REQUEST: 400;
+    readonly UNAUTHORIZED: 401;
+    readonly NOT_FOUND: 404;
+    readonly INTERNAL_SERVER_ERROR: 500;
+    readonly BAD_GATEWAY: 502;
+    readonly SERVICE_UNAVAILABLE: 503;
+    readonly GATEWAY_TIMEOUT: 504;
+    readonly TOO_MANY_REQUESTS: 429;
+};
 /**
  * Note: [💞] Ignore a discrepancy between file name and entity name
  */

package/esm/typings/src/executables/$provideExecutablesForNode.d.ts

@@ -9,4 +9,5 @@ export declare function $provideExecutablesForNode(options?: PrepareAndScrapeOpt
 /**
  * TODO: [🧠] Allow to override the executables without need to call `locatePandoc` / `locateLibreoffice` in case of provided
  * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
+ * TODO: [🏓] Unite `xxxForServer` and `xxxForNode` naming
  */

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

@@ -1,8 +1,5 @@
 import type { ModelVariant } from '../types/ModelVariant';
-import type { number_usd } from '../types/typeAliases';
-import type { string_model_description } from '../types/typeAliases';
-import type { string_model_name } from '../types/typeAliases';
-import type { string_title } from '../types/typeAliases';
+import type { number_usd, string_model_description, string_model_name, string_title, string_url } from '../types/typeAliases';
 /**
  * Represents a model that can be used for prompt execution
  */
@@ -40,6 +37,10 @@ export type AvailableModel = {
         readonly prompt: number_usd;
         readonly output: number_usd;
     };
+    /**
+     * URL to the model (or provider) documentation
+     */
+    readonly documentationUrl?: string_url;
     /**
      * If the model is deprecated, it should not be used for new tasks
      */

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

@@ -56,7 +56,9 @@ export type LlmExecutionTools = {
     /**
      * Calls a chat model with streaming
      */
-    callChatModelStream?(prompt: Prompt, onProgress: (chunk: ChatPromptResult) => void): Promise<ChatPromptResult>;
+    callChatModelStream?(prompt: Prompt, onProgress: (chunk: ChatPromptResult & {
+        isFinished?: boolean;
+    }) => void): Promise<ChatPromptResult>;
     /**
      * Calls a voice chat model
      */

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

@@ -1,5 +1,5 @@
+import type { ToolCall } from '../types/ToolCall';
 import type { string_date_iso8601, string_model_name, string_prompt } from '../types/typeAliases';
-import type { TODO_any } from '../utils/organization/TODO_any';
 import type { TODO_object } from '../utils/organization/TODO_object';
 import type { EmbeddingVector } from './EmbeddingVector';
 import type { Usage } from './Usage';
@@ -26,24 +26,7 @@ export type ChatPromptResult = CommonPromptResult & {
     /**
      * Optional tool calls made during the execution
      */
-    readonly toolCalls?: ReadonlyArray<{
-        /**
-         * Name of the tool
-         */
-        readonly name: string;
-        /**
-         * Arguments of the tool call
-         */
-        readonly arguments: string;
-        /**
-         * Result of the tool call
-         */
-        readonly result: string;
-        /**
-         * Raw tool call from the model
-         */
-        readonly rawToolCall: TODO_any;
-    }>;
+    readonly toolCalls?: ReadonlyArray<ToolCall>;
 };
 /**
  * Image prompt result

package/esm/typings/src/execution/utils/$provideExecutionToolsForNode.d.ts

@@ -10,4 +10,5 @@ import type { ExecutionTools } from '../ExecutionTools';
 export declare function $provideExecutionToolsForNode(options?: PrepareAndScrapeOptions): Promise<ExecutionTools>;
 /**
  * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
+ * TODO: [🏓] Unite `xxxForServer` and `xxxForNode` naming
  */

package/esm/typings/src/llm-providers/agent/Agent.d.ts

@@ -14,7 +14,8 @@ import type { AgentOptions } from './AgentOptions';
  * - `Agent` - which represents an AI Agent with its source, memories, actions, etc. Agent is a higher-level abstraction which is internally using:
  * - `LlmExecutionTools` - which wraps one or more LLM models and provides an interface to execute them
  * - `AgentLlmExecutionTools` - which is a specific implementation of `LlmExecutionTools` that wraps another LlmExecutionTools and applies agent-specific system prompts and requirements
- * - `OpenAiAssistantExecutionTools` - which is a specific implementation of `LlmExecutionTools` for OpenAI models with assistant capabilities, recommended for usage in `Agent` or `AgentLlmExecutionTools`
+ * - `OpenAiAgentExecutionTools` - which is a specific implementation of `LlmExecutionTools` for OpenAI models with agent capabilities (using Responses API), recommended for usage in `Agent` or `AgentLlmExecutionTools`
+ * - `OpenAiAssistantExecutionTools` - (Deprecated) which is a specific implementation of `LlmExecutionTools` for OpenAI models with assistant capabilities
  * - `RemoteAgent` - which is an `Agent` that connects to a Promptbook Agents Server
  *
  * @public exported from `@promptbook/core`
@@ -67,11 +68,16 @@ export declare class Agent extends AgentLlmExecutionTools implements LlmExecutio
         description?: string;
         [key: string]: string | undefined;
     };
+    /**
+     * Human-readable titles for tool functions
+     */
+    toolTitles: Record<string, string>;
     /**
      * Not used in Agent, always returns empty array
      */
     get parameters(): Array<BookParameter>;
     readonly agentSource: BehaviorSubject<string_book>;
+    private readonly teacherAgent;
     constructor(options: AgentOptions);
     /**
      * Calls the chat model with agent-specific system prompt and requirements with streaming

package/esm/typings/src/llm-providers/agent/AgentLlmExecutionTools.d.ts

@@ -16,7 +16,8 @@ import type { CreateAgentLlmExecutionToolsOptions } from './CreateAgentLlmExecut
  * - `Agent` - which represents an AI Agent with its source, memories, actions, etc. Agent is a higher-level abstraction which is internally using:
  * - `LlmExecutionTools` - which wraps one or more LLM models and provides an interface to execute them
  * - `AgentLlmExecutionTools` - which is a specific implementation of `LlmExecutionTools` that wraps another LlmExecutionTools and applies agent-specific system prompts and requirements
- * - `OpenAiAssistantExecutionTools` - which is a specific implementation of `LlmExecutionTools` for OpenAI models with assistant capabilities, recommended for usage in `Agent` or `AgentLlmExecutionTools`
+ * - `OpenAiAgentExecutionTools` - which is a specific implementation of `LlmExecutionTools` for OpenAI models with agent capabilities (using Responses API), recommended for usage in `Agent` or `AgentLlmExecutionTools`
+ * - `OpenAiAssistantExecutionTools` - (Deprecated) which is a specific implementation of `LlmExecutionTools` for OpenAI models with assistant capabilities
  * - `RemoteAgent` - which is an `Agent` that connects to a Promptbook Agents Server
  *
  * @public exported from `@promptbook/core`
@@ -27,6 +28,10 @@ export declare class AgentLlmExecutionTools implements LlmExecutionTools {
      * Cache of OpenAI assistants to avoid creating duplicates
      */
     private static assistantCache;
+    /**
+     * Cache of OpenAI vector stores to avoid creating duplicates
+     */
+    private static vectorStoreCache;
     /**
      * Cached model requirements to avoid re-parsing the agent source
      */

package/esm/typings/src/llm-providers/agent/AgentOptions.d.ts

@@ -2,6 +2,7 @@ import type { string_book } from '../../book-2.0/agent-source/string_book';
 import type { CommonToolsOptions } from '../../execution/CommonToolsOptions';
 import type { ExecutionTools } from '../../execution/ExecutionTools';
 import type { Updatable } from '../../types/Updatable';
+import { Agent } from './Agent';
 /**
  * Options for creating an Agent
  */
@@ -16,4 +17,10 @@ export type AgentOptions = CommonToolsOptions & {
      * The source of the agent
      */
     agentSource: Updatable<string_book>;
+    /**
+     * Teacher agent for self-learning
+     *
+     * Note: If provided, the agent can do full self-learning from the teacher agent during its operation.
+     */
+    teacherAgent: Agent | null;
 };

package/esm/typings/src/llm-providers/agent/RemoteAgent.d.ts

@@ -23,6 +23,7 @@ export declare class RemoteAgent extends Agent {
     private agentUrl;
     private _remoteAgentName;
     private _remoteAgentHash;
+    toolTitles: Record<string, string>;
     private _isVoiceCallingEnabled;
     private constructor();
     get agentName(): string_agent_name;

package/esm/typings/src/llm-providers/agent/RemoteAgentOptions.d.ts

@@ -3,7 +3,7 @@ import type { string_agent_url } from '../../types/typeAliases';
 /**
  * Options for creating a Remote Agent
  */
-export type RemoteAgentOptions = CommonToolsOptions & {
+export type RemoteAgentOptions = Omit<CommonToolsOptions, 'teacherAgent'> & {
     /**
      * Url of the remote agent
      */

package/esm/typings/src/llm-providers/google/createGoogleExecutionTools.d.ts

@@ -10,5 +10,6 @@ export declare const createGoogleExecutionTools: ((options: GoogleExecutionTools
     className: string;
 };
 /**
+ * TODO: !!!!! Rename to `createGoogleLlmExecutionTools`, `...GoogleLlmExecutionTools`
  * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
  */

package/esm/typings/src/llm-providers/openai/OpenAiAgentExecutionTools.d.ts

@@ -0,0 +1,43 @@
+import OpenAI from 'openai';
+import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
+import type { ChatPromptResult } from '../../execution/PromptResult';
+import type { Prompt } from '../../types/Prompt';
+import type { string_markdown, string_markdown_text, string_title } from '../../types/typeAliases';
+import type { OpenAiCompatibleExecutionToolsNonProxiedOptions } from './OpenAiCompatibleExecutionToolsOptions';
+import { OpenAiExecutionTools } from './OpenAiExecutionTools';
+/**
+ * Options for OpenAiAgentExecutionTools
+ */
+export type OpenAiAgentExecutionToolsOptions = OpenAiCompatibleExecutionToolsNonProxiedOptions & {
+    /**
+     * ID of the vector store to use for file search
+     */
+    readonly vectorStoreId?: string;
+};
+/**
+ * Execution Tools for calling OpenAI API using the Responses API (Agents)
+ *
+ * @public exported from `@promptbook/openai`
+ */
+export declare class OpenAiAgentExecutionTools extends OpenAiExecutionTools implements LlmExecutionTools {
+    readonly vectorStoreId?: string;
+    constructor(options: OpenAiAgentExecutionToolsOptions);
+    get title(): string_title & string_markdown_text;
+    get description(): string_markdown;
+    /**
+     * Calls OpenAI API to use a chat model with streaming.
+     */
+    callChatModelStream(prompt: Prompt, onProgress: (chunk: ChatPromptResult) => void): Promise<ChatPromptResult>;
+    /**
+     * Creates a vector store from knowledge sources
+     */
+    static createVectorStore(client: OpenAI, name: string, knowledgeSources: ReadonlyArray<string>): Promise<string>;
+    /**
+     * Discriminant for type guards
+     */
+    protected get discriminant(): string;
+    /**
+     * Type guard to check if given `LlmExecutionTools` are instanceof `OpenAiAgentExecutionTools`
+     */
+    static isOpenAiAgentExecutionTools(llmExecutionTools: LlmExecutionTools): llmExecutionTools is OpenAiAgentExecutionTools;
+}

package/esm/typings/src/llm-providers/openai/OpenAiAssistantExecutionTools.d.ts

@@ -18,6 +18,7 @@ import { OpenAiExecutionTools } from './OpenAiExecutionTools';
  * - `RemoteAgent` - which is an `Agent` that connects to a Promptbook Agents Server
  *
  * @public exported from `@promptbook/openai`
+ * @deprecated Use `OpenAiAgentExecutionTools` instead which uses the new OpenAI Responses API
  */
 export declare class OpenAiAssistantExecutionTools extends OpenAiExecutionTools implements LlmExecutionTools {
     readonly assistantId: string_token;
@@ -33,11 +34,11 @@ export declare class OpenAiAssistantExecutionTools extends OpenAiExecutionTools
     /**
      * Calls OpenAI API to use a chat model.
      */
-    callChatModel(prompt: Pick<Prompt, 'content' | 'parameters' | 'modelRequirements' | 'format'>): Promise<ChatPromptResult>;
+    callChatModel(prompt: Prompt): Promise<ChatPromptResult>;
     /**
      * Calls OpenAI API to use a chat model with streaming.
      */
-    callChatModelStream(prompt: Pick<Prompt, 'content' | 'parameters' | 'modelRequirements' | 'format'>, onProgress: (chunk: ChatPromptResult) => void): Promise<ChatPromptResult>;
+    callChatModelStream(prompt: Prompt, onProgress: (chunk: ChatPromptResult) => void): Promise<ChatPromptResult>;
     /**
      * Get an existing assistant tool wrapper
      */
@@ -94,6 +95,7 @@ export declare class OpenAiAssistantExecutionTools extends OpenAiExecutionTools
     static isOpenAiAssistantExecutionTools(llmExecutionTools: LlmExecutionTools): llmExecutionTools is OpenAiAssistantExecutionTools;
 }
 /**
+ * TODO: !!!!! [✨🥚] Knowledge should work both with and without scrapers
  * TODO: [🙎] In `OpenAiAssistantExecutionTools` Allow to create abstract assistants with `isCreatingNewAssistantsAllowed`
  * TODO: [🧠][🧙‍♂️] Maybe there can be some wizard for those who want to use just OpenAI
  * TODO: Maybe make custom OpenAiError

package/esm/typings/src/llm-providers/openai/OpenAiCompatibleExecutionTools.d.ts

@@ -39,10 +39,17 @@ export declare abstract class OpenAiCompatibleExecutionTools implements LlmExecu
      * List all available OpenAI compatible models that can be used
      */
     listModels(): Promise<ReadonlyArray<AvailableModel>>;
+    /**
+     * Calls OpenAI compatible API to use a chat model.
+     */
     /**
      * Calls OpenAI compatible API to use a chat model.
      */
     callChatModel(prompt: Prompt): Promise<ChatPromptResult>;
+    /**
+     * Calls OpenAI compatible API to use a chat model with streaming.
+     */
+    callChatModelStream(prompt: Prompt, onProgress: (chunk: ChatPromptResult) => void): Promise<ChatPromptResult>;
     /**
      * Internal method that handles parameter retry for chat model calls
      */
@@ -66,7 +73,7 @@ export declare abstract class OpenAiCompatibleExecutionTools implements LlmExecu
     /**
      * Calls OpenAI compatible API to use a image generation model
      */
-    callImageGenerationModel(prompt: Pick<Prompt, 'content' | 'parameters' | 'modelRequirements'>): Promise<ImagePromptResult>;
+    callImageGenerationModel(prompt: Prompt): Promise<ImagePromptResult>;
     /**
      * Internal method that handles parameter retry for image generation model calls
      */

package/esm/typings/src/llm-providers/openai/utils/uploadFilesToOpenAi.d.ts

@@ -0,0 +1,7 @@
+import OpenAI from 'openai';
+/**
+ * Uploads files to OpenAI and returns their IDs
+ *
+ * @private utility for `OpenAiAssistantExecutionTools` and `OpenAiCompatibleExecutionTools`
+ */
+export declare function uploadFilesToOpenAi(client: OpenAI, files: Array<File>): Promise<Array<string>>;

package/esm/typings/src/pipeline/prompt-notation.d.ts

@@ -1,4 +1,28 @@
 import type { string_prompt } from '../types/typeAliases';
+import type { really_unknown } from '../utils/organization/really_unknown';
+/**
+ * Prompt string wrapper to retain prompt context across interpolations.
+ *
+ * @public exported from `@promptbook/utils`
+ */
+export declare class PromptString extends String {
+    /**
+     * @param value Prompt content.
+     */
+    constructor(value: string_prompt);
+    /**
+     * Returns the prompt as a primitive string.
+     */
+    toString(): string_prompt;
+    /**
+     * Returns the prompt as a primitive string for implicit coercion.
+     */
+    valueOf(): string_prompt;
+    /**
+     * Ensures template literal coercion returns the raw string.
+     */
+    [Symbol.toPrimitive](): string_prompt;
+}
 /**
  * Tag function for notating a prompt as template literal
  *
@@ -9,10 +33,10 @@ import type { string_prompt } from '../types/typeAliases';
  *
  * @param strings
  * @param values
- * @returns the prompt string
+ * @returns prompt content wrapped as a PromptString
  * @public exported from `@promptbook/utils`
  */
-export declare function prompt(strings: TemplateStringsArray, ...values: Array<string>): string_prompt;
+export declare function prompt(strings: TemplateStringsArray, ...values: Array<really_unknown>): PromptString;
 /**
  * Tag function for notating a prompt as template literal
  *
@@ -26,6 +50,7 @@ export declare function prompt(strings: TemplateStringsArray, ...values: Array<s
  */
 export declare const promptTemplate: typeof prompt;
 /**
+ * TODO: Maybe split into multiple files
  * TODO: [🧠][🈴] Where is the best location for this file
  * Note: [💞] Ignore a discrepancy between file name and entity name
  */

package/esm/typings/src/pipeline/prompt-notation.test.d.ts

@@ -1,4 +1,4 @@
 export {};
 /**
- * TODO: [🧠][🈴] Where is the best location for this file
+ * TODO: [??][??] Where is the best location for this file
  */

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

@@ -9,4 +9,5 @@ import type { PrepareAndScrapeOptions } from '../../../prepare/PrepareAndScrapeO
 export declare function $provideFilesystemForNode(options?: Pick<PrepareAndScrapeOptions, 'isVerbose'>): FilesystemTools;
 /**
  * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
+ * TODO: [🏓] Unite `xxxForServer` and `xxxForNode` naming
  */

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

@@ -10,4 +10,5 @@ import type { Scraper } from '../Scraper';
 export declare function $provideScrapersForNode(tools: Pick<ExecutionTools, 'fs' | 'llm' | 'executables'>, options?: PrepareAndScrapeOptions): Promise<ReadonlyArray<Scraper>>;
 /**
  * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
+ * TODO: [🏓] Unite `xxxForServer` and `xxxForNode` naming
  */

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

@@ -8,4 +8,5 @@ import type { PrepareAndScrapeOptions } from '../../../prepare/PrepareAndScrapeO
 export declare function $provideScriptingForNode(options?: PrepareAndScrapeOptions): Promise<ReadonlyArray<ScriptExecutionTools>>;
 /**
  * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
+ * TODO: [🏓] Unite `xxxForServer` and `xxxForNode` naming
  */

package/esm/typings/src/search-engines/SearchEngine.d.ts

@@ -5,5 +5,5 @@ export type SearchEngine = {
     readonly title: string_title & string_markdown_text;
     readonly description?: string_markdown;
     checkConfiguration(): Promisable<void>;
-    search(query: string): Promise<SearchResult[]>;
+    search(query: string, options?: Record<string, unknown>): Promise<SearchResult[]>;
 };

package/esm/typings/src/search-engines/_index.d.ts

@@ -0,0 +1,6 @@
+export * from './bing/BingSearchEngine';
+export * from './dummy/DummySearchEngine';
+export * from './google/GoogleSearchEngine';
+export * from './SearchEngine';
+export * from './SearchResult';
+export * from './serp/SerpSearchEngine';

package/esm/typings/src/search-engines/bing/BingSearchEngine.d.ts

@@ -11,5 +11,5 @@ export declare class BingSearchEngine implements SearchEngine {
     get title(): string_title & string_markdown_text;
     get description(): string_markdown;
     checkConfiguration(): Promisable<void>;
-    search(query: string): Promise<SearchResult[]>;
+    search(query: string, options?: Record<string, unknown>): Promise<SearchResult[]>;
 }

package/esm/typings/src/search-engines/dummy/DummySearchEngine.d.ts

@@ -11,5 +11,5 @@ export declare class DummySearchEngine implements SearchEngine {
     get title(): string_title & string_markdown_text;
     get description(): string_markdown;
     checkConfiguration(): Promisable<void>;
-    search(query: string): Promise<SearchResult[]>;
+    search(query: string, options?: Record<string, unknown>): Promise<SearchResult[]>;
 }

package/esm/typings/src/search-engines/google/GoogleSearchEngine.d.ts

@@ -0,0 +1,18 @@
+import type { Promisable } from 'type-fest';
+import type { string_markdown, string_markdown_text, string_title } from '../../types/typeAliases';
+import type { SearchEngine } from '../SearchEngine';
+import type { SearchResult } from '../SearchResult';
+/**
+ * A search engine implementation that uses the Google Custom Search JSON API.
+ *
+ * @private <- TODO: !!!! Export via some package
+ */
+export declare class GoogleSearchEngine implements SearchEngine {
+    get title(): string_title & string_markdown_text;
+    get description(): string_markdown;
+    /**
+     * @see https://developers.google.com/custom-search/v1/overview
+     */
+    checkConfiguration(): Promisable<void>;
+    search(query: string, options?: Record<string, unknown>): Promise<SearchResult[]>;
+}

package/esm/typings/src/search-engines/serp/SerpSearchEngine.d.ts

@@ -0,0 +1,15 @@
+import type { Promisable } from 'type-fest';
+import type { string_markdown, string_markdown_text, string_title } from '../../types/typeAliases';
+import type { SearchEngine } from '../SearchEngine';
+import type { SearchResult } from '../SearchResult';
+/**
+ * A search engine implementation that uses the SerpApi to fetch Google search results.
+ *
+ * @private <- TODO: !!!! Export via some package
+ */
+export declare class SerpSearchEngine implements SearchEngine {
+    get title(): string_title & string_markdown_text;
+    get description(): string_markdown;
+    checkConfiguration(): Promisable<void>;
+    search(query: string, options?: Record<string, unknown>): Promise<SearchResult[]>;
+}

package/esm/typings/src/speech-recognition/BrowserSpeechRecognition.d.ts

@@ -0,0 +1,21 @@
+import type { SpeechRecognition, SpeechRecognitionEvent, SpeechRecognitionStartOptions, SpeechRecognitionState } from '../types/SpeechRecognition';
+/**
+ * Speech recognition using Web Speech API `SpeechRecognition` available in modern browsers
+ *
+ * @public exported from `@promptbook/browser`
+ */
+export declare class BrowserSpeechRecognition implements SpeechRecognition {
+    private recognition;
+    private callbacks;
+    private _state;
+    get state(): SpeechRecognitionState;
+    constructor();
+    $start(options?: SpeechRecognitionStartOptions): void;
+    $stop(): void;
+    subscribe(callback: (event: SpeechRecognitionEvent) => void): () => void;
+    private emit;
+}
+/**
+ * TODO: !!!! Search ACRY for `window` and put -> [🔵]
+ * Note: [🔵] Code in this file should never be published outside of `@promptbook/browser`
+ */

package/esm/typings/src/speech-recognition/OpenAiSpeechRecognition.d.ts

@@ -0,0 +1,35 @@
+import type { SpeechRecognition, SpeechRecognitionEvent, SpeechRecognitionStartOptions, SpeechRecognitionState } from '../types/SpeechRecognition';
+/**
+ * Options for OpenAiSpeechRecognition
+ */
+export type OpenAiSpeechRecognitionOptions = {
+    /**
+     * OpenAI API base URL or proxy endpoint
+     * @default '/api/openai/v1'
+     */
+    readonly baseUrl?: string;
+};
+/**
+ * Speech recognition using OpenAI Whisper API to transcribe audio into text
+ *
+ * @private because it requires server-client communication with a proxy endpoint
+ *
+ * Note: This implementation uses a server-side proxy to avoid exposing the OpenAI API key on the client.
+ */
+export declare class OpenAiSpeechRecognition implements SpeechRecognition {
+    private readonly options;
+    private mediaRecorder;
+    private audioContext;
+    private analyser;
+    private silenceTimeout;
+    private audioChunks;
+    private callbacks;
+    private _state;
+    get state(): SpeechRecognitionState;
+    constructor(options?: OpenAiSpeechRecognitionOptions);
+    $start(options?: SpeechRecognitionStartOptions): Promise<void>;
+    $stop(): void;
+    private transcribe;
+    subscribe(callback: (event: SpeechRecognitionEvent) => void): () => void;
+    private emit;
+}

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

@@ -129,6 +129,12 @@ export type CommonModelRequirements = {
      * Note: [🚉] This is fully serializable as JSON
      */
     readonly tools?: LlmToolDefinition[];
+    /**
+     * Optional list of knowledge source links that the model can use
+     *
+     * Note: [🚉] This is fully serializable as JSON
+     */
+    readonly knowledgeSources?: string[];
 };
 /**
  * TODO: [🧠][🈁] `seed` should maybe be somewhere else (not in `ModelRequirements`) (similar that `user` identification is not here)