Skip to the content.

Mimic Copilot Manual

Mimic Copilot is an AI assistant and translation service designed to convert natural language descriptions of data streams into validated, executable mimic.json Protocol Buffers configurations.


🤖 How It Works

User Prompt:
"Generate a stream of 100 user signup events with a 5% failure rate"
                         │
                         ▼
        ┌──────────────────────────────────┐
        │       POST /generate-config      │
        │      (Python 3.12 + FastAPI)     │
        └────────────────┬─────────────────┘
                         │
                         ▼
        ┌──────────────────────────────────┐
        │   Natural Language Parser & LLM  │
        │ Extracts: limits, fields, weights│
        └────────────────┬─────────────────┘
                         │
                         ▼
        ┌──────────────────────────────────┐
        │    Protocol Buffers Validation   │
        │  google.protobuf.json_format     │
        └────────────────┬─────────────────┘
                         │ Validated GeneratorConfig
                         ▼
        ┌──────────────────────────────────┐
        │   Populated in Mimic Studio      │
        │        Ready to Execute          │
        └──────────────────────────────────┘

💡 Example Prompts

User Signups with Failure Rates

Generate a stream of 100 user signup events with a 5% failure rate

Synthesized Fields:


High-Volume Financial Payments

Generate 10000 payment events with a normal distribution amount mean 150 std dev 20 to Kafka topic transactions.raw

Synthesized Fields:


🛡️ Schema Self-Correction & Validation Guarantee

Every configuration synthesized by Copilot is checked against copilot/proto/mimic_config_pb2.py:

  1. If the generated JSON payload violates types, missing required fields, or unrecognized sink targets, json_format.ParseDict raises an explicit validation exception.
  2. The endpoint returns an HTTP 422 if invalid, prompting an automatic retry before any invalid configuration can reach the UI or the engine.