Embabel Agent Documentation/com.embabel.agent.core.hitl

Package-level declarations

Types

abstract class AbstractAwaitable(val payload: P, val id: String = UUID.randomUUID().toString(), val timestamp: Instant = Instant.now(), persistent: Boolean = false) : Awaitable<P, R>

Convenient support for implementing Awaitable

Awaitable

interface Awaitable

Something awaited by an agent process, such as a request for user input. Added to the Blackboard and treated specially.

AwaitableFactory

fun interface AwaitableFactory

Factory for creating awaitable decisions based on tool execution context.

AwaitableResponse

interface AwaitableResponse

Response to an Awaitable

AwaitableResponseException

class AwaitableResponseException(val awaitable: Awaitable<*, *>) : RuntimeException, ToolControlFlowSignal

Not an error, but gets special treatment in the platform. Implements ToolControlFlowSignal so it propagates through com.embabel.agent.api.tool.TypedTool.call.

AwaitableTypedTool

abstract class AwaitableTypedTool constructor(name: String, description: String, inputType: Class, outputType: Class<O>, metadata: Tool.Metadata = Tool.Metadata.DEFAULT, objectMapper: <Error class: unknown class> = jacksonObjectMapper()) : TypedTool<I, O>

Abstract typed tool that supports Human-in-the-Loop (HITL) interactions.

AwaitContext

data class AwaitContext(val input: String, val agentProcess: AgentProcess, val tool: Tool)

Context provided to awaiting decision functions.

AwaitDecider

fun interface AwaitDecider

Functional interface for deciding whether to await before tool execution.

ConditionalAwaitingTool

class ConditionalAwaitingTool(val delegate: Tool, decider: AwaitDecider) : DelegatingTool

Tool decorator that conditionally requires awaiting before execution.

ConfirmationRequest

class ConfirmationRequest constructor(payload: P, val message: String, persistent: Boolean = false) : AbstractAwaitable<P, ConfirmationResponse>

Request confirmation from the user before promoting an object to the blackboard. Rejection will hold back a flow.

ConfirmationResponse

data class ConfirmationResponse(val id: String = UUID.randomUUID().toString(), val awaitableId: String, val accepted: Boolean, persistent: Boolean = false, val timestamp: Instant = Instant.now()) : AwaitableResponse

ConfirmingTool

class ConfirmingTool(val delegate: Tool, messageProvider: (String) -> String) : DelegatingTool

Tool decorator that always requires confirmation before executing the delegate.

FormBindingRequest

class FormBindingRequest<O : Any> constructor(form: Form, val outputClass: Class<O>, val population: O? = null, val validationErrors: List<ValidationError> = emptyList(), persistent: Boolean = false) : AbstractAwaitable<Form, FormResponse>

Present the user with a form and bind it to the given class

FormResponse

data class FormResponse(val id: String = UUID.randomUUID().toString(), val awaitableId: String, val formSubmission: FormSubmission, persistent: Boolean = false, val timestamp: Instant = Instant.now()) : AwaitableResponse

Response from the UX

ResponseImpact

enum ResponseImpact : Enum<ResponseImpact>

Response of handling an Awaitable

SimpleAwaitableTypedTool

class SimpleAwaitableTypedTool constructor(name: String, description: String, inputType: Class, outputType: Class<O>, awaitableFactory: AwaitableFactory<I, P>, executor: (I) -> O, metadata: Tool.Metadata = Tool.Metadata.DEFAULT, objectMapper: <Error class: unknown class> = jacksonObjectMapper()) : TypedTool<I, O>

Simple implementation of AwaitableTypedTool using functional factories.

TypeRequest

class TypeRequest<T : Any> constructor(val type: Class<T>, val message: String? = null, val hint: T? = null, persistent: Boolean = false) : AbstractAwaitable<Class<T>, TypeResponse<T>>

Request a value of type T from the user.

TypeRequestingTool

class TypeRequestingTool<T : Any>(val delegate: Tool, type: Class<T>, messageProvider: (String) -> String? = { null }) : DelegatingTool

Tool decorator that requires a value of type T from the user before execution.

TypeResponse

data class TypeResponse<T : Any>(val value: T, val awaitableId: String, val id: String = UUID.randomUUID().toString(), val timestamp: Instant = Instant.now(), persistent: Boolean = false) : AwaitableResponse

Response providing a value of the requested type.

ValidationError

interface ValidationError

WaitFor

open class WaitFor

Java syntax sugar for HITL