Embabel Agent Documentation/com.embabel.agent.rag/Retrievable

Retrievable

interface Retrievable : ContentElement

A Retrievable object instance is a ContentElement (normally a chunk or an entity) that can be retrieved by RAG. It has a stable id.

Inheritors

Properties

Link copied to clipboard
abstract val id: String

Embabel id. Will be synthetic.

Link copied to clipboard
abstract val metadata: Map<String, Any?>
Link copied to clipboard
@get:ApiStatus.Experimental
open val neighbors: Map<String, Collection<Retrievable>>

Neighbors of this retrievable object. Allows navigation of a graph

Link copied to clipboard
abstract val uri: String?

URI for the content. May be a URL. Not generated by Embabel, but from the source.

Functions

Link copied to clipboard
abstract fun embeddableValue(): String

Embedding value of this retrievable object.

Link copied to clipboard
open fun labels(): Set<String>

Labels of the entity. In Neo, this might include multiple labels. In a relational database, this might be a single table name.

Link copied to clipboard
open fun propertiesToPersist(): Map<String, Any?>

Properties to persist Subclasses can add their own properties but must call super to include these.