docs

tripolskypetr · tripolskypetr · commit d2c014b3cd1e · 2025-07-14T02:00:48.000+05:00
diff --git a/docs/classes/AgentValidationService.md b/docs/classes/AgentValidationService.md
@@ -29,6 +29,16 @@ loggerService: any
 Logger service instance for logging validation operations and errors.
 Injected via DI, used for info-level logging controlled by GLOBAL_CONFIG.CC_LOGGER_ENABLE_INFO.
 
+### completionSchemaService
+
+```ts
+completionSchemaService: any
+```
+
+Completion schema service instance for managing completion schemas.
+Injected via DI, used in validate method to check agent completions.
+Provides a registry of completion schemas for the swarm.
+
 ### toolValidationService
 
 ```ts
diff --git a/docs/classes/ClientCompute.md b/docs/classes/ClientCompute.md
@@ -21,16 +21,16 @@ constructor(params: IComputeParams<Compute>);
 params: IComputeParams<Compute>
 ```
 
-### __@DISPOSE_SLOT_FN_SYMBOL@3100
+### __@DISPOSE_SLOT_FN_SYMBOL@3106
 
 ```ts
-__@DISPOSE_SLOT_FN_SYMBOL@3100: any
+__@DISPOSE_SLOT_FN_SYMBOL@3106: any
 ```
 
-### __@GET_COMPUTE_DATA_FN_SYMBOL@3101
+### __@GET_COMPUTE_DATA_FN_SYMBOL@3107
 
 ```ts
-__@GET_COMPUTE_DATA_FN_SYMBOL@3101: any
+__@GET_COMPUTE_DATA_FN_SYMBOL@3107: any
 ```
 
 ## Methods
diff --git a/docs/classes/ClientSwarm.md b/docs/classes/ClientSwarm.md
@@ -101,7 +101,7 @@ Returns the current busy state of the swarm.
 Used to check if the swarm is currently processing an operation (e.g., waiting for output or switching agents).
 Supports debugging and flow control in client applications.
 
-### __@SET_BUSY_FN@1558
+### __@SET_BUSY_FN@1563
 
 ```ts
 [SET_BUSY_FN](isBusy: boolean): void;
diff --git a/docs/classes/OutlineSchemaService.md b/docs/classes/OutlineSchemaService.md
@@ -50,7 +50,7 @@ validateShallow: any
 ```
 
 Validates an outline schema for required properties and correct types.
-Ensures `outlineName` is a string, `getStructuredOutput` is a function, and `validations` (if present) is an array of valid validation functions or objects.
+Ensures `outlineName` is a string, `getOutlineHistory` is a function, and `validations` (if present) is an array of valid validation functions or objects.
 Logs validation attempts if `CC_LOGGER_ENABLE_INFO` is enabled.
 
 ### register
diff --git a/docs/classes/OutlineValidationService.md b/docs/classes/OutlineValidationService.md
@@ -26,6 +26,25 @@ loggerService: any
 The logger service instance for logging outline-related operations and errors.
 Injected via dependency injection using the TYPES.loggerService identifier.
 
+### completionSchemaService
+
+```ts
+completionSchemaService: any
+```
+
+Completion schema service instance for managing completion schemas.
+Injected via DI, used in validate method to check outline completions.
+Provides a registry of completion schemas for the swarm.
+
+### completionValidationService
+
+```ts
+completionValidationService: any
+```
+
+Completion validation service instance for validating completion configurations of outlines.
+Injected via DI, used in validate method to check outline completion.
+
 ### _outlineMap
 
 ```ts
@@ -44,6 +63,15 @@ addOutline: (outlineName: string, outlineSchema: IOutlineSchema<any, any>) => vo
 Registers a new outline schema with the given name.
 Logs the addition if info logging is enabled and throws an error if the outline name already exists.
 
+### getOutlineList
+
+```ts
+getOutlineList: () => string[]
+```
+
+Retrieves a list of all registered outline names.
+Logs the retrieval operation if info logging is enabled.
+
 ### validate
 
 ```ts
diff --git a/docs/classes/SchemaUtils.md b/docs/classes/SchemaUtils.md
@@ -16,10 +16,10 @@ constructor();
 
 ## Properties
 
-### __@PERSIST_WRITE_SYMBOL@4268
+### __@PERSIST_WRITE_SYMBOL@4302
 
 ```ts
-__@PERSIST_WRITE_SYMBOL@4268: any
+__@PERSIST_WRITE_SYMBOL@4302: any
 ```
 
 ### writeSessionMemory
diff --git a/docs/functions/addOutline.md b/docs/functions/addOutline.md
@@ -6,7 +6,7 @@ group: docs
 # addOutline
 
 ```ts
-declare function addOutline(outlineSchema: IOutlineSchema): string;
+declare function addOutline<Data extends IOutlineData = IOutlineData, Param extends IOutlineParam = IOutlineParam>(outlineSchema: IOutlineSchema<Data, Param>): string;
 ```
 
 Adds an outline schema to the swarm system by registering it with the outline validation and schema services.
diff --git a/docs/index.md b/docs/index.md
@@ -270,6 +270,16 @@ group: docs
 - [IHistory](interfaces/IHistory.md)
 - [IHistoryParams](interfaces/IHistoryParams.md)
 - [IHistorySchema](interfaces/IHistorySchema.md)
+- [IOutlineFormat](interfaces/IOutlineFormat.md)
+- [IOutlineCallbacks](interfaces/IOutlineCallbacks.md)
+- [IOutlineMessage](interfaces/IOutlineMessage.md)
+- [IOutlineHistory](interfaces/IOutlineHistory.md)
+- [IOutlineArgs](interfaces/IOutlineArgs.md)
+- [IOutlineValidationArgs](interfaces/IOutlineValidationArgs.md)
+- [IOutlineValidationFn](interfaces/IOutlineValidationFn.md)
+- [IOutlineValidation](interfaces/IOutlineValidation.md)
+- [IOutlineResult](interfaces/IOutlineResult.md)
+- [IOutlineSchema](interfaces/IOutlineSchema.md)
 - [ICompletion](interfaces/ICompletion.md)
 - [ICompletionArgs](interfaces/ICompletionArgs.md)
 - [ICompletionCallbacks](interfaces/ICompletionCallbacks.md)
@@ -298,16 +308,6 @@ group: docs
 - [IOperatorParams](interfaces/IOperatorParams.md)
 - [IPipelineSchema](interfaces/IPipelineSchema.md)
 - [IPipelineCallbacks](interfaces/IPipelineCallbacks.md)
-- [IOutlineFormat](interfaces/IOutlineFormat.md)
-- [IOutlineCallbacks](interfaces/IOutlineCallbacks.md)
-- [IOutlineMessage](interfaces/IOutlineMessage.md)
-- [IOutlineHistory](interfaces/IOutlineHistory.md)
-- [IOutlineArgs](interfaces/IOutlineArgs.md)
-- [IOutlineValidationArgs](interfaces/IOutlineValidationArgs.md)
-- [IOutlineValidationFn](interfaces/IOutlineValidationFn.md)
-- [IOutlineValidation](interfaces/IOutlineValidation.md)
-- [IOutlineResult](interfaces/IOutlineResult.md)
-- [IOutlineSchema](interfaces/IOutlineSchema.md)
 - [ISchemaContext](interfaces/ISchemaContext.md)
 - [IAgentConnectionService](interfaces/IAgentConnectionService.md)
 - [IHistoryConnectionService](interfaces/IHistoryConnectionService.md)
@@ -373,6 +373,9 @@ group: docs
 - [THistoryInstanceCtor](types/THistoryInstanceCtor.md)
 - [THistoryPersistInstance](types/THistoryPersistInstance.md)
 - [THistoryMemoryInstance](types/THistoryMemoryInstance.md)
+- [IOutlineParam](types/IOutlineParam.md)
+- [IOutlineData](types/IOutlineData.md)
+- [OutlineName](types/OutlineName.md)
 - [CompletionName](types/CompletionName.md)
 - [WikiName](types/WikiName.md)
 - [MCPToolValue](types/MCPToolValue.md)
@@ -387,9 +390,6 @@ group: docs
 - [TExecutionContextService](types/TExecutionContextService.md)
 - [TPayloadContextService](types/TPayloadContextService.md)
 - [PipelineName](types/PipelineName.md)
-- [IOutlineParam](types/IOutlineParam.md)
-- [IOutlineData](types/IOutlineData.md)
-- [OutlineName](types/OutlineName.md)
 - [TSchemaContextService](types/TSchemaContextService.md)
 - [InternalKeys$b](types/InternalKeys$b.md)
 - [TAgentConnectionService](types/TAgentConnectionService.md)
diff --git a/docs/interfaces/ICompletionArgs.md b/docs/interfaces/ICompletionArgs.md
@@ -16,15 +16,28 @@ Encapsulates context and inputs for generating a model response.
 clientId: string
 ```
 
-The unique ID of the client requesting the completion.
+The unique identifier for the client making the request.
+This is used to track the request and associate it with the correct client context.
+For outline completions, this being skipped
 
 ### agentName
 
 ```ts
 agentName: string
 ```
 
-The unique name of the agent associated with the completion request.
+The name of the agent for which the completion is requested.
+This is used to identify the agent context in which the completion will be generated.
+
+### outlineName
+
+```ts
+outlineName: string
+```
+
+The outline used for json completions, if applicable.
+This is the name of the outline schema that defines the structure of the expected JSON response.
+Used to ensure that the completion adheres to the specified outline format.
 
 ### mode
 
@@ -37,7 +50,7 @@ The source of the last message, indicating whether it originated from a tool or
 ### messages
 
 ```ts
-messages: IModelMessage<object>[]
+messages: (IModelMessage<object> | IOutlineMessage)[]
 ```
 
 An array of model messages providing the conversation history or context for the completion.
diff --git a/docs/interfaces/ICompletionCallbacks.md b/docs/interfaces/ICompletionCallbacks.md
@@ -13,7 +13,7 @@ Provides hooks for post-completion actions.
 ### onComplete
 
 ```ts
-onComplete: (args: ICompletionArgs, output: IModelMessage<object>) => void
+onComplete: (args: ICompletionArgs, output: IModelMessage<object> | IOutlineMessage) => void
 ```
 
 Optional callback triggered after a completion is successfully generated.
diff --git a/docs/interfaces/ICompletionSchema.md b/docs/interfaces/ICompletionSchema.md
@@ -18,6 +18,12 @@ completionName: string
 
 The unique name of the completion mechanism within the swarm.
 
+### json
+
+```ts
+json: boolean
+```
+
 ### flags
 
 ```ts
@@ -39,7 +45,7 @@ Optional partial set of callbacks for completion events, allowing customization
 ### getCompletion
 
 ```ts
-getCompletion: (args: ICompletionArgs) => Promise<IModelMessage<object>>
+getCompletion: (args: ICompletionArgs) => Promise<IModelMessage<object> | IOutlineMessage>
 ```
 
 Retrieves a completion based on the provided arguments.
diff --git a/docs/interfaces/IOutlineMessage.md b/docs/interfaces/IOutlineMessage.md
@@ -13,7 +13,7 @@ Used to structure messages stored in the outline history, typically for user, as
 ### role
 
 ```ts
-role: "user" | "assistant" | "system"
+role: "tool" | "user" | "assistant" | "system"
 ```
 
 The role of the message sender, either user, assistant, or system.
@@ -27,3 +27,21 @@ content: string
 
 The content of the message.
 Contains the raw text or param of the message, used in history storage or processing.
+
+### tool_calls
+
+```ts
+tool_calls: IToolCall[]
+```
+
+The name of the agent associated with the message.
+Allow to attach tool call request to specific message
+
+### tool_call_id
+
+```ts
+tool_call_id: string
+```
+
+Optional ID of the tool call associated with the message.
+Used to link the message to a specific tool execution request.
diff --git a/docs/interfaces/IOutlineSchema.md b/docs/interfaces/IOutlineSchema.md
@@ -10,6 +10,14 @@ Defines the structure and behavior of an outline, including data generation and
 
 ## Properties
 
+### completion
+
+```ts
+completion: string
+```
+
+The name of the completion for JSON
+
 ### prompt
 
 ```ts
@@ -77,10 +85,10 @@ Allows customization of attempt, document, and validation handling.
 
 ## Methods
 
-### getStructuredOutput
+### getOutlineHistory
 
 ```ts
-getStructuredOutput: (args: IOutlineArgs<Param>) => Promise<Data>
+getOutlineHistory: (args: IOutlineArgs<Param>) => Promise<void>
 ```
 
 Function to generate structured data for the outline operation.
