Examples Overview¶
This page lists all maintained Hayhooks examples with detailed descriptions and links to the source code.
Pipeline wrapper examples¶
| Example | Docs | Code | Description |
|---|---|---|---|
| Chat with Website (Streaming) | chat-with-website.md | GitHub | Website Q&A with streaming |
| Chat with Website (basic) | — | GitHub | Minimal website Q&A wrapper |
| Chat with Website (MCP) | — | GitHub | Exposes website Q&A as MCP Tool |
| Async Question Answer (Streaming) | async-operations.md | GitHub | Async pipeline and streaming patterns |
| Open WebUI Agent Events | openwebui-events.md | GitHub | UI events and status updates |
| Open WebUI Agent on Tool Calls | openwebui-events.md | GitHub | Tool call interception & feedback |
| Shared Code Between Wrappers | — | GitHub | Reusing code across wrappers |
End-to-end examples & patterns¶
| Example | Docs | Code | Description |
|---|---|---|---|
| RAG: Indexing and Query with Elasticsearch | rag-system.md | GitHub | Full indexing/query pipelines with Elasticsearch |
How to use examples¶
Prerequisites:
- Install Hayhooks: pip install hayhooks (additional deps per example may apply)
Deployment:
- Pipeline wrappers: deploy directly with hayhooks pipeline deploy-files -n <name> <example_dir> and run via API (POST /<name>/run) or OpenAI-compatible chat endpoints if implemented
- End-to-end examples: follow the example's documentation for full setup (services like Elasticsearch, multi-pipeline deployment, datasets, etc.)
For general usage and CLI commands, see the Getting Started Guide.