@promptbook/types 0.59.0-30 → 0.59.0-31

package/esm/index.es.js

@@ -11,7 +11,7 @@ var EXPECTATION_UNITS = ['CHARACTERS', 'WORDS', 'SENTENCES', 'LINES', 'PARAGRAPH
 /**
  * The version of the Promptbook library
  */
-var PROMPTBOOK_VERSION = '0.59.0-29';
+var PROMPTBOOK_VERSION = '0.59.0-30';
 
 export { EXPECTATION_UNITS, PROMPTBOOK_VERSION };
 //# sourceMappingURL=index.es.js.map

package/esm/typings/src/_packages/core.index.d.ts

@@ -13,6 +13,7 @@ import { TemplateError } from '../errors/TemplateError';
 import { UnexpectedError } from '../errors/UnexpectedError';
 import { assertsExecutionSuccessful } from '../execution/assertsExecutionSuccessful';
 import { createPromptbookExecutor } from '../execution/createPromptbookExecutor';
+import { embeddingVectorToString } from '../execution/embeddingVectorToString';
 import { addUsage } from '../execution/utils/addUsage';
 import { checkExpectations, isPassingExpectations } from '../execution/utils/checkExpectations';
 import { usageToWorktime } from '../execution/utils/usageToWorktime';
@@ -33,7 +34,7 @@ import { ExecutionTypes } from '../types/ExecutionTypes';
 import { PROMPTBOOK_VERSION } from '../version';
 export { PROMPTBOOK_VERSION };
 export { ExecutionTypes };
-export { addUsage, assertsExecutionSuccessful, checkExpectations, executionReportJsonToString, ExecutionReportStringOptions, ExecutionReportStringOptionsDefaults, isPassingExpectations, prepareKnowledgeFromMarkdown, prettifyPromptbookString, usageToWorktime, };
+export { addUsage, assertsExecutionSuccessful, checkExpectations, embeddingVectorToString, executionReportJsonToString, ExecutionReportStringOptions, ExecutionReportStringOptionsDefaults, isPassingExpectations, prepareKnowledgeFromMarkdown, prettifyPromptbookString, usageToWorktime, };
 export { createLibraryFromJson, createLibraryFromPromise, createLibraryFromUrl, createSublibrary, libraryToJson };
 export { SimplePromptInterfaceTools };
 export { promptbookJsonToString, promptbookStringToJson, validatePromptbook };

package/esm/typings/src/_packages/types.index.d.ts

@@ -1,7 +1,8 @@
 import type { CommonExecutionToolsOptions } from '../execution/CommonExecutionToolsOptions';
+import { EmbeddingVector } from '../execution/EmbeddingVector';
 import type { ExecutionTools } from '../execution/ExecutionTools';
 import type { AvailableModel, LlmExecutionTools } from '../execution/LlmExecutionTools';
-import type { PromptChatResult, PromptCommonResult, PromptCompletionResult, PromptResult, PromptResultUsage, PromptResultUsageCounts, UncertainNumber } from '../execution/PromptResult';
+import type { PromptEmbeddingResult, PromptChatResult, PromptCommonResult, PromptCompletionResult, PromptResult, PromptResultUsage, PromptResultUsageCounts, UncertainNumber } from '../execution/PromptResult';
 import type { PromptbookExecutor } from '../execution/PromptbookExecutor';
 import type { ScriptExecutionTools, ScriptExecutionToolsExecuteOptions } from '../execution/ScriptExecutionTools';
 import type { UserInterfaceTools, UserInterfaceToolsPromptDialogOptions } from '../execution/UserInterfaceTools';
@@ -26,7 +27,7 @@ import type { FromtoItems } from '../utils/FromtoItems';
 import { PROMPTBOOK_VERSION } from '../version';
 export { PROMPTBOOK_VERSION };
 export { EXPECTATION_UNITS };
-export type { AvailableModel, client_id, CommonExecutionToolsOptions, ExecutionReportJson, ExecutionTools, ExecutionType, ExpectationAmount, Expectations, ExpectationUnit, FromtoItems, KnowledgeJson, LlmExecutionTools, LlmTemplateJson, MaterialKnowledgePieceJson, ModelRequirements, ModelVariant, Parameters, Prompt, PromptbookExecutor, PromptbookJson, PromptbookLibrary, PromptbookString, PromptChatResult, PromptCommonResult, PromptCompletionResult, PromptDialogJson, PromptResult, PromptResultUsage, PromptResultUsageCounts, PromptTemplateJson, PromptTemplateParameterJson, ScriptExecutionTools, ScriptExecutionToolsExecuteOptions, ScriptJson, ScriptLanguage, SimpleTemplateJson, string_char, string_char_emoji, string_chat_prompt, string_completion_prompt, string_data_url, string_domain, string_email, string_file_absolute_path, string_file_extension, string_file_path, string_file_relative_path, string_filename, string_folder_absolute_path, string_folder_path, string_folder_relative_path, string_host, string_hostname, string_href, string_html, string_javascript, string_javascript_name, string_license, string_markdown, string_markdown_text, string_mime_type, string_mime_type_with_wildcard, string_model_name, string_name, string_person_fullname, string_prompt, string_promptbook_url, string_promptbook_url_with_hashtemplate, string_script, string_sha256, string_tdl, string_template, string_text_prompt, string_title, string_token, string_translate_language, string_uri, string_uri_part, string_url, string_url_image, string_version, TaskProgress, UncertainNumber, UserInterfaceTools, UserInterfaceToolsPromptDialogOptions, };
+export type { AvailableModel, client_id, CommonExecutionToolsOptions, ExecutionReportJson, ExecutionTools, ExecutionType, ExpectationAmount, Expectations, ExpectationUnit, FromtoItems, KnowledgeJson, LlmExecutionTools, LlmTemplateJson, MaterialKnowledgePieceJson, ModelRequirements, ModelVariant, Parameters, Prompt, PromptbookExecutor, PromptbookJson, PromptbookLibrary, PromptbookString, PromptChatResult, PromptEmbeddingResult, EmbeddingVector, PromptCommonResult, PromptCompletionResult, PromptDialogJson, PromptResult, PromptResultUsage, PromptResultUsageCounts, PromptTemplateJson, PromptTemplateParameterJson, ScriptExecutionTools, ScriptExecutionToolsExecuteOptions, ScriptJson, ScriptLanguage, SimpleTemplateJson, string_char, string_char_emoji, string_chat_prompt, string_completion_prompt, string_data_url, string_domain, string_email, string_file_absolute_path, string_file_extension, string_file_path, string_file_relative_path, string_filename, string_folder_absolute_path, string_folder_path, string_folder_relative_path, string_host, string_hostname, string_href, string_html, string_javascript, string_javascript_name, string_license, string_markdown, string_markdown_text, string_mime_type, string_mime_type_with_wildcard, string_model_name, string_name, string_person_fullname, string_prompt, string_promptbook_url, string_promptbook_url_with_hashtemplate, string_script, string_sha256, string_tdl, string_template, string_text_prompt, string_title, string_token, string_translate_language, string_uri, string_uri_part, string_url, string_url_image, string_version, TaskProgress, UncertainNumber, UserInterfaceTools, UserInterfaceToolsPromptDialogOptions, };
 /**
  * TODO: Delete type aliases (from ../types/typeAliases) that are not exported here
  */

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/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,9 @@ 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>;
     /**
      * 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/types",
-    "version": "0.59.0-30",
+    "version": "0.59.0-31",
     "description": "Library to supercharge your use of large language models",
     "private": false,
     "sideEffects": false,
@@ -45,7 +45,7 @@
         }
     ],
     "peerDependencies": {
-        "@promptbook/core": "0.59.0-30"
+        "@promptbook/core": "0.59.0-31"
     },
     "main": "./umd/index.umd.js",
     "module": "./esm/index.es.js",

package/umd/index.umd.js

@@ -17,7 +17,7 @@
 	/**
 	 * The version of the Promptbook library
 	 */
-	var PROMPTBOOK_VERSION = '0.59.0-29';
+	var PROMPTBOOK_VERSION = '0.59.0-30';
 
 	exports.EXPECTATION_UNITS = EXPECTATION_UNITS;
 	exports.PROMPTBOOK_VERSION = PROMPTBOOK_VERSION;

package/umd/typings/src/_packages/core.index.d.ts

@@ -13,6 +13,7 @@ import { TemplateError } from '../errors/TemplateError';
 import { UnexpectedError } from '../errors/UnexpectedError';
 import { assertsExecutionSuccessful } from '../execution/assertsExecutionSuccessful';
 import { createPromptbookExecutor } from '../execution/createPromptbookExecutor';
+import { embeddingVectorToString } from '../execution/embeddingVectorToString';
 import { addUsage } from '../execution/utils/addUsage';
 import { checkExpectations, isPassingExpectations } from '../execution/utils/checkExpectations';
 import { usageToWorktime } from '../execution/utils/usageToWorktime';
@@ -33,7 +34,7 @@ import { ExecutionTypes } from '../types/ExecutionTypes';
 import { PROMPTBOOK_VERSION } from '../version';
 export { PROMPTBOOK_VERSION };
 export { ExecutionTypes };
-export { addUsage, assertsExecutionSuccessful, checkExpectations, executionReportJsonToString, ExecutionReportStringOptions, ExecutionReportStringOptionsDefaults, isPassingExpectations, prepareKnowledgeFromMarkdown, prettifyPromptbookString, usageToWorktime, };
+export { addUsage, assertsExecutionSuccessful, checkExpectations, embeddingVectorToString, executionReportJsonToString, ExecutionReportStringOptions, ExecutionReportStringOptionsDefaults, isPassingExpectations, prepareKnowledgeFromMarkdown, prettifyPromptbookString, usageToWorktime, };
 export { createLibraryFromJson, createLibraryFromPromise, createLibraryFromUrl, createSublibrary, libraryToJson };
 export { SimplePromptInterfaceTools };
 export { promptbookJsonToString, promptbookStringToJson, validatePromptbook };

package/umd/typings/src/_packages/types.index.d.ts

@@ -1,7 +1,8 @@
 import type { CommonExecutionToolsOptions } from '../execution/CommonExecutionToolsOptions';
+import { EmbeddingVector } from '../execution/EmbeddingVector';
 import type { ExecutionTools } from '../execution/ExecutionTools';
 import type { AvailableModel, LlmExecutionTools } from '../execution/LlmExecutionTools';
-import type { PromptChatResult, PromptCommonResult, PromptCompletionResult, PromptResult, PromptResultUsage, PromptResultUsageCounts, UncertainNumber } from '../execution/PromptResult';
+import type { PromptEmbeddingResult, PromptChatResult, PromptCommonResult, PromptCompletionResult, PromptResult, PromptResultUsage, PromptResultUsageCounts, UncertainNumber } from '../execution/PromptResult';
 import type { PromptbookExecutor } from '../execution/PromptbookExecutor';
 import type { ScriptExecutionTools, ScriptExecutionToolsExecuteOptions } from '../execution/ScriptExecutionTools';
 import type { UserInterfaceTools, UserInterfaceToolsPromptDialogOptions } from '../execution/UserInterfaceTools';
@@ -26,7 +27,7 @@ import type { FromtoItems } from '../utils/FromtoItems';
 import { PROMPTBOOK_VERSION } from '../version';
 export { PROMPTBOOK_VERSION };
 export { EXPECTATION_UNITS };
-export type { AvailableModel, client_id, CommonExecutionToolsOptions, ExecutionReportJson, ExecutionTools, ExecutionType, ExpectationAmount, Expectations, ExpectationUnit, FromtoItems, KnowledgeJson, LlmExecutionTools, LlmTemplateJson, MaterialKnowledgePieceJson, ModelRequirements, ModelVariant, Parameters, Prompt, PromptbookExecutor, PromptbookJson, PromptbookLibrary, PromptbookString, PromptChatResult, PromptCommonResult, PromptCompletionResult, PromptDialogJson, PromptResult, PromptResultUsage, PromptResultUsageCounts, PromptTemplateJson, PromptTemplateParameterJson, ScriptExecutionTools, ScriptExecutionToolsExecuteOptions, ScriptJson, ScriptLanguage, SimpleTemplateJson, string_char, string_char_emoji, string_chat_prompt, string_completion_prompt, string_data_url, string_domain, string_email, string_file_absolute_path, string_file_extension, string_file_path, string_file_relative_path, string_filename, string_folder_absolute_path, string_folder_path, string_folder_relative_path, string_host, string_hostname, string_href, string_html, string_javascript, string_javascript_name, string_license, string_markdown, string_markdown_text, string_mime_type, string_mime_type_with_wildcard, string_model_name, string_name, string_person_fullname, string_prompt, string_promptbook_url, string_promptbook_url_with_hashtemplate, string_script, string_sha256, string_tdl, string_template, string_text_prompt, string_title, string_token, string_translate_language, string_uri, string_uri_part, string_url, string_url_image, string_version, TaskProgress, UncertainNumber, UserInterfaceTools, UserInterfaceToolsPromptDialogOptions, };
+export type { AvailableModel, client_id, CommonExecutionToolsOptions, ExecutionReportJson, ExecutionTools, ExecutionType, ExpectationAmount, Expectations, ExpectationUnit, FromtoItems, KnowledgeJson, LlmExecutionTools, LlmTemplateJson, MaterialKnowledgePieceJson, ModelRequirements, ModelVariant, Parameters, Prompt, PromptbookExecutor, PromptbookJson, PromptbookLibrary, PromptbookString, PromptChatResult, PromptEmbeddingResult, EmbeddingVector, PromptCommonResult, PromptCompletionResult, PromptDialogJson, PromptResult, PromptResultUsage, PromptResultUsageCounts, PromptTemplateJson, PromptTemplateParameterJson, ScriptExecutionTools, ScriptExecutionToolsExecuteOptions, ScriptJson, ScriptLanguage, SimpleTemplateJson, string_char, string_char_emoji, string_chat_prompt, string_completion_prompt, string_data_url, string_domain, string_email, string_file_absolute_path, string_file_extension, string_file_path, string_file_relative_path, string_filename, string_folder_absolute_path, string_folder_path, string_folder_relative_path, string_host, string_hostname, string_href, string_html, string_javascript, string_javascript_name, string_license, string_markdown, string_markdown_text, string_mime_type, string_mime_type_with_wildcard, string_model_name, string_name, string_person_fullname, string_prompt, string_promptbook_url, string_promptbook_url_with_hashtemplate, string_script, string_sha256, string_tdl, string_template, string_text_prompt, string_title, string_token, string_translate_language, string_uri, string_uri_part, string_url, string_url_image, string_version, TaskProgress, UncertainNumber, UserInterfaceTools, UserInterfaceToolsPromptDialogOptions, };
 /**
  * TODO: Delete type aliases (from ../types/typeAliases) that are not exported here
  */

package/umd/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/umd/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/umd/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/umd/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,9 @@ 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>;
     /**
      * Default model for chat variant.
      */

package/umd/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/umd/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;