Embabel Agent Documentation/com.embabel.agent.api.common.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

resourcePath

val resourcePath: String

Functions

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

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. Defaults to empty list for backward compatibility.

toString

open override fun toString(): String