feat: Update Azure OpenAI spec version to 2024-10-21
#312
Conversation
| @@ -0,0 +1,15 @@ | |||
| { | |||
There was a problem hiding this comment.
[q] Do we really need these example files checked in, considering we don't do anything (either documentation/validation) with them? We had previously commented these out, until this extension is handled in the sdk generator
There was a problem hiding this comment.
With yaml, it works without examples folder, but with json, generation will fail and complaining there is no examples folder. Not sure if this is wanted behavior though.
There was a problem hiding this comment.
It doesn't work with yaml either, this was the reason we decided to comment x-ms-examples out in the spec.
The SDK generator does not really support this Autorest vendor extension as per my knowledge (for tsdoc purposes, or any other), but breaks if the example file is not there (ideally, this should be handled in the generator to not fail if file is missing).
In the azure spec repository, the only place these example files are used (that I could find) is to run model validation using the oav tool.
IMO, commenting this part out rather than checking in these unused files would be a preferable way to go for now and later fixing it in https://github.com/SAP/cloud-sdk-backlog/issues/1237. @jjtang1985
@MatKuhr How do you handle this in the Java SDK?
There was a problem hiding this comment.
One possibility is to use jq (or with npm, node-jq as dev dependency) to remove all x-ms-examples.
I tried to add the following command to foundation-models/pakcage.json to pre-process the spec:
"pregenerate:azure-openai": "mv ./src/azure-openai/spec/inference.json ./src/azure-openai/spec/inference.json.bak && pnpm node-jq 'walk(if type == \"object\" then (if has(\"x-ms-examples\") then del(.[\"x-ms-examples\"]) else . end) else . end)' src/azure-openai/spec/inference.json.bak > src/azure-openai/spec/inference.json && rm ./src/azure-openai/spec/inference.json.bak",There was a problem hiding this comment.
I updated the package json and removed examples.
Context
AI/gen-ai-hub-sdk-js-backlog#174.
Current progress:
apiVersionupdatedjsonstreamchunk type appliedDefinition of Done