Documentation / FAQ
Frequently asked questions¶
Is VAANI 1.0 stable released?¶
No. Public contracts target 1.0, and the exact tested candidate is
1.0.0rc9 with the digest listed in the
installation guide. Stable
GitHub publication is incomplete; do not assume public PyPI availability.
Is VAANI a ready-made voicebot?¶
No. It is a reusable runtime. Your consumer owns prompts, tools, business rules, provider/model/voice/language choices, and frontend composition.
Can I deploy a live bot with one VAANI command?¶
Not from this runtime repository today. The offline example is one command after
installation, but live use needs provider adapters, credentials, an
already-routed LiveKit call, and a consumer-owned worker bridge. A separate
privately published create-vaani-app==0.1.2
Starter CLI generates that consumer-owned
bridge and browser console. Version 0.1.3 is in progress; the credentialed live
path remains unverified.
Does VAANI own SIP?¶
No. It accepts an already-routed LiveKit call. Numbers, trunks, carrier credentials, routing, and dispatch remain upstream.
Can VAANI translate my prompt?¶
No. Every enabled language needs complete consumer-owned instructions. The same multilingual prompt may be deliberately assigned to several bindings.
Can I change model or voice during a call?¶
Yes when the selected adapters declare the needed update capability. Submit one
atomic CallUpdate against the active revision. Changing only the voice does not
change prompt, model, language, tools, or history.
Does a provider factory read API_KEY automatically?¶
No. The consumer supplies an explicit CredentialSource and matching
CredentialScope. Repository smoke scripts use documented environment names,
but core VAANI performs no ambient discovery.
Are all supported providers equally turnkey?¶
No. The adapter contract covers supported modules/capabilities, while current public factory coverage varies. See the provider matrix.
Does a failed call still return a result?¶
After lifecycle ownership, yes: the call closes once with normalized failure
evidence. Invalid setup before ownership raises and produces no CallResult.
Is CallResult my business/CRM record?¶
No. It is immutable provider-neutral evidence. Map it into your own business schema after Closure.
Does PostgreSQL publication delay Closure?¶
No. Publication is post-Closure and returns a separate DeliveryReport.
Where is the exact API contract?¶
Start with public API reference. Exact signatures and
serialization live in the repository's contracts/public/v1 directory and
public source exports.
Next: documentation home or troubleshooting.