Skip to content

Material

Bases: BaseModel

Represents a material definition with raw OCR text, standard name, designation, and

PARAMETER DESCRIPTION
raw_ocr

Raw OCR text extracted from the drawing.

TYPE: str

standard

Standard that defines the standard.

TYPE: str | None DEFAULT: None

designation

Designation of the material following the spelling used in the standard.

TYPE: str

material_category

Hierarchical Material category.

TYPE: tuple[Optional[MaterialCategory1], Optional[MaterialCategory2], Optional[MaterialCategory3]]

Source code in werk24/models/v2/models.py
class Material(BaseModel):
    """
    Represents a material definition with raw OCR text, standard name, designation, and
    """

    raw_ocr: str = Field(
        ...,
        description="Raw OCR text extracted from the drawing.",
    )
    standard: Optional[str] = Field(
        None,
        description="Standard that defines the standard.",
    )
    designation: str = Field(
        ...,
        description="Designation of the material following the spelling used in the standard.",
    )
    material_category: tuple[
        Optional[MaterialCategory1],
        Optional[MaterialCategory2],
        Optional[MaterialCategory3],
    ] = Field(
        ...,
        description="Hierarchical Material category.",
    )