GenAI.Graph.NodeBehaviour behaviour (GenAI Core v0.3.0)

Behaviour Graph Node Elements must adhere to.

Summary

id(graph_node)

name(graph_node)

new()

new(options)

Define the struct of a node with default fields included.

Define the type of a node with default fields included.

@callback description(graph_node :: term()) :: {:ok, String.t()} | {:error, any()}

@callback description(graph_node :: term(), default :: any()) ::
  {:ok, String.t()} | {:error, any()}

@callback handle(graph_node :: term()) ::
  {:ok, GenAI.Types.Graph.node_handle()} | {:error, any()}

@callback handle(graph_node :: term(), default :: any()) ::
  {:ok, GenAI.Types.Graph.node_handle()} | {:error, any()}

@callback id(graph_node :: term()) :: {:ok, GenAI.Types.Graph.node_id()} | {:error, any()}

@callback name(graph_node :: term()) :: {:ok, String.t()} | {:error, any()}

@callback name(graph_node :: term(), default :: any()) ::
  {:ok, String.t()} | {:error, any()}

@callback new() :: struct()

@callback new(options :: term()) :: struct()

(macro)

Define the struct of a node with default fields included.

  defnodestruct [
      value: nil,
  ]

(macro)

Define the type of a node with default fields included.

defnodetype [
   internal: boolean,
]