Skip to content

Mermaid

Schema for mermaid diagram generation operations in Gen AI applications.

This module defines the additional metadata returned alongside mermaid diagram output from image-to-mermaid converters.

Mermaid

Bases: BaseModel

Additional metadata for mermaid diagram generation.

Attributes:

Name Type Description
diagram_type str | None

Type of the diagram to be generated (e.g. "flowchart", "sequence"). Defaults to None.

context str | None

Additional context or prompt used to generate the mermaid diagram. Defaults to None.