Type Reference

This section documents external types used in the API, organized by package.

Embabel Agent API Types

From com.embabel.agent.api and related packages:

• Autonomy: Core interface for creating and managing agent goal seekers and process execution
• AgentProcessExecution: Result of an agent process execution containing output, cost info, and execution history
• ProcessOptions: Configuration options for agent process execution including debug flags, delays, and planning options
• AgentPlatform: Platform interface for agent and action management
• AgentProcess: Represents a running agent process

Autonomy Types

• Awaitable<TRequest, TResponse>: Base interface for requests requiring user interaction
• AwaitableResponse: Response type for awaitable requests
• ConfirmationRequest: Awaitable requesting yes/no confirmation from user
• FormBindingRequest: Awaitable requesting form data from user

Goal Types

• GoalChoiceApprover: Interface for approving goal selections
• GoalChoiceApprovalRequest: Request for human approval of a goal choice
• GoalChoiceApprovalResponse: Response to goal approval request
• GoalChoiceApproved: Approval response indicating user approved the goal
• GoalChoiceNotApproved: Approval response indicating user declined the goal
• GoalSelectionOptions: Options for goal selection process

Exception Types

• NoGoalFound: Exception when no suitable goal can be found for an intent
• GoalNotApproved: Exception when chosen goal is not approved by user
• NoAgentFound: Exception when no suitable agent can be found
• ProcessExecutionStuckException: Exception when process cannot proceed
• ProcessExecutionTerminatedException: Exception when process is terminated
• ProcessWaitingException: Exception when process is waiting for user input

Output Channel Types

• OutputChannel: Interface for sending output events from agents
• OutputChannelEvent: Base type for output channel events
• MessageOutputChannelEvent: Event containing a message with sender and content
• ContentOutputChannelEvent: Event containing content data
• ProgressOutputChannelEvent: Event indicating progress updates
• LoggingOutputChannelEvent: Event containing log messages

Chat API Types

From com.embabel.chat package:

• Chatbot: Interface for creating chat sessions
• ChatSession: Represents an interactive chat conversation
• Message types: Various message types for chat interactions

Form/UX Types

• TextField: Form control for text input with validation options
• Button: Form control for submission buttons
• FormSubmission: Data structure containing submitted form data
• FormResponse: Response wrapper for form submission

Spring Framework Types

From org.springframework packages:

• ConfigurableEnvironment: Spring environment configuration interface
• ConfigurableApplicationContext: Spring application context interface
• Component: Annotation marking class as Spring component
• Configuration: Annotation marking class as configuration source
• ConditionalOnProperty: Annotation for conditional bean registration based on properties
• ConditionalOnMissingBean: Annotation for conditional bean registration when bean is missing
• EnableConfigurationProperties: Annotation enabling configuration properties binding
• ConfigurationProperties: Annotation for binding configuration properties to a class
• Autowired: Annotation for dependency injection

Jackson Types

From com.fasterxml.jackson.databind package:

• ObjectMapper: JSON serialization/deserialization utility

JLine Types

From org.jline packages:

• Terminal: Interface for terminal interaction
• LineReader: Interface for reading lines from terminal
• AttributedString: String with text attributes (colors, styles)
• AttributedStyle: Style attributes for terminal text (colors, bold, etc.)

Logback Types

From ch.qos.logback packages:

• LoggerContext: Logback context for managing loggers
• PatternLayoutEncoder: Encoder for formatting log messages with patterns
• Appender: Interface for log output destinations
• FileAppender: Appender for writing logs to files

Utility Types

From com.embabel.common.util package:

• MessageGenerator: Interface for generating dynamic messages
• RandomFromFileMessageGenerator: Implementation that selects random messages from a file resource
• ColorPalette: Interface for defining color schemes
• DefaultColorPalette: Default color scheme implementation

Tool Types

From com.embabel.agent.tools package:

• ToolsStats: Statistics tracking for tool usage

Model Types

From com.embabel.agent.model package:

• ModelProvider: Interface for accessing LLM models

Personality Types

From com.embabel.agent.shell.personality packages:

• LoggingPersonality: Interface for logging personality implementations
• StarWarsColorPalette: Star Wars themed color palette
• LumonColorPalette: Severance/Lumon themed color palette
• HitchhikerColorPalette: Hitchhiker's Guide themed color palette
• ColossusColorPalette: Colossus themed color palette
• MontyPythonColorPalette: Monty Python themed color palette