@promptbook/azure-openai 0.103.0-46 → 0.103.0-48

package/esm/typings/src/llm-providers/agent/RemoteAgent.d.ts

@@ -0,0 +1,32 @@
+import type { ChatPromptResult } from '../../execution/PromptResult';
+import type { Prompt } from '../../types/Prompt';
+import { Agent } from './Agent';
+import type { RemoteAgentOptions } from './RemoteAgentOptions';
+/**
+ * Represents one AI Agent
+ *
+ * !!!!!! Note: [🦖] There are several different things in Promptbook:
+ * - `Agent` - which represents an AI Agent with its source, memories, actions, etc. Agent is a higher-level abstraction which is internally using:
+ * !!!!!! `RemoteAgent`
+ * - `LlmExecutionTools` - which wraps one or more LLM models and provides an interface to execute them
+ * - `AgentLlmExecutionTools` - which is a specific implementation of `LlmExecutionTools` that wraps another LlmExecutionTools and applies agent-specific system prompts and requirements
+ * - `OpenAiAssistantExecutionTools` - which is a specific implementation of `LlmExecutionTools` for OpenAI models with assistant capabilities, recommended for usage in `Agent` or `AgentLlmExecutionTools`
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare class RemoteAgent extends Agent {
+    static connect(options: RemoteAgentOptions): Promise<RemoteAgent>;
+    /**
+     * The source of the agent
+     */
+    private agentUrl;
+    private constructor();
+    /**
+     * Calls the agent on agents remote server
+     */
+    callChatModel(prompt: Prompt): Promise<ChatPromptResult>;
+}
+/**
+ * TODO: [🧠][😰]Agent is not working with the parameters, should it be?
+ * TODO: !!! Agent on remote server
+ */

package/esm/typings/src/llm-providers/agent/RemoteAgentOptions.d.ts

@@ -0,0 +1,11 @@
+import type { CommonToolsOptions } from '../../execution/CommonToolsOptions';
+import type { string_agent_url } from '../../types/typeAliases';
+/**
+ * Options for creating a Remote Agent
+ */
+export type RemoteAgentOptions = CommonToolsOptions & {
+    /**
+     * Url of the remote agent
+     */
+    agentUrl: string_agent_url;
+};

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

@@ -1,7 +1,7 @@
 import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
 import type { ChatPromptResult } from '../../execution/PromptResult';
 import type { Prompt } from '../../types/Prompt';
-import type { string_markdown, string_markdown_text, string_title } from '../../types/typeAliases';
+import type { string_markdown, string_markdown_text, string_title, string_token } from '../../types/typeAliases';
 import type { OpenAiAssistantExecutionToolsOptions } from './OpenAiAssistantExecutionToolsOptions';
 import { OpenAiExecutionTools } from './OpenAiExecutionTools';
 /**
@@ -9,7 +9,7 @@ import { OpenAiExecutionTools } from './OpenAiExecutionTools';
  *
  * This is useful for calling OpenAI API with a single assistant, for more wide usage use `OpenAiExecutionTools`.
  *
- * Note: [🦖] There are several different things in Promptbook:
+ * !!! Note: [🦖] There are several different things in Promptbook:
  * - `Agent` - which represents an AI Agent with its source, memories, actions, etc. Agent is a higher-level abstraction which is internally using:
  * - `LlmExecutionTools` - which wraps one or more LLM models and provides an interface to execute them
  * - `AgentLlmExecutionTools` - which is a specific implementation of `LlmExecutionTools` that wraps another LlmExecutionTools and applies agent-specific system prompts and requirements
@@ -18,7 +18,7 @@ import { OpenAiExecutionTools } from './OpenAiExecutionTools';
  * @public exported from `@promptbook/openai`
  */
 export declare class OpenAiAssistantExecutionTools extends OpenAiExecutionTools implements LlmExecutionTools {
-    private readonly assistantId;
+    readonly assistantId: string_token;
     private readonly isCreatingNewAssistantsAllowed;
     /**
      * Creates OpenAI Execution Tools.
@@ -32,7 +32,10 @@ export declare class OpenAiAssistantExecutionTools extends OpenAiExecutionTools
      * Calls OpenAI API to use a chat model.
      */
     callChatModel(prompt: Pick<Prompt, 'content' | 'parameters' | 'modelRequirements' | 'format'>): Promise<ChatPromptResult>;
-    playground(): Promise<void>;
+    /**
+     * Get an existing assistant tool wrapper
+     */
+    getAssistant(assistantId: string_token): OpenAiAssistantExecutionTools;
     createNewAssistant(options: {
         /**
          * Name of the new assistant
@@ -42,6 +45,28 @@ export declare class OpenAiAssistantExecutionTools extends OpenAiExecutionTools
          * Instructions for the new assistant
          */
         readonly instructions: string_markdown;
+        /**
+         * Optional list of knowledge source links (URLs or file paths) to attach to the assistant via vector store
+         */
+        readonly knowledgeSources?: ReadonlyArray<string>;
+    }): Promise<OpenAiAssistantExecutionTools>;
+    updateAssistant(options: {
+        /**
+         * ID of the assistant to update
+         */
+        readonly assistantId: string_token;
+        /**
+         * Name of the assistant
+         */
+        readonly name?: string_title;
+        /**
+         * Instructions for the assistant
+         */
+        readonly instructions?: string_markdown;
+        /**
+         * Optional list of knowledge source links (URLs or file paths) to attach to the assistant via vector store
+         */
+        readonly knowledgeSources?: ReadonlyArray<string>;
     }): Promise<OpenAiAssistantExecutionTools>;
     /**
      * Discriminant for type guards

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

@@ -0,0 +1,4 @@
+export {};
+/**
+ * TODO: [🧠] Maybe do this test for all model providers + boilerplate
+ */

package/esm/typings/src/remote-server/startAgentServer.d.ts

@@ -17,7 +17,7 @@ type AgentsServerOptions = {
  *
  * @see https://github.com/webgptorg/promptbook#remote-server
  * @public exported from `@promptbook/remote-server`
- * <- TODO: !!!! Maybe change to `@promptbook/agent-server`
+ * <- TODO: !!!! Change to `@promptbook/agent-server`
  */
 export declare function startAgentServer(options: AgentsServerOptions): Promise<TODO_any>;
 export {};

package/esm/typings/src/remote-server/startRemoteServer.d.ts

@@ -11,8 +11,7 @@ import type { RemoteServerOptions } from './types/RemoteServerOptions';
  */
 export declare function startRemoteServer<TCustomOptions = undefined>(options: RemoteServerOptions<TCustomOptions>): RemoteServer;
 /**
- * TODO !!!! Add agent
- * TODO: !!!! Allow to chat with agents directly via remote server
+
  * TODO: [🕋] Use here `aboutPromptbookInformation`
  * TODO: [🌡] Add CORS and security - probably via `helmet`
  * TODO: Split this file into multiple functions - handler for each request

package/esm/typings/src/storage/_common/PromptbookStorage.d.ts

@@ -21,4 +21,5 @@ export type PromptbookStorage<TItem> = {
 };
 /**
  * TODO: [💺] Constrain `TItem` to [🚉] JSON-serializable objects only in type level
+ * TODO: [☹️] Unite the storages
  */

package/esm/typings/src/transpilers/openai-sdk/register.d.ts

@@ -7,7 +7,7 @@ import type { Registration } from '../../utils/misc/$Register';
  * @public exported from `@promptbook/wizard`
  * @public exported from `@promptbook/cli`
  *
- * TODO: !!!! Which package should export this?
+ * TODO: [🧠] Which package should export this?
  */
 export declare const _OpenAiSdkTranspilerRegistration: Registration;
 /**

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

@@ -148,6 +148,12 @@ export type string_agent_name = string;
  * For example `"My AI Assistant"`
  */
 export type string_agent_name_in_book = string;
+/**
+ * Semantic helper
+ *
+ * For example `"b126926439c5fcb83609888a11283723c1ef137c0ad599a77a1be81812bd221d"`
+ */
+export type string_agent_hash = string_sha256;
 /**
  * Unstructured description of the persona
  *
@@ -360,6 +366,12 @@ export type string_base_url = string;
  * For example `"https://promptbook.studio/webgpt/"`
  */
 export type string_pipeline_root_url = string;
+/**
+ * Semantic helper
+ *
+ * For example `"https://s6.ptbk.io/agents/agent-007"`
+ */
+export type string_agent_url = string;
 /**
  * Semantic helper
  *

package/esm/typings/src/utils/color/internal-utils/checkChannelValue.d.ts

@@ -9,6 +9,3 @@
  * @private util of `@promptbook/color`
  */
 export declare function checkChannelValue(channelName: string, value: number): asserts value is number;
-/**
- * TODO: [🧠][🚓] Is/which combination it better to use asserts/check, validate or is utility function?
- */

package/esm/typings/src/utils/normalization/normalize-to-kebab-case.d.ts

@@ -9,6 +9,8 @@ export type string_kebab_case = string;
 /**
  * Converts a given text to kebab-case format.
  *
+ * Note: [🔂] This function is idempotent.
+ *
  * @param text The text to be converted.
  * @returns The kebab-case formatted string.
  * @example 'hello-world'

package/esm/typings/src/utils/normalization/normalizeTo_PascalCase.d.ts

@@ -7,6 +7,9 @@
  */
 export type string_PascalCase = string;
 /**
+ * Normalizes a given text to PascalCase format.
+ *
+ * Note: [🔂] This function is idempotent.
  *
  * @param text @public exported from `@promptbook/utils`
  * @returns

package/esm/typings/src/utils/normalization/normalizeTo_camelCase.d.ts

@@ -9,6 +9,8 @@ export type string_camelCase = string;
 /**
  * Normalizes a given text to camelCase format.
  *
+ * Note: [🔂] This function is idempotent.
+ *
  * @param text The text to be normalized.
  * @param _isFirstLetterCapital Whether the first letter should be capitalized.
  * @returns The camelCase formatted string.

package/esm/typings/src/utils/normalization/titleToName.d.ts

@@ -1,6 +1,8 @@
 /**
  * Converts a title string into a normalized name.
  *
+ * Note: [🔂] This function is idempotent.
+ *
  * @param value The title string to be converted to a name.
  * @returns A normalized name derived from the input title.
  * @example 'Hello World!' -> 'hello-world'

package/esm/typings/src/utils/random/$generateBookBoilerplate.d.ts

@@ -1,7 +1,7 @@
 import type { PartialDeep } from 'type-fest';
 import type { AgentBasicInformation } from '../../book-2.0/agent-source/AgentBasicInformation';
-import { string_book } from '../../book-2.0/agent-source/string_book';
-import { string_agent_name_in_book } from '../../types/typeAliases';
+import type { string_book } from '../../book-2.0/agent-source/string_book';
+import type { string_agent_name_in_book } from '../../types/typeAliases';
 type GenerateBookBoilerplateOptions = PartialDeep<Omit<AgentBasicInformation, 'parameters'>> & {
     /**
      * Name of the parent agent to inherit from

package/esm/typings/src/utils/random/$randomFullnameWithColor.d.ts

@@ -1,4 +1,4 @@
-import { string_color, string_person_fullname } from '../../types/typeAliases';
+import type { string_color, string_person_fullname } from '../../types/typeAliases';
 export type RandomFullnameWithColorResult = {
     fullname: string_person_fullname;
     color: string_color;

package/esm/typings/src/version.d.ts

@@ -15,7 +15,7 @@ export declare const BOOK_LANGUAGE_VERSION: string_semantic_version;
 export declare const PROMPTBOOK_ENGINE_VERSION: string_promptbook_version;
 /**
  * Represents the version string of the Promptbook engine.
- * It follows semantic versioning (e.g., `0.103.0-45`).
+ * It follows semantic versioning (e.g., `0.103.0-47`).
  *
  * @generated
  */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/azure-openai",
-    "version": "0.103.0-46",
+    "version": "0.103.0-48",
     "description": "Promptbook: Turn your company's scattered knowledge into AI ready books",
     "private": false,
     "sideEffects": false,
@@ -105,7 +105,7 @@
     "module": "./esm/index.es.js",
     "typings": "./esm/typings/src/_packages/azure-openai.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.103.0-46"
+        "@promptbook/core": "0.103.0-48"
     },
     "dependencies": {
         "@azure/openai": "1.0.0-beta.13",

package/umd/index.umd.js

@@ -24,7 +24,7 @@
      * @generated
      * @see https://github.com/webgptorg/promptbook
      */
-    const PROMPTBOOK_ENGINE_VERSION = '0.103.0-46';
+    const PROMPTBOOK_ENGINE_VERSION = '0.103.0-48';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -259,9 +259,6 @@
             throw new Error(`${channelName} channel is greater than 255, it is ${value}`);
         }
     }
-    /**
-     * TODO: [🧠][🚓] Is/which combination it better to use asserts/check, validate or is utility function?
-     */
 
     /**
      * Color object represents an RGB color with alpha channel
@@ -2279,17 +2276,17 @@
             },
             /**/
             /*/
-          {
-              modelTitle: 'tts-1-hd-1106',
-              modelName: 'tts-1-hd-1106',
-          },
-          /**/
+            {
+                modelTitle: 'tts-1-hd-1106',
+                modelName: 'tts-1-hd-1106',
+            },
+            /**/
             /*/
-          {
-              modelTitle: 'tts-1-hd',
-              modelName: 'tts-1-hd',
-          },
-          /**/
+            {
+                modelTitle: 'tts-1-hd',
+                modelName: 'tts-1-hd',
+            },
+            /**/
             /**/
             {
                 modelVariant: 'CHAT',