Error: "Text message received from client did not match any of the formats we expect." #1090

DrifterAtSea · 2025-02-10T14:18:05Z

DrifterAtSea
Feb 10, 2025

Below is a test script to simply connect to the voice agent. The page includes a button that when clicked will initiate a connection to the voice agent API. When this script is run, the first message that is received is the "Welcome" message. I then start the interval timer with the KeepAlive command. But even before the timer starts, another message is returned in the "message" event listener and it indicates the following error:

Text message received from client did not match any of the formats we expect.

What I don't understand is where the backend is getting another command from the client. There are no other commands sent to the backend other than the KeepAlive and even that doesn't even have a chance to trigger before this error message is returned.

<!DOCTYPE html>
<html>

<head>
  <title>Voice Agent</title>
  <style>
    body {
      font-family: sans-serif;
    }

    #startBtn {
      padding: 10px 20px;
      font-size: 16px;
      cursor: pointer;
    }

    #console {
      margin-top: 20px;
      border: 1px solid #ccc;
      padding: 10px;
      height: 200px;
      overflow-y: scroll;
    }
  </style>
</head>

<body>

  <h1>Voice Agent</h1>
  <button id="startBtn">Start Conversation</button>
  <div id="console"></div>

  <script>
    const startBtn = document.getElementById('startBtn');
    const consoleDiv = document.getElementById('console');
    let socket;
    let recorder;
    let connected = false;

    startBtn.addEventListener('click', initialize);

    setInterval(() => {
      if (connected) {
        console.log("Keep alive!");
        let json = JSON.stringify({ type: "KeepAlive" });
        socket.send(json);
      }
    }, 5000);

    async function initialize() {
      startBtn.disabled = true; // Disable the button after click
      socket = new WebSocket('wss://agent.deepgram.com/agent', ["token", "your_api_key"]);

      socket.addEventListener("open", (event) => {
        consoleLog("socket connection opened.");

        const config = {
          type: "SettingsConfiguration",
          audio: {
            input: {
              encoding: "linear16",
              sampleRate: 44100
            },
            output: {
              encoding: "linear16",
              sampleRate: 24000,
              container: "none"
            },
          },
          agent: {
            listen: {
              model: "nova-2",
            },
            speak: {
              model: "aura-asteria-en",
            },
            think: {
              provider: {
                type: "open_ai", fallback_to_groq: true
              },
              model: "gpt-4o-mini",
              instructions: `
                ## Base instructions
                You are a helpful voice assistant made by Deepgram's engineers.
                Respond in a friendly, human, conversational manner.
                YOU MUST answer in 1-2 sentences at most when the message is not empty.
                Always reply to empty messages with an empty message.
                Ask follow up questions.
                Ask one question at a time.
                Your messages should have no more than than 120 characters.
                Do not use abbreviations for units.
                Separate all items in a list with commas.
                Keep responses unique and free of repetition.
                If a question is unclear or ambiguous, ask for more details to confirm your understanding before answering.
                If someone asks how you are, or how you are feeling, tell them.
                Deepgram gave you a mouth and ears so you can take voice as an input. You can listen and speak.
                Your name is Voicebot.
                `
            },
          },
        }

        socket.send(JSON.stringify(config));
      });

      socket.addEventListener("message", (event) => {
        consoleLog("Received:", event.data); // Display received data in console
        
        try {
          const message = JSON.parse(event.data);

          switch (message.type) {
            case "Welcome":
              connected = true;
              break;
          }
        } catch (error) {
          consoleLog("Error during message reception:", error);
        }
      });

      socket.addEventListener("error", (event) => {
        consoleLog("socket error:", error);
        startBtn.disabled = false;
      });

      socket.addEventListener("close", (event) => {
        consoleLog("socket connection closed.");
        startBtn.disabled = false; 
        
        if (recorder) {
          recorder.stream.getTracks().forEach(track => track.stop());
        }
      });
    }

    function consoleLog(message) {
      const messageDiv = document.createElement('div');
      messageDiv.textContent = message;
      consoleDiv.appendChild(messageDiv);
      consoleDiv.scrollTop = consoleDiv.scrollHeight; // Scroll to bottom
    }

  </script>

</body>

</html>

2025-02-10T14:18:07Z

deepgram-community[bot]
bot Feb 10, 2025

Thanks for asking your question. Please be sure to reply with as much detail as possible so the community can assist you efficiently.
_{Consider joining our Discord community for more opportunity to engage with your fellow Deepgram users. You can earn points which can be redeemed for cool stuff by being active in our communities!}

0 replies

2025-02-10T14:19:02Z

deepgram-community[bot]
bot Feb 10, 2025

Hey there! It looks like you haven't connected your GitHub account to your Deepgram account. You can do this at https://community.deepgram.com - being verified through this process will allow our team to help you in a much more streamlined fashion.

0 replies

2025-02-10T14:19:04Z

deepgram-community[bot]
bot Feb 10, 2025

It looks like we're missing some important information to help debug your issue. Would you mind providing us with the following details in a reply?

A request ID that triggered your error or issue.

0 replies

DrifterAtSea · 2025-02-10T14:53:32Z

DrifterAtSea
Feb 10, 2025
Author

The problem is that the config uses "SampleRate". It should be "sample_rate". I took this sample code from your own docs:

https://developers.deepgram.com/docs/voice-agent

The sample code shows "SampleRate". Please fix your documentation and try testing your code next time before documenting it. It took hours to find this bug.

0 replies

BuckyMcYolo · 2025-02-15T00:27:07Z

BuckyMcYolo
Feb 15, 2025

I received this same error when configuring the 'context' in the settings config with these settings

 context: {
        messages: [
          {
            type: "assistant",
            content:
              "Hello! How can I assist you today?",
          },
        ],
        replay: true,
      },

type: 'Error', message: 'Text message received from client did not match any of the formats we expect.'

When I changed it to this it fixed the problem

context: {
        messages: [
          {
           //@ts-ignore
            role: "assistant", // changed to 'role' instead of 'type'
            content:
              "Hello! How can I assist you today?",
          },
        ],
        replay: true,
      },

The incorrect type is in their official SDK as well

This from the 3.11.1 version of the Deepgram JS SDK

 context?: {
    /**
     * LLM message history (e.g. to restore existing conversation if websocket disconnects)
     */
    messages: { type: "user" | "assistant"; content: string }[];
    /**
     * Whether to replay the last message, if it is an assistant message.
     */
    replay: boolean;
  };

0 replies

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Deepgram

Error: "Text message received from client did not match any of the formats we expect." #1090

{{title}}

Replies: 5 comments

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

Select a reply

Deepgram

Error: "Text message received from client did not match any of the formats we expect." #1090

DrifterAtSea Feb 10, 2025

Replies: 5 comments

deepgram-community[bot] bot Feb 10, 2025

deepgram-community[bot] bot Feb 10, 2025

deepgram-community[bot] bot Feb 10, 2025

DrifterAtSea Feb 10, 2025 Author

BuckyMcYolo Feb 15, 2025

DrifterAtSea
Feb 10, 2025

deepgram-community[bot]
bot Feb 10, 2025

deepgram-community[bot]
bot Feb 10, 2025

deepgram-community[bot]
bot Feb 10, 2025

DrifterAtSea
Feb 10, 2025
Author

BuckyMcYolo
Feb 15, 2025