Merge pull request #21 from eliawaefler/metadata

generate_metadata.py

@@ -0,0 +1,43 @@
+import os
+import json
+import openai
+from dotenv import load_dotenv
+
+from schema import Metadata, BimDiscipline
+
+load_dotenv()
+
+with open('school_plumbing.txt', 'r') as f:
+#with open('schulgebäudes.txt', 'r') as f:
+    context = f.readlines()
+
+# Create client
+client = openai.OpenAI(
+    base_url="https://api.together.xyz/v1",
+    api_key=os.environ["TOGETHER_API_KEY"],
+)
+
+# Call the LLM with the JSON schema
+chat_completion = client.chat.completions.create(
+    model="mistralai/Mixtral-8x7B-Instruct-v0.1",
+    response_format={"type": "json_object", "schema": Metadata.model_json_schema()},
+    messages=[
+    {
+        "role": "system",
+        "content": f"You are a helpful assistant that understands BIM documents and engineering disciplines. Your answer should be in JSON format and only include the title, a brief one-sentence summary, and the discipline the document belongs to distinguishing between {[d.value for d in BimDiscipline]} based on the given document."
+    },
+    {
+        "role": "user",
+        "content": f"Analyze the provided document, which could be in either German or English. Extract the title, summarize it briefly in one sentence, and infer the discipline. Document:\n{context}"
+    }
+],
+)
+
+created_user = json.loads(chat_completion.choices[0].message.content)
+print(json.dumps(created_user, indent=2))
+
+{
+  "title": "Plumbing System for a Typical School Building",
+  "summary": "This document details the plumbing system of a school building, including potable water supply, fixtures and appliances, drainage waste and vent systems, and stormwater management, adhering to ADA compliance, low flow rates, water conservation standards, and local codes and regulations.\n",
+  "discipline": "S - Sanit\u00e4r"
+}

schema.py

@@ -1,130 +1,20 @@
 import os
 import json
 from typing import List, Optional
-from pydantic import BaseModel, Field
+from pydantic import BaseModel, Field, conlist
 from enum import Enum
 
-class BimDiscipline(Enum):
+class BimDiscipline(str, Enum):
     plumbing = 'S - Sanitär'
-    network = 'd - Datennetz'
-    heating = 'h - Heizung'
-    electrical = 'e - Elektro'
-    ventilation = 'l - Lüftung'
-    architecture = 'a - Architektur'
-
-class KeywordChoice(str, Enum):
-    three_dimensional_modeling = "3d modeling"
-    four_dimensional_simulation = "4d simulation"
-    five_dimensional_cost_estimation = "5d cost estimation"
-    six_dimensional_lifecycle_management = "6d lifecycle management"
-    adoption = "adoptions"
-    agile_bim = "agile bim"
-    artificial_intelligence = "artificial intelligence"
-    automated_code_checking = "automated code checking"
-    automation = "automation"
-    big_data_analytics = "big data analytics"
-    bim_based_estimating = "bim-based estimating"
-    bim_execution_plan = "bim execution plan"
-    bim_governance = "bim governance"
-    bim_integration = "bim integration"
-    bim_maturity = "bim maturity"
-    bim_objects = "bim objects"
-    bim_process = "bim process"
-    bim_quality_assurance = "bim quality assurance"
-    bim_requirements = "bim requirements"
-    bim_server = "bim server"
-    bim_standardization = "bim standardization"
-    bim_strategy = "bim strategy"
-    bim_tools = "bim tools"
-    bim_training = "bim training"
-    barriers = "barriers"
-    benchmarking = "benchmarking"
-    building_energy_modeling = "building energy modeling"
-    building_life_cycle = "building life cycle"
-    building_physics = "building physics"
-    building_smartness = "building smartness"
-    built_environment = "built environment"
-    case_studies = "case studies"
-    cloud_computing = "cloud computing"
-    collaborative_environments = "collaborative environments"
-    communication = "communication"
-    computational_design = "computational design"
-    cobie = "construction operations building information exchange"
-    construction_scheduling = "construction scheduling"
-    construction_site_layout = "construction site layout"
-    context_awareness = "context awareness"
-    contractual_issues = "contractual issues"
-    cost_control = "cost control"
-    critical_success_factors = "critical success factors"
-    digital_fabrication = "digital fabrication"
-    digital_twin = "digital twin"
-    disaster_response = "disaster response"
-    dispute_resolution = "dispute resolution"
-    dynamic_scheduling = "dynamic scheduling"
-    education = "education"
-    electronic_tendering = "electronic tendering"
-    empirical_research = "empirical research"
-    energy_analysis = "energy analysis"
-    environmental_impacts = "environmental impacts"
-    facility_management = "facility management"
-    fire_safety = "fire safety"
-    gis_integration = "gis integration"
-    green_buildings = "green buildings"
-    health_and_safety = "health and safety"
-    historical_preservation = "historical preservation"
-    human_behavior = "human behavior"
-    industrialized_construction = "industrialized construction"
-    information_management = "information management"
-    infrastructure_asset_management = "infrastructure asset management"
-    interoperability = "interoperability"
-    iot_integration = "iot integration"
-    knowledge_sharing = "knowledge sharing"
-    lean_construction = "lean construction"
-    legal_frameworks = "legal frameworks"
-    level_of_development = "level of development"
-    level_of_detail = "level of detail"
-    level_of_information_need = "level of information need"
-    lifetime_costs = "lifetime costs"
-    linked_data = "linked data"
-    machine_learning = "machine learning"
-    manufacturing = "manufacturing"
-    materials_management = "materials management"
-    mobile_applications = "mobile applications"
-    multi_criteria_decision_making = "multi-criteria decision making"
-    natural_language_processing = "natural language processing"
-    networking = "networking"
-    open_bim = "open bim"
-    organizational_change = "organizational change"
-    owner_involvement = "owner involvement"
-    parametric_design = "parametric design"
-    performance_measurement = "performance measurement"
-    pipeline_simulation = "pipeline simulation"
-    policy_implications = "policy implications"
-    predictive_maintenance = "predictive maintenance"
-    product_data_templates = "product data templates"
-    public_procurement = "public procurement"
-    radio_frequency_identification = "radio frequency identification"
-    reality_capture = "reality capture"
-    real_time_monitoring = "real-time monitoring"
-    reliability_engineering = "reliability engineering"
-    resilience = "resilience"
-    return_on_investment = "return on investment"
-    reverse_logistics = "reverse logistics"
-    risk_assessment = "risk assessment"
-    robotics = "robotics"
-    maintenance_management = "maintenance management"
+    network = 'D - Datennetz'
+    heating = 'H - Heizung'
+    electrical = 'E - Elektro'
+    ventilation = 'L - Lüftung'
+    architecture = 'A - Architektur'
 
 # Define the schema for the output.
 class Metadata(BaseModel):
     title: str = Field(description='Title of the document')
     summary: str = Field(description='One sentence short summary of the document information')
-    disciplines: List[str] = Field(
-        default_factory=list,
-        description='BIM disciplines the document belongs to',
-        example=['S - Sanitär', 'D - Datennetz']
-    )
-    keywords: List[str] = Field(
-        default_factory=list,
-        description='List of BIM keywords associated with the document',
-        example=['3D Modelling', 'Clash detection']
-    )
+    discipline: BimDiscipline
+       

school_plumbing.txt

@@ -0,0 +1,15 @@
+This document describes the plumbing system for a typical school building. The system includes potable water supply, fixtures and appliances, drainage waste and vent (DWV) systems, and stormwater management.
+
+Potable Water Supply System:
+The potable water supply system consists of incoming water service from the municipal water main, backflow prevention device, water meter, pressure reducing valve, and distribution piping throughout the building to provide water to all fixtures and appliances. All materials used are lead-free and meet local codes and regulations.
+Fixtures and Appliances:
+Fixtures include sinks, toilets, urinals, drinking fountains, showers, eye wash stations, and laboratory equipment. All fixtures are selected based on ADA compliance, low flow rates, and water conservation standards. Appliances such as dishwashers, ice makers, and clothes washing machines are also provided with hot and cold water connections.
+Drainage Waste and Vent (DWV) Systems:
+The DWV system consists of sanitary and roof drains, vents, cleanouts, and traps designed to remove wastewater from fixtures and appliances while preventing sewer gases from entering the building. Materials used include PVC or cast iron pipes, fittings, and accessories.
+Stormwater Management:
+Stormwater management involves collecting rainwater runoff from rooftops and other impervious surfaces, conveying it through underground pipes, and disposing of it into an approved location. This may involve retention/detention ponds, swales, or other methods depending on local codes and regulations.
+Maintenance and Inspection:
+Regular maintenance and inspection of the plumbing system ensure its longevity and proper functioning. Routine tasks include checking for leaks, testing backflow preventers, inspecting fixtures and appliances, cleaning drains, and ensuring code compliance.
+Emergency Procedures:
+Emergency procedures should be established and communicated to staff members regarding responding to plumbing emergencies such as flooding, pipe bursts, or gas leaks. These procedures should include shutting off water supplies, contacting emergency responders, and notifying facilities personnel.
+

schulgebäudes.txt

@@ -0,0 +1,15 @@
+Diese Beschreibung umfasst das Rohrleitungssystem eines typischen Schulgebäudes. Das System besteht aus Trinkwasserversorgungs-, Einrichtungen und Geräten, Abwassersammel-, Lüftungs- und Regenwasserbewirtschaftungssystemen.
+
+Trinkwasserversorgungssystem:
+Das Trinkwasserversorgungssystem umfasst die eingehende Wasserzufuhr von der Hauptwasserleitung des Versorgungsunternehmens, einen Rückschlagverhinderer, einen Wasserzähler, eine Druckreduziervorrichtung sowie Verteilungsrohre im Gebäude zur Bereitstellung von Wasser für alle Einrichtungen und Geräte. Alle verwendeten Materialien sind bleifrei und entsprechen lokalen Vorschriften und Bestimmungen.
+Einrichtungen und Geräte:
+Zu den Einrichtungen gehören Waschbecken, Toiletten, Urinale, Trinkbrunnen, Duschen, Augenduschen und Laborausrüstungen. Alle Einrichtungen werden nach den Kriterien der Barrierefreiheit, niedriger Durchflussraten und Wasser sparenden Standards ausgewählt. Zu den Geräten zählen Geschirrspülmaschinen, Eismaschinen und Kleidungswaschanlagen mit heißem und kaltem Wasseranschluss.
+Sammel- und Entlüftungssystem (DWV):
+Das DWV-System besteht aus Schmutzwassertonnen, Dachabläufen, Belüftungen, Reinigungsöffnungen und Fallstricken, die dazu dienen, Abwasser von Einrichtungen und Geräten zu entfernen, während gleichzeitig verhindert wird, dass schädliche Gase in das Gebäude eindringen. Die verwendeten Materialien sind PVC oder Graugußrohre, -fittinge und -zubehörteile.
+Regenwasserbewirtschaftung:
+Die Regenwasserbewirtschaftung sieht vor, Niederschlagswasser von Dächern und anderen wasserundurchlässigen Oberflächen aufzunehmen, durch unterirdische Rohre abzuleiten und es an einem genehmigten Ort wieder abzugeben. Dies kann Bepumpungsanlagen, Retentions-/Entlastungspoldern oder andere Methoden umfassen, je nach lokalen Vorschriften und Bestimmungen.
+Wartung und Inspektion:
+Routinemäßige Wartung und Inspektion des Rohrleitungssystems gewährleisten seine Lebensdauer und ordnungsgemäße Funktion. Routineaufgaben umfassen das Überprüfen auf Lecks, Testen von Rückschlagverhinderern, Inspizieren von Einrichtungen und Geräten, Reinigen von Abflüssen und Gewährleistung der Codekonformität.
+Notfallmaßnahmen:
+Notfallmaßnahmen sollten festgelegt und dem Personal bekannt gemacht werden, um auf Plattfälle wie Überschwemmungen, Wasserrohrbrüche oder Gaslecks zu reagieren. Diese Maßnahmen umfassen das Absperren der Wasserzuflüsse, Kontaktaufnahme mit Notdiensten, Benachrichtigung von Einrichtungspersonal und Festlegen klarer Anweisungen für die Mitarbeiter.
+