File size: 2,617 Bytes
fcaa164 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 |
# ========= Copyright 2023-2024 @ CAMEL-AI.org. All Rights Reserved. =========
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# ========= Copyright 2023-2024 @ CAMEL-AI.org. All Rights Reserved. =========
from __future__ import annotations
from typing import List, Union
from pydantic import BaseModel, ConfigDict, Field
try:
from unstructured.documents.elements import Element
except ImportError:
Element = None # type:ignore[misc,assignment]
class Node(BaseModel):
r"""Represents a node in a graph with associated properties.
Attributes:
id (Union[str, int]): A unique identifier for the node.
type (str): The type of the relationship.
properties (dict): Additional properties and metadata associated with
the node.
"""
id: Union[str, int]
type: str = "Node"
properties: dict = Field(default_factory=dict)
class Relationship(BaseModel):
r"""Represents a directed relationship between two nodes in a graph.
Attributes:
subj (Node): The subject/source node of the relationship.
obj (Node): The object/target node of the relationship.
type (str): The type of the relationship.
properties (dict): Additional properties associated with the
relationship.
"""
subj: Node
obj: Node
type: str = "Relationship"
properties: dict = Field(default_factory=dict)
class GraphElement(BaseModel):
r"""A graph element with lists 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 (Element): The element from which the graph information is
derived.
"""
model_config = ConfigDict(arbitrary_types_allowed=True)
nodes: List[Node]
relationships: List[Relationship]
source: Element
def __post_init__(self):
if "Element" not in globals():
raise ImportError("""The 'unstructured' package is required to use
the 'source' attribute.""")
|