All Implemented Interfaces:

com.embabel.agent.api.invocation.BaseInvocation , com.embabel.agent.api.invocation.ScopedInvocation
```
public final class UtilityInvocation
 implements BaseInvocation<UtilityInvocation>, ScopedInvocation<UtilityInvocation>
                    
```
Invoker for utility agents. Will pick up all @EmbabelComponent and @Agent annotated classes and apply all their actions and goals

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description
`UtilityInvocation(AgentPlatform agentPlatform, ProcessOptions processOptions, AgentScopeBuilder agentScopeBuilder, String agentName)`
`UtilityInvocation(AgentPlatform agentPlatform, ProcessOptions processOptions, AgentScopeBuilder agentScopeBuilder)`
`UtilityInvocation(AgentPlatform agentPlatform, ProcessOptions processOptions)`
`UtilityInvocation(AgentPlatform agentPlatform)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`UtilityInvocation`	`withProcessOptions(ProcessOptions options)`
`final UtilityInvocation`	`terminateWhenStuck()`	Do we terminate the agent process without error if it gets stuck?
`UtilityInvocation`	`withScope(AgentScopeBuilder agentScopeBuilder)`	Set the scope of actions and goals.
`UtilityInvocation`	`withAgentName(String name)`	Set a custom name for the created agent.
`CompletableFuture<AgentProcess>`	`runAsync(Object obj, Object objs)`	Runs the agent asynchronously with one or more arguments
`CompletableFuture<AgentProcess>`	`runAsync(Map<String, Object> map)`	Runs the agent asynchronously with a map of named inputs.
`final Agent`	`createPlatformAgent()`	Create a platform agent for utility invocations
`final static UtilityInvocation`	`on(AgentPlatform agentPlatform)`

Methods inherited from class com.embabel.agent.api.invocation.BaseInvocation
run, run
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - UtilityInvocation
```
UtilityInvocation(AgentPlatform agentPlatform, ProcessOptions processOptions, AgentScopeBuilder agentScopeBuilder, String agentName)
```
    Parameters:
    
    agentPlatform - the agent platform to create and manage agent processes
    
    processOptions - options to configure the agent process
    
    agentScopeBuilder - emits the scope to create the utility agent in
  - UtilityInvocation
```
UtilityInvocation(AgentPlatform agentPlatform, ProcessOptions processOptions, AgentScopeBuilder agentScopeBuilder)
```
    Parameters:
    
    agentPlatform - the agent platform to create and manage agent processes
    
    processOptions - options to configure the agent process
    
    agentScopeBuilder - emits the scope to create the utility agent in
  - UtilityInvocation
```
UtilityInvocation(AgentPlatform agentPlatform, ProcessOptions processOptions)
```
    Parameters:
    
    agentPlatform - the agent platform to create and manage agent processes
    
    processOptions - options to configure the agent process
  - UtilityInvocation
```
UtilityInvocation(AgentPlatform agentPlatform)
```
    Parameters:
    
    agentPlatform - the agent platform to create and manage agent processes
- Method Detail
  - withProcessOptions
```
 UtilityInvocation withProcessOptions(ProcessOptions options)
```
  - terminateWhenStuck
```
 final UtilityInvocation terminateWhenStuck()
```
    Do we terminate the agent process without error if it gets stuck?
  - withScope
```
 UtilityInvocation withScope(AgentScopeBuilder agentScopeBuilder)
```
    Set the scope of actions and goals.
  - withAgentName
```
 UtilityInvocation withAgentName(String name)
```
    Set a custom name for the created agent. If not set, a default name based on the platform will be used.
  - runAsync
```
 CompletableFuture<AgentProcess> runAsync(Object obj, Object objs)
```
    Runs the agent asynchronously with one or more arguments
    
    Parameters:
    
    obj - the first (and possibly only) input value to be added to the blackboard
    
    objs - additional input values to add to the blackboard
    
    Returns:
    
    the future agent process
  - runAsync
```
 CompletableFuture<AgentProcess> runAsync(Map<String, Object> map)
```
    Runs the agent asynchronously with a map of named inputs.
    
    Parameters:
    
    map - A Map that initializes the blackboard
    
    Returns:
    
    the future agent process
  - createPlatformAgent
```
 final Agent createPlatformAgent()
```
    Create a platform agent for utility invocations
  - on
```
 final static UtilityInvocation on(AgentPlatform agentPlatform)
```

Class UtilityInvocation

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class com.embabel.agent.api.invocation.BaseInvocation

Methods inherited from class java.lang.Object

Constructor Detail

UtilityInvocation

UtilityInvocation

UtilityInvocation

UtilityInvocation

Method Detail

withProcessOptions

terminateWhenStuck

withScope

withAgentName

runAsync

runAsync

createPlatformAgent

on