Source code for langchain.graphs.graph_document
from __future__ import annotations
from typing import List, Union
from langchain.load.serializable import Serializable
from langchain.pydantic_v1 import Field
from langchain.schema import Document
[docs]class Node(Serializable):
    """Represents a node in a graph with associated properties.
    Attributes:
        id (Union[str, int]): A unique identifier for the node.
        type (str): The type or label of the node, default is "Node".
        properties (dict): Additional properties and metadata associated with the node.
    """
    id: Union[str, int]
    type: str = "Node"
    properties: dict = Field(default_factory=dict)
[docs]class Relationship(Serializable):
    """Represents a directed relationship between two nodes in a graph.
    Attributes:
        source (Node): The source node of the relationship.
        target (Node): The target node of the relationship.
        type (str): The type of the relationship.
        properties (dict): Additional properties associated with the relationship.
    """
    source: Node
    target: Node
    type: str
    properties: dict = Field(default_factory=dict)
[docs]class GraphDocument(Serializable):
    """Represents a graph document consisting of nodes and relationships.
    Attributes:
        nodes (List[Node]): A list of nodes in the graph.
        relationships (List[Relationship]): A list of relationships in the graph.
        source (Document): The document from which the graph information is derived.
    """
    nodes: List[Node]
    relationships: List[Relationship]
    source: Document