Examples

Detailed practical examples for common NucleusIQ workflows.

Updated for v0.7.10+: curated examples use the mandatory prompt= API and current provider pins. See migration notes if upgrading from older releases.

Getting started

• Basic agent — Your first agent with tools (OpenAI, Gemini, context management)
• Streaming — Real-time token-by-token output

Workflows

• File workflow — Search, read, and extract from files
• Autonomous workflow — Multi-step task with Critic/Refiner verification

Observability

• Usage tracking — Token usage by purpose and origin
• Cost estimation — Dollar cost tracking after execution

Provider examples

• Gemini quickstart — Google Gemini with all three execution modes
• Groq quickstart — Groq DIRECT / STANDARD / AUTONOMOUS (nucleusiq-groq 0.1.0b1, nucleusiq>=0.7.9)
• Ollama quickstart — Local Ollama DIRECT / STANDARD (nucleusiq-ollama 0.1.0a1, nucleusiq>=0.7.10 — alpha)
• Groq provider guide — Beta scope, 429 / Retry-After, strict_model_capabilities, repo scripts
• Ollama provider guide — Alpha scope, think, structured-output + tools caveat, repo matrix

Which page for Ollama?

Start with Ollama quickstart; use Ollama provider for the full capability matrix and env reference.

Which Groq page?

Start with Groq quickstart for copy-paste snippets; use Groq provider for deeper operational guidance.

Repository examples

Full runnable scripts are available in the GitHub repository:

• Core examples
• OpenAI examples
• Gemini examples
• Groq examples — Direct through Autonomous + structured output
• Ollama examples — Smoke, Direct, streaming live, capabilities matrix (alpha)
• Notebooks — Jupyter notebooks for context management showcase and more