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

ApiReference

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

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.

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

findClassSignatureByFqn

fun findClassSignatureByFqn(fqn: String): String

findClassSignatureBySimpleName

fun findClassSignatureBySimpleName(simpleName: String): String

findPackageSignature

fun findPackageSignature(packageName: String): String

formatAsText

fun formatAsText(): String

formatClass

fun formatClass(clazz: ApiClass): String

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.

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

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.