@promptbook/cli 0.62.0 → 0.62.2

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

@@ -1,66 +1,66 @@
-import type { AvailableModel } from '../../execution/LlmExecutionTools';
-import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
-import type { ChatPromptResult } from '../../execution/PromptResult';
-import type { CompletionPromptResult } from '../../execution/PromptResult';
-import type { EmbeddingPromptResult } from '../../execution/PromptResult';
-import type { Prompt } from '../../types/Prompt';
-import type { string_markdown } from '../../types/typeAliases';
-import type { string_markdown_text } from '../../types/typeAliases';
-import type { string_title } from '../../types/typeAliases';
-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 client;
-    /**
-     * Creates OpenAI Execution Tools.
-     *
-     * @param options which are relevant are directly passed to the OpenAI client
-     */
-    constructor(options?: OpenAiExecutionToolsOptions);
-    get title(): string_title & string_markdown_text;
-    get description(): string_markdown;
-    /**
-     * Calls OpenAI API to use a chat model.
-     */
-    callChatModel(prompt: Pick<Prompt, 'content' | 'parameters' | 'modelRequirements' | 'expectFormat'>): Promise<ChatPromptResult>;
-    /**
-     * Calls OpenAI API to use a complete model.
-     */
-    callCompletionModel(prompt: Pick<Prompt, 'content' | 'parameters' | 'modelRequirements'>): Promise<CompletionPromptResult>;
-    /**
-     * Calls OpenAI API to use a embedding model
-     */
-    callEmbeddingModel(prompt: Pick<Prompt, 'content' | 'parameters' | 'modelRequirements'>): Promise<EmbeddingPromptResult>;
-    /**
-     * Get the model that should be used as default
-     */
-    private getDefaultModel;
-    /**
-     * Default model for chat variant.
-     */
-    private getDefaultChatModel;
-    /**
-     * Default model for completion variant.
-     */
-    private getDefaultCompletionModel;
-    /**
-     * Default model for completion variant.
-     */
-    private getDefaultEmbeddingModel;
-    /**
-     * List all available OpenAI models that can be used
-     */
-    listModels(): Array<AvailableModel>;
-}
-/**
- * TODO: [🧠][🧙‍♂️] Maybe there can be some wizzard for thoose who want to use just OpenAI
- * TODO: Maybe Create some common util for callChatModel and callCompletionModel
- * TODO: Maybe make custom OpenaiError
- * TODO: [🧠][🈁] Maybe use `isDeterministic` from options
- */
+import type { AvailableModel } from '../../execution/LlmExecutionTools';
+import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
+import type { ChatPromptResult } from '../../execution/PromptResult';
+import type { CompletionPromptResult } from '../../execution/PromptResult';
+import type { EmbeddingPromptResult } from '../../execution/PromptResult';
+import type { Prompt } from '../../types/Prompt';
+import type { string_markdown } from '../../types/typeAliases';
+import type { string_markdown_text } from '../../types/typeAliases';
+import type { string_title } from '../../types/typeAliases';
+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 client;
+    /**
+     * Creates OpenAI Execution Tools.
+     *
+     * @param options which are relevant are directly passed to the OpenAI client
+     */
+    constructor(options?: OpenAiExecutionToolsOptions);
+    get title(): string_title & string_markdown_text;
+    get description(): string_markdown;
+    /**
+     * Calls OpenAI API to use a chat model.
+     */
+    callChatModel(prompt: Pick<Prompt, 'content' | 'parameters' | 'modelRequirements' | 'expectFormat'>): Promise<ChatPromptResult>;
+    /**
+     * Calls OpenAI API to use a complete model.
+     */
+    callCompletionModel(prompt: Pick<Prompt, 'content' | 'parameters' | 'modelRequirements'>): Promise<CompletionPromptResult>;
+    /**
+     * Calls OpenAI API to use a embedding model
+     */
+    callEmbeddingModel(prompt: Pick<Prompt, 'content' | 'parameters' | 'modelRequirements'>): Promise<EmbeddingPromptResult>;
+    /**
+     * Get the model that should be used as default
+     */
+    private getDefaultModel;
+    /**
+     * Default model for chat variant.
+     */
+    private getDefaultChatModel;
+    /**
+     * Default model for completion variant.
+     */
+    private getDefaultCompletionModel;
+    /**
+     * Default model for completion variant.
+     */
+    private getDefaultEmbeddingModel;
+    /**
+     * List all available OpenAI models that can be used
+     */
+    listModels(): Array<AvailableModel>;
+}
+/**
+ * TODO: [🧠][🧙‍♂️] Maybe there can be some wizzard for thoose who want to use just OpenAI
+ * TODO: Maybe Create some common util for callChatModel and callCompletionModel
+ * TODO: Maybe make custom OpenaiError
+ * TODO: [🧠][🈁] Maybe use `isDeterministic` from options
+ */

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

@@ -1,18 +1,18 @@
-import type { ClientOptions } from 'openai';
-import type { CommonExecutionToolsOptions } from '../../execution/CommonExecutionToolsOptions';
-import type { string_token } from '../../types/typeAliases';
-/**
- * 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.
-     *
-     * @see https://platform.openai.com/docs/guides/safety-best-practices/end-user-ids
-     */
-    user?: string_token;
-};
+import type { ClientOptions } from 'openai';
+import type { CommonExecutionToolsOptions } from '../../execution/CommonExecutionToolsOptions';
+import type { string_token } from '../../types/typeAliases';
+/**
+ * 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.
+     *
+     * @see https://platform.openai.com/docs/guides/safety-best-practices/end-user-ids
+     */
+    user?: string_token;
+};

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

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

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

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

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

@@ -1,16 +1,16 @@
-/**
- * String value found on OpenAI and Anthropic Claude page
- *
- * @see https://openai.com/api/pricing/
- * @see https://docs.anthropic.com/en/docs/models-overview
- *
- * @private within the repository, used only as internal helper for `OPENAI_MODELS` and `computeUsage`
- */
-type string_model_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 repository, used only as internal helper for `OPENAI_MODELS`
- */
-export declare function computeUsage(value: string_model_price): number;
-export {};
+/**
+ * String value found on OpenAI and Anthropic Claude page
+ *
+ * @see https://openai.com/api/pricing/
+ * @see https://docs.anthropic.com/en/docs/models-overview
+ *
+ * @private within the repository, used only as internal helper for `OPENAI_MODELS` and `computeUsage`
+ */
+type string_model_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 repository, used only as internal helper for `OPENAI_MODELS`
+ */
+export declare function computeUsage(value: string_model_price): number;
+export {};

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

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

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

@@ -1,28 +1,28 @@
-import type { AvailableModel } from '../../execution/LlmExecutionTools';
-import type { number_usd } from '../../types/typeAliases';
-/**
- * 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?: {
-        readonly prompt: number_usd;
-        readonly output: number_usd;
-    };
-}>;
-/**
- * Note: [🤖] Add models of new variant
- * TODO: [🧠] Some mechanism to propagate unsureness
- * TODO: [🕚][👮‍♀️] Make this list dynamic - dynamically can be listed modelNames but not modelVariant, legacy status, context length and pricing
- * TODO: [🧠][👮‍♀️] Put here more info like description, isVision, trainingDateCutoff, languages, strengths (	Top-level performance, intelligence, fluency, and understanding), contextWindow,...
- * @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)"
- * TODO: [🚸] Not all models are compatible with JSON mode, add this information here and use it
- */
+import type { AvailableModel } from '../../execution/LlmExecutionTools';
+import type { number_usd } from '../../types/typeAliases';
+/**
+ * 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?: {
+        readonly prompt: number_usd;
+        readonly output: number_usd;
+    };
+}>;
+/**
+ * Note: [🤖] Add models of new variant
+ * TODO: [🧠] Some mechanism to propagate unsureness
+ * TODO: [🕚][👮‍♀️] Make this list dynamic - dynamically can be listed modelNames but not modelVariant, legacy status, context length and pricing
+ * TODO: [🧠][👮‍♀️] Put here more info like description, isVision, trainingDateCutoff, languages, strengths (	Top-level performance, intelligence, fluency, and understanding), contextWindow,...
+ * @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)"
+ * TODO: [🚸] Not all models are compatible with JSON mode, add this information here and use it
+ */

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

@@ -1,5 +1,5 @@
-#!/usr/bin/env ts-node
-export {};
-/**
- * TODO: !!! Test here that `systemMessage`, `temperature` and `seed` are working correctly
- */
+#!/usr/bin/env ts-node
+export {};
+/**
+ * TODO: !!! Test here that `systemMessage`, `temperature` and `seed` are working correctly
+ */

package/esm/typings/src/llm-providers/remote/RemoteLlmExecutionTools.d.ts

@@ -1,55 +1,55 @@
-import type { AvailableModel } from '../../execution/LlmExecutionTools';
-import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
-import type { ChatPromptResult } from '../../execution/PromptResult';
-import type { CompletionPromptResult } from '../../execution/PromptResult';
-import type { EmbeddingPromptResult } from '../../execution/PromptResult';
-import type { ChatPrompt } from '../../types/Prompt';
-import type { CompletionPrompt } from '../../types/Prompt';
-import type { EmbeddingPrompt } from '../../types/Prompt';
-import type { string_markdown } from '../../types/typeAliases';
-import type { string_markdown_text } from '../../types/typeAliases';
-import type { string_title } from '../../types/typeAliases';
-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);
-    get title(): string_title & string_markdown_text;
-    get description(): string_markdown;
-    /**
-     * Creates a connection to the remote proxy server.
-     */
-    private makeConnection;
-    /**
-     * Calls remote proxy server to use a chat model
-     */
-    callChatModel(prompt: ChatPrompt): Promise<ChatPromptResult>;
-    /**
-     * Calls remote proxy server to use a completion model
-     */
-    callCompletionModel(prompt: CompletionPrompt): Promise<CompletionPromptResult>;
-    /**
-     * Calls remote proxy server to use a embedding model
-     */
-    callEmbeddingModel(prompt: EmbeddingPrompt): Promise<EmbeddingPromptResult>;
-    /**
-     * Calls remote proxy server to use both completion or chat model
-     */
-    private callModelCommon;
-    /**
-     * 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
- * TODO: [🍜] Add anonymous option
- */ 
+import type { AvailableModel } from '../../execution/LlmExecutionTools';
+import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
+import type { ChatPromptResult } from '../../execution/PromptResult';
+import type { CompletionPromptResult } from '../../execution/PromptResult';
+import type { EmbeddingPromptResult } from '../../execution/PromptResult';
+import type { ChatPrompt } from '../../types/Prompt';
+import type { CompletionPrompt } from '../../types/Prompt';
+import type { EmbeddingPrompt } from '../../types/Prompt';
+import type { string_markdown } from '../../types/typeAliases';
+import type { string_markdown_text } from '../../types/typeAliases';
+import type { string_title } from '../../types/typeAliases';
+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);
+    get title(): string_title & string_markdown_text;
+    get description(): string_markdown;
+    /**
+     * Creates a connection to the remote proxy server.
+     */
+    private makeConnection;
+    /**
+     * Calls remote proxy server to use a chat model
+     */
+    callChatModel(prompt: ChatPrompt): Promise<ChatPromptResult>;
+    /**
+     * Calls remote proxy server to use a completion model
+     */
+    callCompletionModel(prompt: CompletionPrompt): Promise<CompletionPromptResult>;
+    /**
+     * Calls remote proxy server to use a embedding model
+     */
+    callEmbeddingModel(prompt: EmbeddingPrompt): Promise<EmbeddingPromptResult>;
+    /**
+     * Calls remote proxy server to use both completion or chat model
+     */
+    private callModelCommon;
+    /**
+     * 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
+ * TODO: [🍜] Add anonymous option
+ */ 

package/esm/typings/src/llm-providers/remote/RemoteLlmExecutionToolsOptions.d.ts

@@ -1,24 +1,24 @@
-import type { CommonExecutionToolsOptions } from '../../execution/CommonExecutionToolsOptions';
-import type { client_id } from '../../types/typeAliases';
-import type { string_uri } from '../../types/typeAliases';
-/**
- * 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;
-};
+import type { CommonExecutionToolsOptions } from '../../execution/CommonExecutionToolsOptions';
+import type { client_id } from '../../types/typeAliases';
+import type { string_uri } from '../../types/typeAliases';
+/**
+ * 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/src/llm-providers/remote/interfaces/Promptbook_Server_Error.d.ts

@@ -1,11 +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;
-}
+/**
+ * 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/src/llm-providers/remote/interfaces/Promptbook_Server_Progress.d.ts

@@ -1,12 +1,12 @@
-import type { 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;
-}
+import type { 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/src/llm-providers/remote/interfaces/Promptbook_Server_Request.d.ts

@@ -1,17 +1,17 @@
-import type { Prompt } from '../../../types/Prompt';
-import type { client_id } from '../../../types/typeAliases';
-/**
- * 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;
-}
+import type { Prompt } from '../../../types/Prompt';
+import type { client_id } from '../../../types/typeAliases';
+/**
+ * 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/src/llm-providers/remote/interfaces/Promptbook_Server_Response.d.ts

@@ -1,12 +1,12 @@
-import type { PromptResult } from '../../../execution/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;
-}
+import type { PromptResult } from '../../../execution/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;
+}