Embabel Agent Documentation/com.embabel.agent.api.reference/LlmReference

LlmReference

interface LlmReference : PromptContributor

An LLmReference exposes tools and is a prompt contributor. The prompt contribution might describe how to use the tools or can include relevant information directly. Consider, for example, a reference to an API which is so small it's included in the prompt, versus a large API which must be accessed via tools. The reference name is used in a strategy for tool naming, so should be fairly short. Description may be more verbose. If you want a custom naming strategy, use a ToolObject directly, and add the PromptContributor separately.

Inheritors

EagerSearch

LiteralText

LocalDirectoryReference

ClonedRepositoryReference

Types

Companion

object Companion

Properties

namingStrategy

open val namingStrategy: StringTransformer

Naming strategy for tools associated with this reference. Defaults to prefixing tool names with the tool prefix and an underscore.

promptContributionLocation

open val promptContributionLocation: PromptContributionLocation

role

open val role: String?

Role defaults to class simple name. Override for stereotyped roles.

Functions

contribution

open override fun contribution(): String

Return the string content of the contribution.

notes

abstract fun notes(): String

Notes about this reference, such as usage guidance. Does not need to consider prompt prefix, name or description as they will be added automatically.

prefixedTools

fun LlmReference.prefixedTools(): List<Tool>

Convenience extension so callers can write reference.prefixedTools() instead of LlmReference.prefixedTools(reference).

promptContribution

open fun promptContribution(): PromptContribution

toolInstances

open fun ~~toolInstances~~(): List<Any>

Return the instances of tool object. Defaults to this

toolPrefix

open fun toolPrefix(): String

A safe prefix for LLM tools associated with this reference. Defaults to the name lowercased with spaces replaced by underscores. Subclasses can override it

tools

open fun tools(): List<Tool>

Return framework-agnostic tools provided by this reference. These tools will be added to the PromptRunner when the reference is added.

withUnfolding

open fun withUnfolding(): LlmReference

Convert this reference to a reference exposing a single unfolding tool. Does not rewrap an unfolding reference. Thus repeated calls to this method are safe.

open fun withUnfolding(childToolUsageNotes: String?): LlmReference

Convert this reference to a reference exposing a single unfolding tool, with progressively-disclosed detail attached.