DICE API Documentation/com.embabel.dice.common/SuggestedEntity

SuggestedEntity

data class SuggestedEntity(val labels: List<String>, val name: String, val summary: String, val chunkId: String, val id: String? = null, val properties: Map<String, Any> = emptyMap(), val confidence: <Error class: unknown class> = 1.0, val decay: <Error class: unknown class> = 0.0, val importance: <Error class: unknown class> = 0.5, val source: String = "source_analyzer") : Suggestion

Entity suggested following analysis of text.

Parameters

labels

the labels (types) for the entity

name

the name of the entity

summary

a brief summary or description of the entity

chunkId

the ID of the chunk from which this entity was suggested

optional ID if the LLM can identify a specific existing entity, meaning it doesn't require resolution

properties

additional properties for the entity

Constructors

SuggestedEntity

constructor(labels: List<String>, name: String, summary: String, chunkId: String, id: String? = null, properties: Map<String, Any> = emptyMap(), confidence: <Error class: unknown class> = 1.0, decay: <Error class: unknown class> = 0.0, importance: <Error class: unknown class> = 0.5, source: String = "source_analyzer")

Properties

chunkId

val chunkId: String

confidence

open override val confidence: <Error class: unknown class> = 1.0

Confidence in this derivation (0.0 to 1.0).

decay

open override val decay: <Error class: unknown class> = 0.0

Decay rate for this derivation (0.0 to 1.0).

grounding

open override val grounding: List<String>

Grounding for a SuggestedEntity is the chunk it was extracted from — same convention as SuggestedPropositions.chunkId. A single-element list keeps the com.embabel.dice.proposition.Suggestion shape uniform with multi-chunk suggestions emitted by downstream extractors.

val id: String? = null

importance

open override val importance: <Error class: unknown class> = 0.5

Importance of this derivation (0.0 to 1.0).

labels

val labels: List<String>

name

val name: String

properties

val properties: Map<String, Any>

source

open override val source: String

Stable identifier of the source that produced this suggestion — e.g. "email", "calendar", "osx", "stripe-receipts", "propose_facts". Powers dedup-by-source, provenance display, and source-scoped retraction.

suggestedEntity

val suggestedEntity: <Error class: unknown class>

summary

val summary: String