backend.api.models.schemas.output_format

Contains the schemas for the output format of the API responses.

Classes

TableModel	Represents a table with headers and rows.
GraphNode	Represents a node in a graph.
GraphEdge	Represents an edge with a label in a graph.
GraphModel	Represents a complete graph with nodes and edges.
ResponseSchema	Represents the response schema for API endpoints.

Module Contents

class backend.api.models.schemas.output_format.TableModel(/, **data: Any)

Bases: pydantic.BaseModel

Represents a table with headers and rows.

headers: List[str]

rows: List[List[str]]

class backend.api.models.schemas.output_format.GraphNode(/, **data: Any)

Bases: pydantic.BaseModel

Represents a node in a graph.

id: str

class backend.api.models.schemas.output_format.GraphEdge(/, **data: Any)

Bases: pydantic.BaseModel

Represents an edge with a label in a graph.

Connects two nodes.

from_: str

to: str

label: str

class Config

Represents a mapping for reserved keywords in Pydantic models.

fields

class backend.api.models.schemas.output_format.GraphModel(/, **data: Any)

Bases: pydantic.BaseModel

Represents a complete graph with nodes and edges.

nodes: List[GraphNode]

edges: List[GraphEdge]

class backend.api.models.schemas.output_format.ResponseSchema(/, **data: Any)

Bases: pydantic.BaseModel

Represents the response schema for API endpoints.

tables: List[TableModel] | None = []

graphs: List[GraphModel] | None = []