agent-core / Exports / Robota
Class: Robota
Core AI agent integrating multiple AI providers, tools, and plugins into a unified conversational interface.
Hierarchy
AbstractAgent<IAgentConfig,IRunOptions,TUniversalMessage>↳
Robota
Implements
Table of contents
Constructors
Properties
Methods
- configure
- dispose
- run
- runStream
- getHistory
- clearHistory
- updateTools
- updateConfiguration
- getConfiguration
- setModel
- getModel
- registerTool
- unregisterTool
- getConfig
- addPlugin
- removePlugin
- getPlugin
- getPlugins
- getPluginNames
- registerModule
- unregisterModule
- getModule
- getModulesByType
- getModules
- getModuleNames
- hasModule
- executeModule
- getModuleStats
- getStats
- destroy
Constructors
constructor
• new Robota(config): Robota
Parameters
| Name | Type |
|---|---|
config | IAgentConfig |
Returns
Overrides
Defined in
packages/agent-core/src/core/robota.ts:95
Properties
name
• Readonly name: string
Defined in
packages/agent-core/src/core/robota.ts:71
version
• Readonly version: string = '1.0.0'
Defined in
packages/agent-core/src/core/robota.ts:72
Methods
configure
▸ configure(config): Promise<void>
Configure the agent with type-safe configuration
Parameters
| Name | Type |
|---|---|
config | IAgentConfig |
Returns
Promise<void>
Implementation of
Inherited from
Defined in
packages/agent-core/src/abstracts/abstract-agent.ts:30
dispose
▸ dispose(): Promise<void>
Cleanup resources
Returns
Promise<void>
Inherited from
Defined in
packages/agent-core/src/abstracts/abstract-agent.ts:88
run
▸ run(input, options?): Promise<string>
Run agent with user input and type-safe context
Parameters
| Name | Type |
|---|---|
input | string |
options | IRunOptions |
Returns
Promise<string>
Implementation of
Overrides
Defined in
packages/agent-core/src/core/robota.ts:205
runStream
▸ runStream(input, options?): AsyncGenerator<string, void, undefined>
Run agent with streaming response and type-safe context
Parameters
| Name | Type |
|---|---|
input | string |
options | IRunOptions |
Returns
AsyncGenerator<string, void, undefined>
Implementation of
Overrides
Defined in
packages/agent-core/src/core/robota.ts:210
getHistory
▸ getHistory(): TUniversalMessage[]
Get conversation history with type-safe messages
Returns
Implementation of
Overrides
Defined in
packages/agent-core/src/core/robota.ts:231
clearHistory
▸ clearHistory(): void
Clear conversation history
Returns
void
Implementation of
Overrides
Defined in
packages/agent-core/src/core/robota.ts:243
updateTools
▸ updateTools(next): Promise<{ version: number }>
Parameters
| Name | Type |
|---|---|
next | IToolWithEventService<TToolParameters, IToolResult>[] |
Returns
Promise<{ version: number }>
Defined in
packages/agent-core/src/core/robota.ts:249
updateConfiguration
▸ updateConfiguration(patch): Promise<{ version: number }>
Parameters
| Name | Type |
|---|---|
patch | Partial<IAgentConfig> |
Returns
Promise<{ version: number }>
Defined in
packages/agent-core/src/core/robota.ts:252
getConfiguration
▸ getConfiguration(): Promise<{ version: number ; tools: { name: string ; parameters?: string[] }[] ; updatedAt: number }>
Returns
Promise<{ version: number ; tools: { name: string ; parameters?: string[] }[] ; updatedAt: number }>
Defined in
packages/agent-core/src/core/robota.ts:255
setModel
▸ setModel(mc): void
Parameters
| Name | Type |
|---|---|
mc | Object |
mc.provider | string |
mc.model | string |
mc.temperature? | number |
mc.maxTokens? | number |
mc.topP? | number |
mc.systemMessage? | string |
Returns
void
Defined in
packages/agent-core/src/core/robota.ts:262
getModel
▸ getModel(): Object
Returns
Object
| Name | Type |
|---|---|
provider | string |
model | string |
temperature? | number |
maxTokens? | number |
topP? | number |
systemMessage? | string |
Defined in
packages/agent-core/src/core/robota.ts:272
registerTool
▸ registerTool(tool): void
Parameters
| Name | Type |
|---|---|
tool | AbstractTool<TToolParameters, IToolResult> |
Returns
void
Defined in
packages/agent-core/src/core/robota.ts:282
unregisterTool
▸ unregisterTool(toolName): void
Parameters
| Name | Type |
|---|---|
toolName | string |
Returns
void
Defined in
packages/agent-core/src/core/robota.ts:285
getConfig
▸ getConfig(): IAgentConfig
Returns
Defined in
packages/agent-core/src/core/robota.ts:288
addPlugin
▸ addPlugin(plugin): void
Parameters
| Name | Type |
|---|---|
plugin | IPluginContract<IPluginOptions, IPluginStats> & IPluginHooks |
Returns
void
Defined in
packages/agent-core/src/core/robota.ts:294
removePlugin
▸ removePlugin(pluginName): boolean
Parameters
| Name | Type |
|---|---|
pluginName | string |
Returns
boolean
Defined in
packages/agent-core/src/core/robota.ts:297
getPlugin
▸ getPlugin(pluginName): undefined | IPluginContract<IPluginOptions, IPluginStats> & IPluginHooks
Parameters
| Name | Type |
|---|---|
pluginName | string |
Returns
undefined | IPluginContract<IPluginOptions, IPluginStats> & IPluginHooks
Defined in
packages/agent-core/src/core/robota.ts:300
getPlugins
▸ getPlugins(): IPluginContract<IPluginOptions, IPluginStats> & IPluginHooks[]
Returns
IPluginContract<IPluginOptions, IPluginStats> & IPluginHooks[]
Defined in
packages/agent-core/src/core/robota.ts:305
getPluginNames
▸ getPluginNames(): string[]
Returns
string[]
Defined in
packages/agent-core/src/core/robota.ts:308
registerModule
▸ registerModule(module, options?): Promise<void>
Parameters
| Name | Type |
|---|---|
module | IModule<IBaseModuleOptions, IModuleStats> |
options? | Object |
options.autoInitialize? | boolean |
options.validateDependencies? | boolean |
Returns
Promise<void>
Defined in
packages/agent-core/src/core/robota.ts:314
unregisterModule
▸ unregisterModule(moduleName): Promise<boolean>
Parameters
| Name | Type |
|---|---|
moduleName | string |
Returns
Promise<boolean>
Defined in
packages/agent-core/src/core/robota.ts:320
getModule
▸ getModule(moduleName): undefined | IModule<IBaseModuleOptions, IModuleStats>
Parameters
| Name | Type |
|---|---|
moduleName | string |
Returns
undefined | IModule<IBaseModuleOptions, IModuleStats>
Defined in
packages/agent-core/src/core/robota.ts:323
getModulesByType
▸ getModulesByType(moduleType): IModule<IBaseModuleOptions, IModuleStats>[]
Parameters
| Name | Type |
|---|---|
moduleType | string |
Returns
IModule<IBaseModuleOptions, IModuleStats>[]
Defined in
packages/agent-core/src/core/robota.ts:326
getModules
▸ getModules(): IModule<IBaseModuleOptions, IModuleStats>[]
Returns
IModule<IBaseModuleOptions, IModuleStats>[]
Defined in
packages/agent-core/src/core/robota.ts:329
getModuleNames
▸ getModuleNames(): string[]
Returns
string[]
Defined in
packages/agent-core/src/core/robota.ts:332
hasModule
▸ hasModule(moduleName): boolean
Parameters
| Name | Type |
|---|---|
moduleName | string |
Returns
boolean
Defined in
packages/agent-core/src/core/robota.ts:335
executeModule
▸ executeModule(moduleName, context): Promise<{ success: boolean ; data?: IModuleResultData ; error?: Error ; duration?: number }>
Parameters
| Name | Type |
|---|---|
moduleName | string |
context | Object |
context.executionId? | string |
context.sessionId? | string |
context.userId? | string |
context.metadata? | Record<string, string | number | boolean | Date> |
Returns
Promise<{ success: boolean ; data?: IModuleResultData ; error?: Error ; duration?: number }>
Defined in
packages/agent-core/src/core/robota.ts:338
getModuleStats
▸ getModuleStats(moduleName): undefined | { totalExecutions: number ; successfulExecutions: number ; failedExecutions: number ; averageExecutionTime: number ; lastExecutionTime?: Date }
Parameters
| Name | Type |
|---|---|
moduleName | string |
Returns
undefined | { totalExecutions: number ; successfulExecutions: number ; failedExecutions: number ; averageExecutionTime: number ; lastExecutionTime?: Date }
Defined in
packages/agent-core/src/core/robota.ts:349
getStats
▸ getStats(): Object
Returns
Object
| Name | Type |
|---|---|
name | string |
version | string |
conversationId | string |
providers | string[] |
currentProvider | null | string |
tools | string[] |
plugins | string[] |
modules | string[] |
historyLength | number |
historyStats | TAgentStatsMetadata |
uptime | number |
Defined in
packages/agent-core/src/core/robota.ts:363
destroy
▸ destroy(): Promise<void>
Returns
Promise<void>