All Implemented Interfaces:

com.embabel.agent.core.ToolConsumer , com.embabel.agent.core.ToolGroupConsumer , com.embabel.agent.core.ToolSpec , com.embabel.agent.core.ToolSpecConsumer , com.embabel.agent.core.support.LlmCall , com.embabel.agent.core.support.LlmUse , com.embabel.common.ai.prompt.PromptContributorConsumer
```
public final class LlmInteraction
 implements LlmCall
                    
```
Encapsulates an interaction with an LLM. An LlmInteraction is a specific instance of an LlmCall. The LLM must have been chosen and the call has a unique identifier.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description
`private final String`	`name`
`private final InteractionId`	`id`
`private final LlmOptions`	`llm`
`private final Set<ToolGroupRequirement>`	`toolGroups`
`private final List<Tool>`	`tools`
`private final List<PromptContributor>`	`promptContributors`
`private final List<ContextualPromptElement>`	`contextualPromptContributors`
`private final Boolean`	`generateExamples`
`private final Predicate<String>`	`propertyFilter`
`private final Boolean`	`validation`
`private final Boolean`	`useEmbabelToolLoop`
`private final Integer`	`maxToolIterations`
`private final List<GuardRail>`	`guardRails`
`private final List<ToolInjectionStrategy>`	`additionalInjectionStrategies`

Constructor Summary

Constructors
Constructor	Description
`LlmInteraction(InteractionId id, LlmOptions llm, Set<ToolGroupRequirement> toolGroups, List<Tool> tools, List<PromptContributor> promptContributors, List<ContextualPromptElement> contextualPromptContributors, Boolean generateExamples, Predicate<String> propertyFilter, Boolean validation, Boolean useEmbabelToolLoop, Integer maxToolIterations, List<GuardRail> guardRails, List<ToolInjectionStrategy> additionalInjectionStrategies)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`String`	`getName()`
`final InteractionId`	`getId()`
`LlmOptions`	`getLlm()`
`Set<ToolGroupRequirement>`	`getToolGroups()`	Tool groups exposed.
`List<Tool>`	`getTools()`
`List<PromptContributor>`	`getPromptContributors()`
`List<ContextualPromptElement>`	`getContextualPromptContributors()`
`Boolean`	`getGenerateExamples()`	Whether to generate examples for the prompt.
`Predicate<String>`	`getPropertyFilter()`	Filter that determines which properties to include when creating objects.
`Boolean`	`getValidation()`	Whether to validate generated objects.
`final Boolean`	`getUseEmbabelToolLoop()`
`final Integer`	`getMaxToolIterations()`
`final List<GuardRail>`	`getGuardRails()`
`final List<ToolInjectionStrategy>`	`getAdditionalInjectionStrategies()`
`final String`	`getId()`	Get the interaction ID as a String.
`final static LlmInteraction`	`from(LlmCall llm, InteractionId id)`
`final static LlmInteraction`	`using(LlmOptions llm)`

Methods inherited from class com.embabel.agent.core.ToolConsumer
resolveTools
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - LlmInteraction
```
LlmInteraction(InteractionId id, LlmOptions llm, Set<ToolGroupRequirement> toolGroups, List<Tool> tools, List<PromptContributor> promptContributors, List<ContextualPromptElement> contextualPromptContributors, Boolean generateExamples, Predicate<String> propertyFilter, Boolean validation, Boolean useEmbabelToolLoop, Integer maxToolIterations, List<GuardRail> guardRails, List<ToolInjectionStrategy> additionalInjectionStrategies)
```
    Parameters:
    
    id - Unique identifier for the interaction.
    
    llm - LLM options to use, specifying model and hyperparameters
    
    tools - Tools to use for this interaction
    
    promptContributors - Prompt contributors to use for this interaction
    
    useEmbabelToolLoop - If true, use Embabel's own tool loop instead of Spring AI's.
    
    maxToolIterations - Maximum number of tool loop iterations (default 20)
- Method Detail
  - getName
```
 String getName()
```
  - getId
```
 final InteractionId getId()
```
  - getLlm
```
 LlmOptions getLlm()
```
  - getToolGroups
```
 Set<ToolGroupRequirement> getToolGroups()
```
    Tool groups exposed. This will include directly registered tool groups and tool groups resolved from ToolGroups.
  - getTools
```
 List<Tool> getTools()
```
  - getPromptContributors
```
 List<PromptContributor> getPromptContributors()
```
  - getContextualPromptContributors
```
 List<ContextualPromptElement> getContextualPromptContributors()
```
  - getGenerateExamples
```
 Boolean getGenerateExamples()
```
    Whether to generate examples for the prompt. Defaults to unknown: Set to false if generating your own examples.
  - getPropertyFilter
```
 Predicate<String> getPropertyFilter()
```
    Filter that determines which properties to include when creating objects.
  - getValidation
```
 Boolean getValidation()
```
    Whether to validate generated objects. Defaults to true; set to false to skip validation.
  - getUseEmbabelToolLoop
```
 final Boolean getUseEmbabelToolLoop()
```
  - getMaxToolIterations
```
 final Integer getMaxToolIterations()
```
  - getGuardRails
```
 final List<GuardRail> getGuardRails()
```
  - getAdditionalInjectionStrategies
```
 final List<ToolInjectionStrategy> getAdditionalInjectionStrategies()
```
  - getId
```
 final String getId()
```
    Get the interaction ID as a String. Provided for Java compatibility since value classes don't generate standard getters.
  - from
```
 final static LlmInteraction from(LlmCall llm, InteractionId id)
```
  - using
```
 final static LlmInteraction using(LlmOptions llm)
```

Class LlmInteraction

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class com.embabel.agent.core.ToolConsumer

Methods inherited from class java.lang.Object

Constructor Detail

LlmInteraction

Method Detail

getName

getId

getLlm

getToolGroups

getTools

getPromptContributors

getContextualPromptContributors

getGenerateExamples

getPropertyFilter

getValidation

getUseEmbabelToolLoop

getMaxToolIterations

getGuardRails

getAdditionalInjectionStrategies

getId

from

using