Skip to main content

DSL for Generative AI Prototyping

Project description

QType

QType is a domain-specific language (DSL) for rapid prototyping of AI applications.
It is designed to help developers define modular, composable AI systems using a structured YAML-based specification. QType supports models, prompts, tools, retrievers, and flow orchestration, and is extensible for code generation or live interpretation.


🚀 Quick Start

Install QType:

pip install qtype[interpreter]

Create a file hello_world.qtype.yaml that executes a single chat question:

id: hello_world
flows:
  - id: simple_qa_flow
    steps:
      - id: llm_inference_step
        model: 
          id: gpt-4o
          provider: openai
          auth: 
            id: openai_auth
            type: api_key
            api_key: ${OPENAI_KEY}
        system_message: |
          You are a helpful assistant.
        inputs:
          - id: prompt
            type: text
        outputs:
          - id: response_message
            type: text

Put your openai api key into your .env file:

echo "OPENAI_KEY=sk...." >> .env

Validate that the file matches the spec:

qtype validate hello_world.qtype.yaml

You should see:

INFO: ✅ Schema validation successful.
INFO: ✅ Model validation successful.
INFO: ✅ Language validation successful
INFO: ✅ Semantic validation successful

Finally,execute the flow.

qtype run flow '{"prompt":"What is the airspeed of a laden swallow?"}' hello_world.qtype.yaml 

You should see (something similar to):

INFO: Executing flow: simple_qa_flow

The airspeed of a laden swallow is a humorous reference from the movie "Monty Python and the Holy Grail." In the film, the question is posed as "What is the airspeed velocity of an unladen swallow?" The joke revolves around the absurdity and specificity of the question, and it doesn't have a straightforward answer. However, if you're curious about the real-life airspeed of a swallow, the European Swallow (Hirundo rustica) typically flies at around 11 meters per second, or 24 miles per hour, when unladen. The concept of a "laden" swallow is part of the humor, as it would depend on what the swallow is carrying and is not a standard measurement.

See the full docs for more examples and guides.

🤝 Contributing

Contributions welcome! Please follow the instructions in the contribution guide.

📄 License

This project is licensed under the MIT License.
See the LICENSE file for details.


🧠 Philosophy

QType is built around modularity, traceability, and rapid iteration. It aims to empower developers to quickly scaffold ideas into usable AI applications without sacrificing maintainability or control.

Stay tuned for upcoming features like:

  • Integrated OpenTelemetry tracing
  • Validation via LLM-as-a-judge
  • UI hinting via input display types
  • Flow state switching and conditional routing

Happy hacking with QType! 🛠️

Generate JSON Schema Publish to PyPI

Project details


Download files

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

Source Distribution

qtype-0.0.2.tar.gz (59.7 kB view details)

Uploaded Source

Built Distribution

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

qtype-0.0.2-py3-none-any.whl (61.2 kB view details)

Uploaded Python 3

File details

Details for the file qtype-0.0.2.tar.gz.

File metadata

  • Download URL: qtype-0.0.2.tar.gz
  • Upload date:
  • Size: 59.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for qtype-0.0.2.tar.gz
Algorithm Hash digest
SHA256 459e6138ed3461768bc929087ea8f86550148130004d758ac128e4030b1ce5b7
MD5 78215d10ca70bbf84f504b2a10bf9bed
BLAKE2b-256 c353b2f8f0940e58dedb23b2dbf05789b511ae4c4f735f942a89ea781d3e8e78

See more details on using hashes here.

Provenance

The following attestation bundles were made for qtype-0.0.2.tar.gz:

Publisher: publish-pypi.yml on bazaarvoice/qtype

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file qtype-0.0.2-py3-none-any.whl.

File metadata

  • Download URL: qtype-0.0.2-py3-none-any.whl
  • Upload date:
  • Size: 61.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for qtype-0.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 f5de4d4ac43fc31a1793dc96198b3a6a2310aa622b7cf997c1439913a5131d26
MD5 4b8a5816d79334fe73db14b29fcb65f4
BLAKE2b-256 31744e9d595c0ec82ccbdf9ce475e0405d7c78bd31dff5e2465eb0fa98da8ec2

See more details on using hashes here.

Provenance

The following attestation bundles were made for qtype-0.0.2-py3-none-any.whl:

Publisher: publish-pypi.yml on bazaarvoice/qtype

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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