llm4s-core
API
Generated with
llm4s-core/org.llm4s/org.llm4s.knowledgegraph/org.llm4s.knowledgegraph.query/GraphQuery

GraphQuery

org.llm4s.knowledgegraph.query.GraphQuery
See theGraphQuery companion trait
object GraphQuery

Attributes

Companion
trait
Graph
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
GraphQuery.type

Members list

Type members

Classlikes

case class CompositeQuery(steps: Seq[GraphQuery]) extends GraphQuery

Execute multiple queries in sequence, feeding results forward.

Execute multiple queries in sequence, feeding results forward.

Value parameters

steps

The ordered list of queries to execute

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait GraphQuery
class Object
trait Matchable
class Any
Show all
case class DescribeNode(nodeId: String, includeNeighbors: Boolean) extends GraphQuery

Get detailed information about a specific node and its immediate context.

Get detailed information about a specific node and its immediate context.

Value parameters

includeNeighbors

Whether to include neighbor information

nodeId

The ID of the node to describe

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait GraphQuery
class Object
trait Matchable
class Any
Show all
case class FindNeighbors(nodeId: String, direction: Direction, relationshipType: Option[String], maxDepth: Int) extends GraphQuery

Find neighbors of a specific node.

Find neighbors of a specific node.

Value parameters

direction

Direction of traversal (Outgoing, Incoming, Both)

maxDepth

Maximum traversal depth (defaults to 1 for direct neighbors)

nodeId

The ID of the node to find neighbors for

relationshipType

Optional filter by relationship type

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait GraphQuery
class Object
trait Matchable
class Any
Show all
case class FindNodes(label: Option[String], properties: Map[String, String]) extends GraphQuery

Find nodes matching a label and/or property criteria.

Find nodes matching a label and/or property criteria.

Value parameters

label

Optional node label filter (e.g., "Person", "Organization")

properties

Optional property key-value pairs to match

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait GraphQuery
class Object
trait Matchable
class Any
Show all
case class FindPath(fromNodeId: String, toNodeId: String, maxHops: Int) extends GraphQuery

Find a path between two nodes.

Find a path between two nodes.

Value parameters

fromNodeId

The starting node ID

maxHops

Maximum number of hops to search

toNodeId

The target node ID

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait GraphQuery
class Object
trait Matchable
class Any
Show all

Inherited and Abstract types

type MirroredElemLabels <: Tuple

The names of the product elements

The names of the product elements

Attributes

Inherited from:
Mirror
type MirroredLabel <: String

The name of the type

The name of the type

Attributes

Inherited from:
Mirror
Generated with