Embabel Agent Documentation/com.embabel.agent.rag.neo.ogm

Package-level declarations

Types

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class CreationPermitted(val value: Boolean)

If this value is false, we cannot create new instances of this type: For example, it's a reference.

class MappedChunk(val id: String, val uri: String? = null, val text: String, val parentId: String? = null, val metadata: Map<String, Any?> = emptyMap()) : Chunk

NeoOgmConfig

class NeoOgmConfig(properties: NeoRagServiceProperties)

NeoRagServiceProperties

data class NeoRagServiceProperties(val uri: String = "bolt://localhost:7687", val username: String = "neo4j", password: String, val chunkNodeName: String = "Chunk", val entityNodeName: String = "Entity", val name: String = "OgmRagService", val description: String = "RAG service using Neo4j OGM for querying and embedding", val contentElementIndex: String = "embabel-content-index", val entityIndex: String = "embabel-entity-index", val contentElementFullTextIndex: String = "embabel-content-fulltext-index", val entityFullTextIndex: String = "embabel-entity-fulltext-index", val ogmPackages: List<String> = listOf("not.a.real.package"), val maxChunkSize: Int = 1500, val overlapSize: Int = 200) : ContentChunker.Config

OgmCypherSearch

class OgmCypherSearch(sessionFactory: <Error class: unknown class>, queryResolver: LogicalQueryResolver) : CypherSearch, ClusterFinder

OgmMappedEntity

open class OgmMappedEntity(val id: String, val uri: String? = null, val chunks: List<MappedChunk> = emptyList()) : RetrievableEntity

Superclass for all entities that are mapped using Neo4j OGM.

OgmMappedNamedAndDescribedEntity

abstract class OgmMappedNamedAndDescribedEntity(val name: String, val id: String, val uri: String? = null) : OgmMappedEntity

OgmMetadataSchemaResolver

class OgmMetadataSchemaResolver(sessionFactory: <Error class: unknown class>, ogmCypherSearch: OgmCypherSearch, properties: NeoRagServiceProperties) : SchemaResolver

Infers schema from OGM metadata

OgmRagFacetProvider

class OgmRagFacetProvider(modelProvider: <Error class: unknown class>, ogmCypherSearch: OgmCypherSearch, schemaResolver: SchemaResolver, sessionFactory: <Error class: unknown class>, platformTransactionManager: <Error class: unknown class>, properties: NeoRagServiceProperties) : AbstractWritableContentElementRepository, RagFacetProvider

Performs RAG queries in readonly transactions using Neo4j OGM. Requires a Neo4j OGM PlatformTransactionManager to be configured in the Spring context.

SchemaDrivenCypherRagQueryGenerator

class SchemaDrivenCypherRagQueryGenerator(modelProvider: <Error class: unknown class>, schema: KnowledgeGraphSchema) : CypherRagQueryGenerator

Generate RAG queries from a given schema

Functions

cleanLlmCypher

fun cleanLlmCypher(rawResponse: String): String

Try to extract Cypher from the response