--- title: "AI Profiles Module Documentation" description: "Documentation for AI Profiles" --- ## Table of Contents 1. [Navigation & Access](#navigation--access) 2. [Screenshots & Visual Interface](#screenshots--visual-interface) 3. [🎯 User Roles & Key Capabilities](#-user-roles--key-capabilities) 4. [Module Overview (Technical)](#1-module-overview-technical) 5. [Module Overview (Commercial/Business)](#2-module-overview-commercialbusiness) 6. [Module Overview (End User/Administrator)](#3-module-overview-end-useradministrator) 7. [Configuration Sections](#4-configuration-sections) 8. [Settings Reference](#5-settings-reference) 9. [Model Context Protocol (MCP) AI Integration](#model-context-protocol-mcp-ai-integration) 10. [Common Scenarios & Examples](#6-common-scenarios--examples) 11. [Limitations & Important Notes](#7-limitations--important-notes) 12. [Troubleshooting Tips](#8-troubleshooting-tips) 13. [Glossary](#9-glossary) --- ## Navigation & Access To access the AI Profiles module: 1. Log in to the Ring2All Web Portal (`https:///login`). 2. In the left navigation sidebar, expand **Administration**. 3. Under **AI Integration**, click **AI Profiles** (`/admin/ai-integration/profiles`). 4. Review available AI profiles, bound provider engines, model families (GPT-4o, Claude 3.5, Whisper, Llama 3.3), temperature parameters, and active statuses. 5. Click **+ Add** to construct a new specialized model profile (`/admin/ai-integration/profiles/new`), or edit existing profile hyperparameters. --- ## Screenshots & Visual Interface ### AI Profiles Directory Central catalog displaying configured AI runtime profiles, bound provider engines, target models, token limits, temperature values, and service scopes. ![AI Profiles Directory](/screenshots/admin/ai/ai-profiles-list.png) ### Create / Edit AI Profile Configuration Form Profile specification editor for naming profiles, choosing providers, selecting target models, tuning temperature (creativity vs determinism), configuring maximum token generation limits, and assigning service scopes. ![AI Profile Configuration Form](/screenshots/admin/ai/ai-profiles-form.png) --- ## 🎯 User Roles & Key Capabilities | Role | Access Level | Responsibilities & Capabilities | | :--- | :--- | :--- | | **PBX Super Administrator** | Full Access (`RW`) | Create and calibrate multi-modal AI profiles (LLM, STT, TTS, Embeddings), assign provider engines, configure temperature, and set system prompts. | | **AI Prompt & Voice Engineer** | Profile Tuning (`RW`) | Tune conversational parameters (temperature, max tokens), configure Google TTS / ElevenLabs voice prosody (pitch, rate), and test sample audio synthesis. | | **Contact Center Supervisor** | Reusable Selection (`RO`) | Inspect which AI Profiles power inbound call transcription, sentiment analysis, agent copilot assistance, and real-time speech translation. | | **AI Platform Copilot / MCP Agent** | Programmatic Audit (`RO`) | Execute `list_ai_profiles` and `get_ai_profile_status` to evaluate model parameters and recommend appropriate profiles for telephony workflows. | --- ## 1. Module Overview (Technical) ### What Are AI Profiles? AI Profiles is an **AI configuration module** that defines how AI services behave in the PBX system. Each profile configures the AI provider, model settings, voice parameters, and behavior for features like TTS, transcription, and intelligent assistants. ### Architecture ``` β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” β”‚ AI Profiles Architecture β”‚ β”œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€ β”‚ β”‚ β”‚ AI Profile: Customer Service β”‚ β”‚ β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” β”‚ β”‚ β”‚ β”‚ β”‚ β”‚ β”‚ API Connection: β”‚ β”‚ β”‚ β”‚ β”œβ”€ Provider: OpenAI β”‚ β”‚ β”‚ β”‚ └─ Model: GPT-4o β”‚ β”‚ β”‚ β”‚ β”‚ β”‚ β”‚ β”‚ Model Behavior: β”‚ β”‚ β”‚ β”‚ β”œβ”€ Temperature: 0.7 (creative) β”‚ β”‚ β”‚ β”‚ β”œβ”€ Max Tokens: 2000 β”‚ β”‚ β”‚ β”‚ └─ Embeddings: text-embedding-3-small β”‚ β”‚ β”‚ β”‚ β”‚ β”‚ β”‚ β”‚ Voice Settings: β”‚ β”‚ β”‚ β”‚ β”œβ”€ Voice Engine: OpenAI TTS β”‚ β”‚ β”‚ β”‚ β”œβ”€ Voice: Alloy β”‚ β”‚ β”‚ β”‚ β”œβ”€ Pitch: Medium β”‚ β”‚ β”‚ β”‚ β”œβ”€ Volume: Medium β”‚ β”‚ β”‚ β”‚ └─ Speech Rate: Normal β”‚ β”‚ β”‚ β”‚ β”‚ β”‚ β”‚ β”‚ System Prompt: "You are a helpful customer service..." β”‚ β”‚ β”‚ β”‚ β”‚ β”‚ β”‚ β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ β”‚ β”‚ β”‚ β”‚ β”‚ β–Ό Referenced by AI Features β”‚ β”‚ β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” β”‚ β”‚ β”‚ β”‚ β”‚ β”‚ β”‚ Recording TTS ──────────► Profile: Studio Voice β”‚ β”‚ β”‚ β”‚ AI Assistant ───────────► Profile: Customer Service β”‚ β”‚ β”‚ β”‚ Voicemail Summary ──────► Profile: Analysis β”‚ β”‚ β”‚ β”‚ IVR Agent ──────────────► Profile: IVR Bot β”‚ β”‚ β”‚ β”‚ β”‚ β”‚ β”‚ β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ β”‚ β”‚ β”‚ β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ ``` --- ## 2. Module Overview (Commercial/Business) ### Business Value AI Profiles provides **customized AI behavior**: | Without Profiles | With Profiles | |------------------|---------------| | Single AI config | Multiple personalities | | Fixed voice | Customizable TTS | | No tuning | Temperature, tokens | | One-size-fits-all | Task-specific AI | ### Use Cases 1. **Customer Service Bot** - Friendly, helpful tone - Moderate creativity 2. **Professional Announcements** - Clear, formal voice - Low creativity (consistent) 3. **Call Transcription** - Accurate model - Fast processing 4. **IVR Assistant** - Natural voice - Specific system prompt ### Feature Highlights | Feature | Benefit | |---------|---------| | **Multiple Profiles** | Different use cases | | **Voice Customization** | Pitch, rate, volume | | **Temperature Control** | Creativity level | | **System Prompts** | Define AI behavior | | **TTS Testing** | Preview voices | | **Embeddings** | Semantic search | --- ## 3. Module Overview (End User/Administrator) ### What Can You Do? - Create AI profiles for different purposes - Select providers and models - Configure temperature and tokens - Choose TTS voice and settings - Write system prompts - Test voice generation - Adjust pitch, volume, rate ### AI Profiles - List View ``` β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” β”‚ AI Profiles β”‚ β”œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€ β”‚ β”‚ β”‚ Configure AI integration settings, voice profiles, and β”‚ β”‚ intelligent assistants β”‚ β”‚ β”‚ β”‚ [+ Add] β”‚ β”‚ β”‚ β”‚ β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” β”‚ β”‚ β”‚ Name β”‚ Provider β”‚ Model β”‚ Voice β”‚ Statusβ”‚ β”‚ β”‚ β”œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”Όβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”Όβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”Όβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”Όβ”€β”€β”€β”€β”€β”€β”€β”€ β”‚ β”‚ β”‚ Customer Service β”‚ OpenAI β”‚ GPT-4o β”‚ Alloy β”‚ Activeβ”‚ β”‚ β”‚ β”‚ Studio Voice β”‚ OpenAI β”‚ - β”‚ Nova β”‚ Activeβ”‚ β”‚ β”‚ β”‚ Analysis β”‚ Anthropicβ”‚ Claude 3β”‚ - β”‚ Activeβ”‚ β”‚ β”‚ β”‚ IVR Bot β”‚ OpenAI β”‚ GPT-4 β”‚ Shimmer β”‚ Activeβ”‚ β”‚ β”‚ β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ β”‚ β”‚ β”‚ β”‚ Actions: [πŸ§ͺ Test] [✏️ Edit] [πŸ—‘οΈ Delete] β”‚ β”‚ β”‚ β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ ``` ### Add/Edit AI Profile ``` β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” β”‚ Edit AI Profile β”‚ β”œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€ β”‚ β”‚ β”‚ [API Connection] [Model Config] [Voice Settings] [System] β”‚ β”‚ β”‚ β”‚ β–Ό API Connection β”‚ β”‚ β”‚ β”‚ β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”β”‚ β”‚ β”‚ β”‚β”‚ β”‚ β”‚ Profile Name: [Customer Service ] β”‚β”‚ β”‚ β”‚ Unique identifier for this AI profile β”‚β”‚ β”‚ β”‚ β”‚β”‚ β”‚ β”‚ Provider: [OpenAI β–Ό] β”‚β”‚ β”‚ β”‚ OpenAI | Anthropic | Google | Hugging Face | Local β”‚β”‚ β”‚ β”‚ β”‚β”‚ β”‚ β”‚ Model: [GPT-4o β–Ό] β”‚β”‚ β”‚ β”‚ Default AI model for reasoning and responses β”‚β”‚ β”‚ β”‚ β”‚β”‚ β”‚ β”‚ [Test Connection] β”‚β”‚ β”‚ β”‚ β”‚β”‚ β”‚ β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜β”‚ β”‚ β”‚ β”‚ β–Ό Model Behavior β”‚ β”‚ β”‚ β”‚ β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”β”‚ β”‚ β”‚ β”‚β”‚ β”‚ β”‚ Temperature: [0.7 ] (0.0 - 1.0) β”‚β”‚ β”‚ β”‚ Lower = focused, Higher = creative β”‚β”‚ β”‚ β”‚ β”‚β”‚ β”‚ β”‚ Max Tokens: [2000 ] (500 - 8000) β”‚β”‚ β”‚ β”‚ Maximum response length β”‚β”‚ β”‚ β”‚ β”‚β”‚ β”‚ β”‚ Embeddings Model: [text-embedding-3-small β–Ό] β”‚β”‚ β”‚ β”‚ Model for semantic search and indexing β”‚β”‚ β”‚ β”‚ β”‚β”‚ β”‚ β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜β”‚ β”‚ β”‚ β”‚ β–Ό System Settings β”‚ β”‚ β”‚ β”‚ β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”β”‚ β”‚ β”‚ β”‚β”‚ β”‚ β”‚ Timeout (ms): [30000 ] (1000 - 60000) β”‚β”‚ β”‚ β”‚ β”‚β”‚ β”‚ β”‚ Retry Attempts: [3 ] (0 - 5) β”‚β”‚ β”‚ β”‚ β”‚β”‚ β”‚ β”‚ Status: βœ“ Enabled β”‚β”‚ β”‚ β”‚ β”‚β”‚ β”‚ β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜β”‚ β”‚ β”‚ β”‚ [Save] [Cancel] β”‚ β”‚ β”‚ β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ ``` ### Voice Settings Tab ``` β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” β”‚ Edit AI Profile - Voice Settings β”‚ β”œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€ β”‚ β”‚ β”‚ β–Ό Voice Selection β”‚ β”‚ β”‚ β”‚ β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”β”‚ β”‚ β”‚ β”‚β”‚ β”‚ β”‚ Voice Engine: [OpenAI TTS β–Ό] β”‚β”‚ β”‚ β”‚ OpenAI TTS | ElevenLabs | AWS Polly | Google TTS β”‚β”‚ β”‚ β”‚ β”‚β”‚ β”‚ β”‚ Voice: [πŸ” Search voices... ] β”‚β”‚ β”‚ β”‚ Alloy | Echo | Fable | Nova | Onyx | Shimmer β”‚β”‚ β”‚ β”‚ β”‚β”‚ β”‚ β”‚ ─── Google TTS Selection (if Google TTS selected) ─── β”‚β”‚ β”‚ β”‚ Language: [πŸ” Search language... ] β”‚β”‚ β”‚ β”‚ Spanish | English | French | Portuguese | German... β”‚β”‚ β”‚ β”‚ Accent: [Spain β–Ό] β”‚β”‚ β”‚ β”‚ Spain | Mexico | US | Argentina... β”‚β”‚ β”‚ β”‚ Voice: [πŸ” Enceladus β–Ό] β”‚β”‚ β”‚ β”‚ Chirp D - Female | Chirp E - Male | Enceladus - Female β”‚β”‚ β”‚ β”‚ Style: [Natural β–Ό] β”‚β”‚ β”‚ β”‚ Natural | Alegre | Triste | Susurrar | Storyteller β”‚β”‚ β”‚ β”‚ β”‚β”‚ β”‚ β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜β”‚ β”‚ β”‚ β”‚ β–Ό Voice Configuration β”‚ β”‚ β”‚ β”‚ β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”β”‚ β”‚ β”‚ β”‚β”‚ β”‚ β”‚ Pitch: [Medium β–Ό] β”‚β”‚ β”‚ β”‚ Very Low | Low | Medium | High | Very High β”‚β”‚ β”‚ β”‚ β”‚β”‚ β”‚ β”‚ Volume: [Medium β–Ό] β”‚β”‚ β”‚ β”‚ Silent | Very Soft | Soft | Medium | Loud | Very Loud β”‚β”‚ β”‚ β”‚ β”‚β”‚ β”‚ β”‚ Speech Rate: [Medium β–Ό] β”‚β”‚ β”‚ β”‚ Very Slow | Slow | Medium | Fast | Very Fast β”‚β”‚ β”‚ β”‚ β”‚β”‚ β”‚ β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜β”‚ β”‚ β”‚ β”‚ β–Ό Test Voice β”‚ β”‚ β”‚ β”‚ β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”β”‚ β”‚ β”‚ β”‚β”‚ β”‚ β”‚ Text to convert: [Hello, welcome to our service ] β”‚β”‚ β”‚ β”‚ β”‚β”‚ β”‚ β”‚ [Generate] [πŸ”Š Play] β”‚β”‚ β”‚ β”‚ β”‚β”‚ β”‚ β”‚ [Download Production] β”‚β”‚ β”‚ β”‚ β”‚β”‚ β”‚ β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜β”‚ β”‚ β”‚ β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ ``` ### System Prompt Tab ``` β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” β”‚ Edit AI Profile - System Settings β”‚ β”œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€ β”‚ β”‚ β”‚ β–Ό System Prompt β”‚ β”‚ β”‚ β”‚ β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”β”‚ β”‚ β”‚ β”‚β”‚ β”‚ β”‚ System Prompt: β”‚β”‚ β”‚ β”‚ β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” β”‚β”‚ β”‚ β”‚ β”‚ You are a helpful customer service assistant for β”‚ β”‚β”‚ β”‚ β”‚ β”‚ a telecommunications company. Be friendly, concise,β”‚ β”‚β”‚ β”‚ β”‚ β”‚ and helpful. Guide users to solutions efficiently. β”‚ β”‚β”‚ β”‚ β”‚ β”‚ β”‚ β”‚β”‚ β”‚ β”‚ β”‚ Key behaviors: β”‚ β”‚β”‚ β”‚ β”‚ β”‚ - Greet customers warmly β”‚ β”‚β”‚ β”‚ β”‚ β”‚ - Understand their needs quickly β”‚ β”‚β”‚ β”‚ β”‚ β”‚ - Provide clear, step-by-step help β”‚ β”‚β”‚ β”‚ β”‚ β”‚ - Offer to transfer to human agent if needed β”‚ β”‚β”‚ β”‚ β”‚ β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ β”‚β”‚ β”‚ β”‚ Instructions that define how the AI should behave β”‚β”‚ β”‚ β”‚ β”‚β”‚ β”‚ β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜β”‚ β”‚ β”‚ β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ ``` ### Quick Tips > [!TIP] > **Temperature**: Use 0.3 for accuracy, 0.7+ for creativity. > [!TIP] > **Test Voice**: Always preview before using in production. > [!NOTE] > **System Prompt**: Define AI personality and behavior. --- ## 4. Configuration Sections ### API Connection | Field | Description | |-------|-------------| | **Profile Name** | Unique identifier | | **Provider** | AI service (OpenAI, etc.) | | **Model** | LLM model to use | ### Model Behavior | Field | Description | |-------|-------------| | **Temperature** | Creativity (0.0-1.0) | | **Max Tokens** | Response length limit | | **Embeddings Model** | For semantic search | ### Voice Settings | Field | Description | |-------|-------------| | **Voice Engine** | TTS provider | | **Voice** | Voice selection | | **Pitch** | Voice pitch level | | **Volume** | Output volume | | **Speech Rate** | Speaking speed | ### System Settings | Field | Description | |-------|-------------| | **Timeout** | API response timeout | | **Retry Attempts** | Retry on failure | | **Status** | Enable/disable | | **System Prompt** | AI behavior instructions | --- ## 5. Settings Reference ### Providers | Provider | Models | Voice Engines | |----------|--------|---------------| | **OpenAI** | GPT-4o, GPT-4 Turbo | OpenAI TTS | | **Anthropic** | Claude 3 Opus | - | | **Google** | Gemini | Google TTS | | **Local** | Local LLM | Local TTS | ### Temperature Guide | Value | Behavior | Use Case | |-------|----------|----------| | 0.0-0.3 | Focused, consistent | Transcription, facts | | 0.4-0.6 | Balanced | General assistance | | 0.7-1.0 | Creative, varied | Creative content | ### Voice Engines | Engine | Provider | Features | |--------|----------|----------| | **OpenAI TTS** | OpenAI | High quality, fast | | **ElevenLabs** | ElevenLabs | Voice cloning | | **AWS Polly** | Amazon | Neural voices | | **Google TTS** | Google | 300+ voices, cascading selection, emotion styles | ### Google TTS Selection Hierarchy Google TTS uses a 4-stage cascading selection to manage 300+ voice options: | Stage | Description | Example | |-------|-------------|----------| | **Language** | Base language | Spanish, English | | **Accent** | Regional variant | Spain, Mexico, US | | **Voice** | Technical variant with persona | Enceladus, Chirp D | | **Style** | Emotional tone | Natural, Alegre, Triste | ### Google TTS Voice Types | Type | Quality | Cost | Use Case | |------|---------|------|----------| | **Standard** | Basic | Low | Testing, drafts | | **Wavenet** | High | Medium | Production | | **Neural2** | Premium | High | Professional | | **Chirp3-HD** | Ultra | Premium | Studio quality | ### Google TTS Prosody Controls | Control | Range | Default | Effect | |---------|-------|---------|--------| | **Speed** | 0.25x - 4.0x | 1.0x | Speaking rate | | **Pitch** | -20 to +20 semitones | 0 | Voice tone | | **Volume** | -10 to +10 dB | 0 dB | Output level | ### Pitch Levels | Level | Value | Effect | |-------|-------|--------| | Very Low | -50% | Deep voice | | Low | -25% | Slightly lower | | Medium | 0% | Normal | | High | +25% | Slightly higher | | Very High | +50% | High pitched | ### Speech Rate Levels | Level | Speed | Use Case | |-------|-------|----------| | Very Slow | 0.5x | Clear dictation | | Slow | 0.75x | Instructions | | Medium | 1.0x | Normal | | Fast | 1.5x | Quick info | | Very Fast | 2.0x | Rapid playback | --- ## Model Context Protocol (MCP) AI Integration The AI Profiles module integrates with the **Model Context Protocol (MCP)**, enabling autonomous agents and the Platform Copilot to discover, inspect, and evaluate model runtime presets across the PBX platform. ### Available MCP Tools | Tool Name | Scope | Description | | :--- | :--- | :--- | | `list_ai_profiles` | Profile Registry (`RO`) | List all configured AI Model Profiles (type: LLM, STT, TTS, embeddings, model name, and assigned provider). | | `get_ai_profile_status` | Hyperparameter Audit (`RO`) | Get configuration parameters of an AI Profile (model, temperature, max tokens, system prompt, timeout). | ### Tool Schemas & Payloads #### `list_ai_profiles` ```json { "name": "list_ai_profiles", "description": "List all configured AI Model Profiles (type: LLM, STT speech-to-text, TTS text-to-speech, embeddings, model name, and assigned provider).", "parameters": { "type": "object", "properties": { "type": { "type": "string", "enum": ["llm", "stt", "tts", "embeddings", "general"], "description": "Filter by profile capability type." }, "search": { "type": "string", "description": "Filter by profile name or model." } } } } ``` **Realistic Execution Response:** ```json { "success": true, "data": { "total": 3, "profiles": [ { "id": 1, "name": "GPT-4o Customer Service Assistant", "type": "llm", "model": "gpt-4o", "providerId": 1, "providerName": "Primary OpenAI Account", "temperature": 0.5, "maxTokens": 2048, "isActive": true }, { "id": 2, "name": "Deepgram Nova-2 Fast Transcription", "type": "stt", "model": "nova-2-general", "providerId": 2, "providerName": "Deepgram Speech Cloud", "isActive": true }, { "id": 3, "name": "ElevenLabs Studio Voice Generator", "type": "tts", "model": "eleven_multilingual_v2", "providerId": 3, "providerName": "ElevenLabs Voice Cloud", "voice": "Rachel", "isActive": true } ] } } ``` #### `get_ai_profile_status` ```json { "name": "get_ai_profile_status", "description": "Get configuration parameters of an AI Profile (model, temperature, max tokens, system prompt, timeout).", "parameters": { "type": "object", "properties": { "profileName": { "type": "string", "description": "Name of the AI Profile (e.g. \"GPT-4o Customer Service Assistant\")." } }, "required": ["profileName"] } } ``` **Realistic Execution Response:** ```json { "success": true, "data": { "profile": { "id": 1, "name": "GPT-4o Customer Service Assistant", "type": "llm", "model": "gpt-4o", "providerName": "Primary OpenAI Account", "temperature": 0.5, "maxTokens": 2048, "systemPrompt": "You are a courteous, professional customer support agent for Ring2All Telephony...", "timeoutSeconds": 30, "presencePenalty": 0.0, "frequencyPenalty": 0.1 } } } ``` ### Bilingual Natural Language Prompt Examples #### English Prompts - *"Copilot, list all active LLM profiles configured for telephony voice agents."* - *"What model and temperature are assigned to the Customer Service Assistant profile?"* - *"Find all speech-to-text (STT) profiles available for real-time call transcription."* #### Spanish Prompts - *"Copilot, lista todos los perfiles de IA activos y sus modelos asignados."* - *"ΒΏCuΓ‘l es la temperatura y el lΓ­mite de tokens del perfil de atenciΓ³n a clientes?"* - *"Muestra los perfiles de sΓ­ntesis de voz (TTS) configurados en el sistema."* ### Enterprise Safeguards & Execution Boundaries 1. **Multi-Tenant Profile Isolation:** Profiles are bound to numeric `tenant_id` (or shared platform default templates). Sub-tenants cannot overwrite core profiles. 2. **Deterministic Hyperparameter Range Checking:** Temperature values must strictly fall within `0.0` and `2.0`; max tokens cannot exceed model context windows. 3. **Dependency Protection:** Deleting an AI Profile is blocked if it is actively linked to a live Voice Agent, Extension Chatbot, or Service Hub mapping. --- ## 6. Common Scenarios & Examples ### Scenario 1: Create Customer Service Profile 1. Add Profile 2. Name = "Customer Service" 3. Provider = OpenAI 4. Model = GPT-4o 5. Temperature = 0.7 6. Max Tokens = 2000 7. Voice Engine = OpenAI TTS 8. Voice = Alloy 9. System Prompt = "You are a helpful..." 10. Save ### Scenario 2: Studio Voice Profile 1. Add Profile 2. Name = "Studio Voice" 3. Voice Engine = ElevenLabs 4. Voice = (select professional voice) 5. Pitch = Medium 6. Rate = Slow 7. Test Voice 8. Save ### Scenario 3: Analysis Profile 1. Add Profile 2. Name = "Analysis" 3. Provider = Anthropic 4. Model = Claude 3 Opus 5. Temperature = 0.3 (accurate) 6. Max Tokens = 4000 7. (No voice settings needed) 8. Save ### Scenario 4: IVR Bot Profile 1. Add Profile 2. Name = "IVR Bot" 3. Provider = OpenAI 4. Model = GPT-4o 5. Temperature = 0.5 6. Voice = Nova 7. Rate = Medium 8. System Prompt = "You are an IVR assistant..." 9. Test Voice with sample greeting 10. Save ### Scenario 5: Google TTS Profile (Spanish) 1. Add Profile 2. Name = "Spanish Voice" 3. Provider = Google 4. Voice Engine = Google TTS 5. Language = Spanish 6. Accent = Spain (or Mexico, US, etc.) 7. Voice = Enceladus (or select from Chirp, Wavenet, Neural2) 8. Style = Natural (or Alegre for friendly, Triste for empathetic) 9. Adjust Speed, Pitch, Volume as needed 10. Enter test text and click "Convert to Audio" 11. Preview, then Save --- ## 7. Limitations & Important Notes ### Technical Notes > [!NOTE] > **Provider Required**: Must select a provider from AI Providers first. > [!NOTE] > **Voice Testing**: Uses API credits for TTS generation. > [!WARNING] > **System Prompt**: Keep concise for faster responses. ### Best Practices 1. **Use Profiles for Purposes**: Don't reuse same profile for everything 2. **Test Voice Settings**: Preview before production 3. **Tune Temperature**: Match to use case 4. **Write Clear Prompts**: Specific instructions work best 5. **Monitor Usage**: API calls cost money ### Profile Use Cases | Profile Type | Temperature | Voice | Example | |--------------|-------------|-------|---------| | Customer Service | 0.6-0.7 | Friendly | Alloy, Nova | | Announcements | 0.2-0.3 | Professional | Onyx | | Analysis | 0.1-0.3 | None | - | | Creative | 0.7-1.0 | Varied | - | --- ## 8. Troubleshooting Tips ### Common Issues | Symptom | Possible Cause | Solution | |---------|---------------|----------| | Connection failed | Wrong provider | Check AI Providers | | Voice won't play | Audio blocked | Check browser | | Slow responses | Low timeout | Increase timeout | | Generic answers | Vague prompt | Improve system prompt | ### Test Connection ```bash # Test API manually curl https://api.openai.com/v1/chat/completions \ -H "Authorization: Bearer $API_KEY" \ -H "Content-Type: application/json" \ -d '{"model":"gpt-4o","messages":[{"role":"user","content":"Hello"}]}' ``` ### Debug Voice 1. Click Test Voice 2. Enter sample text 3. Click Generate 4. Check for error messages 5. Verify voice is selected 6. Check audio playback --- ## 9. Glossary | Term | Definition | |------|------------| | **Temperature** | AI creativity control | | **Max Tokens** | Response length limit | | **TTS** | Text-to-Speech | | **Embeddings** | Vector representations | | **System Prompt** | AI behavior instructions | | **Voice Engine** | TTS service provider | --- *Documentation last updated: January 2026*