@promptbook/cli 0.59.0-30 → 0.59.0-32

package/esm/typings/src/conversion/promptbookStringToJson.d.ts

@@ -27,4 +27,5 @@ export {};
  * TODO: Report here line/column of error
  * TODO: Use spaceTrim more effectively
  * TODO: [🧠] Parameter flags - isInput, isOutput, isInternal
+ * TODO: [🏏] Leverage the batch API and build queues @see https://platform.openai.com/docs/guides/batch
  */

package/esm/typings/src/execution/EmbeddingVector.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Represents a vector in an latent space of the embedding model
+ */
+export type EmbeddingVector = Array<number>;
+/**
+ * TODO: Figure out how to use library xyzt
+ *       Not using IVectorData due to HUGE dimensionality
+ */

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

@@ -4,6 +4,7 @@ import type { number_positive } from '../types/typeAliases';
 import type { number_usd } from '../types/typeAliases';
 import type { string_date_iso8601 } from '../types/typeAliases';
 import type { string_model_name } from '../types/typeAliases';
+import type { EmbeddingVector } from './EmbeddingVector';
 /**
  * Prompt result is the simplest concept of execution.
  * It is the result of executing one prompt _(NOT a template)_.
@@ -20,6 +21,16 @@ export type PromptCompletionResult = PromptCommonResult;
  * Prompt chat result
  */
 export type PromptChatResult = PromptCommonResult & {};
+/**
+ * Prompt embedding result
+ * It contains only the following text NOT the whole completion
+ */
+export type PromptEmbeddingResult = Omit<PromptCommonResult, 'content'> & {
+    /**
+     * The response from the model
+     */
+    content: EmbeddingVector;
+};
 export type PromptCommonResult = {
     /**
      * Exact text response from the model

package/esm/typings/src/execution/embeddingVectorToString.d.ts

@@ -0,0 +1,5 @@
+import type { EmbeddingVector } from './EmbeddingVector';
+/**
+ * Pretty print an embedding vector for logging
+ */
+export declare function embeddingVectorToString(embeddingVector: EmbeddingVector): string;

package/esm/typings/src/llm-providers/anthropic-claude/AnthropicClaudeExecutionTools.d.ts

@@ -27,6 +27,10 @@ export declare class AnthropicClaudeExecutionTools implements LlmExecutionTools
      * Calls Anthropic Claude API to use a complete model.
      */
     gptComplete(prompt: Pick<Prompt, 'content' | 'modelRequirements'>): Promise<PromptCompletionResult>;
+    /**
+     * Get the model that should be used as default
+     */
+    private getDefaultModel;
     /**
      * Default model for chat variant.
      */

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

@@ -2,6 +2,7 @@ import type { AvailableModel } from '../../execution/LlmExecutionTools';
 import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
 import type { PromptChatResult } from '../../execution/PromptResult';
 import type { PromptCompletionResult } from '../../execution/PromptResult';
+import type { PromptEmbeddingResult } from '../../execution/PromptResult';
 import type { Prompt } from '../../types/Prompt';
 import type { OpenAiExecutionToolsOptions } from './OpenAiExecutionToolsOptions';
 /**
@@ -28,9 +29,13 @@ export declare class OpenAiExecutionTools implements LlmExecutionTools {
      */
     gptComplete(prompt: Pick<Prompt, 'content' | 'modelRequirements'>): Promise<PromptCompletionResult>;
     /**
-     * !!!!
+     * Calls OpenAI API to use a embedding model
      */
-    embed(prompt: Pick<Prompt, 'content' | 'modelRequirements'>): Promise<PromptCompletionResult>;
+    embed(prompt: Pick<Prompt, 'content' | 'modelRequirements'>): Promise<PromptEmbeddingResult>;
+    /**
+     * Get the model that should be used as default
+     */
+    private getDefaultModel;
     /**
      * Default model for chat variant.
      */

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

@@ -1,12 +1,14 @@
 import type OpenAI from 'openai';
-import type { PromptResult } from '../../execution/PromptResult';
 import type { PromptResultUsage } from '../../execution/PromptResult';
 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 {PromptbookExecutionError} 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: PromptResult['content'], rawResponse: Pick<OpenAI.Chat.Completions.ChatCompletion | OpenAI.Completions.Completion, 'model' | 'usage'>): PromptResultUsage;
+resultContent: string, rawResponse: Pick<OpenAI.Chat.Completions.ChatCompletion | OpenAI.Completions.Completion | OpenAI.Embeddings.CreateEmbeddingResponse, 'model' | 'usage'>): PromptResultUsage;

package/esm/typings/src/types/PromptbookJson/MaterialKnowledgePieceJson.d.ts

@@ -1,3 +1,4 @@
+import type { EmbeddingVector } from '../../execution/EmbeddingVector';
 import type { string_keyword } from '../../utils/normalization/IKeywords';
 import type { string_href } from '../typeAliases';
 import type { string_markdown } from '../typeAliases';
@@ -11,7 +12,7 @@ export type MaterialKnowledgePieceJson = {
     readonly keywords: Array<string_keyword>;
     readonly index: Array<{
         modelName: string_model_name;
-        position: Array<number>;
+        position: EmbeddingVector;
     }>;
     readonly sources: Array<{
         title: string_markdown_text;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/cli",
-    "version": "0.59.0-30",
+    "version": "0.59.0-32",
     "description": "Library to supercharge your use of large language models",
     "private": false,
     "sideEffects": false,
@@ -52,7 +52,7 @@
         }
     ],
     "peerDependencies": {
-        "@promptbook/core": "0.59.0-30"
+        "@promptbook/core": "0.59.0-32"
     },
     "main": "./umd/index.umd.js",
     "module": "./esm/index.es.js",

package/umd/index.umd.js

@@ -147,7 +147,7 @@
     /**
      * The version of the Promptbook library
      */
-    var PROMPTBOOK_VERSION = '0.59.0-29';
+    var PROMPTBOOK_VERSION = '0.59.0-31';
 
     /**
      * Initializes testing `hello` command for Promptbook CLI utilities
@@ -441,7 +441,7 @@
      *     >  ex port function validatePromptbook(promptbook: unknown): asserts promptbook is PromptbookJson {
      */
 
-    var promptbookLibrary = [{title:"Prepare Keywords",promptbookUrl:"https://promptbook.studio/promptbook/prepare-keywords.ptbk.md",promptbookVersion:"0.59.0-29",parameters:[{name:"content",description:"The content",isInput:true,isOutput:false},{name:"keywords",description:"Keywords separated by comma",isInput:false,isOutput:true}],promptTemplates:[{name:"knowledge",title:"Knowledge",dependentParameterNames:["content"],executionType:"PROMPT_TEMPLATE",modelRequirements:{modelVariant:"CHAT",modelName:"claude-3-opus-20240229"},content:"You are experienced data researcher, detect the important keywords in the document.\n\n# Rules\n\n-   Write just keywords separated by comma\n\n# The document\n\nTake information from this document:\n\n> {content}",resultingParameterName:"keywords"}],knowledge:[]},{title:"Prepare Knowledge from Markdown",promptbookUrl:"https://promptbook.studio/promptbook/prepare-knowledge-from-markdown.ptbk.md",promptbookVersion:"0.59.0-29",parameters:[{name:"content",description:"Markdown document content",isInput:true,isOutput:false},{name:"knowledge",description:"The knowledge JSON object",isInput:false,isOutput:true}],promptTemplates:[{name:"knowledge",title:"Knowledge",dependentParameterNames:["content"],executionType:"PROMPT_TEMPLATE",modelRequirements:{modelVariant:"CHAT",modelName:"claude-3-opus-20240229"},content:"You are experienced data researcher, extract the important knowledge from the document.\n\n# Rules\n\n-   Make pieces of information concise, clear, and easy to understand\n-   One piece of information should be approximately 1 paragraph\n-   Divide the paragraphs by markdown horizontal lines ---\n-   Omit irrelevant information\n-   Group redundant information\n-   Write just extracted information, nothing else\n\n# The document\n\nTake information from this document:\n\n> {content}",resultingParameterName:"knowledge"}],knowledge:[]}];
+    var promptbookLibrary = [{title:"Prepare Keywords",promptbookUrl:"https://promptbook.studio/promptbook/prepare-keywords.ptbk.md",promptbookVersion:"0.59.0-31",parameters:[{name:"content",description:"The content",isInput:true,isOutput:false},{name:"keywords",description:"Keywords separated by comma",isInput:false,isOutput:true}],promptTemplates:[{name:"knowledge",title:"Knowledge",dependentParameterNames:["content"],executionType:"PROMPT_TEMPLATE",modelRequirements:{modelVariant:"CHAT",modelName:"claude-3-opus-20240229"},content:"You are experienced data researcher, detect the important keywords in the document.\n\n# Rules\n\n-   Write just keywords separated by comma\n\n# The document\n\nTake information from this document:\n\n> {content}",resultingParameterName:"keywords"}],knowledge:[]},{title:"Prepare Knowledge from Markdown",promptbookUrl:"https://promptbook.studio/promptbook/prepare-knowledge-from-markdown.ptbk.md",promptbookVersion:"0.59.0-31",parameters:[{name:"content",description:"Markdown document content",isInput:true,isOutput:false},{name:"knowledge",description:"The knowledge JSON object",isInput:false,isOutput:true}],promptTemplates:[{name:"knowledge",title:"Knowledge",dependentParameterNames:["content"],executionType:"PROMPT_TEMPLATE",modelRequirements:{modelVariant:"CHAT",modelName:"claude-3-opus-20240229"},content:"You are experienced data researcher, extract the important knowledge from the document.\n\n# Rules\n\n-   Make pieces of information concise, clear, and easy to understand\n-   One piece of information should be approximately 1 paragraph\n-   Divide the paragraphs by markdown horizontal lines ---\n-   Omit irrelevant information\n-   Group redundant information\n-   Write just extracted information, nothing else\n\n# The document\n\nTake information from this document:\n\n> {content}",resultingParameterName:"knowledge"}],knowledge:[]}];
 
     /**
      * This error indicates errors during the execution of the promptbook
@@ -3217,6 +3217,7 @@
      * TODO: Report here line/column of error
      * TODO: Use spaceTrim more effectively
      * TODO: [🧠] Parameter flags - isInput, isOutput, isInternal
+     * TODO: [🏏] Leverage the batch API and build queues @see https://platform.openai.com/docs/guides/batch
      */
 
     /**
@@ -3345,8 +3346,8 @@
                             console.info(colors__default["default"].yellow("Tip: Prebuild your promptbook library (file with supposed prebuild ".concat(makedLibraryFilePath, " not found) with CLI util \"promptbook make\" to speed up the library creation.")));
                         }
                         else {
-                            colors__default["default"].green("Using your prebuild promptbook library ".concat(makedLibraryFilePath));
-                            // TODO: !!!!! Implement;
+                            colors__default["default"].green("(In future, not implemented yet) Using your prebuild promptbook library ".concat(makedLibraryFilePath));
+                            // TODO: !! Implement;
                         }
                         _a = options || {}, _b = _a.isRecursive, isRecursive = _b === void 0 ? true : _b, _c = _a.isVerbose, isVerbose = _c === void 0 ? false : _c, _d = _a.isLazyLoaded, isLazyLoaded = _d === void 0 ? false : _d, _e = _a.isCrashOnError, isCrashOnError = _e === void 0 ? true : _e;
                         library = createLibraryFromPromise(function () { return __awaiter(_this, void 0, void 0, function () {
@@ -3661,7 +3662,7 @@
                                 return __generator(this, function (_a) {
                                     switch (_a.label) {
                                         case 0:
-                                            filePath = path.join(path$1, "promptbook-library.".concat(extension));
+                                            filePath = path.join(path$1, "".concat(PROMPTBOOK_MAKED_BASE_FILENAME, ".").concat(extension));
                                             return [4 /*yield*/, promises.writeFile(filePath, content, 'utf-8')];
                                         case 1:
                                             _a.sent();