Embabel Agent Documentation/com.embabel.agent.rag.tools/RagReference

RagReference

class RagReference(val name: String, val description: String, val options: RagOptions, summarizerPromptRunner: PromptRunner) : LlmReference

Expose a RagService as an LlmReference with tools.

Constructors

constructor(name: String, description: String, options: RagOptions, summarizerPromptRunner: PromptRunner)

Properties

open val description: String

open val name: String

val options: RagOptions

Functions

open fun contribution(): 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.

open override fun toolInstance(): Any

Return the instance of the tool object. Defaults to this

open fun toolObject(): ToolObject

Create a tool object for this reference.

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