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

SpringResource

data class SpringResource constructor(val resourcePath: String, val name: String = resourcePath, val description: String = "Spring resource at ") : LlmReferenceProvider, LlmReference

Contents of a Spring resource as an LlmReference. Read and held in memory.

Constructors

SpringResource

constructor(resourcePath: String, name: String = resourcePath, description: String = "Spring resource at ")

Properties

description

open val description: String

name

open val name: String

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.

resourcePath

val resourcePath: String

Functions

asMatryoshka

open fun ~~asMatryoshka~~(): LlmReference

Convert this reference to a MatryoshkaReference, exposing a single tool object that supports nesting. Do not rewrap a MatryoshkaReference. Thus repeated calls to this method are safe.

contribution

open fun contribution(): String

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

notes

open override 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.

reference

open override fun reference(): LlmReference

Create an LLM reference

toolInstances

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

Return the instances of tool object. Defaults to this

toolObject

open fun ~~toolObject~~(): ToolObject

Create a tool object for this reference.

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.

toString

open override fun toString(): String

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.