Embabel Agent Documentation/com.embabel.agent.api.invocation/AgentInvocation

AgentInvocation

interface AgentInvocation<T : Any> : TypedInvocation<T, AgentInvocation<T>>

Defines the contract for invoking an agent.

Default instances are created with AgentInvocation.create; AgentInvocation.builder allows for customization of the invocation before creation. Once created, invoke or invokeAsync is used to invoke the agent.

Parameters

type of result returned by the invocation

Types

Builder

class Builder

Builder for configuring and creating instances of AgentInvocation.

Companion

object Companion

Properties

resultType

abstract val resultType: Class<T>

The class of the result type this invocation will produce.

Functions

invoke

open fun invoke(map: Map<String, Any>): T

Invokes the agent with a map of named inputs and returns the typed result.

open fun invoke(obj: Any, vararg objs: Any): T

Invokes the agent with one or more arguments and returns the typed result.

invokeAsync

open fun invokeAsync(map: Map<String, Any>): CompletableFuture<T>

Invokes the agent asynchronously with a map of named inputs.

open fun invokeAsync(obj: Any, vararg objs: Any): CompletableFuture<T>

Invokes the agent asynchronously with one or more arguments.

returning

abstract fun returning(resultType: Class): AgentInvocation

run

open fun run(map: Map<String, Any>): AgentProcess

Runs the agent with a map of named inputs.

open fun run(obj: Any, vararg objs: Any): AgentProcess

Runs the agent with one or more arguments

runAsync

abstract fun runAsync(map: Map<String, Any>): CompletableFuture<AgentProcess>

Runs the agent asynchronously with a map of named inputs.

abstract fun runAsync(obj: Any, vararg objs: Any): CompletableFuture<AgentProcess>

Runs the agent asynchronously with one or more arguments

withAgentPlatform

abstract fun withAgentPlatform(agentPlatform: AgentPlatform): AgentInvocation<T>

withProcessOptions

abstract fun withProcessOptions(options: ProcessOptions): AgentInvocation<T>

withResultType

open fun ~~withResultType~~(resultType: Class): AgentInvocation