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

Package-level declarations

Types

class NeoOgmConfig(properties: NeoRagServiceProperties)

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

Implements several interfaces to read and write knowledge graph data to Neo4j using Neo4j OGM.

NeoRagServiceProperties

data class NeoRagServiceProperties(val uri: String = "bolt://localhost:7687", val username: String = "neo4j", password: String = "brahmsian", 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 packages: List<String> = listOf("not.a.real.package"))

OgmCypherSearch

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

OgmMappedEntity

abstract class OgmMappedEntity(val id: String) : MappedEntity

Superclass for all entities that are mapped using Neo4j OGM.

OgmMappedNamedEntity

abstract class OgmMappedNamedEntity(val name: String, val id: String) : OgmMappedEntity

OgmRagService

class OgmRagService(modelProvider: <Error class: unknown class>, ogmCypherSearch: OgmCypherSearch, schemaResolver: SchemaResolver, sessionFactory: <Error class: unknown class>, platformTransactionManager: <Error class: unknown class>, properties: NeoRagServiceProperties = NeoRagServiceProperties()) : AbstractWritableRagService

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