Missing name parameter in chat completion message parameters.

[anzemur]

According to the documentation we should be able to specify the name for each of the base message types/roles (system, assistant, and user) to provide the model with additional information to differentiate between participants of the same role (useful for few-shot prompting).

[rattrayalex]

cc @nknj – thoughts on adding this?

[anzemur]

@rattrayalex @nknj any more information on this? I encountered this issue when migrating from version 3.x.x and it seems like these parameters are not deprecated.

[transitive-bullshit]

It looks like they're deprecating name support, but it would be nice to get an official explanation.

[logankilpatrick]

Can you confirm what the issue is? We document these in the API, are you saying they are not supported here in the SDK?

[anzemur]

Yes, they are not supported in the SDK - types ChatCompletionSystemMessageParam, ChatCompletionUserMessageParam, and ChatCompletionAssistantMessageParam should all include the name parameter but the usage of these types would result in the following error: Object literal may only specify known properties, and ''name'' does not exist in type.

I am using the node library v4.18.0.

[logankilpatrick]

This should be fixed soon! Hang tight.

[davidmigloz]

#126 includes the fix, so, when merged, #119 can be closed

[anzemur]

@logankilpatrick any info on this?

[logankilpatrick]

Fixed!

[anzemur]

@logankilpatrick @rattrayalex I updated the npm package version to the current latest version (v4.20.1) and the name parameter is still not available.

[sp88011]

Same (?) issue here. I'm using 4.20.1 and am getting this error when calling openai.chat.completions.create({...payload})

  Types of property 'messages' are incompatible.
        Type '{ role: ChatCompletionRole; content: string; }[]' is not assignable to type 'ChatCompletionMessageParam[]'.
          Type '{ role: OpenAI.Chat.Completions.ChatCompletionRole; content: string; }' is not assignable to type 'ChatCompletionMessageParam'.
            Property 'name' is missing in type '{ role: OpenAI.Chat.Completions.ChatCompletionRole; content: string; }' but required in type 'ChatCompletionFunctionMessageParam'.

My payload looks like this:

      const payload = {
        messages: [
          {
            role: "system" as OpenAI.Chat.ChatCompletionRole,
            content:
              "Use the provided function to solve the user's request and provide a JSON object as a response",
          },
          {
            role: "user" as OpenAI.Chat.ChatCompletionRole,
            content: input.text,
          },
        ],
        tools: tools,
        tool_choice: {
          type: "function",
          function: { name: "my_function_name" },
        },
        response_format: { type: "json_object" },
        model: "gpt-3.5-turbo-1106",
      };
      ```

[rattrayalex]

Sorry about this! A true fix has merged on this repo and should go out in the SDKs shortly.

[shamoons]

Still seems to be broken?

[rattrayalex]

@shamoons where do you see name missing that you would have expected it?