Skip to content

Reference

Reference is a versatile linking object that connects extracted entries to external identifiers or related resources. It can point to standards, supplier catalog numbers, or cross-references within the drawing itself. The model stores reference type, target identifier, descriptive text, and provenance information so downstream systems can interpret how the reference should be used. Additional metadata covers the originating view, the document version, and confidence scores that indicate when review might be necessary. By normalizing references you can build navigation between drawing sections, attach supporting documents, or reconcile extracted data with enterprise databases. The object also supports rich filtering, making it easy to surface all references tied to compliance, test results, or customer specifications in a single query.

Bases: BaseModel

Base model that allows refering to a specific object by its reference_id.

PARAMETER DESCRIPTION
reference_id

Reference ID to identify the object.

TYPE: int

Source code in werk24/models/v2/models.py
class Reference(BaseModel):
    """
    Base model that allows refering to a specific object by its reference_id.
    """

    reference_id: int = Field(
        ...,
        description="Reference ID to identify the object.",
        examples=[12345],
    )