get_graph_visualization

Retrieve nodes and links for visualizing a knowledge graph

Sync

def get_graph_visualization(
    name: str,
    folder_name: Optional[Union[str, List[str]]] = None,
    folder_depth: Optional[int] = None,
    end_user_id: Optional[str] = None,
) -> Dict[str, Any]

Async

async def get_graph_visualization(
    name: str,
    folder_name: Optional[Union[str, List[str]]] = None,
    folder_depth: Optional[int] = None,
    end_user_id: Optional[str] = None,
) -> Dict[str, Any]

Parameters

• name (str): Graph name.
• folder_name (str | List[str], optional): Folder scope filter (canonical path or list of paths/names).
• folder_depth (int, optional): Folder scope depth. None/0 = exact match, -1 = include all descendants, n > 0 = include descendants up to n levels deep.
• end_user_id (str, optional): End-user scope filter.

Returns

• Dict[str, Any]: JSON with nodes and links arrays ready for d3-force or similar libraries.

Example

viz = db.get_graph_visualization("research_graph")
print(len(viz["nodes"]), "nodes", len(viz["links"]), "edges")