DICE API Documentation/com.embabel.dice.entity

Package-level declarations

Types

data class ChunkEntityResult(val chunkId: String, val suggestedEntities: SuggestedEntities, val entityResolutions: Resolutions<SuggestedEntityResolution>) : EntityExtractionResult

Result of processing a single chunk through the entity pipeline.

EntityAssertion

data class EntityAssertion constructor(val name: String, val labels: List<String> = emptyList(), val description: String? = null, val properties: Map<String, Any> = emptyMap(), val id: String? = null)

A single entity to assert into the knowledge graph.

EntityAssertionRequest

data class EntityAssertionRequest(val entities: List<EntityAssertion>, val relationships: List<RelationshipAssertion> = emptyList())

Request to assert entities and relationships into the knowledge graph.

EntityAssertionResult

data class EntityAssertionResult(val resolutions: List<EntityResolutionResult>, val relationships: List<RelationshipResult>)

Result of processing an EntityAssertionRequest.

EntityExtractor

interface EntityExtractor

Extracts entities from text chunks.

EntityIncrementalAnalyzer

class EntityIncrementalAnalyzer<T>(pipeline: EntityPipeline, historyStore: ChunkHistoryStore, formatter: IncrementalSourceFormatter<T>, config: WindowConfig = WindowConfig()) : AbstractIncrementalAnalyzer<T, ChunkEntityResult>

Incremental analyzer that extracts entities (without propositions) using an EntityPipeline.

EntityPipeline

class EntityPipeline

Pipeline for extracting and resolving entities from chunks.

EntityResolutionResult

data class EntityResolutionResult(val name: String, val entityId: String, val resolution: ResolutionOutcome, val labels: Set<String>)

Resolution outcome for a single entity.

EntityResolutionService

class EntityResolutionService(entityResolver: EntityResolver, repository: <Error class: unknown class>, schema: <Error class: unknown class>)

Standalone service for resolving, creating, and relating entities in the knowledge graph.

EntityResolutionTools

class EntityResolutionTools(service: EntityResolutionService)

LLM-invocable tools for asserting entities and relationships into the knowledge graph.

EntityResults

data class EntityResults(val chunkResults: List<ChunkEntityResult>) : EntityExtractionResult

Result of processing multiple chunks through the entity pipeline.

LlmEntityExtractor

data class LlmEntityExtractor(llmOptions: <Error class: unknown class>, ai: <Error class: unknown class>, template: String = "suggest_entities") : EntityExtractor

LLM-based entity extractor.

RelationshipAssertion

data class RelationshipAssertion(val source: String, val target: String, val type: String, val description: String? = null, val properties: Map<String, Any> = emptyMap())

A relationship to assert between two entities.

RelationshipResult

data class RelationshipResult(val source: String, val target: String, val type: String, val persisted: Boolean)

Persistence outcome for a single relationship.

ResolutionOutcome

enum ResolutionOutcome : Enum<ResolutionOutcome>

How an entity assertion was resolved.