Knowledge Graph Operations
get_graph
Get a graph by name
Parameters
name
(str): Name of the graph to retrieve
Returns
Graph
: The requested graph object
Examples
Graph Properties
The returned Graph
object has the following properties:
id
(str): Unique graph identifiername
(str): Graph nameentities
(List[Entity]): List of entities in the graphrelationships
(List[Relationship]): List of relationships in the graphmetadata
(Dict[str, Any]): Graph metadatadocument_ids
(List[str]): Source document IDsfilters
(Dict[str, Any], optional): Document filters used to create the graphcreated_at
(datetime): Creation timestampupdated_at
(datetime): Last update timestampowner
(Dict[str, str]): Graph owner informationaccess_control
(Dict[str, List[str]]): Access control information
Entity Properties
Each Entity
object has the following properties:
id
(str): Unique entity identifierlabel
(str): Display label for the entitytype
(str): Entity typeproperties
(Dict[str, Any]): Entity propertiesdocument_ids
(List[str]): Source document IDschunk_sources
(Dict[str, List[int]]): Source chunk numbers by document ID
Relationship Properties
Each Relationship
object has the following properties:
id
(str): Unique relationship identifiersource_id
(str): Source entity IDtarget_id
(str): Target entity IDtype
(str): Relationship typedocument_ids
(List[str]): Source document IDschunk_sources
(Dict[str, List[int]]): Source chunk numbers by document ID