ChatCompletions interface does not match actual payload

[dangchinh25]

• Package Name: @azure/openai
• Package Version: 1.0.0-beta.11
• Operating system:
• [ ] nodejs
  • version:
• [ ] browser
  • name/version:
• [ ] typescript
  • version:
• Is the bug related to documentation in
  • [ ] README.md
  • [x] source code documentation
  • [x] SDK API docs on https://docs.microsoft.com

Describe the bug ChatCompletions interface does not contain model and object attribute, but the actual received payload does have these values.

The code I tried with:

 const chatCompletion = await azureOpenAIClient.getChatCompletions(azureOpenAIDeploymentName, payload.messages, {
      functions: payload.functions,
      functionCall: payload.function_call,
      maxTokens: payload.maxTokens,
      temperature: payload.temperature,
      topP: payload.topP,
    })

console.log(chatCompletion)

To Reproduce Steps to reproduce the behavior:

Expected behavior Type definition and actual response object match each other.

Screenshots If applicable, add screenshots to help explain your problem.

Additional context Add any other context about the problem here.

[github-actions[bot]]

Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc @glharper.

[deyaaeldeen]

This is similar to https://github.com/Azure/azure-sdk-for-js/issues/26579. It is intentional to hide those properties because we believe they're not relevant to the experience of the SDK customers. Could you please share how do you intend to use object and model?

[dangchinh25]

I think I'm in a similar scenario with issue https://github.com/Azure/azure-sdk-for-js/issues/26579 where we just want to do some logging/auditing on our end. I also want to point out that the deploymentId is not always the model name so we can't rely on that. I see that you also mentioned some workaround but I'm not sure that is the best way to do this when we already have this information ready on our end.

[huytool157]

Seeing the same issue

[deyaaeldeen]

Hi @dangchinh25 and @huytool157, we strongly recommend that you migrate to use the AzureOpenAI client exported by the official OpenAI client library for JavaScript. Checkout the migration guide for how to do so while maintaining typing for Azure features.

Please let us know if you have any other questions!