Upgrade Cadl file to 0.38 for OpenAI.Authoring service #22104
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Hi, @MaryGao Thanks for your PR. I am workflow bot for review process. Here are some small tips. Any feedback about review process or workflow bot, pls contact swagger and tools team. vscswagger@microsoft.com |
Swagger Validation Report
|
| Rule | Message |
|---|---|
|
Unknown word (apiview), please fix the error or add words to ./custom-words.txt path: specification/cognitiveservices/OpenAI.Authoring/package-lock.json#L10:28 |
|
Unknown word (apiview), please fix the error or add words to ./custom-words.txt path: specification/cognitiveservices/OpenAI.Authoring/package-lock.json#L20:37 |
|
Unknown word (globby), please fix the error or add words to ./custom-words.txt path: specification/cognitiveservices/OpenAI.Authoring/package-lock.json#L98:10 |
|
Unknown word (picocolors), please fix the error or add words to ./custom-words.txt path: specification/cognitiveservices/OpenAI.Authoring/package-lock.json#L104:10 |
|
Unknown word (nodelib), please fix the error or add words to ./custom-words.txt path: specification/cognitiveservices/OpenAI.Authoring/package-lock.json#L201:20 |
|
Unknown word (scandir), please fix the error or add words to ./custom-words.txt path: specification/cognitiveservices/OpenAI.Authoring/package-lock.json#L201:31 |
|
Unknown word (nodelib), please fix the error or add words to ./custom-words.txt path: specification/cognitiveservices/OpenAI.Authoring/package-lock.json#L206:11 |
|
Unknown word (nodelib), please fix the error or add words to ./custom-words.txt path: specification/cognitiveservices/OpenAI.Authoring/package-lock.json#L213:20 |
|
Unknown word (nodelib), please fix the error or add words to ./custom-words.txt path: specification/cognitiveservices/OpenAI.Authoring/package-lock.json#L221:20 |
|
Unknown word (scandir), please fix the error or add words to ./custom-words.txt path: specification/cognitiveservices/OpenAI.Authoring/package-lock.json#L226:22 |
|
Unknown word (fastq), please fix the error or add words to ./custom-words.txt path: specification/cognitiveservices/OpenAI.Authoring/package-lock.json#L227:10 |
|
Unknown word (cliui), please fix the error or add words to ./custom-words.txt path: specification/cognitiveservices/OpenAI.Authoring/package-lock.json#L334:19 |
|
Unknown word (fastq), please fix the error or add words to ./custom-words.txt path: specification/cognitiveservices/OpenAI.Authoring/package-lock.json#L439:19 |
|
Unknown word (reusify), please fix the error or add words to ./custom-words.txt path: specification/cognitiveservices/OpenAI.Authoring/package-lock.json#L444:10 |
|
Unknown word (domexception), please fix the error or add words to ./custom-words.txt path: specification/cognitiveservices/OpenAI.Authoring/package-lock.json#L462:15 |
|
Unknown word (formdata), please fix the error or add words to ./custom-words.txt path: specification/cognitiveservices/OpenAI.Authoring/package-lock.json#L480:19 |
|
Unknown word (globby), please fix the error or add words to ./custom-words.txt path: specification/cognitiveservices/OpenAI.Authoring/package-lock.json#L510:19 |
|
Unknown word (extglob), please fix the error or add words to ./custom-words.txt path: specification/cognitiveservices/OpenAI.Authoring/package-lock.json#L553:22 |
|
Unknown word (extglob), please fix the error or add words to ./custom-words.txt path: specification/cognitiveservices/OpenAI.Authoring/package-lock.json#L574:13 |
|
Unknown word (kleur), please fix the error or add words to ./custom-words.txt path: specification/cognitiveservices/OpenAI.Authoring/package-lock.json#L609:19 |
|
Unknown word (picomatch), please fix the error or add words to ./custom-words.txt path: specification/cognitiveservices/OpenAI.Authoring/package-lock.json#L639:10 |
|
Unknown word (domexception), please fix the error or add words to ./custom-words.txt path: specification/cognitiveservices/OpenAI.Authoring/package-lock.json#L673:24 |
|
Unknown word (formdata), please fix the error or add words to ./custom-words.txt path: specification/cognitiveservices/OpenAI.Authoring/package-lock.json#L698:10 |
|
Unknown word (opencollective), please fix the error or add words to ./custom-words.txt path: specification/cognitiveservices/OpenAI.Authoring/package-lock.json#L704:18 |
|
Unknown word (picocolors), please fix the error or add words to ./custom-words.txt path: specification/cognitiveservices/OpenAI.Authoring/package-lock.json#L751:19 |
|
Unknown word (picomatch), please fix the error or add words to ./custom-words.txt path: specification/cognitiveservices/OpenAI.Authoring/package-lock.json#L756:19 |
|
Unknown word (kleur), please fix the error or add words to ./custom-words.txt path: specification/cognitiveservices/OpenAI.Authoring/package-lock.json#L786:10 |
|
Unknown word (sisteransi), please fix the error or add words to ./custom-words.txt path: specification/cognitiveservices/OpenAI.Authoring/package-lock.json#L787:10 |
|
Unknown word (reusify), please fix the error or add words to ./custom-words.txt path: specification/cognitiveservices/OpenAI.Authoring/package-lock.json#L836:19 |
|
Unknown word (iojs), please fix the error or add words to ./custom-words.txt path: specification/cognitiveservices/OpenAI.Authoring/package-lock.json#L841:10 |
️❌CadlValidation: 4 Errors, 46 Warnings failed [Detail]
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
"details":"The 'examples' directory is missing in the cadl folder specification/cognitiveservices/OpenAI.Authoring, please ensure the 'examples' is added in the PR." |
|
"details":"The generated swagger file 2022-06-01-preview/openapi.json from cadl specification/cognitiveservices/OpenAI.Authoring is not the same as the '/mnt/vss/_work/1/azure-rest-api-specs/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2022-06-01-preview/azureopenai.json' in PR, please make sure the swagger is consistent with the generated swagger. You can find the difference in the pipeline log." |
|
"details":"The 'examples' directory is missing in the cadl folder specification/cognitiveservices/OpenAI.Inference, please ensure the 'examples' is added in the PR." |
|
"details":"The generated swagger file 2022-06-01-preview/openapi.json from cadl specification/cognitiveservices/OpenAI.Inference is not the same as the '/mnt/vss/_work/1/azure-rest-api-specs/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2022-06-01-preview/azureopenai.json' in PR, please make sure the swagger is consistent with the generated swagger. You can find the difference in the pipeline log." |
| The names of Property types must use camelCase Location: cognitiveservices/OpenAI.Authoring/models/model.models.cadl#L58 |
|
| The names of Property types must use camelCase Location: cognitiveservices/OpenAI.Authoring/models/model.models.cadl#L88 |
|
| The names of Property types must use camelCase Location: cognitiveservices/OpenAI.Authoring/models/finetune.models.cadl#L25 |
|
| The names of Property types must use camelCase Location: cognitiveservices/OpenAI.Authoring/models/finetune.models.cadl#L46 |
|
| The names of Property types must use camelCase Location: cognitiveservices/OpenAI.Authoring/models/file.models.cadl#L27 |
|
| The names of Property types must use camelCase Location: cognitiveservices/OpenAI.Authoring/models/finetune.models.cadl#L52 |
|
| The names of Property types must use camelCase Location: cognitiveservices/OpenAI.Authoring/models/finetune.models.cadl#L67 |
|
| The names of Property types must use camelCase Location: cognitiveservices/OpenAI.Authoring/models/finetune.models.cadl#L109 |
|
| The names of Property types must use camelCase Location: cognitiveservices/OpenAI.Authoring/models/finetune.models.cadl#L131 |
|
| The names of Property types must use camelCase Location: cognitiveservices/OpenAI.Authoring/models/finetune.models.cadl#L149 |
|
| The names of Property types must use camelCase Location: cognitiveservices/OpenAI.Authoring/models/finetune.models.cadl#L170 |
|
| The names of Property types must use camelCase Location: cognitiveservices/OpenAI.Authoring/models/model.models.cadl#L21 |
|
| The names of Property types must use camelCase Location: cognitiveservices/OpenAI.Authoring/models/model.models.cadl#L38 |
|
Azure services should not use the @format decorator.Location: specification/cognitiveservices/OpenAI.Authoring/common.cadl#L82 |
|
| The names of Property types must use camelCase Location: cognitiveservices/OpenAI.Authoring/models/deployment.models.cadl#L26 |
|
| The names of Property types must use camelCase Location: cognitiveservices/OpenAI.Authoring/models/file.models.cadl#L74 |
|
| The names of Property types must use camelCase Location: cognitiveservices/OpenAI.Authoring/models/finetune.models.cadl#L199 |
|
| The names of Property types must use camelCase Location: cognitiveservices/OpenAI.Authoring/models/model.models.cadl#L111 |
|
| The names of Property types must use camelCase Location: cognitiveservices/OpenAI.Authoring/models/deployment.models.cadl#L45 |
|
| The names of Property types must use camelCase Location: cognitiveservices/OpenAI.Authoring/models/file.models.cadl#L27 |
|
| The names of Property types must use camelCase Location: cognitiveservices/OpenAI.Authoring/models/finetune.models.cadl#L196 |
|
| The names of Property types must use camelCase Location: cognitiveservices/OpenAI.Authoring/models/finetune.models.cadl#L21 |
|
| The names of Property types must use camelCase Location: cognitiveservices/OpenAI.Authoring/models/finetune.models.cadl#L37 |
|
| The names of Property types must use camelCase Location: cognitiveservices/OpenAI.Authoring/models/finetune.models.cadl#L49 |
|
| The names of Property types must use camelCase Location: cognitiveservices/OpenAI.Authoring/models/finetune.models.cadl#L67 |
|
Azure services should not use the @format decorator.Location: specification/cognitiveservices/OpenAI.Authoring/common.cadl#L82 |
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
ghost
added
the
Swagger Generation Artifacts
|
| Rule | Message |
|---|---|
|
"logUrl":"https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=340053&view=logs&j=fd490c07-0b22-5182-fac9-6d67fe1e939b", "detail":"Run.ps1 failed with exit code 1 " |
️️✔️SDK Breaking Change Tracking succeeded [Detail] [Expand]
Breaking Changes Tracking
|
Swagger pipeline started successfully. If there is ApiView generated, it will be updated in this comment. |
weidongxu-microsoft
approved these changes
Jan 10, 2023
haolingdong-msft
approved these changes
Jan 10, 2023
glharper
approved these changes
Jan 10, 2023
lmazuel
added a commit
that referenced
this pull request
Feb 3, 2023
* Initial commit. * Commit OpenAI inference cadl files. * use non-deprecated service decorator * Fixes to main * Reverted changes * use latest cadl to sync with vs code properly * cadl compilation works for authoring (but it is correct?) * Cleaned up routes and model for Inference REST CADL spec * Added cadl-output to .gitignore file and removed error response * Implemented polymorphic return for endpoint * enable Files_Import as non-standard operation, use standard operation names * Authoring CADL now emits openAPI schema almost identical to current Authoring schema * Empty model used for polymorphic expectation in embedding endpoint * Renamed models to match convention * Renamed completions related models * Adjusted comment for embeddings body types * Split up models.cadl into completions and embeddings files * Renamed models * Refactored model names * Removed redundants bits of model names * added headers * Added header to correct model * break up monolithic routes and model cadl files * add namespace to all models * Removed gitIgnore file and changed files to not have domain related namespaces * Finished embeddings endpoint and verified against source json * Verified round trip for swagger * Almost done with security types * Configured correctly OAth2 * Add Auth and OAuth2 to service (thanks Jose!) * Add auth and OAuth to openapi json * Review comments * Review comments * camel casing * add versionedDependency * better versioning * Added the apiview emitter to OpenAI.Inference endpoints * PR feedback for Inference endpoints * Feature/cognitiveservices/openai cadl (#21574) * Added openai specific list API op template. * Simplified OAI authoring cadl * update package versions, correct camelCase warning in common * remove commented out models, changed AcceptedResponse to CreatedResponse * Reverted completion to use snake_casing and removed the Response and Request namespaces * reverted to snake_casing and removed Request namespace for embeddings * Added missing namespace declaration in embeddings * Updated dependencies and enabled csharp emitter for Inference * use string literals for now as enum value types (TypeDiscriminatorKnownValues) not supported in csharp emitter * Add TODO to TypeDiscriminatorKnownValues def * More specific route operation names, use snake casing for all model fields * Added more options to csharp emitter * Simplify OpenAI inferrence models and use core (#21609) * Simplify OpenAI inferrence models and use core * Simplified and corrected Cadl type usage for OpenAI.Inference * Fix camel case issues. Co-authored-by: tjprescott <trpresco@microsoft.com> * Upgrade Cadl file to 0.38 for OpenAI.Authoring service (#22104) * Upgrade Cadl file to 0.38 * Upgrade the package.json file and relevant cadl decorator * Embedding in Azure do not support integer (#22091) * Fix auth in OpenAI CADL (#22191) * Change aliases to models, renamed model Embedding to EmbeddingItem to avoid conflicts, and Completion types * Changed prompt into string[][] * update package name (#22312) * Archboard feedback (#22315) * Archboard feedback * Disable stream for now * Rename to options * Fix operation name (#22319) * Feature/openai add missing usage (#22337) * add new API version and usage field on completions and embeddings * typo * Added docs for Usage classes in completions and embeddings * Added versioning mark for new usage model * Added disambiguation for names and removed unnecessary versioning decorator * Removed unused version bump * Removed unused version from enum * Removed wrong annotation --------- Co-authored-by: Jose Alvarez <josealvar@microsoft.com> * Update main.cadl (#22362) * Embeddings model and field documentation and fix to models (#22368) * Moved usage to the response object of embeddings and added some basic documentation to models and fields * Fixed typo * Update specification/cognitiveservices/OpenAI.Inference/models/embeddings.create.cadl --------- Co-authored-by: Laurent Mazuel <laurent.mazuel@gmail.com> * Removing Model from model name and removing unnecessary aliases (#22390) * updated deps and added visibility decorator to deploymentId (#22417) * Made CompletionsOptions.model optional again * Removing ...Models namespace in the C# classes (#22449) * AOAI: fix CompletionsUsage model (#22439) --------- Co-authored-by: tjprescott <trpresco@microsoft.com> Co-authored-by: Glenn Harper <glharper@microsoft.com> Co-authored-by: Jose Alvarez <josealvar@microsoft.com> Co-authored-by: Glenn Harper <64209257+glharper@users.noreply.github.com> Co-authored-by: Johan Stenberg (MSFT) <johan.stenberg@microsoft.com> Co-authored-by: Mary Gao <yanmeigao1210@gmail.com> Co-authored-by: m-nash <64171366+m-nash@users.noreply.github.com> Co-authored-by: Jose Alvarez <jpalvarezl@users.noreply.github.com> Co-authored-by: Travis Wilson <35748617+trrwilson@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Currently the service is still in 0.37 version so I init this pr tp upgrade Cadl file to 0.38. Mainly do following two things:
npx @cadl-lang/migrateto automatically migrate previous usagesAlso I update the relevant dependencies.