Skip to content

Material

Material captures the specified material for a part or feature, including the raw OCR text, the normalized designation, and the standard the designation follows when the drawing provides one. It also carries a three-level material category classification that places the material in a hierarchy such as metal, steel, or a specific alloy family. Structuring material information allows you to integrate with inventory systems, validate compatibility with manufacturing processes, or trigger compliance checks. Because material choices influence cost and lead time, the model’s data can feed directly into quoting tools or change management workflows, and the raw OCR text lets you reconcile similar material names across different languages or legacy nomenclature.

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[MaterialCategory1 | None, MaterialCategory2 | None, MaterialCategory3 | None]

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.",
    )