@promptbook/openai 0.76.0 → 0.77.0-3

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

@@ -33,5 +33,5 @@ export type AzureOpenAiExecutionToolsOptions = CommonToolsOptions & {
      *
      * @see https://platform.openai.com/docs/guides/safety-best-practices/end-user-ids (document from OpenAI not Azure, but same concept)
      */
-    readonly userId: string_user_id | null;
+    readonly userId?: string_user_id;
 };

package/esm/typings/src/llm-providers/google/GoogleExecutionToolsOptions.d.ts

@@ -0,0 +1,12 @@
+import type { createGoogleGenerativeAI } from '@ai-sdk/google';
+import type { CommonToolsOptions } from '../../execution/CommonToolsOptions';
+/**
+ * Options for `GoogleExecutionTools`
+ *
+ * !!!!!! This extends Google's `ClientOptions` with are directly passed to the Google generative AI client.
+ * @public exported from `@promptbook/google`
+ */
+export type GoogleExecutionToolsOptions = CommonToolsOptions & Parameters<typeof createGoogleGenerativeAI>[0];
+/**
+ * TODO: [🧠][🤺] Pass `userId`
+ */

package/esm/typings/src/llm-providers/google/createGoogleExecutionTools.d.ts

@@ -0,0 +1,18 @@
+import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
+import type { GoogleExecutionToolsOptions } from './GoogleExecutionToolsOptions';
+/**
+ * Execution Tools for calling Google Gemini API.
+ *
+ * @public exported from `@promptbook/google`
+ */
+export declare const createGoogleExecutionTools: ((options: GoogleExecutionToolsOptions) => LlmExecutionTools) & {
+    packageName: string;
+    className: string;
+};
+/**
+ * TODO: [🧠][main] !!!! Make anonymous this with all LLM providers
+ * TODO: [🧠][🧱][main] !!!! Maybe change all `new GoogleExecutionTools` -> `createGoogleExecutionTools` in manual
+ * TODO: [🧠] Maybe auto-detect usage in browser and determine default value of `isProxied`
+ * TODO: [🦺] Is there some way how to put `packageName` and `className` on top and function definition on bottom?
+ * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
+ */

package/esm/typings/src/llm-providers/google/register-configuration.d.ts

@@ -0,0 +1,13 @@
+import type { Registration } from '../../utils/$Register';
+/**
+ * Registration of LLM provider metadata
+ *
+ * Warning: This is not useful for the end user, it is just a side effect of the mechanism that handles all available LLM tools
+ *
+ * @public exported from `@promptbook/core`
+ * @public exported from `@promptbook/cli`
+ */
+export declare const _GoogleMetadataRegistration: Registration;
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/src/llm-providers/google/register-constructor.d.ts

@@ -0,0 +1,14 @@
+import type { Registration } from '../../utils/$Register';
+/**
+ * Registration of LLM provider
+ *
+ * Warning: This is not useful for the end user, it is just a side effect of the mechanism that handles all available LLM tools
+ *
+ * @public exported from `@promptbook/google`
+ * @public exported from `@promptbook/cli`
+ */
+export declare const _GoogleRegistration: Registration;
+/**
+ * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

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

@@ -1,6 +1,5 @@
 import type { ClientOptions } from 'openai';
 import type { CommonToolsOptions } from '../../execution/CommonToolsOptions';
-import type { string_user_id } from '../../types/typeAliases';
 /**
  * Options for `OpenAiExecutionTools`
  *
@@ -9,12 +8,4 @@ import type { string_user_id } from '../../types/typeAliases';
  *
  * @public exported from `@promptbook/openai`
  */
-export type OpenAiExecutionToolsOptions = CommonToolsOptions & ClientOptions & {
-    /**
-     * A unique identifier representing your end-user, which can help OpenAI to monitor
-     * and detect abuse.
-     *
-     * @see https://platform.openai.com/docs/guides/safety-best-practices/end-user-ids
-     */
-    userId: string_user_id | null;
-};
+export type OpenAiExecutionToolsOptions = CommonToolsOptions & ClientOptions;

package/esm/typings/src/llm-providers/remote/interfaces/PromptbookServer_ListModels_Request.d.ts

@@ -24,7 +24,7 @@ export type PromptbookServer_ListModels_AnonymousRequest = {
      * Note: this is passed to the certain model providers to identify misuse
      * Note: In anonymous mode, there is no need to identify yourself, nor does it change the actual configuration of LLM Tools (unlike in application mode)
      */
-    readonly userId: string_user_id | null;
+    readonly userId?: string_user_id;
     /**
      * Configuration for the LLM tools
      */

package/esm/typings/src/llm-providers/remote/interfaces/PromptbookServer_Prompt_Request.d.ts

@@ -29,7 +29,7 @@ export type PromptbookServer_Prompt_AnonymousRequest = {
      * Note: this is passed to the certain model providers to identify misuse
      * Note: In anonymous mode, there is no need to identify yourself, nor does it change the actual configuration of LLM Tools (unlike in application mode)
      */
-    readonly userId: string_user_id | null;
+    readonly userId?: string_user_id;
     /**
      * Configuration for the LLM tools
      */

package/esm/typings/src/llm-providers/remote/interfaces/RemoteLlmExecutionToolsOptions.d.ts

@@ -41,7 +41,7 @@ export type RemoteLlmExecutionToolsOptions<TCustomOptions> = CommonToolsOptions
      * Note: This is passed to the certain model providers to identify misuse
      * Note: In anonymous mode, there is no need to identify yourself, nor does it change the actual configuration of LLM Tools (unlike in application mode).
      */
-    readonly userId: string_user_id | null;
+    readonly userId?: string_user_id;
 } | ({
     /**
      * Use anonymous server with client identification and fixed collection

package/esm/typings/src/llm-providers/remote/interfaces/RemoteServerOptions.d.ts

@@ -62,7 +62,7 @@ export type CollectionRemoteServerClientOptions<TCustomOptions> = {
     /**
      * @@@
      */
-    readonly userId: string_user_id | null;
+    readonly userId?: string_user_id;
     /**
      * @@@
      */

package/esm/typings/src/llm-providers/vercel/VercelExecutionToolsOptions.d.ts

@@ -0,0 +1,22 @@
+import type { AvailableModel } from '../../execution/AvailableModel';
+import type { CommonToolsOptions } from '../../execution/CommonToolsOptions';
+import type { VercelProvider } from './VercelProvider';
+/**
+ * Options for `createExecutionToolsFromVercelProvider`
+ *
+ * @public exported from `@promptbook/google`
+ */
+export type VercelExecutionToolsOptions = CommonToolsOptions & {
+    /**
+     * Vercel provider for the execution tools
+     */
+    readonly vercelProvider: VercelProvider;
+    /**
+     * List of available models for given Vercel provider
+     */
+    readonly availableModels: ReadonlyArray<AvailableModel>;
+    /**
+     * Additional settings for chat models when calling `vercelProvider.chat('model-name', settings)`
+     */
+    readonly additionalChatSettings?: Partial<Parameters<VercelProvider['chat']>[1]>;
+};

package/esm/typings/src/llm-providers/vercel/VercelProvider.d.ts

@@ -0,0 +1,13 @@
+import type { createGoogleGenerativeAI } from '@ai-sdk/google';
+import type { createOpenAI } from '@ai-sdk/openai';
+/**
+ * This is common interface for all v1 Vercel providers
+ *
+ * @public exported from `@promptbook/vercel`
+ */
+export type VercelProvider = ReturnType<typeof createOpenAI> | ReturnType<typeof createGoogleGenerativeAI>;
+/**
+ * ^^^^
+ * TODO: Is there some way to get the type of the provider directly,
+ *       NOT this stupid way via inferring the return type from a specific vercel provider⁉
+ */

package/esm/typings/src/llm-providers/vercel/createExecutionToolsFromVercelProvider.d.ts

@@ -0,0 +1,8 @@
+import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
+import type { VercelExecutionToolsOptions } from './VercelExecutionToolsOptions';
+/**
+ * !!!!!!
+ *
+ * @public exported from `@promptbook/vercel`
+ */
+export declare function createExecutionToolsFromVercelProvider(options: VercelExecutionToolsOptions): LlmExecutionTools;

package/esm/typings/src/llm-providers/vercel/playground/playground.d.ts

@@ -0,0 +1,6 @@
+#!/usr/bin/env ts-node
+export {};
+/**
+ * TODO: [main] !!! Test here that `systemMessage`, `temperature` and `seed` are working correctly
+ * Note: [⚫] Code in this file should never be published in any package
+ */

package/esm/typings/src/utils/{$currentDate.d.ts → $getCurrentDate.d.ts}

@@ -7,4 +7,4 @@ import type { string_date_iso8601 } from '../types/typeAliases';
  * @returns string_date branded type
  * @public exported from `@promptbook/utils`
  */
-export declare function $currentDate(): string_date_iso8601;
+export declare function $getCurrentDate(): string_date_iso8601;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/openai",
-    "version": "0.76.0",
+    "version": "0.77.0-3",
     "description": "It's time for a paradigm shift. The future of software in plain English, French or Latin",
     "--note-0": "    <- [🐊]",
     "private": false,
@@ -54,7 +54,7 @@
     "module": "./esm/index.es.js",
     "typings": "./esm/typings/src/_packages/openai.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.76.0"
+        "@promptbook/core": "0.77.0-3"
     },
     "dependencies": {
         "colors": "1.4.0",

package/umd/index.umd.js

@@ -22,7 +22,7 @@
      *
      * @see https://github.com/webgptorg/promptbook
      */
-    var PROMPTBOOK_ENGINE_VERSION = '0.75.10';
+    var PROMPTBOOK_ENGINE_VERSION = '0.77.0-2';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -288,11 +288,14 @@
      */
 
     /**
-     * Get current date in ISO 8601 format
+     * Simple wrapper `new Date().toISOString()`
      *
-     * @private internal utility
+     * Note: `$` is used to indicate that this function is not a pure function - it is not deterministic because it depends on the current time
+     *
+     * @returns string_date branded type
+     * @public exported from `@promptbook/utils`
      */
-    function getCurrentIsoDate() {
+    function $getCurrentDate() {
         return new Date().toISOString();
     }
 
@@ -1577,7 +1580,7 @@
                                         content: rawPromptContent,
                                     },
                                 ], false), user: (_a = this.options.userId) === null || _a === void 0 ? void 0 : _a.toString() });
-                            start = getCurrentIsoDate();
+                            start = $getCurrentDate();
                             if (this.options.isVerbose) {
                                 console.info(colors__default["default"].bgWhite('rawRequest'), JSON.stringify(rawRequest, null, 4));
                             }
@@ -1601,7 +1604,7 @@
                             }
                             resultContent = rawResponse.choices[0].message.content;
                             // eslint-disable-next-line prefer-const
-                            complete = getCurrentIsoDate();
+                            complete = $getCurrentDate();
                             usage = computeOpenAiUsage(content || '', resultContent || '', rawResponse);
                             if (resultContent === null) {
                                 throw new PipelineExecutionError('No response message from OpenAI');
@@ -1656,7 +1659,7 @@
                             };
                             rawPromptContent = replaceParameters(content, __assign(__assign({}, parameters), { modelName: modelName }));
                             rawRequest = __assign(__assign({}, modelSettings), { prompt: rawPromptContent, user: (_a = this.options.userId) === null || _a === void 0 ? void 0 : _a.toString() });
-                            start = getCurrentIsoDate();
+                            start = $getCurrentDate();
                             if (this.options.isVerbose) {
                                 console.info(colors__default["default"].bgWhite('rawRequest'), JSON.stringify(rawRequest, null, 4));
                             }
@@ -1680,7 +1683,7 @@
                             }
                             resultContent = rawResponse.choices[0].text;
                             // eslint-disable-next-line prefer-const
-                            complete = getCurrentIsoDate();
+                            complete = $getCurrentDate();
                             usage = computeOpenAiUsage(content || '', resultContent || '', rawResponse);
                             return [2 /*return*/, $asDeeplyFrozenSerializableJson('OpenAiExecutionTools CompletionPromptResult', {
                                     content: resultContent,
@@ -1726,7 +1729,7 @@
                                 input: rawPromptContent,
                                 model: modelName,
                             };
-                            start = getCurrentIsoDate();
+                            start = $getCurrentDate();
                             if (this.options.isVerbose) {
                                 console.info(colors__default["default"].bgWhite('rawRequest'), JSON.stringify(rawRequest, null, 4));
                             }
@@ -1746,7 +1749,7 @@
                             }
                             resultContent = rawResponse.data[0].embedding;
                             // eslint-disable-next-line prefer-const
-                            complete = getCurrentIsoDate();
+                            complete = $getCurrentDate();
                             usage = computeOpenAiUsage(content || '', '', 
                             // <- Note: Embedding does not have result content
                             rawResponse);
@@ -1899,7 +1902,7 @@
                                 },
                                 // <- TODO: Add user identification here> user: this.options.user,
                             };
-                            start = getCurrentIsoDate();
+                            start = $getCurrentDate();
                             if (this.options.isVerbose) {
                                 console.info(colors__default["default"].bgWhite('rawRequest'), JSON.stringify(rawRequest, null, 4));
                             }
@@ -1950,7 +1953,7 @@
                             resultContent = (_c = rawResponse[0].content[0]) === null || _c === void 0 ? void 0 : _c.text.value;
                             //                                                     <- TODO: [🧠] There are also annotations, maybe use them
                             // eslint-disable-next-line prefer-const
-                            complete = getCurrentIsoDate();
+                            complete = $getCurrentDate();
                             usage = UNCERTAIN_USAGE;
                             // <- TODO: [🥘] Compute real usage for assistant
                             //       ?> const usage = computeOpenAiUsage(content, resultContent || '', rawResponse);