Embabel Agent Documentation/com.embabel.agent.api.common.reference/WebPage

WebPage

data class WebPage(val url: String, val name: String = url, val description: String = "Web page at ") : LlmReferenceProvider, LlmReference

Reference for the contents of a web page. Works only if fetch tool is available. See CoreToolGroups.WEB

Constructors

WebPage

constructor(url: String, name: String = url, description: String = "Web page 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.

url

val url: 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

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.