Missing parameter 'tool_call_id': messages with role 'tool' must have a 'tool_call_id'."

Question

Hi all,

Please consider the following messages array that I send to Azure OpenAI (using GPT4o). This produces the error: "Missing parameter 'tool_call_id': messages with role 'tool' must have a 'tool_call_id'.", But, as you can see, the property is there. Any idea what I might be doing wrong?

 "messages": [
    {
      "role": "system",
      "content": "You are an assistant... <shortened>"
    },
    {
      "role": "assistant",
      "content": "Hey there! Thanks for calling C Clinics. Want to book an appointment?"
    },
    {
      "role": "user",
      "content": "<shortened>"
    },
    {
      "role": "assistant",
      "content": "<shortened>"
    },
    {
      "role": "assistant",
      "tool_calls": [
        {
          "function": {
            "arguments": "{\"date\":\"2024-7-04T14:00:00\",\"treatment",
            "name": "check_appointment_availability"
          },
          "id": "call_UppFZO2cl44QV4EDaJSBX1bJ",
          "type": "function"
        }
      ]
    },
    {
      "role": "tool",
      "name": "check_appointment_availability",
      "content": "Yes, we have slots available",
      "tool_call_id": "call_UppFZO2cl44QV4EDaJSBX1bJ"
    }
  ]

Answer 1

The error you are encountering, "Missing parameter 'tool_call_id': messages with role 'tool' must have a 'tool_call_id'," suggests that there is an issue with how the tool_call_id parameter is being interpreted or formatted in your JSON.

Let's review and correct your JSON structure:

Corrected JSON Structure

{

  "messages": [

    {

      "role": "system",

      "content": "You are an assistant... <shortened>"

    },

    {

      "role": "assistant",

      "content": "Hey there! Thanks for calling C Clinics. Want to book an appointment?"

    },

    {

      "role": "user",

      "content": "<shortened>"

    },

    {

      "role": "assistant",

      "content": "<shortened>"

    },

    {

      "role": "assistant",

      "tool_calls": [

        {

          "function": {

            "arguments": "{\"date\":\"2024-7-04T14:00:00\",\"treatment",

            "name": "check_appointment_availability"

          },

          "id": "call_UppFZO2cl44QV4EDaJSBX1bJ",

          "type": "function"

        }

      ]

    },

    {

      "role": "tool",

      "name": "check_appointment_availability",

      "content": "Yes, we have slots available",

      "tool_call_id": "call_UppFZO2cl44QV4EDaJSBX1bJ"

    }

  ]

}

By ensuring that the structure and placement of the tool_calls and tool_call_id are correct, you should be able to resolve the error and successfully validate the messages.