@flatfile/improv/docs/README.md

A powerful TypeScript library for building AI agents with multi-threaded conversations, tool execution, and event handling capabilities

# Improv Documentation

Welcome to the comprehensive documentation for the Improv AI agent library.

## Getting Started

- [Main README](../README.md) - Quick start and overview
- [Adoption Guide](./ADOPTION_GUIDE.md) - Migrating from other libraries

## Core Concepts

### API Reference
- [API Overview](./api-overview.md) - Complete overview of all APIs
- [Structured Output](./structured-output.md) - Solo API for type-safe LLM responses
- [Agent & Solo Patterns](./agent-solo-patterns.md) - When to use each API
- [Creating Pieces](./creating-pieces.md) - Building reusable workflow components

### Event System
- [Event System Guide](./events-guide.md) - Complete guide to using events
- [Events Reference](./events.md) - Full registry of all events and payloads

## Advanced Topics

### Workflow Orchestration
- Gig API documentation (coming soon)
- Piece composition patterns (coming soon)
- Error handling strategies (coming soon)

### Model Drivers
- AWS Bedrock integration (coming soon)
- OpenAI driver configuration (coming soon)
- Multi-provider setup (coming soon)

### Development
- Tool development guide (coming soon)
- Custom evaluators (coming soon)
- Tracing and debugging (coming soon)

## Examples

Check the [examples directory](../src/examples/) for practical code examples:

- Structured output examples
- Agent tool usage
- Workflow orchestration
- Multi-driver setups

## API Reference

For the complete TypeScript API reference, see the generated type definitions in your IDE or the published package.

## Contributing

See the main [README](../README.md) for contribution guidelines.