@promptbook/remote-server 0.30.0 → 0.31.0-1

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

@@ -1,4 +1,4 @@
-import type { string_model_name } from '.././types/typeAliases';
+import type { number_positive_or_zero, number_tokens, number_usd, string_date_iso8601, string_model_name } from '.././types/typeAliases';
 /**
  * Prompt result is the simplest concept of execution.
  * It is the result of executing one prompt _(NOT a template)_.
@@ -25,12 +25,49 @@ export interface PromptCommonResult {
      * Name of the model used to generate the response
      */
     readonly model: string_model_name;
+    /**
+     * Timing
+     */
+    readonly timing: {
+        /**
+         * Start of the execution
+         */
+        start: string_date_iso8601;
+        /**
+         * First token generated
+         */
+        firstToken?: string_date_iso8601;
+        /**
+         * End of the execution
+         */
+        complete: string_date_iso8601;
+    };
+    /**
+     * 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;
+        /**
+         * Number of tokens used in the output aka. `completion_tokens`
+         */
+        outputTokens: number_tokens;
+    };
     /**
      * Raw response from the model
      */
     readonly rawResponse: object;
 }
 /**
+ * TODO: [🧠] Maybe timing more accurate then seconds?
  * TODO: [🧠] Should here be link to the prompt?
  * TODO: [🧠] Maybe type raw properly - not onject but OpenAI.result.whatever
  * TODO: [🧠] Maybe remove redundant raw.choices.text

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

@@ -0,0 +1,3 @@
+import type OpenAI from 'openai';
+import type { PromptResult } from '../../../PromptResult';
+export declare function computeOpenaiUsage(rawResponse: Pick<OpenAI.Chat.Completions.ChatCompletion | OpenAI.Completions.Completion, 'model' | 'usage'>): PromptResult['usage'];

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

@@ -404,6 +404,22 @@ export type string_license_token = string_token;
 export type string_password = string;
 export type string_ssh_key = string;
 export type string_pgp_key = string;
+/**
+ * Semantic helper for `Date.toISOString()` result
+ *
+ * @example "2011-10-05T14:48:00.000Z".
+ * @see https://en.wikipedia.org/wiki/ISO_8601
+ * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString
+ */
+export type string_date_iso8601 = `${number}-${number}-${number}${string}${number}:${number}:${number}${string}`;
+/**
+ * Semantic helper for US Dollars
+ */
+export type number_usd = number;
+/**
+ * Semantic helper for number of tokens
+ */
+export type number_tokens = number_integer & number_positive_or_zero;
 export type number_positive = number;
 export type number_negative = number;
 export type number_positive_or_zero = number;

package/esm/typings/utils/getCurrentIsoDate.d.ts

@@ -0,0 +1,7 @@
+import type { string_date_iso8601 } from '../types/typeAliases';
+/**
+ * Get current date in ISO 8601 format
+ *
+ * @private This is internal util of the promptbook
+ */
+export declare function getCurrentIsoDate(): string_date_iso8601;

package/esm/typings/utils/markdown/escapeMarkdownBlock.d.ts

@@ -0,0 +1,6 @@
+import { string_markdown_text } from '../../types/typeAliases';
+/**
+ * Function escapeMarkdownBlock will escape markdown block if needed
+ * It is useful when you want have block in block
+ */
+export declare function escapeMarkdownBlock(value: string_markdown_text): string_markdown_text;

package/esm/typings/utils/markdown/escapeMarkdownBlock.test.d.ts

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

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/remote-server",
-    "version": "0.30.0",
+    "version": "0.31.0-1",
     "description": "Library to supercharge your use of large language models",
     "private": false,
     "sideEffects": false,
@@ -38,7 +38,7 @@
         "spacetrim": "0.9.21"
     },
     "peerDependencies": {
-        "@promptbook/core": "0.30.0"
+        "@promptbook/core": "0.31.0-1"
     },
     "main": "./umd/index.umd.js",
     "module": "./esm/index.es.js",

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

@@ -1,4 +1,4 @@
-import type { string_model_name } from '.././types/typeAliases';
+import type { number_positive_or_zero, number_tokens, number_usd, string_date_iso8601, string_model_name } from '.././types/typeAliases';
 /**
  * Prompt result is the simplest concept of execution.
  * It is the result of executing one prompt _(NOT a template)_.
@@ -25,12 +25,49 @@ export interface PromptCommonResult {
      * Name of the model used to generate the response
      */
     readonly model: string_model_name;
+    /**
+     * Timing
+     */
+    readonly timing: {
+        /**
+         * Start of the execution
+         */
+        start: string_date_iso8601;
+        /**
+         * First token generated
+         */
+        firstToken?: string_date_iso8601;
+        /**
+         * End of the execution
+         */
+        complete: string_date_iso8601;
+    };
+    /**
+     * 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;
+        /**
+         * Number of tokens used in the output aka. `completion_tokens`
+         */
+        outputTokens: number_tokens;
+    };
     /**
      * Raw response from the model
      */
     readonly rawResponse: object;
 }
 /**
+ * TODO: [🧠] Maybe timing more accurate then seconds?
  * TODO: [🧠] Should here be link to the prompt?
  * TODO: [🧠] Maybe type raw properly - not onject but OpenAI.result.whatever
  * TODO: [🧠] Maybe remove redundant raw.choices.text

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

@@ -0,0 +1,3 @@
+import type OpenAI from 'openai';
+import type { PromptResult } from '../../../PromptResult';
+export declare function computeOpenaiUsage(rawResponse: Pick<OpenAI.Chat.Completions.ChatCompletion | OpenAI.Completions.Completion, 'model' | 'usage'>): PromptResult['usage'];

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

@@ -404,6 +404,22 @@ export type string_license_token = string_token;
 export type string_password = string;
 export type string_ssh_key = string;
 export type string_pgp_key = string;
+/**
+ * Semantic helper for `Date.toISOString()` result
+ *
+ * @example "2011-10-05T14:48:00.000Z".
+ * @see https://en.wikipedia.org/wiki/ISO_8601
+ * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString
+ */
+export type string_date_iso8601 = `${number}-${number}-${number}${string}${number}:${number}:${number}${string}`;
+/**
+ * Semantic helper for US Dollars
+ */
+export type number_usd = number;
+/**
+ * Semantic helper for number of tokens
+ */
+export type number_tokens = number_integer & number_positive_or_zero;
 export type number_positive = number;
 export type number_negative = number;
 export type number_positive_or_zero = number;

package/umd/typings/utils/getCurrentIsoDate.d.ts

@@ -0,0 +1,7 @@
+import type { string_date_iso8601 } from '../types/typeAliases';
+/**
+ * Get current date in ISO 8601 format
+ *
+ * @private This is internal util of the promptbook
+ */
+export declare function getCurrentIsoDate(): string_date_iso8601;

package/umd/typings/utils/markdown/escapeMarkdownBlock.d.ts

@@ -0,0 +1,6 @@
+import { string_markdown_text } from '../../types/typeAliases';
+/**
+ * Function escapeMarkdownBlock will escape markdown block if needed
+ * It is useful when you want have block in block
+ */
+export declare function escapeMarkdownBlock(value: string_markdown_text): string_markdown_text;

package/umd/typings/utils/markdown/escapeMarkdownBlock.test.d.ts

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