@promptbook/openai 0.77.0-5 → 0.77.0-6

package/esm/index.es.js

@@ -14,7 +14,7 @@ var BOOK_LANGUAGE_VERSION = '1.0.0';
  *
  * @see https://github.com/webgptorg/promptbook
  */
-var PROMPTBOOK_ENGINE_VERSION = '0.77.0-4';
+var PROMPTBOOK_ENGINE_VERSION = '0.77.0-5';
 /**
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
  * Note: [💞] Ignore a discrepancy between file name and entity name

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

@@ -145,6 +145,7 @@ import type { string_reserved_parameter_name } from '../types/typeAliases';
 import type { ReservedParameters } from '../types/typeAliases';
 import type { string_title } from '../types/typeAliases';
 import type { string_persona_description } from '../types/typeAliases';
+import type { string_model_description } from '../types/typeAliases';
 import type { string_knowledge_source_content } from '../types/typeAliases';
 import type { string_knowledge_source_link } from '../types/typeAliases';
 import type { string_html } from '../types/typeAliases';
@@ -402,6 +403,7 @@ export type { string_reserved_parameter_name };
 export type { ReservedParameters };
 export type { string_title };
 export type { string_persona_description };
+export type { string_model_description };
 export type { string_knowledge_source_content };
 export type { string_knowledge_source_link };
 export type { string_html };

package/esm/typings/src/execution/AvailableModel.d.ts

@@ -1,4 +1,5 @@
 import type { ModelVariant } from '../types/ModelVariant';
+import type { string_model_description } from '../types/typeAliases';
 import type { string_model_name } from '../types/typeAliases';
 import type { string_title } from '../types/typeAliases';
 /**
@@ -6,19 +7,32 @@ import type { string_title } from '../types/typeAliases';
  */
 export type AvailableModel = {
     /**
-     * The model title
+     * The model title, when not provided, the `modelName` should be used
+     *
+     * @example "GPT o1"
      */
     readonly modelTitle?: string_title;
     /**
      * The model name aviailable
+     *
+     * @example "o1"
      */
     readonly modelName: string_model_name;
     /**
      * Variant of the model
+     *
+     * @example "CHAT"
      */
     readonly modelVariant: ModelVariant;
+    /**
+     * Unstructured description of the model
+     *
+     * This will be used to pick the best available model for each task
+     *
+     * @example "Model with 1 billion parameters and advanced reasoning capabilities"
+     */
+    readonly modelDescription?: string_model_description;
 };
 /**
- * TODO: !!!!!! Maybe remove `modelTitle`
  * TODO: !!!!!! Put pricing information here
  */

package/esm/typings/src/execution/LlmExecutionTools.d.ts

@@ -26,7 +26,7 @@ export type LlmExecutionTools = {
      *
      * @example "Use all models from OpenAI"
      */
-    readonly description: string_markdown;
+    readonly description?: string_markdown;
     /**
      * Check comfiguration
      *

package/esm/typings/src/llm-providers/_common/register/$provideLlmToolsConfigurationFromEnv.d.ts

@@ -21,5 +21,5 @@ export declare function $provideLlmToolsConfigurationFromEnv(): LlmToolsConfigur
  * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
  * TODO: [👷‍♂️] @@@ Manual about construction of llmTools
  * TODO: This should be maybe not under `_common` but under `utils`
- * TODO: [🧠] Maybe pass env as argument
+ * TODO: [🧠][⚛] Maybe pass env as argument
  * TODO: [®] DRY Register logic */

package/esm/typings/src/llm-providers/_common/register/$registeredLlmToolsMessage.d.ts

@@ -9,4 +9,5 @@ import type { string_markdown } from '../../../types/typeAliases';
 export declare function $registeredLlmToolsMessage(): string_markdown;
 /**
  * TODO: [®] DRY Register logic
+ * TODO: [🧠][⚛] Maybe pass env as argument
  */

package/esm/typings/src/llm-providers/_common/register/LlmToolsMetadata.d.ts

@@ -1,7 +1,7 @@
-import type { string_SCREAMING_CASE } from '../../../utils/normalization/normalizeTo_SCREAMING_CASE';
 import type { string_name } from '../../../types/typeAliases';
 import type { string_title } from '../../../types/typeAliases';
 import type { Registered } from '../../../utils/$Register';
+import type { string_SCREAMING_CASE } from '../../../utils/normalization/normalizeTo_SCREAMING_CASE';
 import type { LlmToolsConfiguration } from './LlmToolsConfiguration';
 /**
  * @@@
@@ -14,9 +14,12 @@ export type LlmToolsMetadata = Registered & {
      */
     readonly title: string_title;
     /**
-     * @@@
+     * List of environment variables that can be used to configure the provider
+     *
+     * If `[]`, empty array, it means that the provider is available automatically without any configuration
+     * If `null`, it means that the provider can not be configured via environment variables
      */
-    readonly envVariables: ReadonlyArray<string_name & string_SCREAMING_CASE>;
+    readonly envVariables: ReadonlyArray<string_name & string_SCREAMING_CASE> | null;
     /**
      * @@@
      */

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

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

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

@@ -1,12 +1,13 @@
 import type { AvailableModel } from '../../execution/AvailableModel';
 import type { CommonToolsOptions } from '../../execution/CommonToolsOptions';
+import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
 import type { VercelProvider } from './VercelProvider';
 /**
  * Options for `createExecutionToolsFromVercelProvider`
  *
  * @public exported from `@promptbook/google`
  */
-export type VercelExecutionToolsOptions = CommonToolsOptions & {
+export type VercelExecutionToolsOptions = CommonToolsOptions & Pick<LlmExecutionTools, 'title' | 'description'> & {
     /**
      * Vercel provider for the execution tools
      */

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

@@ -1,7 +1,7 @@
 import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
 import type { VercelExecutionToolsOptions } from './VercelExecutionToolsOptions';
 /**
- * !!!!!!
+ * Adapter which creates Promptbook execution tools from Vercel provider
  *
  * @public exported from `@promptbook/vercel`
  */

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

@@ -128,11 +128,17 @@ export type ReservedParameters = Record<string_reserved_parameter_name, string_p
  */
 export type string_title = string;
 /**
- * Description of persona
+ * Unstructured description of the persona
  *
  * For example `"Skilled copywriter"`
  */
 export type string_persona_description = string;
+/**
+ * Unstructured description of the model
+ *
+ * For example `"Model with logical reasoning and creative mindset"`
+ */
+export type string_model_description = string;
 /**
  * Source of one knowledge
  *

package/esm/typings/src/utils/serialization/asSerializable.d.ts

@@ -0,0 +1,11 @@
+import type { really_any } from '../organization/really_any';
+/**
+ * Function `asSerializable` will convert values which are not serializable to serializable values
+ * It walks deeply through the object and converts all values
+ *
+ * For example:
+ * - `Date` objects will be converted to string
+ *
+ * @private Internal helper function
+ */
+export declare function asSerializable(value: really_any): really_any;

package/esm/typings/src/utils/serialization/asSerializable.test.d.ts

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

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/openai",
-    "version": "0.77.0-5",
+    "version": "0.77.0-6",
     "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.77.0-5"
+        "@promptbook/core": "0.77.0-6"
     },
     "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.77.0-4';
+    var PROMPTBOOK_ENGINE_VERSION = '0.77.0-5';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name