@promptbook/execute-javascript - npm Package Compare versions

Comparing version 0.19.8 to 0.20.0

esm/typings/config.d.ts

@@ -9,3 +9,9 @@ import { ModelRequirements } from './types/ModelRequirements';
  * 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?
+ */

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

 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
  */

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

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

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

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

esm/typings/execution/NaturalExecutionTools.d.ts

@@ -21,3 +21,4 @@ import { Prompt } from '../types/Prompt';
 /**
+ * TODO: [🏳] gptChat -> chat, gptComplete -> complete, translate
  * TODO: [🧠] Should or should not there be a word "GPT" in both gptComplete and gptChat
  */

esm/typings/types/Command.d.ts

@@ -8,3 +8,3 @@ import { string_markdown_text, string_name, string_version } from '.././types/typeAliases';
  */
-export type Command = PtbkUrlCommand | PtbkVersionCommand | ExecuteCommand | UseCommand | ParameterCommand | PostprocessCommand;
+export type Command = PtbkUrlCommand | PtbkVersionCommand | ExecuteCommand | ModelCommand | ParameterCommand | PostprocessCommand;
 /**
@@ -39,6 +39,6 @@ * PtpVersion command tells which version is .ptp file using
 /**
- * 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;
@@ -45,0 +45,0 @@ readonly value: any;

esm/typings/types/ModelRequirements.d.ts

@@ -0,1 +1,2 @@
+import { string_model_name } from './typeAliases';
 export declare const MODEL_VARIANTS: readonly ["COMPLETION", "CHAT"];
@@ -23,4 +24,12 @@ /**
      */
-    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
@@ -27,0 +36,0 @@ */

package.json

 {
     "name": "@promptbook/execute-javascript",
-    "version": "0.19.8",
+    "version": "0.20.0",
     "description": "Library to supercharge your use of large language models",
@@ -42,3 +42,3 @@ "private": false,
     "peerDependencies": {
-        "@promptbook/core": "0.19.8"
+        "@promptbook/core": "0.20.0"
     },
@@ -45,0 +45,0 @@ "main": "./umd/index.umd.js",

umd/typings/config.d.ts

@@ -9,3 +9,9 @@ import { ModelRequirements } from './types/ModelRequirements';
  * 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?
+ */

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

 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
  */

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

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

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

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

umd/typings/execution/NaturalExecutionTools.d.ts

@@ -21,3 +21,4 @@ import { Prompt } from '../types/Prompt';
 /**
+ * TODO: [🏳] gptChat -> chat, gptComplete -> complete, translate
  * TODO: [🧠] Should or should not there be a word "GPT" in both gptComplete and gptChat
  */

umd/typings/types/Command.d.ts

@@ -8,3 +8,3 @@ import { string_markdown_text, string_name, string_version } from '.././types/typeAliases';
  */
-export type Command = PtbkUrlCommand | PtbkVersionCommand | ExecuteCommand | UseCommand | ParameterCommand | PostprocessCommand;
+export type Command = PtbkUrlCommand | PtbkVersionCommand | ExecuteCommand | ModelCommand | ParameterCommand | PostprocessCommand;
 /**
@@ -39,6 +39,6 @@ * PtpVersion command tells which version is .ptp file using
 /**
- * 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;
@@ -45,0 +45,0 @@ readonly value: any;

umd/typings/types/ModelRequirements.d.ts

@@ -0,1 +1,2 @@
+import { string_model_name } from './typeAliases';
 export declare const MODEL_VARIANTS: readonly ["COMPLETION", "CHAT"];
@@ -23,4 +24,12 @@ /**
      */
-    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
@@ -27,0 +36,0 @@ */

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

421178

increased by1.19%

Number of package files

206

increased by8.42%

Lines of code

5309

increased by2.35%

No dependency changes