Datatypes for fields should match in NPM package vs. API reference.

[lif2]

Is your feature request related to a problem? Please describe.
In my opinion @azure/openai package should follow the same datatypes definition that official AzureOpenAI API.
I've noticed that "created" field is a Date, while OpenAI and Azure OpenAI API references, have this field in "number" (int) format.
Example for created date in chat completions below.
Created date in this package -> https://learn.microsoft.com/en-us/javascript/api/@azure/openai/chatcompletions?view=azure-node-preview#@azure-openai-chatcompletions-created
Created date in Azure OpenAI Rest Api -> https://github.com/Azure/azure-rest-api-specs/blob/e6a20fec72ed3bcb4b43c559ee20b56ca2786ec0/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-02-01/inference.json#L2467

Describe the solution you'd like
Datatypes are the same. Example -> "created" field [date vs number].

Describe alternatives you've considered
If it's not possible, it will be nice to mention in package documentation, which fields are not the same datatype, so community will be careful about them.

Additional context
"created" field was 'number' few months back; but it was changed by this PR -> [OpenAI] Support Functions by deyaaeldeen · Pull Request #26782 · Azure/azure-sdk-for-js · GitHub

[github-actions]

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

[lif2]

I've just found new package -> https://www.npmjs.com/package/@azure-rest/openai. First release was done ~2months ago.

Is it new package that should be used instead '@azure/openai', to be sure schema/models match 'official OpenAI' rest apis? I wasn't able to find [yet] any official statement on microsoft example pages for '@azure-rest/openai'?
Microsoft page just informs about '@azure/openai':

[minhanh-phan]

Hi @lif2, thank you for raising the issue. To better assist you, would you mind giving us more context on your scenario uses created field as an integer? For reference, the @azure-rest/openai package has not been officially released yet and it is generated off of our pipeline build, so that's why there is no official document on this package yet. Please let us know if you have and additional questions.

[lif2]

Hi @minhanh-phan!

'Created' field is in Azure OpenAI REST API documentations a number type field.

We are using this package to build JavaScript based app which also has some Rest API endpoints. By returning completions "as is" using your package, package is returning Date for this field (string in json). Some other apps that are integrating with our endpoints (endpoint returns completions based on @azure/openai), simply fails because these expect 'number' field for 'created' - because that's how Azure OpenAI REST API defines that field.

[minhanh-phan]

Hi @lif2, @azure/openai SDK for JS is designed to provide the customer with a convenience layer and serve as a high level package. It is isomorphic to the Rest API but it doesn't necessarily correspond 1 to 1. For example, the SDK use camel casing convention while the Rest API uses snake case.

For your specific scenario, it'd be more beneficial to use the @azure/openai Rest API endpoint directly through importing from @azure/openai/rest. You can see an example of how to use them here. For instance, a request for Completions operation would be as follow:

import OpenAIClient from "@azure/openai/rest";

const client = OpenAIClient(endpoint, new AzureKeyCredential(azureApiKey));

const result = await client.path("/deployments/{deploymentId}/completions", deploymentId).post({
  body: { prompt, max_tokens: 128 },
});

console.log(JSON.stringify(result));

Please feel free to refer to the Azure OpenAI Rest API documentation here and let us know if you have any questions in the meantime.