@promptbook/anthropic-claude 0.52.0-1

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

@@ -0,0 +1,48 @@
+import type { Promisable } from 'type-fest';
+import type { ModelVariant } from '../types/ModelRequirements';
+import type { Prompt } from '../types/Prompt';
+import type { string_model_name, string_title } from '../types/typeAliases';
+import type { PromptChatResult, PromptCompletionResult } from './PromptResult';
+/**
+ * Container for all the tools needed to execute prompts to large language models like GPT-4
+ * On its interface it exposes common methods for prompt execution.
+ * Inside (in constructor) it calls OpenAI, Azure, GPU, proxy, cache, logging,...
+ *
+ * @see https://github.com/webgptorg/promptbook#llm-execution-tools
+ */
+export type LlmExecutionTools = {
+    /**
+     * Use a chat model
+     */
+    gptChat(prompt: Prompt): Promise<PromptChatResult>;
+    /**
+     * Use a completion model
+     */
+    gptComplete(prompt: Prompt): Promise<PromptCompletionResult>;
+    /**
+     * List all available models that can be used
+     */
+    listModels(): Promisable<Array<AvailableModel>>;
+};
+/**
+ * Represents a model that can be used for prompt execution
+ */
+export type AvailableModel = {
+    /**
+     * The model title
+     */
+    readonly modelTitle: string_title;
+    /**
+     * The model name aviailable
+     */
+    readonly modelName: string_model_name;
+    /**
+     * Variant of the model
+     */
+    readonly modelVariant: ModelVariant;
+};
+/**
+ * TODO: [🍓][♐] Some heuristic to pick the best model in listed models
+ * TODO: [🏳] gptChat -> chat, gptComplete -> complete, translate
+ * TODO: [🧠] Should or should not there be a word "GPT" in both gptComplete and gptChat
+ */

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

@@ -0,0 +1,74 @@
+import type { number_positive_or_zero, number_tokens, number_usd, string_date_iso8601, string_model_name } from '.././types/typeAliases';
+/**
+ * Prompt result is the simplest concept of execution.
+ * It is the result of executing one prompt _(NOT a template)_.
+ *
+ * @see https://github.com/webgptorg/promptbook#prompt-result
+ */
+export type PromptResult = PromptCompletionResult | PromptChatResult;
+/**
+ * Prompt completion result
+ * It contains only the following text NOT the whole completion
+ */
+export type PromptCompletionResult = PromptCommonResult;
+/**
+ * Prompt chat result
+ */
+export type PromptChatResult = PromptCommonResult & {};
+export type PromptCommonResult = {
+    /**
+     * Exact text response from the model
+     */
+    readonly content: string;
+    /**
+     * Name of the model used to generate the response
+     */
+    readonly model: string_model_name;
+    /**
+     * Timing
+     */
+    readonly timing: {
+        /**
+         * Start of the execution
+         */
+        start: string_date_iso8601;
+        /**
+         * First token generated
+         */
+        firstToken?: string_date_iso8601;
+        /**
+         * End of the execution
+         */
+        complete: string_date_iso8601;
+    };
+    /**
+     * Usage of the prompt execution
+     */
+    readonly usage: {
+        /**
+         * Cost of the execution in USD
+         *
+         * If the cost is unknown, the value is `'UNKNOWN'`
+         */
+        price: (number_positive_or_zero & number_usd) | 'UNKNOWN';
+        /**
+         * Number of tokens used in the input aka. `prompt_tokens`
+         */
+        inputTokens: number_tokens;
+        /**
+         * Number of tokens used in the output aka. `completion_tokens`
+         */
+        outputTokens: number_tokens;
+    };
+    /**
+     * Raw response from the model
+     */
+    readonly rawResponse: object;
+};
+/**
+ * TODO: [🧠] Maybe timing more accurate then seconds?
+ * TODO: [🧠] Should here be link to the prompt?
+ * TODO: [🧠] Maybe type raw properly - not onject but OpenAI.result.whatever
+ * TODO: [🧠] Maybe remove redundant raw.choices.text
+ * TODO: Log raw even if prompt failed - log the raw error
+ */

package/esm/typings/execution/PromptbookExecutor.d.ts

@@ -0,0 +1,37 @@
+import type { Promisable } from 'type-fest';
+import type { TaskProgress } from '../types/TaskProgress';
+import type { ExecutionReportJson } from '../types/execution-report/ExecutionReportJson';
+import type { string_name } from '../types/typeAliases';
+/**
+ * Executor is a simple async function that takes INPUT  PARAMETERs and returns result parameters _(along with all intermediate parameters and INPUT  PARAMETERs = it extends input object)_.
+ * Executor is made by combining execution tools and promptbook library.
+ *
+ * It can be created with `createPromptbookExecutor` function.
+ *
+ * @see https://github.com/webgptorg/promptbook#executor
+ */
+export type PromptbookExecutor = {
+    (inputParameters: Record<string_name, string>, onProgress?: (taskProgress: TaskProgress) => Promisable<void>): Promise<{
+        /**
+         * Whether the execution was successful
+         */
+        isSuccessful: boolean;
+        /**
+         * Errors that occured during the execution
+         */
+        errors: Array<Error>;
+        /**
+         * The report of the execution
+         */
+        executionReport: ExecutionReportJson;
+        /**
+         * Result parameters of the execution
+         *
+         * Note: If the execution was not successful, there are only some of the result parameters
+         */
+        outputParameters: Record<string_name, string>;
+    }>;
+};
+/**
+ * TODO: [🧠] Should this file be in /execution or /types folder?
+ */

package/esm/typings/execution/ScriptExecutionTools.d.ts

@@ -0,0 +1,37 @@
+import type { string_name, string_script } from '.././types/typeAliases';
+import type { ScriptLanguage } from '../types/ScriptLanguage';
+/**
+ * Represents all the tools needed to EXECUTE SCRIPTs
+ *
+ * @see https://github.com/webgptorg/promptbook#script-execution-tools
+ */
+export type ScriptExecutionTools = {
+    execute(options: ScriptExecutionToolsExecuteOptions): Promise<string>;
+};
+/**
+ * Input for the script execution
+ */
+export type ScriptExecutionToolsExecuteOptions = {
+    /**
+     * Language of the script
+     */
+    scriptLanguage: ScriptLanguage;
+    /**
+     * Parameters for the script
+     * Theese parameters are passed to the script as variables
+     * For example: { "name": "John" } => const name = "John";
+     */
+    parameters: Record<string_name, string>;
+    /**
+     * The content of the script to execute
+     * - It can be a single statement
+     * - It can be multiple statements separated by semicolon and return
+     * - It can be a function (but you need to call it)
+     * - It can be IIFE (immediately invoked function expression)
+     * - It can use the parameters as variables and functions from global scope
+     */
+    script: string_script;
+};
+/**
+ * TODO: [🧠][💙] Distinct between options passed into ExecutionTools and to ExecutionTools.execute
+ */

package/esm/typings/execution/UserInterfaceTools.d.ts

@@ -0,0 +1,45 @@
+import type { number_integer, number_positive } from '../types/typeAliases';
+/**
+ * Represents all the tools needed to interact with the user.
+ *
+ * @see https://github.com/webgptorg/promptbook#user-interface-tools
+ */
+export type UserInterfaceTools = {
+    /**
+     * Asks the user to answer a free-text (multi-line) question
+     *
+     * @param options the question to ask
+     * @returns the answer from the user
+     */
+    promptDialog(options: UserInterfaceToolsPromptDialogOptions): Promise<string>;
+};
+export type UserInterfaceToolsPromptDialogOptions = {
+    /**
+     * Prompt title
+     *
+     * Note: This is not a prompt to language model but a prompt to the user
+     * @example "Your name"
+     */
+    promptTitle: string;
+    /**
+     * Prompt message
+     *
+     * Note: This is not a prompt to language model but a prompt to the user
+     * @example "Please enter your name, including your last name, title, etc."
+     */
+    promptMessage: string;
+    /**
+     * Default value for the input/textarea
+     */
+    defaultValue: string | null;
+    /**
+     * Placeholder for the input/textarea
+     */
+    placeholder?: string;
+    /**
+     * Priority of the prompt
+     *
+     * Note: This would be reflected for example into the UI z-index of the prompt modal
+     */
+    priority: number_integer & number_positive;
+};

package/esm/typings/execution/assertsExecutionSuccessful.d.ts

@@ -0,0 +1,11 @@
+import type { PromptbookExecutor } from './PromptbookExecutor';
+/**
+ * Asserts that the execution of a promptnook is successful
+ *
+ * @param executionResult - The partial result of the promptnook execution
+ * @throws {PromptbookExecutionError} If the execution is not successful or if multiple errors occurred
+ */
+export declare function assertsExecutionSuccessful(executionResult: Pick<Awaited<ReturnType<PromptbookExecutor>>, 'isSuccessful' | 'errors'>): void;
+/**
+ * TODO: [🧠] Can this return type be better typed than void
+ */

package/esm/typings/execution/createPromptbookExecutor.d.ts

@@ -0,0 +1,42 @@
+import { PromptbookJson } from '../_packages/types.index';
+import { ExecutionTools } from './ExecutionTools';
+import { PromptbookExecutor } from './PromptbookExecutor';
+type CreatePromptbookExecutorSettings = {
+    /**
+     * When executor does not satisfy expectations it will be retried this amount of times
+     *
+     * @default 3
+     */
+    readonly maxExecutionAttempts: number;
+};
+/**
+ * Options for creating a promptbook executor
+ */
+interface CreatePromptbookExecutorOptions {
+    /**
+     * The promptbook to be executed
+     */
+    readonly promptbook: PromptbookJson;
+    /**
+     * The execution tools to be used during the execution of the PROMPTBOOK
+     */
+    readonly tools: ExecutionTools;
+    /**
+     * Optional settings for the PROMPTBOOK executor
+     */
+    readonly settings?: Partial<CreatePromptbookExecutorSettings>;
+}
+/**
+ * Creates executor function from promptbook and execution tools.
+ *
+ * @returns The executor function
+ * @throws {PromptbookLogicError} on logical error in the promptbook
+ */
+export declare function createPromptbookExecutor(options: CreatePromptbookExecutorOptions): PromptbookExecutor;
+export {};
+/**
+ * TODO: [🧠] When not meet expectations in PROMPT_DIALOG, make some way to tell the user
+ * TODO: [👧] Strongly type the executors to avoid need of remove nullables whtn noUncheckedIndexedAccess in tsconfig.json
+ * Note: CreatePromptbookExecutorOptions are just connected to PromptbookExecutor so do not extract to types folder
+ * TODO: [🧠][3] transparent = (report intermediate parameters) / opaque execution = (report only output parameters) progress reporting mode
+ */

package/esm/typings/execution/plugins/llm-execution-tools/langtail/LangtailExecutionTools.d.ts

@@ -0,0 +1,10 @@
+import type { LlmExecutionTools } from '../../../LlmExecutionTools';
+import { OpenAiExecutionTools } from '../openai/OpenAiExecutionTools';
+/**
+ * Execution Tools for calling OpenAI API.
+ */
+export declare class LangtailExecutionTools extends OpenAiExecutionTools implements LlmExecutionTools {
+}
+/**
+ * TODO: [🍓][♐] Allow to list the available prompts in Langtail
+ */

package/esm/typings/execution/plugins/llm-execution-tools/langtail/LangtailExecutionToolsOptions.d.ts

@@ -0,0 +1,11 @@
+import type { OpenAiExecutionToolsOptions } from '../openai/OpenAiExecutionToolsOptions';
+/**
+ * Options for LangtailExecutionTools
+ *
+ * This extends OpenAI's `ClientOptions` with are directly passed to the OpenAI client.
+ * Rest is used by the `OpenAiExecutionTools`.
+ */
+export type LangtailExecutionToolsOptions = OpenAiExecutionToolsOptions;
+/**
+ * TODO: !!! Use or remove
+ */

package/esm/typings/execution/plugins/llm-execution-tools/mocked/MockedEchoLlmExecutionTools.d.ts

@@ -0,0 +1,26 @@
+import type { Prompt } from '../../../../types/Prompt';
+import type { CommonExecutionToolsOptions } from '../../../CommonExecutionToolsOptions';
+import type { AvailableModel, LlmExecutionTools } from '../../../LlmExecutionTools';
+import type { PromptChatResult, PromptCompletionResult } from '../../../PromptResult';
+/**
+ * Mocked execution Tools for just echoing the requests for testing purposes.
+ */
+export declare class MockedEchoLlmExecutionTools implements LlmExecutionTools {
+    private readonly options;
+    constructor(options: CommonExecutionToolsOptions);
+    /**
+     * Mocks chat model
+     */
+    gptChat(prompt: Prompt): Promise<PromptChatResult>;
+    /**
+     * Mocks completion model
+     */
+    gptComplete(prompt: Prompt): Promise<PromptCompletionResult>;
+    /**
+     * List all available mocked-models that can be used
+     */
+    listModels(): Array<AvailableModel>;
+}
+/**
+ * TODO: Allow in spaceTrim: nesting with > ${block(prompt.request)}, same as replace params
+ */

package/esm/typings/execution/plugins/llm-execution-tools/mocked/MockedFackedLlmExecutionTools.d.ts

@@ -0,0 +1,23 @@
+import type { Prompt } from '../../../../types/Prompt';
+import type { CommonExecutionToolsOptions } from '../../../CommonExecutionToolsOptions';
+import type { AvailableModel, LlmExecutionTools } from '../../../LlmExecutionTools';
+import type { PromptChatResult, PromptCompletionResult } from '../../../PromptResult';
+/**
+ * Mocked execution Tools for just faking expected responses for testing purposes
+ */
+export declare class MockedFackedLlmExecutionTools implements LlmExecutionTools {
+    private readonly options;
+    constructor(options: CommonExecutionToolsOptions);
+    /**
+     * Fakes chat model
+     */
+    gptChat(prompt: Prompt): Promise<PromptChatResult & PromptCompletionResult>;
+    /**
+     * Fakes completion model
+     */
+    gptComplete(prompt: Prompt): Promise<PromptCompletionResult>;
+    /**
+     * List all available fake-models that can be used
+     */
+    listModels(): Array<AvailableModel>;
+}

package/esm/typings/execution/plugins/llm-execution-tools/mocked/fakeTextToExpectations.d.ts

@@ -0,0 +1,15 @@
+import type { Expectations } from '../../../../types/PromptbookJson/PromptTemplateJson';
+import { PostprocessingFunction } from '../../script-execution-tools/javascript/JavascriptExecutionToolsOptions';
+/**
+ * Gets the expectations and creates a fake text that meets the expectations
+ *
+ * Note: You can provide postprocessing functions to modify the text before checking the expectations
+ *       The result will be the text BEFORE the postprocessing
+ *
+ * @private internal util for MockedFackedLlmExecutionTools
+ */
+export declare function $fakeTextToExpectations(expectations: Expectations, postprocessing?: Array<PostprocessingFunction>): Promise<string>;
+/**
+ * TODO: [🚏] Implement better - create FakeLLM from this
+ * TODO: [💝] Unite object for expecting amount and format - use here also a format
+ */

package/esm/typings/execution/plugins/llm-execution-tools/mocked/fakeTextToExpectations.test.d.ts

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

package/esm/typings/execution/plugins/llm-execution-tools/mocked/faked-completion.test.d.ts

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

package/esm/typings/execution/plugins/llm-execution-tools/mocked/joker.test.d.ts

@@ -0,0 +1,4 @@
+export {};
+/**
+ * TODO: [🧠] What should be name of this test "MockedEchoExecutionTools.test.ts" or "createPromptbookExecutor.test.ts"
+ */

package/esm/typings/execution/plugins/llm-execution-tools/mocked/mocked-chat.test.d.ts

@@ -0,0 +1,4 @@
+export {};
+/**
+ * TODO: [🧠] What should be name of this test "MockedEchoExecutionTools.test.ts" or "createPromptbookExecutor.test.ts"
+ */

package/esm/typings/execution/plugins/llm-execution-tools/mocked/mocked-completion.test.d.ts

@@ -0,0 +1,4 @@
+export {};
+/**
+ * TODO: [🧠] What should be name of this test "MockedEchoExecutionTools.test.ts" or "createPromptbookExecutor.test.ts"
+ */

package/esm/typings/execution/plugins/llm-execution-tools/openai/OpenAiExecutionTools.d.ts

@@ -0,0 +1,45 @@
+import type { Prompt } from '../../../../types/Prompt';
+import type { AvailableModel, LlmExecutionTools } from '../../../LlmExecutionTools';
+import type { PromptChatResult, PromptCompletionResult } from '../../../PromptResult';
+import type { OpenAiExecutionToolsOptions } from './OpenAiExecutionToolsOptions';
+/**
+ * Execution Tools for calling OpenAI API.
+ */
+export declare class OpenAiExecutionTools implements LlmExecutionTools {
+    private readonly options;
+    /**
+     * OpenAI API client.
+     */
+    private readonly openai;
+    /**
+     * Creates OpenAI Execution Tools.
+     *
+     * @param options which are relevant are directly passed to the OpenAI client
+     */
+    constructor(options: OpenAiExecutionToolsOptions);
+    /**
+     * Calls OpenAI API to use a chat model.
+     */
+    gptChat(prompt: Prompt): Promise<PromptChatResult>;
+    /**
+     * Calls OpenAI API to use a complete model.
+     */
+    gptComplete(prompt: Prompt): Promise<PromptCompletionResult>;
+    /**
+     * Default model for chat variant.
+     */
+    private getDefaultChatModel;
+    /**
+     * Default model for completion variant.
+     */
+    private getDefaultCompletionModel;
+    /**
+     * List all available OpenAI models that can be used
+     */
+    listModels(): Array<AvailableModel>;
+}
+/**
+ * TODO: [🍓][♐] Allow to list compatible models with each variant
+ * TODO: Maybe Create some common util for gptChat and gptComplete
+ * TODO: Maybe make custom OpenaiError
+ */

package/esm/typings/execution/plugins/llm-execution-tools/openai/OpenAiExecutionToolsOptions.d.ts

@@ -0,0 +1,16 @@
+import type { ClientOptions } from 'openai';
+import type { string_token } from '../../../.././types/typeAliases';
+import type { CommonExecutionToolsOptions } from '../../../CommonExecutionToolsOptions';
+/**
+ * Options for OpenAiExecutionTools
+ *
+ * This extends OpenAI's `ClientOptions` with are directly passed to the OpenAI client.
+ * Rest is used by the `OpenAiExecutionTools`.
+ */
+export type OpenAiExecutionToolsOptions = CommonExecutionToolsOptions & ClientOptions & {
+    /**
+     * A unique identifier representing your end-user, which can help OpenAI to monitor
+     * and detect abuse. [Learn more](/docs/guides/safety-best-practices/end-user-ids).
+     */
+    user?: string_token;
+};

package/esm/typings/execution/plugins/llm-execution-tools/openai/computeOpenaiUsage.d.ts

@@ -0,0 +1,8 @@
+import type OpenAI from 'openai';
+import type { PromptResult } from '../../../PromptResult';
+/**
+ * Computes the usage of the OpenAI API based on the response from OpenAI
+ *
+ * @throws {PromptbookExecutionError} If the usage is not defined in the response from OpenAI
+ */
+export declare function computeOpenaiUsage(rawResponse: Pick<OpenAI.Chat.Completions.ChatCompletion | OpenAI.Completions.Completion, 'model' | 'usage'>): PromptResult['usage'];

package/esm/typings/execution/plugins/llm-execution-tools/openai/computeUsage.d.ts

@@ -0,0 +1,13 @@
+/**
+ * String value found on openai page
+ *
+ * @private within the library, used only as internal helper for `OPENAI_MODELS` and `computeUsage`
+ */
+type string_openai_price = `$${number}.${number} / ${number}M tokens`;
+/**
+ * Function computeUsage will create price per one token based on the string value found on openai page
+ *
+ * @private within the library, used only as internal helper for `OPENAI_MODELS`
+ */
+export declare function computeUsage(value: string_openai_price): number;
+export {};

package/esm/typings/execution/plugins/llm-execution-tools/openai/computeUsage.test.d.ts

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

package/esm/typings/execution/plugins/llm-execution-tools/openai/models.d.ts

@@ -0,0 +1,25 @@
+import { number_usd } from '../../../../types/typeAliases';
+import type { AvailableModel } from '../../../LlmExecutionTools';
+/**
+ * List of available OpenAI models with pricing
+ *
+ * Note: Done at 2024-05-20
+ *
+ * @see https://platform.openai.com/docs/models/
+ * @see https://openai.com/api/pricing/
+ */
+export declare const OPENAI_MODELS: Array<AvailableModel & {
+    pricing?: {
+        prompt: number_usd;
+        output: number_usd;
+    };
+}>;
+/**
+ * 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
+ * @see https://platform.openai.com/docs/models/gpt-4-turbo-and-gpt-4
+ * @see https://openai.com/api/pricing/
+ * @see /other/playground/playground.ts
+ * TODO: [🍓] Make better
+ * TODO: Change model titles to human eg: "gpt-4-turbo-2024-04-09" -> "GPT-4 Turbo (2024-04-09)"
+ */

package/esm/typings/execution/plugins/llm-execution-tools/remote/RemoteLlmExecutionTools.d.ts

@@ -0,0 +1,40 @@
+import type { Prompt } from '../../../../types/Prompt';
+import type { AvailableModel, LlmExecutionTools } from '../../../LlmExecutionTools';
+import type { PromptChatResult, PromptCompletionResult } from '../../../PromptResult';
+import type { RemoteLlmExecutionToolsOptions } from './RemoteLlmExecutionToolsOptions';
+/**
+ * Remote server is a proxy server that uses its execution tools internally and exposes the executor interface externally.
+ *
+ * You can simply use `RemoteExecutionTools` on client-side javascript and connect to your remote server.
+ * This is useful to make all logic on browser side but not expose your API keys or no need to use customer's GPU.
+ *
+ * @see https://github.com/webgptorg/promptbook#remote-server
+ */
+export declare class RemoteLlmExecutionTools implements LlmExecutionTools {
+    private readonly options;
+    constructor(options: RemoteLlmExecutionToolsOptions);
+    /**
+     * Creates a connection to the remote proxy server.
+     */
+    private makeConnection;
+    /**
+     * Calls remote proxy server to use a chat model.
+     */
+    gptChat(prompt: Prompt): Promise<PromptChatResult>;
+    /**
+     * Calls remote proxy server to use a completion model.
+     */
+    gptComplete(prompt: Prompt): Promise<PromptCompletionResult>;
+    /**
+     * Calls remote proxy server to use both completion or chat model.
+     */
+    private gptCommon;
+    /**
+     * List all available models that can be used
+     */
+    listModels(): Promise<Array<AvailableModel>>;
+}
+/**
+ * TODO: [🍓][♐] Allow to list compatible models with each variant
+ * TODO: [🤹‍♂️] RemoteLlmExecutionTools should extend Destroyable and implement IDestroyable
+ */

package/esm/typings/execution/plugins/llm-execution-tools/remote/RemoteLlmExecutionToolsOptions.d.ts

@@ -0,0 +1,23 @@
+import type { client_id, string_uri } from '../../../../types/typeAliases';
+import type { CommonExecutionToolsOptions } from '../../../CommonExecutionToolsOptions';
+/**
+ * Options for RemoteLlmExecutionTools
+ */
+export type RemoteLlmExecutionToolsOptions = CommonExecutionToolsOptions & {
+    /**
+     * URL of the remote PROMPTBOOK server
+     * On this server will be connected to the socket.io server
+     */
+    readonly remoteUrl: URL;
+    /**
+     * Path for the Socket.io server to listen
+     *
+     * @default '/socket.io'
+     * @example '/promptbook/socket.io'
+     */
+    readonly path: string_uri;
+    /**
+     * Your client ID
+     */
+    readonly clientId: client_id;
+};

package/esm/typings/execution/plugins/llm-execution-tools/remote/interfaces/Promptbook_Server_Error.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Socket.io error for remote text generation
+ *
+ * This is sent from server to client when error occurs and stops the process
+ */
+export interface Promptbook_Server_Error {
+    /**
+     * The error message which caused the error
+     */
+    readonly errorMessage: string;
+}

package/esm/typings/execution/plugins/llm-execution-tools/remote/interfaces/Promptbook_Server_Progress.d.ts

@@ -0,0 +1,12 @@
+import { TaskProgress } from '../../../../../types/TaskProgress';
+/**
+ * Socket.io progress for remote text generation
+ *
+ * This is sent from server to client arbitrarily and may be sent multiple times
+ */
+export interface Promptbook_Server_Progress {
+    /**
+     * The progress of text generation
+     */
+    readonly taskProgress: TaskProgress;
+}

package/esm/typings/execution/plugins/llm-execution-tools/remote/interfaces/Promptbook_Server_Request.d.ts

@@ -0,0 +1,17 @@
+import type { client_id } from '../../../../../types/typeAliases';
+import type { Prompt } from '../../../../../types/Prompt';
+/**
+ * Socket.io progress for remote text generation
+ *
+ * This is a request from client to server
+ */
+export interface Promptbook_Server_Request {
+    /**
+     * Client responsible for the requests
+     */
+    readonly clientId: client_id;
+    /**
+     * The Prompt to execute
+     */
+    readonly prompt: Prompt;
+}

package/esm/typings/execution/plugins/llm-execution-tools/remote/interfaces/Promptbook_Server_Response.d.ts

@@ -0,0 +1,12 @@
+import { PromptResult } from '../../../../PromptResult';
+/**
+ * Socket.io error for remote text generation
+ *
+ * This is sent from server to client when the generated text is completed
+ */
+export interface Promptbook_Server_Response {
+    /**
+     * The result of the prompt
+     */
+    promptResult: PromptResult;
+}