@promptbook/javascript 0.111.0-4 → 0.111.0-7

package/umd/src/types/ModelRequirements.d.ts

@@ -0,0 +1,158 @@
+import type { LlmToolDefinition } from './LlmToolDefinition';
+import type { ModelVariant } from './ModelVariant';
+import type { number_model_temperature, number_seed, string_model_name, string_system_message } from './typeAliases';
+import type OpenAI from 'openai';
+/**
+ * Abstract way to specify the LLM.
+ * It does not specify the LLM with concrete version itself, only the requirements for the LLM.
+ *
+ * Note: [🚉] This is fully serializable as JSON
+ * @see https://github.com/webgptorg/promptbook#model-requirements
+ */
+export type ModelRequirements = CompletionModelRequirements | ChatModelRequirements | ImageGenerationModelRequirements | EmbeddingModelRequirements;
+/**
+ * Model requirements for the completion variant
+ *
+ * Note: [🚉] This is fully serializable as JSON
+ */
+export type CompletionModelRequirements = CommonModelRequirements & {
+    /**
+     * Completion model variant
+     */
+    readonly modelVariant: 'COMPLETION';
+    /**
+     * The temperature of the model
+     *
+     * Note: [💱] Promptbook is using just `temperature` (not `top_k` and `top_p`)
+     */
+    readonly temperature?: number_model_temperature;
+    /**
+     * Maximum number of tokens that can be generated by the model
+     */
+    readonly maxTokens?: number;
+};
+/**
+ * Model requirements for the chat variant
+ *
+ * Note: [🚉] This is fully serializable as JSON
+ */
+export type ChatModelRequirements = CommonModelRequirements & {
+    /**
+     * Chat model variant
+     */
+    readonly modelVariant: 'CHAT';
+    /**
+     * System message to be used in the model
+     */
+    readonly systemMessage?: string_system_message;
+    /**
+     * The temperature of the model
+     *
+     * Note: [💱] Promptbook is using just `temperature` (not `top_k` and `top_p`)
+     */
+    readonly temperature?: number_model_temperature;
+    /**
+     * Maximum number of tokens that can be generated by the model
+     */
+    readonly maxTokens?: number;
+    /**
+     * Optional OpenAI `response_format` override that should be forwarded to compatible APIs.
+     */
+    readonly responseFormat?: OpenAI.Chat.Completions.ChatCompletionCreateParamsNonStreaming['response_format'];
+    /**
+     * Optional OpenAI `tool_choice` override that should be forwarded to compatible APIs.
+     */
+    readonly toolChoice?: OpenAI.Chat.Completions.ChatCompletionToolChoiceOption;
+};
+/**
+ * Model requirements for the image generation variant
+ *
+ * Note: [🚉] This is fully serializable as JSON
+ */
+export type ImageGenerationModelRequirements = CommonModelRequirements & {
+    /**
+     * Image generation model variant
+     */
+    readonly modelVariant: 'IMAGE_GENERATION';
+    /**
+     * Size of the generated image
+     *
+     * e.g. '1536x1536'
+     */
+    readonly size?: '1024x1024' | '1792x1024' | '1024x1792' | `${number}x${number}`;
+    /**
+     * Quality of the generated image
+     */
+    readonly quality?: 'standard' | 'hd';
+    /**
+     * Style of the generated image
+     */
+    readonly style?: 'vivid' | 'natural';
+};
+/**
+ * Model requirements for the embedding variant
+ *
+ * Note: [🚉] This is fully serializable as JSON
+ */
+export type EmbeddingModelRequirements = CommonModelRequirements & {
+    /**
+     * Embedding model variant
+     */
+    readonly modelVariant: 'EMBEDDING';
+};
+/**
+ * Common properties for all model requirements variants
+ *
+ * Note: [🚉] This is fully serializable as JSON
+ *
+ * @private just abstract the common properties of the model requirements
+ */
+export type CommonModelRequirements = {
+    /**
+     * Model variant describes the very general type of the model
+     *
+     * There are 3 variants:
+     * - **COMPLETION** - model that takes prompt and writes the rest of the text
+     * - **CHAT** - model that takes prompt and previous messages and returns response
+     * - **IMAGE_GENERATION** - model that takes prompt and returns image
+     * - **EMBEDDING** - model that takes prompt and returns embedding
+     * <- [🤖]
+     */
+    readonly modelVariant: ModelVariant;
+    /**
+     * The model for text prompt
+     *
+     * Note: Model must be compatible with the model variant
+     * Note: If not specified, the best model for the variant will be used
+     *
+     * @example 'gpt-4', 'gpt-4-32k-0314', 'gpt-3.5-turbo-instruct',...
+     */
+    readonly modelName?: string_model_name;
+    /**
+     * Seed for the model
+     */
+    readonly seed?: number_seed;
+    /**
+     * Tools available for the model
+     *
+     * 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)
+ * TODO: [🧠][💱] Add more model options: `stop_token`, `logit_bias`, `logprobs` (`top_logprobs`), `top_k`, `top_p`, `presence_penalty`, `frequency_penalty`, `bestOf`, `logitBias`, `logitBiasType`,...
+ *       [💱] 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.
+ * TODO: [💕][🧠] Just selecting gpt3 or gpt4 level of model
+ * TODO: [🧄] Replace all "github.com/webgptorg/promptbook#xxx" with "ptbk.io/xxx"
+ * TODO: [🐤] DRY `AgentModelRequirements` and `ModelRequirements`
+ */

package/umd/src/types/ModelVariant.d.ts

@@ -0,0 +1,15 @@
+import type { TupleToUnion } from 'type-fest';
+/**
+ * Model variant describes the very general type of the model
+ *
+ * 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", "IMAGE_GENERATION", "EMBEDDING"];

package/umd/src/types/NonEmptyArray.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Represents an array that is guaranteed to have at least one element
+ */
+export type NonEmptyArray<TItem> = [TItem, ...TItem[]];
+/**
+ * Represents an array that is guaranteed to have at least one element and is readonly
+ */
+export type NonEmptyReadonlyArray<TItem> = ReadonlyArray<TItem> & NonEmptyArray<TItem>;

package/umd/src/types/Prompt.d.ts

@@ -0,0 +1,153 @@
+import type { FormatCommand } from '../commands/FORMAT/FormatCommand';
+import type { ChatMessage } from '../book-components/Chat/types/ChatMessage';
+import type { Expectations } from '../pipeline/PipelineJson/Expectations';
+import type { LlmToolDefinition } from './LlmToolDefinition';
+import type { ChatModelRequirements } from './ModelRequirements';
+import type { CompletionModelRequirements } from './ModelRequirements';
+import type { EmbeddingModelRequirements } from './ModelRequirements';
+import type { ImageGenerationModelRequirements } from './ModelRequirements';
+import type { ModelRequirements } from './ModelRequirements';
+import type { Parameters } from './typeAliases';
+import type { string_pipeline_url_with_task_hash } from './typeAliases';
+import type { string_postprocessing_function_name } from './typeAliases';
+import type { string_prompt } from './typeAliases';
+import type { string_template } from './typeAliases';
+import type { string_title } from './typeAliases';
+/**
+ * Prompt in a text along with model requirements, but without any execution or templating logic.
+ *
+ * Note: [🚉] This is fully serializable as JSON
+ * @see https://github.com/webgptorg/promptbook#prompt
+ */
+export type Prompt = CompletionPrompt | ChatPrompt | ImagePrompt | EmbeddingPrompt;
+/**
+ * Completion prompt
+ *
+ * Note: [🚉] This is fully serializable as JSON
+ */
+export type CompletionPrompt = CommonPrompt & {
+    /**
+     * Requirements for completion model
+     */
+    modelRequirements: CompletionModelRequirements;
+};
+/**
+ * Chat prompt
+ *
+ * Note: [🚉] This is fully serializable as JSON
+ */
+export type ChatPrompt = CommonPrompt & {
+    /**
+     * Requirements for chat model
+     */
+    modelRequirements: ChatModelRequirements;
+    /**
+     * Optional chat thread (history of previous messages)
+     */
+    thread?: ChatMessage[];
+    /**
+     * Optional file attachments
+     */
+    attachments?: Array<{
+        name: string;
+        type: string;
+        url: string;
+    }>;
+    /**
+     * Optional tools that can be called by the model
+     */
+    tools?: Array<LlmToolDefinition>;
+    /**
+     * Optional file attachments
+     */
+    files?: Array<File>;
+};
+/**
+ * Image prompt
+ *
+ * Note: [🚉] This is fully serializable as JSON
+ */
+export type ImagePrompt = CommonPrompt & {
+    /**
+     * Requirements for image generation model
+     */
+    modelRequirements: ImageGenerationModelRequirements;
+    /**
+     * Optional file attachments
+     */
+    attachments?: Array<{
+        name: string;
+        type: string;
+        url: string;
+    }>;
+};
+/**
+ * Embedding prompt
+ *
+ * Note: [🚉] This is fully serializable as JSON
+ */
+export type EmbeddingPrompt = CommonPrompt & {
+    /**
+     * Requirements for chat model
+     */
+    modelRequirements: EmbeddingModelRequirements;
+};
+/**
+ * Common properties for all prompt results
+ *
+ * Note: [🚉] This is fully serializable as JSON
+ *
+ * @private just abstract the common properties of the prompts
+ */
+export type CommonPrompt = {
+    /**
+     * The title of the prompt
+     *
+     * Note: This has no effect on the model, it is just for the reporting
+     */
+    readonly title: string_title;
+    /**
+     * The text of the prompt with placeholders for parameters
+     *
+     * @example "What is the capital of {country}?"
+     */
+    readonly content: string_prompt & string_template;
+    /**
+     * Requirements for the model
+     */
+    readonly modelRequirements: ModelRequirements;
+    /**
+     * List of postprocessing steps that are executed after the prompt
+     */
+    readonly postprocessingFunctionNames?: ReadonlyArray<string_postprocessing_function_name>;
+    /**
+     * Expectations for the answer
+     *
+     * For example 5 words, 3 sentences, 2 paragraphs, ...
+     * If not set, nothing is expected from the answer
+     */
+    readonly expectations?: Expectations;
+    /**
+     * Expect this format of the answer
+     *
+     * Note: Expectations are performed after all postprocessing steps
+     * @deprecated [💝]
+     */
+    readonly format?: FormatCommand['format'];
+    /**
+     * Unique identifier of the pipeline with specific task name as hash
+     *
+     * @example https://promptbook.studio/webgpt/write-website-content-cs.book#keywords
+     */
+    readonly pipelineUrl?: string_pipeline_url_with_task_hash;
+    /**
+     * Parameters used in the `content`
+     */
+    readonly parameters: Parameters;
+};
+/**
+ * TODO: [🧄] Replace all "github.com/webgptorg/promptbook#xxx" with "ptbk.io/xxx"
+ * TODO: [✔] Check ModelRequirements in runtime
+ * TODO: [🏳] Add options for translation - maybe create `TranslationPrompt`
+ * TODO: [🧠][🤺] Maybe allow overriding of `userId` for each prompt
+ */

package/umd/src/types/ScriptLanguage.d.ts

@@ -0,0 +1,13 @@
+import type { TupleToUnion } from 'type-fest';
+/**
+ * Script language
+ *
+ * Note: [🚉] This is fully serializable as JSON
+ */
+export type ScriptLanguage = TupleToUnion<typeof SUPPORTED_SCRIPT_LANGUAGES>;
+/**
+ * Supported script languages
+ *
+ * @private internal base for `ScriptLanguage`
+ */
+export declare const SUPPORTED_SCRIPT_LANGUAGES: readonly ["javascript", "typescript", "python"];

package/umd/src/types/SectionType.d.ts

@@ -0,0 +1,21 @@
+import type { TupleToUnion } from 'type-fest';
+/**
+ * Type of the section
+ */
+export type SectionType = TupleToUnion<typeof SectionTypes>;
+/**
+ * All available sections which are not tasks
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const NonTaskSectionTypes: readonly ["EXAMPLE", "KNOWLEDGE", "INSTRUMENT", "ACTION"];
+/**
+ * All available section types
+ *
+ * There is is distinction between task types and section types
+ * - Every section in markdown has its SectionType
+ * - Some sections are tasks but other can be non-task sections
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const SectionTypes: readonly [...("PROMPT_TASK" | "SIMPLE_TASK" | "SCRIPT_TASK" | "DIALOG_TASK")[], "EXAMPLE", "KNOWLEDGE", "INSTRUMENT", "ACTION"];

package/umd/src/types/SpeechRecognition.d.ts

@@ -0,0 +1,58 @@
+import type { string_language } from './typeAliases';
+/**
+ * Interface for speech-to-text recognition
+ *
+ * @🚉 fully serializable as JSON
+ */
+export type SpeechRecognition = {
+    /**
+     * Start the speech recognition
+     */
+    $start(options: SpeechRecognitionStartOptions): void;
+    /**
+     * Stop the speech recognition
+     */
+    $stop(): void;
+    /**
+     * Current state of the speech recognition
+     */
+    readonly state: SpeechRecognitionState;
+    /**
+     * Subscribe to speech recognition events
+     */
+    subscribe(callback: (event: SpeechRecognitionEvent) => void): () => void;
+};
+/**
+ * Options for starting speech recognition
+ */
+export type SpeechRecognitionStartOptions = {
+    /**
+     * Language for speech recognition
+     * @default 'en-US'
+     */
+    readonly language?: string_language;
+    /**
+     * Whether to return interim results
+     * @default true
+     */
+    readonly interimResults?: boolean;
+};
+/**
+ * Current state of the speech recognition
+ */
+export type SpeechRecognitionState = 'IDLE' | 'STARTING' | 'RECORDING' | 'TRANSCRIBING' | 'ERROR';
+/**
+ * Event emitted by speech recognition
+ */
+export type SpeechRecognitionEvent = {
+    readonly type: 'START';
+} | {
+    readonly type: 'RESULT';
+    readonly text: string;
+    readonly isFinal: boolean;
+} | {
+    readonly type: 'ERROR';
+    readonly message: string;
+} | {
+    readonly type: 'STOP';
+};

package/umd/src/types/TaskType.d.ts

@@ -0,0 +1,15 @@
+import type { TupleToUnion } from 'type-fest';
+/**
+ * Type of the task
+ */
+export type TaskType = TupleToUnion<typeof TaskTypes>;
+/**
+ * All available task types
+ *
+ * There is is distinction between task types and section types
+ * - Every section in markdown has its SectionType
+ * - Some sections are tasks but other can be non-task sections
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const TaskTypes: readonly ["PROMPT", "SIMPLE", "SCRIPT", "DIALOG"];

package/umd/src/types/ToolCall.d.ts

@@ -0,0 +1,116 @@
+import type { TODO_any } from '../utils/organization/TODO_any';
+import type { string_date_iso8601 } from './typeAliases';
+/**
+ * Represents a single tool call with its inputs, outputs, and timing.
+ *
+ * Note: This is fully serializable as JSON.
+ */
+export type ToolCall = {
+    /**
+     * Name of the tool.
+     */
+    readonly name: string;
+    /**
+     * Arguments for the tool call.
+     */
+    readonly arguments?: string | Record<string, TODO_any>;
+    /**
+     * Result of the tool call.
+     */
+    readonly result?: TODO_any;
+    /**
+     * Raw tool call payload from the model.
+     */
+    readonly rawToolCall?: TODO_any;
+    /**
+     * Timestamp when the tool call was initiated.
+     */
+    readonly createdAt?: string_date_iso8601;
+    /**
+     * Errors thrown during tool execution.
+     */
+    readonly errors?: ReadonlyArray<TODO_any>;
+    /**
+     * Warnings reported during tool execution.
+     */
+    readonly warnings?: ReadonlyArray<TODO_any>;
+};
+/**
+ * Breakdown of teacher-learned commitment categories for self-learning.
+ */
+export type SelfLearningCommitmentTypeCounts = {
+    /**
+     * Total number of learned commitments.
+     */
+    readonly total: number;
+    /**
+     * Count of knowledge commitments.
+     */
+    readonly knowledge: number;
+    /**
+     * Count of rule commitments.
+     */
+    readonly rule: number;
+    /**
+     * Count of persona commitments.
+     */
+    readonly persona: number;
+    /**
+     * Count of other commitment types.
+     */
+    readonly other: number;
+};
+/**
+ * Summary of the teacher review step during self-learning.
+ */
+export type SelfLearningTeacherSummary = {
+    /**
+     * Indicates whether the teacher step was used.
+     */
+    readonly used: boolean;
+    /**
+     * Commitment breakdown produced by the teacher step.
+     */
+    readonly commitmentTypes: SelfLearningCommitmentTypeCounts;
+    /**
+     * Normalized commitment lines produced by the teacher step.
+     */
+    readonly commitments?: ReadonlyArray<string>;
+};
+/**
+ * Result payload for the self-learning tool call.
+ */
+export type SelfLearningToolCallResult = {
+    /**
+     * Indicates whether self-learning completed successfully.
+     */
+    readonly success: boolean;
+    /**
+     * Timestamp for when self-learning started.
+     */
+    readonly startedAt?: string_date_iso8601;
+    /**
+     * Timestamp for when self-learning finished.
+     */
+    readonly completedAt?: string_date_iso8601;
+    /**
+     * Number of conversation examples saved from this turn.
+     */
+    readonly samplesAdded?: number;
+    /**
+     * Summary of the teacher review step.
+     */
+    readonly teacher?: SelfLearningTeacherSummary;
+};
+/**
+ * Tool call name emitted while preparing a GPT assistant for an agent.
+ *
+ * @public exported from `@promptbook/types`
+ */
+export declare const ASSISTANT_PREPARATION_TOOL_CALL_NAME = "assistant_preparation";
+/**
+ * Checks whether a tool call is the assistant preparation marker.
+ *
+ * @public exported from `@promptbook/types`
+ */
+export declare function isAssistantPreparationToolCall(toolCall: ToolCall): boolean;

package/umd/src/types/Updatable.d.ts

@@ -0,0 +1,19 @@
+import { BehaviorSubject } from 'rxjs';
+/**
+ * A type that represents a value that can be updated over time:
+ *
+ * 1) It can be a static value of type `TValue`
+ * 2) Or a `BehaviorSubject` that emits values of type `TValue`
+ * 3) Or pair of `[getValue, setValue]` functions for getting and setting the value
+ */
+export type Updatable<TValue> = TValue | BehaviorSubject<TValue> | [TValue, (value: TValue) => void];
+/**
+ * Restricts an Updatable to a (2) BehaviorSubject variant
+ *
+ * @see Updatable
+ * @private internal utility <- TODO: [🧠] Maybe export from `@promptbook/types`
+ */
+export declare function asUpdatableSubject<TValue>(value: Updatable<TValue>): BehaviorSubject<TValue>;
+/**
+ * TODO: [🧠] Maybe `BehaviorSubject` is too heavy for this use case, maybe just tuple `[value,setValue]` is enough
+ */