@promptbook/markdown-utils 0.103.0-45 → 0.103.0-47

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

@@ -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
@@ -42,6 +42,10 @@ 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>;
     /**
      * Discriminant for type guards

package/esm/typings/src/pipeline/validatePipelineString.d.ts

@@ -3,6 +3,8 @@ import type { PipelineString } from './PipelineString';
  * Function `validatePipelineString` will validate the if the string is a valid pipeline string
  * It does not check if the string is fully logically correct, but if it is a string that can be a pipeline string or the string looks completely different.
  *
+ * Note: [🔂] This function is idempotent.
+ *
  * @param {string} pipelineString the candidate for a pipeline string
  * @returns {PipelineString} the same string as input, but validated as valid
  * @throws {ParseError} if the string is not a valid pipeline string

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/types/typeAliases.d.ts

@@ -360,6 +360,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/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/utils/validators/parameterName/validateParameterName.d.ts

@@ -3,6 +3,8 @@ import type { string_parameter_name } from '../../../types/typeAliases';
  * Function `validateParameterName` will normalize and validate a parameter name for use in pipelines.
  * It removes diacritics, emojis, and quotes, normalizes to camelCase, and checks for reserved names and invalid characters.
  *
+ * Note: [🔂] This function is idempotent.
+ *
  * @param parameterName The parameter name to validate and normalize.
  * @returns The validated and normalized parameter name.
  * @throws {ParseError} If the parameter name is empty, reserved, or contains invalid characters.

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-44`).
+ * It follows semantic versioning (e.g., `0.103.0-46`).
  *
  * @generated
  */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/markdown-utils",
-    "version": "0.103.0-45",
+    "version": "0.103.0-47",
     "description": "Promptbook: Turn your company's scattered knowledge into AI ready books",
     "private": false,
     "sideEffects": false,

package/umd/index.umd.js

@@ -24,7 +24,7 @@
      * @generated
      * @see https://github.com/webgptorg/promptbook
      */
-    const PROMPTBOOK_ENGINE_VERSION = '0.103.0-45';
+    const PROMPTBOOK_ENGINE_VERSION = '0.103.0-47';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -402,9 +402,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
@@ -1524,6 +1521,8 @@
      * Function `validatePipelineString` will validate the if the string is a valid pipeline string
      * It does not check if the string is fully logically correct, but if it is a string that can be a pipeline string or the string looks completely different.
      *
+     * Note: [🔂] This function is idempotent.
+     *
      * @param {string} pipelineString the candidate for a pipeline string
      * @returns {PipelineString} the same string as input, but validated as valid
      * @throws {ParseError} if the string is not a valid pipeline string
@@ -2102,6 +2101,8 @@
      * -   if it is valid json
      * -   if it is meaningful
      *
+     * Note: [🔂] This function is idempotent.
+     *
      * @param pipeline valid or invalid PipelineJson
      * @returns the same pipeline if it is logically valid
      * @throws {PipelineLogicError} on logical error in the pipeline
@@ -5880,6 +5881,8 @@
      * This function provides a common abstraction for result validation that can be used
      * by both execution logic and caching logic to ensure consistency.
      *
+     * Note: [🔂] This function is idempotent.
+     *
      * @param options - The validation options including result string, expectations, and format
      * @returns Validation result with processed string and validity status
      * @private internal function of `createPipelineExecutor` and `cacheLlmTools`