ContextAssembly API
Context Assembly API
import { CodeBoltClient } from '@codebolt/clientsdk';
const client = new CodeBoltClient();
Quick Reference
| Method | Description |
|---|---|
assemble | Assembles context from multiple sources. |
evaluateRules | Evaluates context rules against provided data. |
getMemoryTypes | Retrieves available memory types for context assembly. |
getRequiredVariables | Retrieves required variables for a context assembly configuration. |
validate | Validates a context assembly configuration. |
Methods
assemble
client.contextAssembly.assemble(data: ContextAssembleRequest): Promise<ContextAssembleResult>
Assembles context from multiple sources.
Gathers and merges data from configured context sources (memory types, rules, files) into a single unified context object for agent consumption.
| Parameter | Type | Required | Description |
|---|---|---|---|
data | ContextAssembleRequest | Yes | The assembly request specifying sources and parameters |
Returns: Promise<ContextAssembleResult> — A promise that resolves to the assembled
evaluateRules
client.contextAssembly.evaluateRules(data: EvaluateContextRulesRequest): Promise<unknown>
Evaluates context rules against provided data.
Runs the configured context rules to determine which context sources should be included based on the current state.
| Parameter | Type | Required | Description |
|---|---|---|---|
data | EvaluateContextRulesRequest | Yes | The evaluation request with rule inputs |
Returns: Promise<unknown> — A promise that resolves with the rule evaluation results
getMemoryTypes
client.contextAssembly.getMemoryTypes(): Promise<ContextMemoryType[]>
Retrieves available memory types for context assembly.
Returns the list of memory type sources that can be used when assembling context (e.g., episodic, semantic, working memory).
No parameters.
Returns: Promise<ContextMemoryType[]> — A promise that resolves to an array of objects
getRequiredVariables
client.contextAssembly.getRequiredVariables(data: GetRequiredVariablesRequest): Promise<string[]>
Retrieves required variables for a context assembly configuration.
Returns the list of variable names that must be provided when assembling context with the given configuration.
| Parameter | Type | Required | Description |
|---|---|---|---|
data | GetRequiredVariablesRequest | Yes | The configuration to inspect for required variables |
Returns: Promise<string[]> — A promise that resolves to an array of variable name strings
validate
client.contextAssembly.validate(data: ValidateContextAssemblyRequest): Promise<unknown>
Validates a context assembly configuration.
Checks that the provided assembly configuration is valid and all referenced sources and rules exist before execution.
| Parameter | Type | Required | Description |
|---|---|---|---|
data | ValidateContextAssemblyRequest | Yes | The configuration to validate |
Returns: Promise<unknown> — A promise that resolves with the validation result