All Implemented Interfaces:

com.embabel.agent.core.ToolCallbackConsumer , com.embabel.agent.core.ToolCallbackSpec , com.embabel.agent.core.ToolConsumer , com.embabel.agent.core.ToolGroupConsumer , com.embabel.agent.spi.LlmCall , com.embabel.agent.spi.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<ToolCallback>`	`toolCallbacks`
`private final List<PromptContributor>`	`promptContributors`
`private final List<ContextualPromptElement>`	`contextualPromptContributors`
`private final Boolean`	`generateExamples`
`private final Predicate<String>`	`propertyFilter`

Constructor Summary

Constructors
Constructor	Description
`LlmInteraction(InteractionId id, LlmOptions llm, Set<ToolGroupRequirement> toolGroups, List<ToolCallback> toolCallbacks, List<PromptContributor> promptContributors, List<ContextualPromptElement> contextualPromptContributors, Boolean generateExamples, Predicate<String> propertyFilter)`

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<ToolCallback>`	`getToolCallbacks()`
`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.
`final static LlmInteraction`	`from(LlmCall llm, InteractionId id)`
`final static LlmInteraction`	`using(LlmOptions llm)`

Methods inherited from class com.embabel.agent.core.ToolConsumer
resolveToolCallbacks
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<ToolCallback> toolCallbacks, List<PromptContributor> promptContributors, List<ContextualPromptElement> contextualPromptContributors, Boolean generateExamples, Predicate<String> propertyFilter)

Parameters:: id - Unique identifier for the interaction.; llm - LLM options to use, specifying model and hyperparameters; toolCallbacks - Tool callbacks to use for this interaction; promptContributors - Prompt contributors to use for this interaction

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.

getToolCallbacks
```
 List<ToolCallback> getToolCallbacks()
```

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.

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

getToolCallbacks

getPromptContributors

getContextualPromptContributors

getGenerateExamples

getPropertyFilter

from

using