Configure the Voice Agent

1
{
2
  "type": "Settings",
3
  "experimental": false,
4
  "mip_opt_out": false,
5
  "flags": {
6
    "history": true
7
  },
8
  "audio": {
9
    "input": {
10
      "encoding": "linear16",
11
      "sample_rate": 24000
12
    },
13
    "output": {
14
      "encoding": "mp3",
15
      "sample_rate": 24000,
16
      "bitrate": 48000,
17
      "container": "none"
18
    }
19
  },
20
  "agent": {
21
    "language": "en",
22
    "context": {
23
      "messages": [
24
        {
25
          "type": "History",
26
          "role": "user",
27
          "content": "What's my order status?"
28
        },
29
        {
30
          "type": "History",
31
          "function_calls": [
32
            {
33
              "id": "fc_12345678-90ab-cdef-1234-567890abcdef",
34
              "name": "check_order_status",
35
              "client_side": true,
36
              "arguments": "{\"order_id\": \"ORD-123456\"}",
37
              "response": "Order #123456 status: Shipped - Expected delivery date: 2024-03-15"
38
            }
39
          ]
40
        },
41
        {
42
          "type": "History",
43
          "role": "assistant",
44
          "content": "Your order #123456 has been shipped and is expected to arrive on March 15th, 2024."
45
        }
46
      ]
47
    },
48
    "listen": {
49
      "provider": {
50
        "type": "deepgram",
51
        "model": "nova-3",
52
        "keyterms": ["hello", "goodbye"]
53
      }
54
    },
55
    "think": {
56
      "provider": {
57
        "type": "open_ai",
58
        "model": "gpt-4o-mini",
59
        "temperature": 0.7
60
      },
61
      "endpoint": { // Optional for non-Deepgram LLM providers. When present, must include url field and headers object
62
        "url": "https://api.example.com/llm",
63
        "headers": {
64
          "authorization": "Bearer {{token}}"
65
        }
66
      },
67
      "prompt": "You are a helpful AI assistant focused on customer service.",
68
      "context_length": 15000,  // Optional and can only be used when a custom think endpoint is used. Use max for maximum context length
69
      "functions": [
70
        {
71
          "name": "check_order_status",
72
          "description": "Check the status of a customer order",
73
          "parameters": {
74
            "type": "object",
75
            "properties": {
76
              "order_id": {
77
                "type": "string",
78
                "description": "The order ID to check"
79
              }
80
            },
81
            "required": ["order_id"]
82
          },
83
          "endpoint": { // If not provided, function is called client-side
84
            "url": "https://api.example.com/orders/status",
85
            "method": "post",
86
            "headers": {
87
              "authorization": "Bearer {{token}}"
88
            }
89
          }
90
        }
91
      ]
92
    },
93
    "speak": {
94
      "provider": {
95
        "type": "deepgram",
96
        "model": "aura-2-thalia-en", // For Deepgram or OpenAI providers
97
        "model_id": "1234567890", // For Eleven Labs or Cartesia providers
98
        "voice": {
99
          "mode": "id", // For Cartesia provider only
100
          "id": "a167e0f3-df7e-4d52-a9c3-f949145efdab" // For Cartesia provider only
101
        },
102
        "language": "en", // For Cartesia provider only
103
        "language_code": "en-US", // For Eleven Labs provider only
104
        "engine": "standard", // For AWS Polly provider only
105
        "credentials": { // For AWS Polly provider only
106
          "type": "IAM", // For AWS Polly provider only. Must be "IAM" or "STS"
107
          "region": "us-east-1",
108
          "access_key_id": "{{access_key_id}}",
109
          "secret_access_key": "{{secret_access_key}}",
110
          "session_token": "{{session_token}}" // Required for STS only
111
        }
112
      },
113
      "endpoint": {
114
        "url": "https://api.example.com/tts",
115
        "headers": {
116
          "authorization": "Bearer {{token}}"
117
        }
118
      }
119
    },
120
    "greeting": "Hello! How can I help you today?"
121
  }
122
}