docs

Author: tripolskypetr

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "agent-swarm-kit",
-  "version": "1.1.126",
+  "version": "1.1.128",
   "description": "A TypeScript library for building orchestrated framework-agnostic multi-agent AI systems",
   "author": {
     "name": "Petr Tripolsky",

package.json

@@ -0,0 +1,20 @@
+import { IOutlineObjectFormat, IOutlineSchemaFormat } from "../interfaces/Outline.interface";
+
+/**
+ * Converts a given schema object into a JSON schema format object.
+ *
+ * @param {string} name - The name of the schema.
+ * @param {IOutlineObjectFormat} schema - The schema definition object.
+ * @returns {IOutlineSchemaFormat}
+ *   An object containing the JSON schema representation.
+ */
+export const toJsonSchema = (name: string, schema: IOutlineObjectFormat): IOutlineSchemaFormat => ({
+  type: "json_schema",
+  json_schema: {
+    name,
+    strict: true,
+    schema,
+  },
+});
+
+export default toJsonSchema;

src/helpers/toJsonSchema.ts

@@ -283,3 +283,5 @@ export const Utils = {
   PersistPolicyUtils,
   PersistEmbeddingUtils,
 };
+
+export { toJsonSchema } from "./helpers/toJsonSchema";

src/index.ts

@@ -48,7 +48,8 @@ export interface IOutlineSchemaFormat {
 export interface IOutlineObjectFormat {
   /**
    * The root type of the outline format (e.g., "object").
-   * Should be "json_object" for partial JSON schemas or "json_schema" for full matching schemas.
+   * If openai used Should be "json_object" for partial JSON schemas or "json_schema" for full matching schemas.
+   * If ollama or `toJsonSchema` function used should just pass "object"
    */
   type: string;
 

src/interfaces/Outline.interface.ts

@@ -27,7 +27,9 @@ import ComputeSchemaService from "../schema/ComputeSchemaService";
 import OutlineValidationService from "../validation/OutlineValidationService";
 import OutlineSchemaService from "../schema/OutlineSchemaService";
 import {
+  IOutlineObjectFormat,
   IOutlineSchema,
+  IOutlineSchemaFormat,
 } from "../../../interfaces/Outline.interface";
 
 /**
@@ -485,56 +487,74 @@ export class DocService {
         }
       }
 
-      if ("properties" in outlineSchema.format) {
-        result.push("");
-        result.push("## Output format");
-        result.push("");
-        result.push("*Partial template match*");
-        result.push("");
-        const entries = Object.entries(outlineSchema.format.properties);
-        entries.forEach(([key, { type, description, enum: e }], idx) => {
+      const writeObjectFormat = (object: IOutlineObjectFormat, strict: boolean) => {
+        if ("properties" in object) {
           result.push("");
-          result.push(`> **${idx + 1}. ${sanitizeMarkdown(key)}**`);
-          {
-            result.push("");
-            result.push(`*Type:* \`${sanitizeMarkdown(type)}\``);
-          }
-          {
-            result.push("");
-            result.push(`*Description:* \`${sanitizeMarkdown(description)}\``);
-          }
-          if (e) {
+          result.push("## Output format");
+          result.push("");
+          result.push(strict ? "*Strict template match*" : "*Partial template match*");
+          const entries = Object.entries(object.properties);
+          entries.forEach(([key, { type, description, enum: e }], idx) => {
             result.push("");
-            result.push(`*Enum:* \`${e.map(sanitizeMarkdown).join(", ")}\``);
-          }
-          if ("required" in outlineSchema.format) {
+            result.push(`> **${idx + 1}. ${sanitizeMarkdown(key)}**`);
+            {
+              result.push("");
+              result.push(`*Type:* \`${sanitizeMarkdown(type)}\``);
+            }
+            {
+              result.push("");
+              result.push(
+                `*Description:* \`${sanitizeMarkdown(description)}\``
+              );
+            }
+            if (e) {
+              result.push("");
+              result.push(`*Enum:* \`${e.map(sanitizeMarkdown).join(", ")}\``);
+            }
+            if ("required" in object) {
+              result.push("");
+              result.push(
+                `*Required:* [${object.required.includes(key) ? "x" : " "}]`
+              );
+            }
+          });
+          if (!entries.length) {
             result.push("");
-            result.push(
-              `*Required:* [${
-                outlineSchema.format.required.includes(key) ? "x" : " "
-              }]`
-            );
+            result.push(`*Empty parameters*`);
           }
-        });
-        if (!entries.length) {
           result.push("");
-          result.push(`*Empty parameters*`);
         }
-        result.push("");
-      }
+      };
 
-      if (outlineSchema.format.type === "json_schema") {
-        result.push("");
-        result.push("## Output format");
-        result.push("");
-        result.push("*Strict template match*");
-        result.push("");
-        result.push("```json");
-        result.push(JSON.stringify(outlineSchema.format, null, 2));
-        result.push("```");
-        result.push("");
+      const writeStrictFormat = (schema: IOutlineSchemaFormat) => {
+        if (schema?.type === "json_schema") {
+          result.push("");
+          result.push("## Output format");
+          result.push("");
+          result.push("*Strict template match*");
+          result.push("");
+          result.push("```json");
+          result.push(JSON.stringify(schema, null, 2));
+          result.push("```");
+          result.push("");
+        }
+      };
+
+      const writeFormat = () => {
+        let object: any = outlineSchema.format;
+        if (object?.json_schema?.schema?.type === "object") {
+          writeObjectFormat(object.json_schema.schema, true);
+          return;
+        }
+        if (object.properties) {
+          writeObjectFormat(object, false);
+          return;
+        }
+        writeStrictFormat(object);
       }
 
+      writeFormat();
+
       const getValidations = () => {
         if (outlineSchema.validations) {
           return outlineSchema.validations
@@ -553,7 +573,9 @@ export class DocService {
           if (!validations[i].docDescription) {
             continue;
           }
-          result.push(`${i + 1}. \`${sanitizeMarkdown(validations[i].docDescription)}\``);
+          result.push(
+            `${i + 1}. \`${sanitizeMarkdown(validations[i].docDescription)}\``
+          );
           result.push("");
         }
       }

src/lib/services/base/DocService.ts

@@ -3069,7 +3069,8 @@ interface IOutlineSchemaFormat {
 interface IOutlineObjectFormat {
     /**
      * The root type of the outline format (e.g., "object").
-     * Should be "json_object" for partial JSON schemas or "json_schema" for full matching schemas.
+     * If openai used Should be "json_object" for partial JSON schemas or "json_schema" for full matching schemas.
+     * If ollama or `toJsonSchema` function used should just pass "object"
      */
     type: string;
     /**
@@ -15731,6 +15732,16 @@ declare const Adapter: AdapterUtils;
  */
 declare const beginContext: <T extends (...args: any[]) => any>(run: T) => ((...args: Parameters<T>) => ReturnType<T>);
 
+/**
+ * Converts a given schema object into a JSON schema format object.
+ *
+ * @param {string} name - The name of the schema.
+ * @param {IOutlineObjectFormat} schema - The schema definition object.
+ * @returns {IOutlineSchemaFormat}
+ *   An object containing the JSON schema representation.
+ */
+declare const toJsonSchema: (name: string, schema: IOutlineObjectFormat) => IOutlineSchemaFormat;
+
 declare const Utils: {
     PersistStateUtils: typeof PersistStateUtils;
     PersistSwarmUtils: typeof PersistSwarmUtils;
@@ -15741,4 +15752,4 @@ declare const Utils: {
     PersistEmbeddingUtils: typeof PersistEmbeddingUtils;
 };
 
-export { Adapter, Chat, ChatInstance, Compute, type EventSource, ExecutionContextService, History, HistoryMemoryInstance, HistoryPersistInstance, type IAgentSchemaInternal, type IAgentTool, type IBaseEvent, type IBusEvent, type IBusEventContext, type IChatArgs, type IChatInstance, type IChatInstanceCallbacks, type ICompletionArgs, type ICompletionSchema, type IComputeSchema, type ICustomEvent, type IEmbeddingSchema, type IGlobalConfig, type IHistoryAdapter, type IHistoryControl, type IHistoryInstance, type IHistoryInstanceCallbacks, type IIncomingMessage, type ILoggerAdapter, type ILoggerInstance, type ILoggerInstanceCallbacks, type IMCPSchema, type IMCPTool, type IMCPToolCallDto, type IMakeConnectionConfig, type IMakeDisposeParams, type IModelMessage, type INavigateToAgentParams, type INavigateToTriageParams, type IOutgoingMessage, type IOutlineFormat, type IOutlineHistory, type IOutlineMessage, type IOutlineObjectFormat, type IOutlineResult, type IOutlineSchema, type IOutlineSchemaFormat, type IOutlineValidationFn, type IPersistActiveAgentData, type IPersistAliveData, type IPersistBase, type IPersistEmbeddingData, type IPersistMemoryData, type IPersistNavigationStackData, type IPersistPolicyData, type IPersistStateData, type IPersistStorageData, type IPipelineSchema, type IPolicySchema, type ISessionConfig, type IStateSchema, type IStorageData, type IStorageSchema, type ISwarmSchema, type ITool, type IToolCall, type IWikiSchema, Logger, LoggerInstance, MCP, type MCPToolProperties, MethodContextService, Operator, OperatorInstance, PayloadContextService, PersistAlive, PersistBase, PersistEmbedding, PersistList, PersistMemory, PersistPolicy, PersistState, PersistStorage, PersistSwarm, Policy, type ReceiveMessageFn, RoundRobin, Schema, SchemaContextService, type SendMessageFn, SharedCompute, SharedState, SharedStorage, State, Storage, type THistoryInstanceCtor, type THistoryMemoryInstance, type THistoryPersistInstance, type TLoggerInstance, type TOperatorInstance, type TPersistBase, type TPersistBaseCtor, type TPersistList, type ToolValue, Utils, addAgent, addAgentNavigation, addCompletion, addCompute, addEmbedding, addMCP, addOutline, addPipeline, addPolicy, addState, addStorage, addSwarm, addTool, addTriageNavigation, addWiki, beginContext, cancelOutput, cancelOutputForce, changeToAgent, changeToDefaultAgent, changeToPrevAgent, commitAssistantMessage, commitAssistantMessageForce, commitFlush, commitFlushForce, commitStopTools, commitStopToolsForce, commitSystemMessage, commitSystemMessageForce, commitToolOutput, commitToolOutputForce, commitToolRequest, commitToolRequestForce, commitUserMessage, commitUserMessageForce, complete, createNavigateToAgent, createNavigateToTriageAgent, disposeConnection, dumpAgent, dumpClientPerformance, dumpDocs, dumpPerfomance, dumpSwarm, emit, emitForce, event, execute, executeForce, fork, getAgent, getAgentHistory, getAgentName, getAssistantHistory, getCheckBusy, getCompletion, getCompute, getEmbeding, getLastAssistantMessage, getLastSystemMessage, getLastUserMessage, getMCP, getNavigationRoute, getPayload, getPipeline, getPolicy, getRawHistory, getSessionContext, getSessionMode, getState, getStorage, getSwarm, getTool, getToolNameForModel, getUserHistory, getWiki, hasNavigation, hasSession, json, listenAgentEvent, listenAgentEventOnce, listenEvent, listenEventOnce, listenExecutionEvent, listenExecutionEventOnce, listenHistoryEvent, listenHistoryEventOnce, listenPolicyEvent, listenPolicyEventOnce, listenSessionEvent, listenSessionEventOnce, listenStateEvent, listenStateEventOnce, listenStorageEvent, listenStorageEventOnce, listenSwarmEvent, listenSwarmEventOnce, makeAutoDispose, makeConnection, markOffline, markOnline, notify, notifyForce, overrideAgent, overrideCompletion, overrideCompute, overrideEmbeding, overrideMCP, overrideOutline, overridePipeline, overridePolicy, overrideState, overrideStorage, overrideSwarm, overrideTool, overrideWiki, question, questionForce, runStateless, runStatelessForce, scope, session, setConfig, startPipeline, swarm };
+export { Adapter, Chat, ChatInstance, Compute, type EventSource, ExecutionContextService, History, HistoryMemoryInstance, HistoryPersistInstance, type IAgentSchemaInternal, type IAgentTool, type IBaseEvent, type IBusEvent, type IBusEventContext, type IChatArgs, type IChatInstance, type IChatInstanceCallbacks, type ICompletionArgs, type ICompletionSchema, type IComputeSchema, type ICustomEvent, type IEmbeddingSchema, type IGlobalConfig, type IHistoryAdapter, type IHistoryControl, type IHistoryInstance, type IHistoryInstanceCallbacks, type IIncomingMessage, type ILoggerAdapter, type ILoggerInstance, type ILoggerInstanceCallbacks, type IMCPSchema, type IMCPTool, type IMCPToolCallDto, type IMakeConnectionConfig, type IMakeDisposeParams, type IModelMessage, type INavigateToAgentParams, type INavigateToTriageParams, type IOutgoingMessage, type IOutlineFormat, type IOutlineHistory, type IOutlineMessage, type IOutlineObjectFormat, type IOutlineResult, type IOutlineSchema, type IOutlineSchemaFormat, type IOutlineValidationFn, type IPersistActiveAgentData, type IPersistAliveData, type IPersistBase, type IPersistEmbeddingData, type IPersistMemoryData, type IPersistNavigationStackData, type IPersistPolicyData, type IPersistStateData, type IPersistStorageData, type IPipelineSchema, type IPolicySchema, type ISessionConfig, type IStateSchema, type IStorageData, type IStorageSchema, type ISwarmSchema, type ITool, type IToolCall, type IWikiSchema, Logger, LoggerInstance, MCP, type MCPToolProperties, MethodContextService, Operator, OperatorInstance, PayloadContextService, PersistAlive, PersistBase, PersistEmbedding, PersistList, PersistMemory, PersistPolicy, PersistState, PersistStorage, PersistSwarm, Policy, type ReceiveMessageFn, RoundRobin, Schema, SchemaContextService, type SendMessageFn, SharedCompute, SharedState, SharedStorage, State, Storage, type THistoryInstanceCtor, type THistoryMemoryInstance, type THistoryPersistInstance, type TLoggerInstance, type TOperatorInstance, type TPersistBase, type TPersistBaseCtor, type TPersistList, type ToolValue, Utils, addAgent, addAgentNavigation, addCompletion, addCompute, addEmbedding, addMCP, addOutline, addPipeline, addPolicy, addState, addStorage, addSwarm, addTool, addTriageNavigation, addWiki, beginContext, cancelOutput, cancelOutputForce, changeToAgent, changeToDefaultAgent, changeToPrevAgent, commitAssistantMessage, commitAssistantMessageForce, commitFlush, commitFlushForce, commitStopTools, commitStopToolsForce, commitSystemMessage, commitSystemMessageForce, commitToolOutput, commitToolOutputForce, commitToolRequest, commitToolRequestForce, commitUserMessage, commitUserMessageForce, complete, createNavigateToAgent, createNavigateToTriageAgent, disposeConnection, dumpAgent, dumpClientPerformance, dumpDocs, dumpPerfomance, dumpSwarm, emit, emitForce, event, execute, executeForce, fork, getAgent, getAgentHistory, getAgentName, getAssistantHistory, getCheckBusy, getCompletion, getCompute, getEmbeding, getLastAssistantMessage, getLastSystemMessage, getLastUserMessage, getMCP, getNavigationRoute, getPayload, getPipeline, getPolicy, getRawHistory, getSessionContext, getSessionMode, getState, getStorage, getSwarm, getTool, getToolNameForModel, getUserHistory, getWiki, hasNavigation, hasSession, json, listenAgentEvent, listenAgentEventOnce, listenEvent, listenEventOnce, listenExecutionEvent, listenExecutionEventOnce, listenHistoryEvent, listenHistoryEventOnce, listenPolicyEvent, listenPolicyEventOnce, listenSessionEvent, listenSessionEventOnce, listenStateEvent, listenStateEventOnce, listenStorageEvent, listenStorageEventOnce, listenSwarmEvent, listenSwarmEventOnce, makeAutoDispose, makeConnection, markOffline, markOnline, notify, notifyForce, overrideAgent, overrideCompletion, overrideCompute, overrideEmbeding, overrideMCP, overrideOutline, overridePipeline, overridePolicy, overrideState, overrideStorage, overrideSwarm, overrideTool, overrideWiki, question, questionForce, runStateless, runStatelessForce, scope, session, setConfig, startPipeline, swarm, toJsonSchema };