Skip to main content

UnifyOps Python SDK (unifyops)

PyPI Version Python Versions License: MIT

UnifyOps is an enterprise-grade AI Industrial Knowledge Intelligence Platform Python SDK for industrial plant operations. It unifies plant manuals, SOPs, work orders, incident logs, and regulatory standard specifications into a continuously-updating Knowledge Graph, exposing callable Python interfaces for:

  1. Expert Knowledge Copilot (RAG Engine) - Hybrid graph-proximity & vector retrieval with citation grounding and confidence scoring.
  2. Maintenance Intelligence & RCA Agent - Automated Root Cause Analysis, failure mode prediction, and maintenance timelines.
  3. Quality & Regulatory Compliance Layer - Automated SOP gap scanning against OISD, API, PNGRB, and ISO standards.
  4. Lessons Learned Engine - Operational failure intelligence and incident knowledge capture.

📦 Installation

pip install unifyops

🚀 Quickstart Guide

1. Initialize Client & Ingest Plant SOP Document

from unifyops import UnifyOpsClient, DocumentType

# Initialize UnifyOps Client for your plant organization
client = UnifyOpsClient(org_id="refinery_unit_2")

# Ingest an SOP document into the Knowledge Graph
doc_text = """
SOP-204: Emergency Shutdown and Trip Protocol for Pump P-204.
When bearing temperature exceeds 95°C or vibration exceeds 6.5 mm/s,
execute immediate trip sequence. Refer to OISD-STD-154 for safety clearance.
"""

doc = client.ingest_document(
    text=doc_text,
    filename="SOP_Pump_P204.txt",
    document_type=DocumentType.SOP,
    plant_id="Unit-2"
)

print(f"Ingested Document ID: {doc.id} with {doc.chunk_count} chunk(s).")

2. Query Expert Knowledge Copilot

from unifyops import CopilotQuery

# Ask a technical question to the RAG engine
query = CopilotQuery(
    query="What are the trip thresholds for Pump P-204?",
    user_role="maintenance_engineer"
)

response = client.copilot.query(query, org_id="refinery_unit_2")

print(f"Answer: {response.answer}")
print(f"Confidence Score: {response.confidence_score}%")
for citation in response.citations:
    print(f"Citation: {citation.citation_id} -> {citation.document_name}")

3. Execute Automated Root Cause Analysis (RCA)

from unifyops import RCARequest

rca_request = RCARequest(
    equipment_tag="P-204",
    incident_description="Centrifugal pump tripped unexpectedly with high vibration and seal leak."
)

rca = client.maintenance.analyze_root_cause(rca_request, org_id="refinery_unit_2")

print(f"Equipment: {rca.equipment_tag}")
print(f"Root Cause: {rca.root_cause}")
print("Recommended Actions:")
for action in rca.recommended_actions:
    print(f"  - {action}")

4. Scan Regulatory Compliance Gaps

from unifyops import ComplianceScanRequest

scan_req = ComplianceScanRequest(
    standard="OISD-STD-154",
    plant_unit="Unit-2"
)

report = client.compliance.scan_gaps(scan_req, org_id="refinery_unit_2")

print(f"Standard: {report.standard}")
print(f"Compliance Score: {report.compliance_percentage}%")
for gap in report.gaps:
    print(f"Gap [{gap.severity}]: {gap.description}")
    print(f"Recommendation: {gap.recommendation}")

🛠️ API Reference Summary

Module Core Class / Method Description
unifyops.client UnifyOpsClient Main SDK orchestrator
unifyops.store KnowledgeStore Knowledge Graph & Document Chunk Registry
unifyops.copilot CopilotEngine Hybrid RAG Q&A with Grounded Citations
unifyops.maintenance MaintenanceEngine Root Cause Analysis & Maintenance Intelligence
unifyops.compliance ComplianceEngine SOP vs Regulatory Standard Gap Analysis
unifyops.lessons LessonsEngine Lessons Learned & Failure Intelligence

📄 License

MIT License. Copyright (c) 2026 UnifyOps Team.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

unifyops-0.1.0.tar.gz (15.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

unifyops-0.1.0-py3-none-any.whl (16.0 kB view details)

Uploaded Python 3

File details

Details for the file unifyops-0.1.0.tar.gz.

File metadata

  • Download URL: unifyops-0.1.0.tar.gz
  • Upload date:
  • Size: 15.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.10

File hashes

Hashes for unifyops-0.1.0.tar.gz
Algorithm Hash digest
SHA256 98ac489b868af5b4170d3530995787e767ac6e002f32f8db6591f76b2c91e895
MD5 6815568c790fdaa9b7b042e255e4a3eb
BLAKE2b-256 cf5773d2bde41057069d82ccd438237059da1f3c6120cc350d0cd5413f4b2ade

See more details on using hashes here.

File details

Details for the file unifyops-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: unifyops-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 16.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.10

File hashes

Hashes for unifyops-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 bb879024e9962b6ea7099674525d733469bedc2b22733ca85cc9fb91ee9eb7e5
MD5 aa228e58d77a28070dca8e0cae6f66d9
BLAKE2b-256 39806deca077a7324c31070076b1920960ce3f62672331b9cb5d278277a39f63

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

0.1.0 This release

2 files

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page