Skip to main content

Common Types Reference

This section provides documentation for common TypeScript types, interfaces, and enums used throughout the Agent Forge framework. Understanding these types is crucial for effectively configuring agents, defining tools, and interpreting results.

Key type categories and important definitions include:

  • Core Configuration & Results:

    • AgentConfig: Defines the configuration for an Agent.
    • ToolConfig: Describes the static configuration of a Tool.
    • ToolParameter: Specifies the parameters a Tool accepts.
    • AgentResult: The standard structure for results returned by agents, workflows, and teams.
    • ToolCall: Details a single tool invocation made during an agent's run.

  • Communication & Events:

    • Message: Represents a message in an agent's conversation history.
    • ExecutionMode: Enum for agent execution modes (e.g., sequential, hierarchical).
    • AgentForgeEvents: Enum listing event types used by the framework's event emitter.

Many simpler types or those specific to a single class (like LLMResponse or TeamRunOptions) are documented directly on the page of the class/function that uses them. Refer to the relevant API pages for those.

Select a page from the sidebar to explore these common type definitions in more detail.