Document ai.multilingual and qualify voice strings with their engine

[hey-august]

Description

Documents ai.multilingual for SWML.

Additions

• ai.multilingual reference page, modeled field-by-field against source code. States the mutual exclusivity with regular ai.languages on both pages, plus the ai method (object) page.

Changes

• Added engine for incorrect "bare form" examples: Per AI voice docs: bare voice names break when the default TTS engine changes to ElevenLabs #577 , while the technical reference and TTS pages were correct, a few stray examples passed voice IDs without engine. These examples would only work if the voice ID string matched the platform default engine, which sometimes changes. Every voice example now names its engine.
• Removed default engine assertions: Since the platform default TTS engine can change, I removed references to the default. Users who need a specific engine should declare it.
• Corrected params.languages_enabled: its description previously claimed it enabled multilingualism when it only toggles handling for a languages array.
• Fixed a broken #providers anchor

Type of Change

• Bug fix
• New feature
• Breaking change
• Documentation update
• Code cleanup / refactor

Related Issues

#577

Testing

• Added/updated unit tests
• Tested manually
• Tested with live SignalWire credentials (if applicable)

Checklist

• I have read the CONTRIBUTING guidelines
• My code follows the project's style guidelines
• I have added tests for my changes (if applicable)
• I have updated documentation (if applicable)
• All existing tests pass

Additional Notes

Two corrections to the originating ticket, both verified against source.

1. multilingual is an object, not a boolean, which is why this is a full reference page rather than a one-line note.
2. The new default engine-voice combination (ElevenLabs "Mark") has not landed, so these docs are written to be default-agnostic.

[github-actions]

🌿 Preview

https://signalwire-preview-docs-578.docs.buildwithfern.com/docs

---

View workflow run