https://github.com/bazaarvoice/qtype
From AI Idea to Prototype, Instantly
https://github.com/bazaarvoice/qtype
Last synced: 4 months ago
JSON representation
From AI Idea to Prototype, Instantly
- Host: GitHub
- URL: https://github.com/bazaarvoice/qtype
- Owner: bazaarvoice
- License: apache-2.0
- Created: 2025-07-09T13:39:04.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2025-10-18T00:20:08.000Z (8 months ago)
- Last Synced: 2025-10-18T14:45:15.665Z (8 months ago)
- Language: Python
- Homepage:
- Size: 4.71 MB
- Stars: 0
- Watchers: 0
- Forks: 1
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# 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:
```bash
pip install qtype[interpreter]
```
Create a file `hello_world.qtype.yaml` that answers a question:
```yaml
id: hello_world
flows:
- id: chat_example
description: A simple chat flow with OpenAI
mode: Chat
steps:
- id: llm_inference_step
model:
id: gpt-4
provider: openai
auth:
id: openai_auth
type: api_key
api_key: ${OPENAI_KEY}
system_message: |
You are a helpful assistant.
inputs:
- id: user_message
type: ChatMessage
outputs:
- id: response
type: ChatMessage
```
Put your openai api key into your `.env` file:
```
echo "OPENAI_KEY=sk...." >> .env
```
Validate it's semantic correctness:
```bash
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
```
Launch the interpreter:
```bash
qtype serve hello_world.qtype.yaml`
```
And go to [http://localhost:8000/ui](http://localhost:8000/ui) to see the user interface for your application:
---
See the [full docs](https://bazaarvoice.github.io/qtype/) for more examples and guides.
## ✨ Developing with AI?
Use the QType MCP server to speed yourself up! Just set your assistant to run `qtype mcp`.
For VSCode, just add the following to `.vscode/mcp.json`:
```json
{
"servers": {
"qtype": {
"type": "stdio",
"command": "qtype",
"cwd": "${workspaceFolder}",
"args": ["mcp", "--transport", "stdio"]
}
}
}
```
## 🤝 Contributing
Contributions welcome! Please follow the instructions in the [contribution guide](https://bazaarvoice.github.io/qtype/contributing/).
## 📄 License
This project is licensed under the **MIT License**.
See the [LICENSE](./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! 🛠️
[](https://github.com/bazaarvoice/qtype/actions/workflows/github_workflows_generate-schema.yml) [](https://github.com/bazaarvoice/qtype/actions/workflows/publish-pypi.yml)