@promptbook/remote-client 0.54.1 → 0.55.0-1

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

@@ -11,6 +11,7 @@ import { PromptbookReferenceError } from '../errors/PromptbookReferenceError';
 import { PromptbookSyntaxError } from '../errors/PromptbookSyntaxError';
 import { TemplateError } from '../errors/TemplateError';
 import { UnexpectedError } from '../errors/UnexpectedError';
+import { addPromptResultUsage } from '../execution/addPromptResultUsage';
 import { assertsExecutionSuccessful } from '../execution/assertsExecutionSuccessful';
 import { createPromptbookExecutor } from '../execution/createPromptbookExecutor';
 import { MultipleLlmExecutionTools } from '../execution/plugins/llm-execution-tools/multiple/MultipleLlmExecutionTools';
@@ -30,7 +31,7 @@ import { ExecutionTypes } from '../types/ExecutionTypes';
 import { PROMPTBOOK_VERSION } from '../version';
 export { justTestFsImport };
 export { ExecutionTypes, PROMPTBOOK_VERSION };
-export { assertsExecutionSuccessful, checkExpectations, executionReportJsonToString, ExecutionReportStringOptions, ExecutionReportStringOptionsDefaults, isPassingExpectations, prettifyPromptbookString, };
+export { addPromptResultUsage, assertsExecutionSuccessful, checkExpectations, executionReportJsonToString, ExecutionReportStringOptions, ExecutionReportStringOptionsDefaults, isPassingExpectations, prettifyPromptbookString, };
 export { createPromptbookLibraryFromDirectory, createPromptbookLibraryFromSources, createPromptbookLibraryFromUrl, createPromptbookSublibrary, SimplePromptbookLibrary, };
 export { SimplePromptInterfaceTools };
 export { promptbookJsonToString, promptbookStringToJson, validatePromptbookJson };

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

@@ -1,7 +1,7 @@
 import type { CommonExecutionToolsOptions } from '../execution/CommonExecutionToolsOptions';
 import type { ExecutionTools } from '../execution/ExecutionTools';
 import type { AvailableModel, LlmExecutionTools } from '../execution/LlmExecutionTools';
-import type { PromptChatResult, PromptCommonResult, PromptCompletionResult, PromptResult } from '../execution/PromptResult';
+import type { 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';
@@ -21,7 +21,7 @@ import type { ExecutionReportJson } from '../types/execution-report/ExecutionRep
 import type { string_char_emoji } from '../types/typeAliasEmoji';
 import type { client_id, string_char, 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 } from '../types/typeAliases';
 import { FromtoItems } from '../utils/FromtoItems';
-export { AvailableModel, client_id, CommonExecutionToolsOptions, ExecutionReportJson, ExecutionTools, ExecutionType, EXPECTATION_UNITS, ExpectationAmount, Expectations, ExpectationUnit, FromtoItems, LlmExecutionTools, LlmTemplateJson, ModelRequirements, ModelVariant, Parameters, Prompt, PromptbookExecutor, PromptbookJson, PromptbookLibrary, PromptbookString, PromptChatResult, PromptCommonResult, PromptCompletionResult, PromptDialogJson, PromptResult, 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, UserInterfaceTools, UserInterfaceToolsPromptDialogOptions, };
+export { AvailableModel, client_id, CommonExecutionToolsOptions, ExecutionReportJson, ExecutionTools, ExecutionType, EXPECTATION_UNITS, ExpectationAmount, Expectations, ExpectationUnit, FromtoItems, LlmExecutionTools, LlmTemplateJson, 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, };
 /**
  * TODO: Delete type aliases (from ../types/typeAliases) that are not exported here
  */

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

@@ -1,5 +1,6 @@
-import type { number_positive_or_zero } from '../types/typeAliases';
-import type { number_tokens } from '../types/typeAliases';
+import type { KebabCase } from 'type-fest';
+import type { ExpectationUnit } from '../types/PromptbookJson/PromptTemplateJson';
+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';
@@ -48,27 +49,51 @@ export type PromptCommonResult = {
     /**
      * Usage of the prompt execution
      */
-    readonly usage: {
-        /**
-         * Cost of the execution in USD
-         *
-         * If the cost is unknown, the value is `'UNKNOWN'`
-         */
-        price: (number_positive_or_zero & number_usd) | 'UNKNOWN';
-        /**
-         * Number of tokens used in the input aka. `prompt_tokens`
-         */
-        inputTokens: number_tokens | 'UNKNOWN';
-        /**
-         * Number of tokens used in the output aka. `completion_tokens`
-         */
-        outputTokens: number_tokens | 'UNKNOWN';
-    };
+    readonly usage: PromptResultUsage;
     /**
      * Raw response from the model
      */
     readonly rawResponse: object;
 };
+/**
+ * Usage statistics for one or many prompt results
+ */
+export type PromptResultUsage = {
+    /**
+     * Cost of the execution in USD
+     *
+     * Note: If the cost is unknown, the value 0 and isUncertain is true
+     */
+    price: UncertainNumber;
+    /**
+     * Number of whatever used in the input aka. `prompt_tokens`
+     */
+    input: PromptResultUsageCounts;
+    /**
+     * Number of tokens used in the output aka. `completion_tokens`
+     */
+    output: PromptResultUsageCounts;
+};
+/**
+ * Record of all possible measurable units
+ */
+export type PromptResultUsageCounts = Record<`${KebabCase<'TOKENS' | ExpectationUnit>}Count`, UncertainNumber>;
+/**
+ * Number which can be uncertain
+ *
+ * Note: If the value is completelly unknown, the value 0 and isUncertain is true
+ * Note: Not using NaN or null because it looses the value which is better to be uncertain then not to be at all
+ */
+export type UncertainNumber = {
+    /**
+     * The numeric value
+     */
+    value: number_usd & (number_positive | 0);
+    /**
+     * Is the value uncertain
+     */
+    isUncertain?: true;
+};
 /**
  * TODO: [🧠] Maybe timing more accurate then seconds?
  * TODO: [🧠] Should here be link to the prompt?

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

@@ -0,0 +1,7 @@
+import type { PromptResultUsage } from './PromptResult';
+/**
+ * Function addPromptResultUsage will add multiple usages into one
+ *
+ * Note: If you provide 0 values, it returns void usage
+ */
+export declare function addPromptResultUsage(...usageItems: Array<PromptResultUsage>): PromptResultUsage;

package/esm/typings/execution/addPromptResultUsage.test.d.ts

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

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

@@ -0,0 +1,10 @@
+import type { PromptResultUsageCounts } from './PromptResult';
+/**
+ * Helper of usage compute
+ *
+ * @param content the content of prompt or response
+ * @returns part of PromptResultUsageCounts
+ *
+ * @private internal util of LlmExecutionTools
+ */
+export declare function computeUsageCounts(content: string): Omit<PromptResultUsageCounts, 'tokensCount'>;

package/esm/typings/execution/plugins/llm-execution-tools/openai/computeOpenaiUsage.d.ts

@@ -1,8 +1,12 @@
 import type OpenAI from 'openai';
+import type { Prompt } from '../../../../types/Prompt';
 import type { PromptResult } from '../../../PromptResult';
+import type { PromptResultUsage } from '../../../PromptResult';
 /**
  * Computes the usage of the OpenAI API based on the response from OpenAI
  *
  * @throws {PromptbookExecutionError} If the usage is not defined in the response from OpenAI
+ * @private internal util of `OpenAiExecutionTools`
  */
-export declare function computeOpenaiUsage(rawResponse: Pick<OpenAI.Chat.Completions.ChatCompletion | OpenAI.Completions.Completion, 'model' | 'usage'>): PromptResult['usage'];
+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;

package/esm/typings/types/PromptbookJson/PromptTemplateJson.d.ts

@@ -3,11 +3,11 @@ import type { ExecutionType } from '../ExecutionTypes';
 import type { ModelRequirements } from '../ModelRequirements';
 import type { ScriptLanguage } from '../ScriptLanguage';
 import type { number_integer } from '../typeAliases';
-import type { string_markdown_text } from '../typeAliases';
-import type { number_positive_or_zero } from '../typeAliases';
+import type { number_positive } from '../typeAliases';
 import type { string_javascript } from '../typeAliases';
 import type { string_javascript_name } from '../typeAliases';
 import type { string_markdown } from '../typeAliases';
+import type { string_markdown_text } from '../typeAliases';
 import type { string_name } from '../typeAliases';
 import type { string_prompt } from '../typeAliases';
 import type { string_template } from '../typeAliases';
@@ -48,7 +48,7 @@ export type ExpectationUnit = typeof EXPECTATION_UNITS[number];
 /**
  * Amount of text measurement
  */
-export type ExpectationAmount = number_integer & number_positive_or_zero;
+export type ExpectationAmount = number_integer & (number_positive | 0);
 /**
  * Template for simple concatenation of strings
  */

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

@@ -393,11 +393,9 @@ export type number_usd = number;
 /**
  * Semantic helper for number of tokens
  */
-export type number_tokens = number_integer & number_positive_or_zero;
+export type number_tokens = number_integer & (number_positive | 0);
 export type number_positive = number;
 export type number_negative = number;
-export type number_positive_or_zero = number;
-export type number_negative_or_zero = number;
 export type number_integer = number;
 /**
  * Semantic helper;

package/package.json

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

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

@@ -11,6 +11,7 @@ import { PromptbookReferenceError } from '../errors/PromptbookReferenceError';
 import { PromptbookSyntaxError } from '../errors/PromptbookSyntaxError';
 import { TemplateError } from '../errors/TemplateError';
 import { UnexpectedError } from '../errors/UnexpectedError';
+import { addPromptResultUsage } from '../execution/addPromptResultUsage';
 import { assertsExecutionSuccessful } from '../execution/assertsExecutionSuccessful';
 import { createPromptbookExecutor } from '../execution/createPromptbookExecutor';
 import { MultipleLlmExecutionTools } from '../execution/plugins/llm-execution-tools/multiple/MultipleLlmExecutionTools';
@@ -30,7 +31,7 @@ import { ExecutionTypes } from '../types/ExecutionTypes';
 import { PROMPTBOOK_VERSION } from '../version';
 export { justTestFsImport };
 export { ExecutionTypes, PROMPTBOOK_VERSION };
-export { assertsExecutionSuccessful, checkExpectations, executionReportJsonToString, ExecutionReportStringOptions, ExecutionReportStringOptionsDefaults, isPassingExpectations, prettifyPromptbookString, };
+export { addPromptResultUsage, assertsExecutionSuccessful, checkExpectations, executionReportJsonToString, ExecutionReportStringOptions, ExecutionReportStringOptionsDefaults, isPassingExpectations, prettifyPromptbookString, };
 export { createPromptbookLibraryFromDirectory, createPromptbookLibraryFromSources, createPromptbookLibraryFromUrl, createPromptbookSublibrary, SimplePromptbookLibrary, };
 export { SimplePromptInterfaceTools };
 export { promptbookJsonToString, promptbookStringToJson, validatePromptbookJson };

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

@@ -1,7 +1,7 @@
 import type { CommonExecutionToolsOptions } from '../execution/CommonExecutionToolsOptions';
 import type { ExecutionTools } from '../execution/ExecutionTools';
 import type { AvailableModel, LlmExecutionTools } from '../execution/LlmExecutionTools';
-import type { PromptChatResult, PromptCommonResult, PromptCompletionResult, PromptResult } from '../execution/PromptResult';
+import type { 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';
@@ -21,7 +21,7 @@ import type { ExecutionReportJson } from '../types/execution-report/ExecutionRep
 import type { string_char_emoji } from '../types/typeAliasEmoji';
 import type { client_id, string_char, 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 } from '../types/typeAliases';
 import { FromtoItems } from '../utils/FromtoItems';
-export { AvailableModel, client_id, CommonExecutionToolsOptions, ExecutionReportJson, ExecutionTools, ExecutionType, EXPECTATION_UNITS, ExpectationAmount, Expectations, ExpectationUnit, FromtoItems, LlmExecutionTools, LlmTemplateJson, ModelRequirements, ModelVariant, Parameters, Prompt, PromptbookExecutor, PromptbookJson, PromptbookLibrary, PromptbookString, PromptChatResult, PromptCommonResult, PromptCompletionResult, PromptDialogJson, PromptResult, 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, UserInterfaceTools, UserInterfaceToolsPromptDialogOptions, };
+export { AvailableModel, client_id, CommonExecutionToolsOptions, ExecutionReportJson, ExecutionTools, ExecutionType, EXPECTATION_UNITS, ExpectationAmount, Expectations, ExpectationUnit, FromtoItems, LlmExecutionTools, LlmTemplateJson, 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, };
 /**
  * TODO: Delete type aliases (from ../types/typeAliases) that are not exported here
  */

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

@@ -1,5 +1,6 @@
-import type { number_positive_or_zero } from '../types/typeAliases';
-import type { number_tokens } from '../types/typeAliases';
+import type { KebabCase } from 'type-fest';
+import type { ExpectationUnit } from '../types/PromptbookJson/PromptTemplateJson';
+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';
@@ -48,27 +49,51 @@ export type PromptCommonResult = {
     /**
      * Usage of the prompt execution
      */
-    readonly usage: {
-        /**
-         * Cost of the execution in USD
-         *
-         * If the cost is unknown, the value is `'UNKNOWN'`
-         */
-        price: (number_positive_or_zero & number_usd) | 'UNKNOWN';
-        /**
-         * Number of tokens used in the input aka. `prompt_tokens`
-         */
-        inputTokens: number_tokens | 'UNKNOWN';
-        /**
-         * Number of tokens used in the output aka. `completion_tokens`
-         */
-        outputTokens: number_tokens | 'UNKNOWN';
-    };
+    readonly usage: PromptResultUsage;
     /**
      * Raw response from the model
      */
     readonly rawResponse: object;
 };
+/**
+ * Usage statistics for one or many prompt results
+ */
+export type PromptResultUsage = {
+    /**
+     * Cost of the execution in USD
+     *
+     * Note: If the cost is unknown, the value 0 and isUncertain is true
+     */
+    price: UncertainNumber;
+    /**
+     * Number of whatever used in the input aka. `prompt_tokens`
+     */
+    input: PromptResultUsageCounts;
+    /**
+     * Number of tokens used in the output aka. `completion_tokens`
+     */
+    output: PromptResultUsageCounts;
+};
+/**
+ * Record of all possible measurable units
+ */
+export type PromptResultUsageCounts = Record<`${KebabCase<'TOKENS' | ExpectationUnit>}Count`, UncertainNumber>;
+/**
+ * Number which can be uncertain
+ *
+ * Note: If the value is completelly unknown, the value 0 and isUncertain is true
+ * Note: Not using NaN or null because it looses the value which is better to be uncertain then not to be at all
+ */
+export type UncertainNumber = {
+    /**
+     * The numeric value
+     */
+    value: number_usd & (number_positive | 0);
+    /**
+     * Is the value uncertain
+     */
+    isUncertain?: true;
+};
 /**
  * TODO: [🧠] Maybe timing more accurate then seconds?
  * TODO: [🧠] Should here be link to the prompt?

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

@@ -0,0 +1,7 @@
+import type { PromptResultUsage } from './PromptResult';
+/**
+ * Function addPromptResultUsage will add multiple usages into one
+ *
+ * Note: If you provide 0 values, it returns void usage
+ */
+export declare function addPromptResultUsage(...usageItems: Array<PromptResultUsage>): PromptResultUsage;

package/umd/typings/execution/addPromptResultUsage.test.d.ts

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

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

@@ -0,0 +1,10 @@
+import type { PromptResultUsageCounts } from './PromptResult';
+/**
+ * Helper of usage compute
+ *
+ * @param content the content of prompt or response
+ * @returns part of PromptResultUsageCounts
+ *
+ * @private internal util of LlmExecutionTools
+ */
+export declare function computeUsageCounts(content: string): Omit<PromptResultUsageCounts, 'tokensCount'>;

package/umd/typings/execution/plugins/llm-execution-tools/openai/computeOpenaiUsage.d.ts

@@ -1,8 +1,12 @@
 import type OpenAI from 'openai';
+import type { Prompt } from '../../../../types/Prompt';
 import type { PromptResult } from '../../../PromptResult';
+import type { PromptResultUsage } from '../../../PromptResult';
 /**
  * Computes the usage of the OpenAI API based on the response from OpenAI
  *
  * @throws {PromptbookExecutionError} If the usage is not defined in the response from OpenAI
+ * @private internal util of `OpenAiExecutionTools`
  */
-export declare function computeOpenaiUsage(rawResponse: Pick<OpenAI.Chat.Completions.ChatCompletion | OpenAI.Completions.Completion, 'model' | 'usage'>): PromptResult['usage'];
+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;

package/umd/typings/types/PromptbookJson/PromptTemplateJson.d.ts

@@ -3,11 +3,11 @@ import type { ExecutionType } from '../ExecutionTypes';
 import type { ModelRequirements } from '../ModelRequirements';
 import type { ScriptLanguage } from '../ScriptLanguage';
 import type { number_integer } from '../typeAliases';
-import type { string_markdown_text } from '../typeAliases';
-import type { number_positive_or_zero } from '../typeAliases';
+import type { number_positive } from '../typeAliases';
 import type { string_javascript } from '../typeAliases';
 import type { string_javascript_name } from '../typeAliases';
 import type { string_markdown } from '../typeAliases';
+import type { string_markdown_text } from '../typeAliases';
 import type { string_name } from '../typeAliases';
 import type { string_prompt } from '../typeAliases';
 import type { string_template } from '../typeAliases';
@@ -48,7 +48,7 @@ export type ExpectationUnit = typeof EXPECTATION_UNITS[number];
 /**
  * Amount of text measurement
  */
-export type ExpectationAmount = number_integer & number_positive_or_zero;
+export type ExpectationAmount = number_integer & (number_positive | 0);
 /**
  * Template for simple concatenation of strings
  */

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

@@ -393,11 +393,9 @@ export type number_usd = number;
 /**
  * Semantic helper for number of tokens
  */
-export type number_tokens = number_integer & number_positive_or_zero;
+export type number_tokens = number_integer & (number_positive | 0);
 export type number_positive = number;
 export type number_negative = number;
-export type number_positive_or_zero = number;
-export type number_negative_or_zero = number;
 export type number_integer = number;
 /**
  * Semantic helper;