Class MicroAgentica<Model>

Micro AI chatbot.

MicroAgentica is a facade class for the micro AI chatbot agent which performs LLM (Large Language Model) function calling from the user's conversation and manages the prompt histories.

Different between MicroAgentica and Agentica is that MicroAgentica does not have function selecting filter. It directly list up every functions to the agent. Besides, Agentica has a function selecting mechanism to reduce the number of functions to be listed up to the agent.

Therefore, if you have a lot of functions to call, you must not use this MicroAgentica class. Use this MicroAgentica class only when you have a few functions to call.

Multi-agent orchestration of @agentica
Internal agents of MicroAgentica
- executor
- describier
Internal agents of Agentica
- initializer
- selector
- executor
- describer

Author

Samchon

Type Parameters

Model extends ILlmSchema.Model

Index

Constructors

constructor

Methods

conversate getConfig getControllers getHistories getTokenUsage getVendor off on

Constructors

constructor

new MicroAgentica<Model extends Model>(
props: IMicroAgenticaProps<Model>,
): MicroAgentica<Model>
Initializer Constructor.
Type Parameters
- Model extends Model
Parameters
- props: IMicroAgenticaProps<Model>
  Properties to construct the micro agent
Returns MicroAgentica<Model>
- Defined in packages/core/src/MicroAgentica.ts:70

Methods

conversate

conversate(content: string): Promise<MicroAgenticaHistory<Model>[]>
Conversate with the micro agent.

User talks to the AI chatbot with the given content.

When the user's conversation implies the AI chatbot to execute a function calling, the returned chat prompts will contain the function callinng information like AgenticaExecuteHistory
Parameters
- content: string
  The content to talk
Returns Promise<MicroAgenticaHistory<Model>[]>
List of newly created histories
- Defined in packages/core/src/MicroAgentica.ts:110

getConfig

getConfig(): undefined | IMicroAgenticaConfig<Model>
Get configuration.

Returns undefined | IMicroAgenticaConfig<Model>
- Defined in packages/core/src/MicroAgentica.ts:145

getControllers

getControllers(): readonly IAgenticaController<Model>[]
Get controllers.

Get list of controllers, which are the collection of functions that the agent can execute.

Returns readonly IAgenticaController<Model>[]
- Defined in packages/core/src/MicroAgentica.ts:162

getHistories

getHistories(): MicroAgenticaHistory<Model>[]
Get the chatbot's histories.

Get list of chat histories that the chatbot has been conversated.

Returns MicroAgenticaHistory<Model>[]
List of chat histories
- Defined in packages/core/src/MicroAgentica.ts:173

getTokenUsage

getTokenUsage(): AgenticaTokenUsage
Get token usage of the AI chatbot.

Entire token usage of the AI chatbot during the conversating with the user by conversate method callings.

Returns AgenticaTokenUsage
Cost of the AI chatbot
- Defined in packages/core/src/MicroAgentica.ts:185

getVendor

getVendor(): IAgenticaVendor
Get LLM vendor.

Returns IAgenticaVendor
- Defined in packages/core/src/MicroAgentica.ts:152

off

off<
    Type extends
        | "call"
        | "describe"
        | "execute"
        | "text"
        | "request"
        | "validate"
        | "response",
>(
    type: Type,
    listener: (
        event: MicroAgenticaEvent.Mapper<Model>[Type],
    ) => void | Promise<void>,
): this
Erase an event listener.

Erase an event listener to stop calling the callback function.
Type Parameters
- Type extends "call" | "describe" | "execute" | "text" | "request" | "validate" | "response"
Parameters
- type: Type
  Type of event
- listener: (event: MicroAgenticaEvent.Mapper<Model>[Type]) => void | Promise<void>
  Callback function to erase
Returns this
- Defined in packages/core/src/MicroAgentica.ts:301

on

on<
    Type extends
        | "call"
        | "describe"
        | "execute"
        | "text"
        | "request"
        | "validate"
        | "response",
>(
    type: Type,
    listener: (
        event: MicroAgenticaEvent.Mapper<Model>[Type],
    ) => void | Promise<void>,
): this
Add an event listener.

Add an event listener to be called whenever the event is emitted.
Type Parameters
- Type extends "call" | "describe" | "execute" | "text" | "request" | "validate" | "response"
Parameters
- type: Type
  Type of event
- listener: (event: MicroAgenticaEvent.Mapper<Model>[Type]) => void | Promise<void>
  Callback function to be called whenever the event is emitted
Returns this
- Defined in packages/core/src/MicroAgentica.ts:280

Class MicroAgentica<Model>

Author

Type Parameters

Index

Constructors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns MicroAgentica<Model>

Methods

conversate

Parameters

Returns Promise<MicroAgenticaHistory<Model>[]>

getConfig

Returns undefined | IMicroAgenticaConfig<Model>

getControllers

Returns readonly IAgenticaController<Model>[]

getHistories

Returns MicroAgenticaHistory<Model>[]

getTokenUsage

Returns AgenticaTokenUsage

getVendor

Returns IAgenticaVendor

off

Type Parameters

Parameters

Returns this

on

Type Parameters

Parameters

Returns this

Settings

On This Page