agents / Exports / AgentFactory
Class: AgentFactory
Agent Factory for creating and managing agents Instance-based for isolated agent factory management
Table of contents
Constructors
Methods
- initialize
- createAgent
- createFromTemplate
- registerTemplate
- unregisterTemplate
- getTemplates
- getTemplate
- findTemplates
- applyTemplate
- destroyAgent
- getCreationStats
- getActiveAgents
- validateConfiguration
Constructors
constructor
• new AgentFactory(options?, lifecycleEvents?): AgentFactory
Parameters
| Name | Type |
|---|---|
options | IAgentFactoryOptions |
lifecycleEvents | IAgentLifecycleEvents |
Returns
Defined in
packages/agents/src/managers/agent-factory.ts:68
Methods
initialize
▸ initialize(): Promise<void>
Initialize the factory
Returns
Promise<void>
Defined in
packages/agents/src/managers/agent-factory.ts:100
createAgent
▸ createAgent(AgentClass, config, fromTemplate?): Promise<IAgent<IAgentConfig, IRunOptions, TUniversalMessage>>
Create a new agent instance
Parameters
| Name | Type | Default value |
|---|---|---|
AgentClass | (config: IAgentConfig) => IAgent<IAgentConfig, IRunOptions, TUniversalMessage> | undefined |
config | Partial<IAgentConfig> | undefined |
fromTemplate | boolean | false |
Returns
Promise<IAgent<IAgentConfig, IRunOptions, TUniversalMessage>>
Defined in
packages/agents/src/managers/agent-factory.ts:113
createFromTemplate
▸ createFromTemplate(AgentClass, templateId, overrides?): Promise<IAgent<IAgentConfig, IRunOptions, TUniversalMessage>>
Create agent from template
Parameters
| Name | Type |
|---|---|
AgentClass | (config: IAgentConfig) => IAgent<IAgentConfig, IRunOptions, TUniversalMessage> |
templateId | string |
overrides | Partial<IAgentConfig> |
Returns
Promise<IAgent<IAgentConfig, IRunOptions, TUniversalMessage>>
Defined in
packages/agents/src/managers/agent-factory.ts:192
registerTemplate
▸ registerTemplate(template): void
Register a template
Parameters
| Name | Type |
|---|---|
template | IAgentTemplate |
Returns
void
Defined in
packages/agents/src/managers/agent-factory.ts:227
unregisterTemplate
▸ unregisterTemplate(templateId): boolean
Unregister a template
Parameters
| Name | Type |
|---|---|
templateId | string |
Returns
boolean
Defined in
packages/agents/src/managers/agent-factory.ts:234
getTemplates
▸ getTemplates(): IAgentTemplate[]
Get all templates
Returns
Defined in
packages/agents/src/managers/agent-factory.ts:241
getTemplate
▸ getTemplate(templateId): undefined | IAgentTemplate
Get template by ID
Parameters
| Name | Type |
|---|---|
templateId | string |
Returns
undefined | IAgentTemplate
Defined in
packages/agents/src/managers/agent-factory.ts:248
findTemplates
▸ findTemplates(criteria): IAgentTemplate[]
Find templates by criteria
Parameters
| Name | Type |
|---|---|
criteria | Object |
criteria.category? | string |
criteria.tags? | string[] |
criteria.provider? | string |
criteria.model? | string |
Returns
Defined in
packages/agents/src/managers/agent-factory.ts:255
applyTemplate
▸ applyTemplate(template, overrides?): ITemplateApplicationResult
Apply template to configuration
Parameters
| Name | Type |
|---|---|
template | IAgentTemplate |
overrides | Partial<IAgentConfig> |
Returns
Defined in
packages/agents/src/managers/agent-factory.ts:267
destroyAgent
▸ destroyAgent(agentId): Promise<boolean>
Destroy an agent
Parameters
| Name | Type |
|---|---|
agentId | string |
Returns
Promise<boolean>
Defined in
packages/agents/src/managers/agent-factory.ts:274
getCreationStats
▸ getCreationStats(): IAgentCreationStats
Get creation statistics
Returns
Defined in
packages/agents/src/managers/agent-factory.ts:313
getActiveAgents
▸ getActiveAgents(): Map<string, IAgent<IAgentConfig, IRunOptions, TUniversalMessage>>
Get all active agents
Returns
Map<string, IAgent<IAgentConfig, IRunOptions, TUniversalMessage>>
Defined in
packages/agents/src/managers/agent-factory.ts:320
validateConfiguration
▸ validateConfiguration(config): Object
Validate agent configuration
Parameters
| Name | Type |
|---|---|
config | Partial<IAgentConfig> |
Returns
Object
| Name | Type |
|---|---|
isValid | boolean |
errors | string[] |