Embabel Agent Documentation/com.embabel.coding.tools.api/ApiReference

ApiReference

class ApiReference(val description: String, api: Api, classLimit: Int = 100) : LlmReference

API reference that can be exposed to LLMs as a prompt contribution and tools. Can also be used in configuration to provide API reference information.

Constructors

constructor(description: String, api: Api, classLimit: Int = 100)

Properties

open val description: String

open val name: String

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

open val role: String?

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

Functions

open override fun contribution(): String

Return the string content of the contribution.

findClassSignatureByFqn

fun findClassSignatureByFqn(fqn: String): String

findClassSignatureBySimpleName

fun findClassSignatureBySimpleName(simpleName: String): String

findPackageSignature

fun findPackageSignature(packageName: String): String

fun formatAsText(): String

fun formatClass(clazz: ApiClass): String

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.

fun LlmReference.prefixedTools(): List<Tool>

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

promptContribution

open fun promptContribution(): PromptContribution

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

Return the instances of tool object. Defaults to this

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

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

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.