@promptbook/openai 0.88.0 → 0.89.0-2

package/esm/typings/src/execution/utils/usage-constants.d.ts

@@ -1,57 +1,74 @@
+/**
+ * Represents the uncertain value
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const ZERO_VALUE: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
+    readonly value: 0;
+}>;
+/**
+ * Represents the uncertain value
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const UNCERTAIN_ZERO_VALUE: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
+    readonly value: 0;
+    readonly isUncertain: true;
+}>;
 /**
  * Represents the usage with no resources consumed
  *
  * @public exported from `@promptbook/core`
  */
 export declare const ZERO_USAGE: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
-    readonly price: {
+    readonly price: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
         readonly value: 0;
-    };
+    }>;
     readonly input: {
-        readonly tokensCount: {
+        readonly tokensCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
             readonly value: 0;
-        };
-        readonly charactersCount: {
+        }>;
+        readonly charactersCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
             readonly value: 0;
-        };
-        readonly wordsCount: {
+        }>;
+        readonly wordsCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
             readonly value: 0;
-        };
-        readonly sentencesCount: {
+        }>;
+        readonly sentencesCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
             readonly value: 0;
-        };
-        readonly linesCount: {
+        }>;
+        readonly linesCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
             readonly value: 0;
-        };
-        readonly paragraphsCount: {
+        }>;
+        readonly paragraphsCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
             readonly value: 0;
-        };
-        readonly pagesCount: {
+        }>;
+        readonly pagesCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
             readonly value: 0;
-        };
+        }>;
     };
     readonly output: {
-        readonly tokensCount: {
+        readonly tokensCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
             readonly value: 0;
-        };
-        readonly charactersCount: {
+        }>;
+        readonly charactersCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
             readonly value: 0;
-        };
-        readonly wordsCount: {
+        }>;
+        readonly wordsCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
             readonly value: 0;
-        };
-        readonly sentencesCount: {
+        }>;
+        readonly sentencesCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
             readonly value: 0;
-        };
-        readonly linesCount: {
+        }>;
+        readonly linesCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
             readonly value: 0;
-        };
-        readonly paragraphsCount: {
+        }>;
+        readonly paragraphsCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
             readonly value: 0;
-        };
-        readonly pagesCount: {
+        }>;
+        readonly pagesCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
             readonly value: 0;
-        };
+        }>;
     };
 }>;
 /**
@@ -60,69 +77,69 @@ export declare const ZERO_USAGE: import("type-fest/source/readonly-deep").Readon
  * @public exported from `@promptbook/core`
  */
 export declare const UNCERTAIN_USAGE: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
-    readonly price: {
+    readonly price: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
         readonly value: 0;
         readonly isUncertain: true;
-    };
+    }>;
     readonly input: {
-        readonly tokensCount: {
+        readonly tokensCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
             readonly value: 0;
             readonly isUncertain: true;
-        };
-        readonly charactersCount: {
+        }>;
+        readonly charactersCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
             readonly value: 0;
             readonly isUncertain: true;
-        };
-        readonly wordsCount: {
+        }>;
+        readonly wordsCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
             readonly value: 0;
             readonly isUncertain: true;
-        };
-        readonly sentencesCount: {
+        }>;
+        readonly sentencesCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
             readonly value: 0;
             readonly isUncertain: true;
-        };
-        readonly linesCount: {
+        }>;
+        readonly linesCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
             readonly value: 0;
             readonly isUncertain: true;
-        };
-        readonly paragraphsCount: {
+        }>;
+        readonly paragraphsCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
             readonly value: 0;
             readonly isUncertain: true;
-        };
-        readonly pagesCount: {
+        }>;
+        readonly pagesCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
             readonly value: 0;
             readonly isUncertain: true;
-        };
+        }>;
     };
     readonly output: {
-        readonly tokensCount: {
+        readonly tokensCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
             readonly value: 0;
             readonly isUncertain: true;
-        };
-        readonly charactersCount: {
+        }>;
+        readonly charactersCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
             readonly value: 0;
             readonly isUncertain: true;
-        };
-        readonly wordsCount: {
+        }>;
+        readonly wordsCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
             readonly value: 0;
             readonly isUncertain: true;
-        };
-        readonly sentencesCount: {
+        }>;
+        readonly sentencesCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
             readonly value: 0;
             readonly isUncertain: true;
-        };
-        readonly linesCount: {
+        }>;
+        readonly linesCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
             readonly value: 0;
             readonly isUncertain: true;
-        };
-        readonly paragraphsCount: {
+        }>;
+        readonly paragraphsCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
             readonly value: 0;
             readonly isUncertain: true;
-        };
-        readonly pagesCount: {
+        }>;
+        readonly pagesCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
             readonly value: 0;
             readonly isUncertain: true;
-        };
+        }>;
     };
 }>;
 /**

package/esm/typings/src/execution/utils/usageToHuman.d.ts

@@ -1,20 +1,20 @@
 import type { string_markdown } from '../../types/typeAliases';
-import type { PromptResultUsage } from '../PromptResultUsage';
 import type { UncertainNumber } from '../UncertainNumber';
+import type { Usage } from '../Usage';
 /**
  * Minimal usage information required to calculate worktime
  */
-type PartialPromptResultUsage = Partial<PromptResultUsage> & {
+type PartialUsage = Partial<Usage> & {
     price: UncertainNumber;
-    input: Pick<PromptResultUsage['input'], 'wordsCount'>;
-    output: Pick<PromptResultUsage['output'], 'wordsCount' | 'charactersCount'>;
+    input: Pick<Usage['input'], 'wordsCount'>;
+    output: Pick<Usage['output'], 'wordsCount' | 'charactersCount'>;
 };
 /**
  * Function `usageToHuman` will take usage and convert it to human readable report
  *
  * @public exported from `@promptbook/core`
  */
-export declare function usageToHuman(usage: PartialPromptResultUsage): string_markdown;
+export declare function usageToHuman(usage: PartialUsage): string_markdown;
 export {};
 /**
  * TODO: [🍓][🧞‍♂️] Use "$1" not "1 USD"

package/esm/typings/src/execution/utils/usageToWorktime.d.ts

@@ -1,11 +1,11 @@
-import type { PromptResultUsage } from '../PromptResultUsage';
 import type { UncertainNumber } from '../UncertainNumber';
+import type { Usage } from '../Usage';
 /**
  * Minimal usage information required to calculate worktime
  */
-type PartialPromptResultUsage = Pick<PromptResultUsage, 'input' | 'output'> & {
-    input: Pick<PromptResultUsage['input'], 'wordsCount'>;
-    output: Pick<PromptResultUsage['output'], 'wordsCount'>;
+type PartialUsage = Pick<Usage, 'input' | 'output'> & {
+    input: Pick<Usage['input'], 'wordsCount'>;
+    output: Pick<Usage['output'], 'wordsCount'>;
 };
 /**
  * Function usageToWorktime will take usage and estimate saved worktime in hours of reading / writing
@@ -16,5 +16,5 @@ type PartialPromptResultUsage = Pick<PromptResultUsage, 'input' | 'output'> & {
  *
  * @public exported from `@promptbook/core`
  */
-export declare function usageToWorktime(usage: PartialPromptResultUsage): UncertainNumber;
+export declare function usageToWorktime(usage: PartialUsage): UncertainNumber;
 export {};

package/esm/typings/src/llm-providers/_common/utils/count-total-usage/LlmExecutionToolsWithTotalUsage.d.ts

@@ -1,5 +1,6 @@
+import type { Observable } from 'rxjs';
 import type { LlmExecutionTools } from '../../../../execution/LlmExecutionTools';
-import type { PromptResultUsage } from '../../../../execution/PromptResultUsage';
+import type { Usage } from '../../../../execution/Usage';
 /**
  * LLM tools with option to get total usage of the execution
  */
@@ -7,7 +8,13 @@ export type LlmExecutionToolsWithTotalUsage = LlmExecutionTools & {
     /**
      * Get total cost of the execution up to this point
      */
-    getTotalUsage(): PromptResultUsage;
+    getTotalUsage(): Usage;
+    /**
+     * Observable of total cost of the execution up to this point
+     *
+     * Note: This does report the cost of the last prompt, not the total cost of the execution up to this point
+     */
+    spending(): Observable<Usage>;
 };
 /**
  * TODO: [👷‍♂️] @@@ Manual about construction of llmTools

package/esm/typings/src/llm-providers/_common/utils/count-total-usage/{countTotalUsage.d.ts → countUsage.d.ts}

@@ -7,7 +7,7 @@ import type { LlmExecutionToolsWithTotalUsage } from './LlmExecutionToolsWithTot
  * @returns LLM tools with same functionality with added total cost counting
  * @public exported from `@promptbook/core`
  */
-export declare function countTotalUsage(llmTools: LlmExecutionTools): LlmExecutionToolsWithTotalUsage;
+export declare function countUsage(llmTools: LlmExecutionTools): LlmExecutionToolsWithTotalUsage;
 /**
  * TODO: [🧠][💸] Maybe make some common abstraction `interceptLlmTools` and use here (or use javascript Proxy?)
  * TODO: [🧠] Is there some meaningfull way how to test this util

package/esm/typings/src/llm-providers/_common/utils/count-total-usage/limitTotalUsage.d.ts

@@ -1,5 +1,5 @@
 import type { LlmExecutionTools } from '../../../../execution/LlmExecutionTools';
-import type { PromptResultUsage } from '../../../../execution/PromptResultUsage';
+import type { Usage } from '../../../../execution/Usage';
 import type { PromptbookStorage } from '../../../../storage/_common/PromptbookStorage';
 import type { TODO_any } from '../../../../utils/organization/TODO_any';
 import type { LlmExecutionToolsWithTotalUsage } from './LlmExecutionToolsWithTotalUsage';
@@ -12,7 +12,7 @@ type LimitTotalUsageOptions = {
      *
      * @default ZERO_USAGE
      */
-    maxTotalUsage: PromptResultUsage;
+    maxTotalUsage: Usage;
     /**
      * @@@
      *

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

@@ -1,6 +1,6 @@
 import type Anthropic from '@anthropic-ai/sdk';
 import type { PartialDeep } from 'type-fest';
-import type { PromptResultUsage } from '../../execution/PromptResultUsage';
+import type { Usage } from '../../execution/Usage';
 import type { Prompt } from '../../types/Prompt';
 /**
  * Computes the usage of the Anthropic Claude API based on the response from Anthropic Claude
@@ -12,7 +12,7 @@ import type { Prompt } from '../../types/Prompt';
  * @private internal utility of `AnthropicClaudeExecutionTools`
  */
 export declare function computeAnthropicClaudeUsage(promptContent: Prompt['content'], // <- Note: Intentionally using [] to access type properties to bring jsdoc from Prompt/PromptResult to consumer
-resultContent: string, rawResponse: PartialDeep<Pick<Anthropic.Messages.Message, 'model' | 'usage'>>): PromptResultUsage;
+resultContent: string, rawResponse: PartialDeep<Pick<Anthropic.Messages.Message, 'model' | 'usage'>>): Usage;
 /**
  * TODO: [🤝] DRY Maybe some common abstraction between `computeOpenAiUsage` and `computeAnthropicClaudeUsage`
  */

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

@@ -8,8 +8,6 @@ import type { Prompt } from '../../types/Prompt';
 import type { string_markdown } from '../../types/typeAliases';
 import type { string_markdown_text } from '../../types/typeAliases';
 import type { string_title } from '../../types/typeAliases';
-import type { string_token } from '../../types/typeAliases';
-import { OpenAiAssistantExecutionTools } from './OpenAiAssistantExecutionTools';
 import type { OpenAiExecutionToolsOptions } from './OpenAiExecutionToolsOptions';
 /**
  * Execution Tools for calling OpenAI API
@@ -31,13 +29,6 @@ export declare class OpenAiExecutionTools implements LlmExecutionTools {
     get title(): string_title & string_markdown_text;
     get description(): string_markdown;
     getClient(): Promise<OpenAI>;
-    /**
-     * Create (sub)tools for calling OpenAI API Assistants
-     *
-     * @param assistantId Which assistant to use
-     * @returns Tools for calling OpenAI API Assistants with same token
-     */
-    createAssistantSubtools(assistantId: string_token): OpenAiAssistantExecutionTools;
     /**
      * Check the `options` passed to `constructor`
      */

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

@@ -1,6 +1,6 @@
 import type OpenAI from 'openai';
 import type { PartialDeep } from 'type-fest';
-import type { PromptResultUsage } from '../../execution/PromptResultUsage';
+import type { Usage } from '../../execution/Usage';
 import type { Prompt } from '../../types/Prompt';
 /**
  * Computes the usage of the OpenAI API based on the response from OpenAI
@@ -12,7 +12,7 @@ import type { Prompt } from '../../types/Prompt';
  * @private internal utility 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: string, rawResponse: PartialDeep<Pick<OpenAI.Chat.Completions.ChatCompletion | OpenAI.Completions.Completion | OpenAI.Embeddings.CreateEmbeddingResponse, 'model' | 'usage'>>): PromptResultUsage;
+resultContent: string, rawResponse: PartialDeep<Pick<OpenAI.Chat.Completions.ChatCompletion | OpenAI.Completions.Completion | OpenAI.Embeddings.CreateEmbeddingResponse, 'model' | 'usage'>>): Usage;
 /**
  * TODO: [🤝] DRY Maybe some common abstraction between `computeOpenAiUsage` and `computeAnthropicClaudeUsage`
  */

package/esm/typings/src/pipeline/PipelineJson/PreparationJson.d.ts

@@ -1,4 +1,4 @@
-import type { PromptResultUsage } from '../../execution/PromptResultUsage';
+import type { Usage } from '../../execution/Usage';
 import type { number_id } from '../../types/typeAliases';
 import type { string_promptbook_version } from '../../version';
 export type PreparationJson = {
@@ -13,7 +13,7 @@ export type PreparationJson = {
     /**
      * Usage of the prompt execution
      */
-    readonly usage: PromptResultUsage;
+    readonly usage: Usage;
 };
 /**
  * TODO: [🍙] Make some standard order of json properties

package/esm/typings/src/playground/BrjappConnector.d.ts

@@ -0,0 +1,67 @@
+/**
+ * TODO: !!!!!! Implement Promptbook remote server login and move to Promptbook.studio
+ */
+type BrjappOptions = {
+    /**
+     * Add user to these groups
+     */
+    readonly userGroups: Array<string>;
+    /**
+     * Add this amount of credits to new users
+     */
+    readonly initialCredits: number;
+};
+/**
+ * Note: Credit = 1 Word to generate or read
+ * Note: What we call here "user" is on BRJ.APP "customer"
+ *
+ * @private - this will be moved to Promptbook studio
+ */
+export declare class BrjappConnector {
+    private readonly apiKey;
+    private options;
+    private readonly client;
+    constructor(apiKey: string, options: BrjappOptions);
+    /**
+     * Login or register user
+     *
+     * TODO: [🧠] Probbably better name for this method
+     *
+     * @param options
+     * @returns user token or null if user needs to verify email
+     */
+    loginOrRegister(options: {
+        email: string;
+        password: string;
+        customerRealIp: string;
+    }): Promise<{
+        isSuccess: boolean;
+        message: string;
+        token: string | null;
+        isEmailVerificationRequired: boolean;
+    }>;
+    private addInitailCredits;
+    buyCredits(options: {
+        email: string;
+        customerRealIp: string;
+    }): Promise<{
+        isSuccess: boolean;
+        message: string;
+        payLink: string | null;
+    }>;
+    /**
+     *
+     * @returns true if credits were spent, false if not enough credits or another error
+     */
+    spendCredits(options: {
+        email: string;
+        token: string;
+        creditsAmount: number;
+        description: string;
+        customerRealIp: string;
+    }): Promise<{
+        isSuccess: boolean;
+        message: string;
+    }>;
+}
+export {};