VAANI / Documentation

VAANI documentation

Build a consumer-owned voicebot on a reusable call runtime. The docs progress from one deterministic call to live provider composition and production operations.

Recommended reading paths

Goal	Read in this order
New voicebot	Installation → Quickstart → Project structure → Architecture
Existing voicebot	Architecture → Porting → Deterministic testing → Production
Provider integration	Profiles and adapters → Provider setup → Provider reference
Operations	Lifecycle → Results → PostgreSQL → Production

Getting started

• Installation and distribution choices
• First deterministic offline voicebot
• Project structure and configuration
• Companion Starter CLI

Core concepts

• Architecture and ownership boundary
• CallSetup, LanguageBinding, profiles, and adapters
• ActiveCall lifecycle and Closure
• Prompts, tools, business state, and live updates
• Results, evidence, usage, cost, and failures

Guides

• Port an existing voicebot
• Configure providers, factories, extras, and credentials
• Build multilingual switching
• Apply live updates
• Perform a blind transfer
• Coordinate recording with GCS
• Publish results to PostgreSQL
• Test deterministically
• Prepare for production
• Distribute VAANI privately

Examples

• Examples index
• Minimal offline bot explained
• Vertex Product Catalog consumer

Reference

• Public root API
• Provider modules and extras
• Configuration, deadlines, and policies
• Results and error taxonomy
• Canonical domain glossary (repository CONTEXT.md)

Help

• Troubleshooting
• Frequently asked questions

Contract authority

Documentation favors stable concepts and runnable patterns. For exact field order, signatures, defaults, schemas, and supported lazy modules, the authoritative sources are:

• vaani.__all__ in src/vaani/__init__.py
• contracts/public/v1
• supported-adapters@1 in src/vaani/contracts/supported-adapters.v1.json
• domain contracts in contracts/domain/v1

Next: install VAANI or understand the ownership boundary.