@promptbook/remote-client 0.19.7 → 0.20.0

package/esm/typings/config.d.ts

@@ -6,5 +6,11 @@ import { string_version } from './types/typeAliases';
 export declare const PTBK_VERSION: string_version;
 /**
  * Default model requirements for the pipeline
+ *
+ * Note: As default, we use the chat model gpt-3.5-turbo. For most tasks, this is the best model with most intuitive usage.
+ *       GPT-4 is overkill for most tasks so keeping it as opt-in option.
  */
 export declare const DEFAULT_MODEL_REQUIREMENTS: ModelRequirements;
+/**
+ * TODO: [🧠] What should be the default model?
+ */

package/esm/typings/conversion/parseCommand.test.d.ts

@@ -1,7 +1,6 @@
 export {};
 /**
- * TODO: [🧠] Probbably change syntax USE -> MODEL
- * TODO: !!!! Allow to use other models
+ * TODO: [🧠] Probbably change syntax MODEL VARIANT -> MODEL
  * TODO: !!!! Allow to skip segments SKIP IF {foo} NOT DEFINED
  * TODO: !!! Allow to EXPECT 3 words
  */

package/esm/typings/conversion/promptTemplatePipelineStringToJson.test.d.ts

@@ -1 +1,4 @@
 export {};
+/**
+ * TODO: [💥] Some system to automatically generate tests for all the templates in the folder
+ */

package/esm/typings/conversion/validatePromptTemplatePipelineJson.test.d.ts

@@ -1 +1,4 @@
 export {};
+/**
+ * TODO: [💥] Some system to automatically generate tests for all the templates in the folder
+ */

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

@@ -18,5 +18,6 @@ export interface NaturalExecutionTools {
     gptComplete(prompt: Prompt): Promise<PromptCompletionResult>;
 }
 /**
+ * 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/translation/automatic-translate/automatic-translators/DebugAutomaticTranslator.d.ts

@@ -0,0 +1,9 @@
+import { IAutomaticTranslator } from './IAutomaticTranslator';
+/**
+ * This will wrap an automatic translator and log each translation into the console
+ */
+export declare class DebugAutomaticTranslator implements IAutomaticTranslator {
+    private readonly automaticTranslator;
+    constructor(automaticTranslator: IAutomaticTranslator);
+    translate(message: string): Promise<string>;
+}

package/esm/typings/execution/translation/automatic-translate/automatic-translators/FakeAutomaticTranslator.d.ts

@@ -0,0 +1,5 @@
+import { IAutomaticTranslator } from './IAutomaticTranslator';
+export declare class FakeAutomaticTranslator implements IAutomaticTranslator {
+    constructor();
+    translate(message: string): string;
+}

package/esm/typings/execution/translation/automatic-translate/automatic-translators/IAutomaticTranslator.d.ts

@@ -0,0 +1,4 @@
+import { Promisable } from 'type-fest';
+export interface IAutomaticTranslator {
+    translate(message: string): Promisable<string>;
+}

package/esm/typings/execution/translation/automatic-translate/automatic-translators/ITranslatorOptions.d.ts

@@ -0,0 +1,4 @@
+export interface ITranslatorOptions {
+    from: string;
+    to: string;
+}

package/esm/typings/execution/translation/automatic-translate/automatic-translators/LindatAutomaticTranslator.d.ts

@@ -0,0 +1,11 @@
+import { IAutomaticTranslator } from './IAutomaticTranslator';
+import { ITranslatorOptions } from './ITranslatorOptions';
+interface ILindatAutomaticTranslatorOptions extends ITranslatorOptions {
+    apiUrl: URL;
+}
+export declare class LindatAutomaticTranslator implements IAutomaticTranslator {
+    private readonly options;
+    constructor(options: ILindatAutomaticTranslatorOptions);
+    translate(message: string): Promise<string>;
+}
+export {};

package/esm/typings/execution/translation/automatic-translate/automatic-translators/utils/extractMultiplicatedOccurrence.d.ts

@@ -0,0 +1 @@
+export declare function extractMultiplicatedOccurrence(message: string): string;

package/esm/typings/execution/translation/automatic-translate/automatic-translators/utils/extractMultiplicatedOccurrence.test.d.ts

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

package/esm/typings/execution/translation/automatic-translate/translateMessages.d.ts

@@ -0,0 +1,5 @@
+import { IAutomaticTranslator } from './automatic-translators/IAutomaticTranslator';
+import { ITranslatorOptions } from './automatic-translators/ITranslatorOptions';
+export declare function translateMessages({ automaticTranslator, from, to, }: {
+    automaticTranslator: IAutomaticTranslator;
+} & ITranslatorOptions): Promise<void>;

package/esm/typings/types/Command.d.ts

@@ -5,7 +5,7 @@ import { ModelRequirements } from './ModelRequirements';
  * Command is one piece of the prompt template which adds some logic to the prompt template or the whole pipeline.
  * It is parsed from the markdown from ul/ol items - one command per one item.
  */
-export type Command = PtbkUrlCommand | PtbkVersionCommand | ExecuteCommand | UseCommand | ParameterCommand | PostprocessCommand;
+export type Command = PtbkUrlCommand | PtbkVersionCommand | ExecuteCommand | ModelCommand | ParameterCommand | PostprocessCommand;
 /**
  * PtpVersion command tells which version is .ptp file using
  *
@@ -35,10 +35,10 @@ export interface ExecuteCommand {
     readonly executionType: ExecutionType;
 }
 /**
- * Use command tells which model and modelRequirements to use for the prompt template. execution
+ * Model command tells which model and modelRequirements to use for the prompt template. execution
  */
-export interface UseCommand {
-    readonly type: 'USE';
+export interface ModelCommand {
+    readonly type: 'MODEL';
     readonly key: keyof ModelRequirements;
     readonly value: any;
 }

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

@@ -1,3 +1,4 @@
+import { string_model_name } from './typeAliases';
 export declare const MODEL_VARIANTS: readonly ["COMPLETION", "CHAT"];
 /**
  * Model variant describes the very general type of the model
@@ -20,7 +21,15 @@ export interface ModelRequirements {
      * - **COMPLETION** - model that takes prompt and writes the rest of the text
      * - **CHAT** - model that takes prompt and previous messages and returns response
      */
-    readonly variant: ModelVariant;
+    readonly modelVariant: ModelVariant;
+    /**
+     * The model for text prompt
+     *
+     * Note: Model must be compatible with the model variant
+     *
+     * @example 'gpt-4', 'gpt-4-32k-0314', 'gpt-3.5-turbo-instruct',...
+     */
+    readonly modelName: string_model_name;
     /**
      * Maximum number of tokens that can be generated by the model
      */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/remote-client",
-    "version": "0.19.7",
+    "version": "0.20.0",
     "description": "Library to supercharge your use of large language models",
     "private": false,
     "sideEffects": false,
@@ -37,7 +37,7 @@
         "socket.io-client": "4.7.2"
     },
     "peerDependencies": {
-        "@promptbook/core": "0.19.7"
+        "@promptbook/core": "0.20.0"
     },
     "main": "./umd/index.umd.js",
     "module": "./esm/index.es.js",

package/umd/typings/config.d.ts

@@ -6,5 +6,11 @@ import { string_version } from './types/typeAliases';
 export declare const PTBK_VERSION: string_version;
 /**
  * Default model requirements for the pipeline
+ *
+ * Note: As default, we use the chat model gpt-3.5-turbo. For most tasks, this is the best model with most intuitive usage.
+ *       GPT-4 is overkill for most tasks so keeping it as opt-in option.
  */
 export declare const DEFAULT_MODEL_REQUIREMENTS: ModelRequirements;
+/**
+ * TODO: [🧠] What should be the default model?
+ */

package/umd/typings/conversion/parseCommand.test.d.ts

@@ -1,7 +1,6 @@
 export {};
 /**
- * TODO: [🧠] Probbably change syntax USE -> MODEL
- * TODO: !!!! Allow to use other models
+ * TODO: [🧠] Probbably change syntax MODEL VARIANT -> MODEL
  * TODO: !!!! Allow to skip segments SKIP IF {foo} NOT DEFINED
  * TODO: !!! Allow to EXPECT 3 words
  */

package/umd/typings/conversion/promptTemplatePipelineStringToJson.test.d.ts

@@ -1 +1,4 @@
 export {};
+/**
+ * TODO: [💥] Some system to automatically generate tests for all the templates in the folder
+ */

package/umd/typings/conversion/validatePromptTemplatePipelineJson.test.d.ts

@@ -1 +1,4 @@
 export {};
+/**
+ * TODO: [💥] Some system to automatically generate tests for all the templates in the folder
+ */

package/umd/typings/execution/NaturalExecutionTools.d.ts

@@ -18,5 +18,6 @@ export interface NaturalExecutionTools {
     gptComplete(prompt: Prompt): Promise<PromptCompletionResult>;
 }
 /**
+ * TODO: [🏳] gptChat -> chat, gptComplete -> complete, translate
  * TODO: [🧠] Should or should not there be a word "GPT" in both gptComplete and gptChat
  */

package/umd/typings/execution/translation/automatic-translate/automatic-translators/DebugAutomaticTranslator.d.ts

@@ -0,0 +1,9 @@
+import { IAutomaticTranslator } from './IAutomaticTranslator';
+/**
+ * This will wrap an automatic translator and log each translation into the console
+ */
+export declare class DebugAutomaticTranslator implements IAutomaticTranslator {
+    private readonly automaticTranslator;
+    constructor(automaticTranslator: IAutomaticTranslator);
+    translate(message: string): Promise<string>;
+}

package/umd/typings/execution/translation/automatic-translate/automatic-translators/FakeAutomaticTranslator.d.ts

@@ -0,0 +1,5 @@
+import { IAutomaticTranslator } from './IAutomaticTranslator';
+export declare class FakeAutomaticTranslator implements IAutomaticTranslator {
+    constructor();
+    translate(message: string): string;
+}

package/umd/typings/execution/translation/automatic-translate/automatic-translators/IAutomaticTranslator.d.ts

@@ -0,0 +1,4 @@
+import { Promisable } from 'type-fest';
+export interface IAutomaticTranslator {
+    translate(message: string): Promisable<string>;
+}

package/umd/typings/execution/translation/automatic-translate/automatic-translators/ITranslatorOptions.d.ts

@@ -0,0 +1,4 @@
+export interface ITranslatorOptions {
+    from: string;
+    to: string;
+}

package/umd/typings/execution/translation/automatic-translate/automatic-translators/LindatAutomaticTranslator.d.ts

@@ -0,0 +1,11 @@
+import { IAutomaticTranslator } from './IAutomaticTranslator';
+import { ITranslatorOptions } from './ITranslatorOptions';
+interface ILindatAutomaticTranslatorOptions extends ITranslatorOptions {
+    apiUrl: URL;
+}
+export declare class LindatAutomaticTranslator implements IAutomaticTranslator {
+    private readonly options;
+    constructor(options: ILindatAutomaticTranslatorOptions);
+    translate(message: string): Promise<string>;
+}
+export {};

package/umd/typings/execution/translation/automatic-translate/automatic-translators/utils/extractMultiplicatedOccurrence.d.ts

@@ -0,0 +1 @@
+export declare function extractMultiplicatedOccurrence(message: string): string;

package/umd/typings/execution/translation/automatic-translate/automatic-translators/utils/extractMultiplicatedOccurrence.test.d.ts

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

package/umd/typings/execution/translation/automatic-translate/translateMessages.d.ts

@@ -0,0 +1,5 @@
+import { IAutomaticTranslator } from './automatic-translators/IAutomaticTranslator';
+import { ITranslatorOptions } from './automatic-translators/ITranslatorOptions';
+export declare function translateMessages({ automaticTranslator, from, to, }: {
+    automaticTranslator: IAutomaticTranslator;
+} & ITranslatorOptions): Promise<void>;

package/umd/typings/types/Command.d.ts

@@ -5,7 +5,7 @@ import { ModelRequirements } from './ModelRequirements';
  * Command is one piece of the prompt template which adds some logic to the prompt template or the whole pipeline.
  * It is parsed from the markdown from ul/ol items - one command per one item.
  */
-export type Command = PtbkUrlCommand | PtbkVersionCommand | ExecuteCommand | UseCommand | ParameterCommand | PostprocessCommand;
+export type Command = PtbkUrlCommand | PtbkVersionCommand | ExecuteCommand | ModelCommand | ParameterCommand | PostprocessCommand;
 /**
  * PtpVersion command tells which version is .ptp file using
  *
@@ -35,10 +35,10 @@ export interface ExecuteCommand {
     readonly executionType: ExecutionType;
 }
 /**
- * Use command tells which model and modelRequirements to use for the prompt template. execution
+ * Model command tells which model and modelRequirements to use for the prompt template. execution
  */
-export interface UseCommand {
-    readonly type: 'USE';
+export interface ModelCommand {
+    readonly type: 'MODEL';
     readonly key: keyof ModelRequirements;
     readonly value: any;
 }

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

@@ -1,3 +1,4 @@
+import { string_model_name } from './typeAliases';
 export declare const MODEL_VARIANTS: readonly ["COMPLETION", "CHAT"];
 /**
  * Model variant describes the very general type of the model
@@ -20,7 +21,15 @@ export interface ModelRequirements {
      * - **COMPLETION** - model that takes prompt and writes the rest of the text
      * - **CHAT** - model that takes prompt and previous messages and returns response
      */
-    readonly variant: ModelVariant;
+    readonly modelVariant: ModelVariant;
+    /**
+     * The model for text prompt
+     *
+     * Note: Model must be compatible with the model variant
+     *
+     * @example 'gpt-4', 'gpt-4-32k-0314', 'gpt-3.5-turbo-instruct',...
+     */
+    readonly modelName: string_model_name;
     /**
      * Maximum number of tokens that can be generated by the model
      */