Adding 'model' property to ChatCompletions. #28554

richardpark-msft · 2024-04-02T00:38:21Z

ChatCompletions (the response from GetChatCompletions) is missing the model property that's in OpenAI's docs and in our example output in our docs.

This adds it back in, with the C# project to rename it to DeploymentName.

…own docs, in OpenAI docs but is missing from our TSP for some reason.

openapi-pipeline-app · 2024-04-02T00:38:25Z

Next Steps to Merge

✅ All automated merging requirements have been met! To get your PR merged, see https://aka.ms/azsdk/specreview/merge.

openapi-pipeline-app · 2024-04-02T00:38:26Z

Swagger Validation Report

️❌BreakingChange: 5 Errors, 0 Warnings failed [Detail]

Compared specs (v0.10.7)	new version	base version
generated.json	2023-06-01-preview(1236daa)	2023-06-01-preview(main)
generated.json	2023-07-01-preview(1236daa)	2023-07-01-preview(main)
generated.json	2024-02-15-preview(1236daa)	2024-02-15-preview(main)
generated.json	2024-03-01-preview(1236daa)	2024-03-01-preview(main)
generated.json	2023-05-15(1236daa)	2023-05-15(main)

Rule	Message
`❌` 1041 - AddedPropertyInResponse	The new version has a new property 'model' in response that was not found in the old version. New: inference/preview/2023-06-01-preview/generated.json#L489:7 Old: inference/preview/2023-06-01-preview/generated.json#L489:7
`❌` 1041 - AddedPropertyInResponse	The new version has a new property 'model' in response that was not found in the old version. New: inference/preview/2023-07-01-preview/generated.json#L489:7 Old: inference/preview/2023-07-01-preview/generated.json#L489:7
`❌` 1041 - AddedPropertyInResponse	The new version has a new property 'model' in response that was not found in the old version. New: inference/preview/2024-02-15-preview/generated.json#L1780:7 Old: inference/preview/2024-02-15-preview/generated.json#L1780:7
`❌` 1041 - AddedPropertyInResponse	The new version has a new property 'model' in response that was not found in the old version. New: inference/preview/2024-03-01-preview/generated.json#L1780:7 Old: inference/preview/2024-03-01-preview/generated.json#L1780:7
`❌` 1041 - AddedPropertyInResponse	The new version has a new property 'model' in response that was not found in the old version. New: inference/stable/2023-05-15/generated.json#L310:7 Old: inference/stable/2023-05-15/generated.json#L310:7

️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]

There are no breaking changes.

️️✔️CredScan succeeded [Detail] [Expand]

There is no credential detected.

️⚠️LintDiff: 0 Warnings warning [Detail]

Compared specs (v2.2.0)	new version	base version
release_2023_05_15_autogen	release_2023_05_15_autogen(1236daa)	release_2023_05_15_autogen(main)
release_2023_06_01_preview_autogen	release_2023_06_01_preview_autogen(1236daa)	release_2023_06_01_preview_autogen(main)
release_2023_07_01_preview_autogen	release_2023_07_01_preview_autogen(1236daa)	release_2023_07_01_preview_autogen(main)
release_2024_02_15_preview_autogen	release_2024_02_15_preview_autogen(1236daa)	release_2024_02_15_preview_autogen(main)

The following errors/warnings exist before current PR submission:

Only 30 items are listed, please refer to log for more details.

Rule	Message
`❌` IntegerTypeMustHaveFormat	The integer type does not have a format, please add it. Location: inference/preview/2023-06-01-preview/generated.json#L423
`❌` IntegerTypeMustHaveFormat	The integer type does not have a format, please add it. Location: inference/preview/2023-06-01-preview/generated.json#L494
`❌` IntegerTypeMustHaveFormat	The integer type does not have a format, please add it. Location: inference/preview/2023-06-01-preview/generated.json#L793
`❌` DefaultInEnum	Default value should appear in the enum constraint for a schema Location: inference/preview/2023-06-01-preview/generated.json#L1289
`❌` IntegerTypeMustHaveFormat	The integer type does not have a format, please add it. Location: inference/preview/2023-06-01-preview/generated.json#L1353
`❌` IntegerTypeMustHaveFormat	The integer type does not have a format, please add it. Location: inference/preview/2023-07-01-preview/generated.json#L423
`❌` IntegerTypeMustHaveFormat	The integer type does not have a format, please add it. Location: inference/preview/2023-07-01-preview/generated.json#L494
`❌` IntegerTypeMustHaveFormat	The integer type does not have a format, please add it. Location: inference/preview/2023-07-01-preview/generated.json#L846
`❌` DefaultInEnum	Default value should appear in the enum constraint for a schema Location: inference/preview/2023-07-01-preview/generated.json#L1386
`❌` IntegerTypeMustHaveFormat	The integer type does not have a format, please add it. Location: inference/preview/2023-07-01-preview/generated.json#L1450
`❌` IntegerTypeMustHaveFormat	The integer type does not have a format, please add it. Location: inference/preview/2024-02-15-preview/generated.json#L1785
`❌` IntegerTypeMustHaveFormat	The integer type does not have a format, please add it. Location: inference/preview/2024-02-15-preview/generated.json#L2428
`❌` IntegerTypeMustHaveFormat	The integer type does not have a format, please add it. Location: inference/preview/2024-02-15-preview/generated.json#L3430
`❌` IntegerTypeMustHaveFormat	The integer type does not have a format, please add it. Location: inference/stable/2023-05-15/generated.json#L315
`❌` IntegerTypeMustHaveFormat	The integer type does not have a format, please add it. Location: inference/stable/2023-05-15/generated.json#L600
⚠️ SecurityDefinitionDescription	Security definition should have a description. Location: inference/preview/2023-06-01-preview/generated.json#L46
⚠️ SecurityDefinitionDescription	Security definition should have a description. Location: inference/preview/2023-06-01-preview/generated.json#L51
⚠️ OperationId	OperationId should be of the form 'Noun_Verb' Location: inference/preview/2023-06-01-preview/generated.json#L64
⚠️ PathParameterSchema	Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: inference/preview/2023-06-01-preview/generated.json#L70
⚠️ OperationId	OperationId should be of the form 'Noun_Verb' Location: inference/preview/2023-06-01-preview/generated.json#L115
⚠️ PathParameterSchema	Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: inference/preview/2023-06-01-preview/generated.json#L121
⚠️ PaginationResponse	Operation might be pageable. Consider adding the x-ms-pageable extension. Location: inference/preview/2023-06-01-preview/generated.json#L165
⚠️ OperationId	OperationId should be of the form 'Noun_Verb' Location: inference/preview/2023-06-01-preview/generated.json#L166
⚠️ PathParameterSchema	Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: inference/preview/2023-06-01-preview/generated.json#L172
⚠️ LongRunningOperationsOptionsValidator	A LRO Post operation with return schema must have 'x-ms-long-running-operation-options' extension enabled. Location: inference/preview/2023-06-01-preview/generated.json#L215
⚠️ OperationId	OperationId should be of the form 'Noun_Verb' Location: inference/preview/2023-06-01-preview/generated.json#L217
⚠️ OperationId	OperationId should be of the form 'Noun_Verb' Location: inference/preview/2023-06-01-preview/generated.json#L269
⚠️ PathParameterSchema	Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: inference/preview/2023-06-01-preview/generated.json#L275
⚠️ EnumInsteadOfBoolean	Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: inference/preview/2023-06-01-preview/generated.json#L598
⚠️ PropertyType	Property should have a defined type. Location: inference/preview/2023-06-01-preview/generated.json#L676

️️✔️Avocado succeeded [Detail] [Expand]

Validation passes for Avocado.

️️✔️SwaggerAPIView succeeded [Detail] [Expand]

️❌TypeSpecAPIView: 0 Errors, 0 Warnings failed [Detail]

️️✔️ModelValidation succeeded [Detail] [Expand]

Validation passes for ModelValidation.

️️✔️SemanticValidation succeeded [Detail] [Expand]

Validation passes for SemanticValidation.

️️✔️PoliCheck succeeded [Detail] [Expand]

Validation passed for PoliCheck.

️️✔️SpellCheck succeeded [Detail] [Expand]

Validation passes for SpellCheck.

️️✔️Lint(RPaaS) succeeded [Detail] [Expand]

Validation passes for Lint(RPaaS).

️️✔️PR Summary succeeded [Detail] [Expand]

Validation passes for Summary.

️️✔️Automated merging requirements met succeeded [Detail] [Expand]

_{Posted by Swagger Pipeline | How to fix these errors?}

openapi-pipeline-app · 2024-04-02T00:38:27Z

Swagger Generation Artifacts

️️✔️ApiDocPreview succeeded [Detail] [Expand]

 Please click here to preview with your @microsoft account.

️❌ azure-sdk-for-net-track2 failed [Detail]

❌Failed [Logs] Generate from 2eeb42fb2117e1286859fc5e87f02b4447a60c97. SDK Automation 14.0.0

command	pwsh ./eng/scripts/Automation-Sdk-Init.ps1 ../azure-sdk-for-net_tmp/initInput.json ../azure-sdk-for-net_tmp/initOutput.json
warn		specification/cognitiveservices/data-plane/AzureOpenAI/inference/readme.md skipped due to azure-sdk-for-net-track2 not found in swagger-to-sdk
command	pwsh ./eng/scripts/Invoke-GenerateAndBuildV2.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1mGeneratePackage: �[0m/mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/Invoke-GenerateAndBuildV2.ps1:131�[0m
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1m�[0m�[36;1mLine |�[0m
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1m�[0m�[36;1m�[36;1m 131 | �[0m               �[36;1mGeneratePackage `�[0m
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1m�[0m�[36;1m�[36;1m�[0m�[36;1m�[0m�[36;1m     | �[31;1m               ~~~~~~~~~~~~~~~~~�[0m
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1m�[0m�[36;1m�[36;1m�[0m�[36;1m�[0m�[36;1m�[31;1m�[31;1m�[36;1m     | �[31;1mFailed to build sdk. exit code: False�[0m
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1mGeneratePackage: �[0m/mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/Invoke-GenerateAndBuildV2.ps1:131�[0m
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1m�[0m�[36;1mLine |�[0m
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1m�[0m�[36;1m�[36;1m 131 | �[0m               �[36;1mGeneratePackage `�[0m
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1m�[0m�[36;1m�[36;1m�[0m�[36;1m�[0m�[36;1m     | �[31;1m               ~~~~~~~~~~~~~~~~~�[0m
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1m�[0m�[36;1m�[36;1m�[0m�[36;1m�[0m�[36;1m�[31;1m�[31;1m�[36;1m     | �[31;1mFailed to packe sdk. exit code: False�[0m
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1mGet-ChildItem: �[0m/mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/automation/GenerateAndBuildLib.ps1:807�[0m
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1m�[0m�[36;1mLine |�[0m
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1m�[0m�[36;1m�[36;1m 807 | �[0m … rtifacts += �[36;1mGet-ChildItem $artifactsPath -Filter *.nupkg -exclude *.s�[0m …�[0m
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1m�[0m�[36;1m�[36;1m�[0m�[36;1m�[0m�[36;1m     | �[31;1m               ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~�[0m
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1m�[0m�[36;1m�[36;1m�[0m�[36;1m�[0m�[36;1m�[31;1m�[31;1m�[36;1m     | �[31;1mCannot find path�[0m
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1m�[0m�[36;1m�[36;1m�[0m�[36;1m�[0m�[36;1m�[31;1m�[31;1m�[36;1m�[31;1m�[36;1m     | �[31;1m'/mnt/vss/_work/1/s/azure-sdk-for-net/artifacts/packages/Debug/' because�[0m
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1m�[0m�[36;1m�[36;1m�[0m�[36;1m�[0m�[36;1m�[31;1m�[31;1m�[36;1m�[31;1m�[36;1m�[31;1m�[36;1m     | �[31;1mit does not exist.�[0m
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1mGeneratePackage: �[0m/mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/Invoke-GenerateAndBuildV2.ps1:131�[0m
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1m�[0m�[36;1mLine |�[0m
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1m�[0m�[36;1m�[36;1m 131 | �[0m               �[36;1mGeneratePackage `�[0m
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1m�[0m�[36;1m�[36;1m�[0m�[36;1m�[0m�[36;1m     | �[31;1m               ~~~~~~~~~~~~~~~~~�[0m
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1m�[0m�[36;1m�[36;1m�[0m�[36;1m�[0m�[36;1m�[31;1m�[31;1m�[36;1m     | �[31;1mFailed to generate sdk artifact�[0m

❌Azure.AI.OpenAI [View full logs] [Preview SDK Changes]
```
info	[Changelog]
```

️⚠️ azure-sdk-for-java warning [Detail]

⚠️Warning [Logs] Generate from 2eeb42fb2117e1286859fc5e87f02b4447a60c97. SDK Automation 14.0.0

command	./eng/mgmt/automation/init.sh ../azure-sdk-for-java_tmp/initInput.json ../azure-sdk-for-java_tmp/initOutput.json
cmderr	[init.sh] [notice] A new release of pip is available: 23.0.1 -> 24.0
cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
cmderr	[init.sh] [notice] A new release of pip is available: 23.0.1 -> 24.0
cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
warn		specification/cognitiveservices/data-plane/AzureOpenAI/inference/readme.md skipped due to azure-sdk-for-java not found in swagger-to-sdk
command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
cmderr	[generate.py]
cmderr	[generate.py] npm notice New minor version of npm available! 10.2.4 -> 10.5.0
cmderr	[generate.py] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.5.0>
cmderr	[generate.py] npm notice Run `npm install -g [email protected]` to update!
cmderr	[generate.py] npm notice

️✔️azure-ai-openai [View full logs] [Preview SDK Changes]

️❌ azure-sdk-for-js failed [Detail]

❌Failed [Logs] Generate from 2eeb42fb2117e1286859fc5e87f02b4447a60c97. SDK Automation 14.0.0

command	sh .scripts/automation_init.sh ../azure-sdk-for-js_tmp/initInput.json ../azure-sdk-for-js_tmp/initOutput.json
warn	File azure-sdk-for-js_tmp/initOutput.json not found to read
warn		specification/cognitiveservices/data-plane/AzureOpenAI/inference/readme.md skipped due to azure-sdk-for-js not found in swagger-to-sdk
command	sh .scripts/automation_generate.sh ../azure-sdk-for-js_tmp/generateInput.json ../azure-sdk-for-js_tmp/generateOutput.json
cmderr	[automation_generate.sh] [ERROR] Error:
cmderr	[automation_generate.sh] [ERROR] An error occurred while run build for typespec project: "specification/cognitiveservices/OpenAI.Inference":
cmderr	[automation_generate.sh] [ERROR] Err: Error: Command failed: rush build -t @azure/openai
cmderr	[automation_generate.sh] [ERROR] Stderr: "null"
cmderr	[automation_generate.sh] [ERROR] Stdout: "null"
cmderr	[automation_generate.sh] [ERROR] ErrorStack: "Error: Command failed: rush build -t @azure/openai
cmderr	[automation_generate.sh] [ERROR]     at checkExecSyncError (node:child_process:885:11)
cmderr	[automation_generate.sh] [ERROR]     at Object.execSync (node:child_process:957:15)
cmderr	[automation_generate.sh] [ERROR]     at Object.<anonymous> (/home/cloudtest/.nvm/versions/node/v18.15.0/lib/node_modules/@azure-tools/js-sdk-release-tools/dist/llc/generateRLCInPipeline/generateRLCInPipeline.js:209:29)
cmderr	[automation_generate.sh] [ERROR]     at Generator.next (<anonymous>)
cmderr	[automation_generate.sh] [ERROR]     at fulfilled (/home/cloudtest/.nvm/versions/node/v18.15.0/lib/node_modules/@azure-tools/js-sdk-release-tools/node_modules/tslib/tslib.js:112:62)
cmderr	[automation_generate.sh] [ERROR]     at process.processTicksAndRejections (node:internal/process/task_queues:95:5)"

❌@azure/openai [View full logs] [Preview SDK Changes]

info	[Changelog]
error	breakingChangeTracking is enabled, but version or changelogItem is not found in output.

_{Posted by Swagger Pipeline | How to fix these errors?}

openapi-pipeline-app · 2024-04-02T00:38:27Z

Generated ApiView

Language	Package Name	ApiView Link
Java	azure-ai-openai	https://apiview.dev/Assemblies/Review/0b875c11102a447c8807ad710b3d4e7c?revisionId=5352984e7dbd4b25be421840dab010eb
Swagger	AzureOpenAI	https://apiview.dev/Assemblies/Review/6693675ace534d4aa3159f202a195962?revisionId=88899b3714f04e3599bce9a47b1ca9fc
TypeSpec	OpenAI.Inference	Create ApiView failed. To get help, please see [aka.ms/azsdk/pr-getting-help](https://aka.ms/azsdk/pr-getting-help).

specification/cognitiveservices/OpenAI.Inference/models/completions/chat_completions.tsp

…g spaces that shouldn't be there) - Checking in the generated.json files.

mario-guerra · 2024-04-02T21:13:29Z

@richardpark-msft is the service team aware of and in agreement with these changes?

richardpark-msft · 2024-04-02T21:24:21Z

@richardpark-msft is the service team aware of and in agreement with these changes?

I'd worked with @trrwilson and @johanste on this. Apparently this was an SDK omission and, now that we have a good use case for it, we're just bringing it back.

* Adding 'model' property. It's present in our example response in our own docs, in OpenAI docs but is missing from our TSP for some reason.

Adding 'model' property. It's present in our example response in our …

a27810b

…own docs, in OpenAI docs but is missing from our TSP for some reason.

richardpark-msft requested a review from trrwilson April 2, 2024 00:38

AzureRestAPISpecReview added the TypeSpec Authored with TypeSpec label Apr 2, 2024

johanste reviewed Apr 2, 2024

View reviewed changes

specification/cognitiveservices/OpenAI.Inference/models/completions/chat_completions.tsp Outdated Show resolved Hide resolved

It's apparently the actual model, not the deployment at all.

7d2847b

richardpark-msft marked this pull request as ready for review April 2, 2024 02:17

richardpark-msft requested a review from yangyuan as a code owner April 2, 2024 02:17

- Fixing it so my doc string wasn't multiline (and thus adding leadin…

bbe5417

…g spaces that shouldn't be there) - Checking in the generated.json files.

AzureRestAPISpecReview added data-plane VersioningReviewRequired <valid label in PR review process>add this label when versioning review is required labels Apr 2, 2024

johanste added the Versioning-Approved-BugFix https://github.com/Azure/azure-sdk-tools/issues/6374 label Apr 2, 2024

richardpark-msft enabled auto-merge (squash) April 2, 2024 18:27

Merge branch 'main' into api-ai-add-model

1236daa

johanste approved these changes Apr 2, 2024

View reviewed changes

kristapratico approved these changes Apr 2, 2024

View reviewed changes

richardpark-msft merged commit 2a96c42 into Azure:main Apr 2, 2024
29 of 32 checks passed

richardpark-msft deleted the api-ai-add-model branch April 2, 2024 21:24

This was referenced Apr 10, 2024

[SDK Automation - JS] Build error reported without clear output Azure/azure-sdk-tools#8058

Closed

[SDK Automation - .NET] Test code build failure should not impact the API view generation Azure/azure-sdk-tools#8059

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adding 'model' property to ChatCompletions. #28554

Adding 'model' property to ChatCompletions. #28554

richardpark-msft commented Apr 2, 2024

openapi-pipeline-app bot commented Apr 2, 2024 •

edited

Loading

openapi-pipeline-app bot commented Apr 2, 2024 •

edited

Loading

openapi-pipeline-app bot commented Apr 2, 2024 •

edited

Loading

openapi-pipeline-app bot commented Apr 2, 2024 •

edited

Loading

mario-guerra commented Apr 2, 2024

richardpark-msft commented Apr 2, 2024

Adding 'model' property to ChatCompletions. #28554

Adding 'model' property to ChatCompletions. #28554

Conversation

richardpark-msft commented Apr 2, 2024

openapi-pipeline-app bot commented Apr 2, 2024 • edited Loading

Next Steps to Merge

openapi-pipeline-app bot commented Apr 2, 2024 • edited Loading

Swagger Validation Report

openapi-pipeline-app bot commented Apr 2, 2024 • edited Loading

Swagger Generation Artifacts

openapi-pipeline-app bot commented Apr 2, 2024 • edited Loading

Generated ApiView

mario-guerra commented Apr 2, 2024

richardpark-msft commented Apr 2, 2024

openapi-pipeline-app bot commented Apr 2, 2024 •

edited

Loading

openapi-pipeline-app bot commented Apr 2, 2024 •

edited

Loading

openapi-pipeline-app bot commented Apr 2, 2024 •

edited

Loading

openapi-pipeline-app bot commented Apr 2, 2024 •

edited

Loading