Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[OpenAI] Added missing GA service versions, 2024-02-01 and 2024-06-01 #29424

Merged
merged 19 commits into from
Jul 17, 2024

Conversation

mssfang
Copy link
Member

@mssfang mssfang commented Jun 13, 2024

We have announced a GA release version, 2024-02-01, but it is not supported in the latest TypeSpec 's service version list.

We have this GA version in the repo.
https://github.com/Azure/azure-rest-api-specs/tree/main/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-02-01

Updates (2024/07/10):
We just have 2024-06-01 Service API version supported recently. This PR will add it to the Service API version list as well.

@mssfang mssfang self-assigned this Jun 13, 2024
@mssfang mssfang requested a review from yangyuan as a code owner June 13, 2024 04:25
Copy link

openapi-pipeline-app bot commented Jun 13, 2024

Next Steps to Merge

Next steps that must be taken to merge this PR:
  • ❌ This is public specs repo main branch which not intended for iterative development.
    You must acknowledge that you understand that after this PR is merged, you won't be able to stop your changes from being published to Azure customers.
    If this is what you intend, add PublishToCustomers label to your PR.
    Otherwise, retarget this PR onto a feature branch, i.e. with prefix release- (see aka.ms/azsdk/api-versions#release--branches).
  • ❌ This PR has at least one change violating Azure versioning policy (label: VersioningReviewRequired).
    To unblock this PR, either a) introduce a new API version with these changes instead of modifying an existing API version, or b) follow the process at aka.ms/brch.
  • ❌ The required check named TypeSpec Validation has failed. Refer to the check in the PR's 'Checks' tab for details on how to fix it and consult the aka.ms/ci-fix guide

Copy link

openapi-pipeline-app bot commented Jun 13, 2024

Swagger Validation Report

️❌BreakingChange: 14 Errors, 0 Warnings failed [Detail]
Compared specs (v0.10.12) new version base version
generated.json 2024-02-01(98cb3b3) 2024-02-01(main)
generated.json 2024-06-01(98cb3b3) 2024-06-01(main)
Rule Message
1038 - AddedPath The new version is adding a path that was not found in the old version.
New: inference/stable/2024-02-01/generated.json#L62:5
1038 - AddedPath The new version is adding a path that was not found in the old version.
New: inference/stable/2024-02-01/generated.json#L114:5
1038 - AddedPath The new version is adding a path that was not found in the old version.
New: inference/stable/2024-02-01/generated.json#L166:5
1038 - AddedPath The new version is adding a path that was not found in the old version.
New: inference/stable/2024-02-01/generated.json#L218:5
1038 - AddedPath The new version is adding a path that was not found in the old version.
New: inference/stable/2024-02-01/generated.json#L271:5
1038 - AddedPath The new version is adding a path that was not found in the old version.
New: inference/stable/2024-06-01/generated.json#L62:5
1038 - AddedPath The new version is adding a path that was not found in the old version.
New: inference/stable/2024-06-01/generated.json#L118:5
1038 - AddedPath The new version is adding a path that was not found in the old version.
New: inference/stable/2024-06-01/generated.json#L291:5
1038 - AddedPath The new version is adding a path that was not found in the old version.
New: inference/stable/2024-06-01/generated.json#L423:5
1038 - AddedPath The new version is adding a path that was not found in the old version.
New: inference/stable/2024-06-01/generated.json#L496:5
1038 - AddedPath The new version is adding a path that was not found in the old version.
New: inference/stable/2024-06-01/generated.json#L548:5
1038 - AddedPath The new version is adding a path that was not found in the old version.
New: inference/stable/2024-06-01/generated.json#L600:5
1038 - AddedPath The new version is adding a path that was not found in the old version.
New: inference/stable/2024-06-01/generated.json#L654:5
1038 - AddedPath The new version is adding a path that was not found in the old version.
New: inference/stable/2024-06-01/generated.json#L823:5
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️❌LintDiff: 8 Errors, 80 Warnings failed [Detail]
Compared specs (v2.2.2) new version base version
release_2024_02_01 release_2024_02_01(98cb3b3) default(main)
release_2024_02_01_autogen release_2024_02_01_autogen(98cb3b3) default(main)
release_2024_06_01_autogen release_2024_06_01_autogen(98cb3b3) default(main)

[must fix]The following errors/warnings are introduced by current PR:

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

Rule Message Related RPC [For API reviewers]
IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
Location: inference/stable/2024-02-01/generated.json#L427
IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
Location: inference/stable/2024-02-01/generated.json#L498
IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
Location: inference/stable/2024-02-01/generated.json#L850
DefaultInEnum Default value should appear in the enum constraint for a schema
Location: inference/stable/2024-02-01/generated.json#L1390
IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
Location: inference/stable/2024-02-01/generated.json#L1454
IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
Location: inference/stable/2024-06-01/generated.json#L2345
IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
Location: inference/stable/2024-06-01/generated.json#L2988
IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
Location: inference/stable/2024-06-01/generated.json#L4066
⚠️ SecurityDefinitionDescription Security definition should have a description.
Location: inference/stable/2024-02-01/generated.json#L46
⚠️ SecurityDefinitionDescription Security definition should have a description.
Location: inference/stable/2024-02-01/generated.json#L51
⚠️ OperationId OperationId should be of the form 'Noun_Verb'
Location: inference/stable/2024-02-01/generated.json#L64
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: inference/stable/2024-02-01/generated.json#L70
⚠️ OperationId OperationId should be of the form 'Noun_Verb'
Location: inference/stable/2024-02-01/generated.json#L116
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: inference/stable/2024-02-01/generated.json#L122
⚠️ PaginationResponse Operation might be pageable. Consider adding the x-ms-pageable extension.
Location: inference/stable/2024-02-01/generated.json#L167
⚠️ OperationId OperationId should be of the form 'Noun_Verb'
Location: inference/stable/2024-02-01/generated.json#L168
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: inference/stable/2024-02-01/generated.json#L174
⚠️ LongRunningOperationsOptionsValidator A LRO Post operation with return schema must have 'x-ms-long-running-operation-options' extension enabled.
Location: inference/stable/2024-02-01/generated.json#L218
RPC-Async-V1-05
⚠️ OperationId OperationId should be of the form 'Noun_Verb'
Location: inference/stable/2024-02-01/generated.json#L220
⚠️ OperationId OperationId should be of the form 'Noun_Verb'
Location: inference/stable/2024-02-01/generated.json#L273
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: inference/stable/2024-02-01/generated.json#L279
⚠️ PropertyType Property should have a defined type.
Location: inference/stable/2024-02-01/generated.json#L556
⚠️ 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/stable/2024-02-01/generated.json#L614
⚠️ PropertyType Property should have a defined type.
Location: inference/stable/2024-02-01/generated.json#L722
⚠️ 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/stable/2024-02-01/generated.json#L1027
⚠️ 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/stable/2024-02-01/generated.json#L1056
⚠️ 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/stable/2024-02-01/generated.json#L1102
⚠️ PropertyType Property should have a defined type.
Location: inference/stable/2024-02-01/generated.json#L1348
⚠️ SecurityDefinitionDescription Security definition should have a description.
Location: inference/stable/2024-06-01/generated.json#L46
⚠️ SecurityDefinitionDescription Security definition should have a description.
Location: inference/stable/2024-06-01/generated.json#L51
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️️✔️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: 14 Errors, 0 Warnings failed [Detail]
Rule Message
HowToFix Unknown word (flac), please fix the error. See https://aka.ms/ci-fix#spell-check
path: inference/stable/2024-06-01/generated.json#L143:142
HowToFix Unknown word (mpga), please fix the error. See https://aka.ms/ci-fix#spell-check
path: inference/stable/2024-06-01/generated.json#L143:164
HowToFix Unknown word (flac), please fix the error. See https://aka.ms/ci-fix#spell-check
path: inference/stable/2024-06-01/generated.json#L316:141
HowToFix Unknown word (mpga), please fix the error. See https://aka.ms/ci-fix#spell-check
path: inference/stable/2024-06-01/generated.json#L316:163
HowToFix Unknown word (flac), please fix the error. See https://aka.ms/ci-fix#spell-check
path: inference/stable/2024-06-01/generated.json#L675:142
HowToFix Unknown word (mpga), please fix the error. See https://aka.ms/ci-fix#spell-check
path: inference/stable/2024-06-01/generated.json#L675:164
HowToFix Unknown word (flac), please fix the error. See https://aka.ms/ci-fix#spell-check
path: inference/stable/2024-06-01/generated.json#L844:141
HowToFix Unknown word (mpga), please fix the error. See https://aka.ms/ci-fix#spell-check
path: inference/stable/2024-06-01/generated.json#L844:163
HowToFix Unknown word (rerank), please fix the error. See https://aka.ms/ci-fix#spell-check
path: inference/stable/2024-06-01/generated.json#L1550:10
HowToFix Unknown word (rerank), please fix the error. See https://aka.ms/ci-fix#spell-check
path: inference/stable/2024-06-01/generated.json#L1562:22
HowToFix Unknown word (rerank), please fix the error. See https://aka.ms/ci-fix#spell-check
path: inference/stable/2024-06-01/generated.json#L1563:23
HowToFix Unknown word (rerank), please fix the error. See https://aka.ms/ci-fix#spell-check
path: inference/stable/2024-06-01/generated.json#L1564:113
HowToFix Unknown word (FLAC), please fix the error. See https://aka.ms/ci-fix#spell-check
path: inference/stable/2024-06-01/generated.json#L4699:37
HowToFix Unknown word (FLAC), please fix the error. See https://aka.ms/ci-fix#spell-check
path: inference/stable/2024-06-01/generated.json#L4699:70
️️✔️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?

Copy link

openapi-pipeline-app bot commented Jun 13, 2024

Swagger Generation Artifacts

️️✔️ApiDocPreview succeeded [Detail] [Expand]
 Please click here to preview with your @microsoft account. 
️❌ azure-sdk-for-net-track2 failed [Detail]
    For more instructions, please refer to the FAQ .
  • Failed in generating from 3c2c34f. 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		Warning: azure-sdk-for-net-track2 cannot be found in specification/cognitiveservices/data-plane/AzureOpenAI/inference/readme.md. This SDK will be skipped from SDK generation. Please add the right config to the readme file according to this guidance https://github.com/Azure/azure-rest-api-specs/blob/main/documentation/code-gen/configure-go-sdk.md#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] [Warn]: Enum 'ServiceApiVersions' must have a description
    cmderr	[Invoke-GenerateAndBuildV2.ps1] npm notice
    cmderr	[Invoke-GenerateAndBuildV2.ps1] npm notice New minor version of npm available! 10.7.0 -> 10.8.2
    cmderr	[Invoke-GenerateAndBuildV2.ps1] npm notice Changelog: https://github.com/npm/cli/releases/tag/v10.8.2
    cmderr	[Invoke-GenerateAndBuildV2.ps1] npm notice To update run: npm install -g npm@10.8.2
    cmderr	[Invoke-GenerateAndBuildV2.ps1] npm notice
    cmderr	[Invoke-GenerateAndBuildV2.ps1] GeneratePackage: /mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/Invoke-GenerateAndBuildV2.ps1:144
    cmderr	[Invoke-GenerateAndBuildV2.ps1] Line |
    cmderr	[Invoke-GenerateAndBuildV2.ps1]  144 |              GeneratePackage `
    cmderr	[Invoke-GenerateAndBuildV2.ps1]      |              ~~~~~~~~~~~~~~~~~
    cmderr	[Invoke-GenerateAndBuildV2.ps1]      | Failed to build project. exit code: False
  • Azure.AI.OpenAI [Preview SDK Changes]
    info	[Changelog]
️️✔️ azure-sdk-for-java succeeded [Detail] [Expand]
    For more instructions, please refer to the FAQ .
  • ️✔️Succeeded in generating from 3c2c34f. SDK Automation 14.0.0
    command	./eng/automation/init.sh ../azure-sdk-for-java_tmp/initInput.json ../azure-sdk-for-java_tmp/initOutput.json
    warn		Warning: azure-sdk-for-java cannot be found in specification/cognitiveservices/data-plane/AzureOpenAI/inference/readme.md. This SDK will be skipped from SDK generation. Please add the right config to the readme file according to this guidance https://github.com/Azure/azure-rest-api-specs/blob/main/documentation/code-gen/configure-go-sdk.md#swagger-to-sdk.
    command	./eng/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
    command	./eng/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
    info	[Changelog]
    command	./eng/automation/install_instruction.py ../azure-sdk-for-java_tmp/installInstructionInput.json ../azure-sdk-for-java_tmp/installInstructionOutput.json
  • ️✔️azure-ai-openai [Preview SDK Changes]
    info	[Changelog]
️❌ azure-sdk-for-js failed [Detail]
    For more instructions, please refer to the FAQ .
  • Failed in generating from 3c2c34f. 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	Warning: File azure-sdk-for-js_tmp/initOutput.json not found to read. Please re-run the pipeline if the error is transitient error or report this issue through https://aka.ms/azsdk/support/specreview-channel.
    warn		Warning: azure-sdk-for-js cannot be found in specification/cognitiveservices/data-plane/AzureOpenAI/inference/readme.md. This SDK will be skipped from SDK generation. Please add the right config to the readme file according to this guidance https://github.com/Azure/azure-rest-api-specs/blob/main/documentation/code-gen/configure-go-sdk.md#swagger-to-sdk.
    command	sh .scripts/automation_generate.sh ../azure-sdk-for-js_tmp/generateInput.json ../azure-sdk-for-js_tmp/generateOutput.json
    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] Error:
    cmderr	[automation_generate.sh] [ERROR] An error occurred while run build for typespec project: "specification/cognitiveservices/OpenAI.Inference":
    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] Err: Error: Command failed: rush build -t @azure/openai
    cmderr	[automation_generate.sh] [ERROR] Stderr: "null"
    cmderr	[automation_generate.sh] [ERROR] Stderr: "null"
    cmderr	[automation_generate.sh] [ERROR] Stdout: "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] 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 checkExecSyncError (node:child_process:885:11)
    cmderr	[automation_generate.sh] [ERROR]     at execSync (node:child_process:957:15)
    cmderr	[automation_generate.sh] [ERROR]     at execSync (node:child_process:957:15)
    cmderr	[automation_generate.sh] [ERROR]     at /home/cloudtest/.nvm/versions/node/v18.15.0/lib/node_modules/@azure-tools/js-sdk-release-tools/dist/llc/generateRLCInPipeline/generateRLCInPipeline.js:209:42
    cmderr	[automation_generate.sh] [ERROR]     at /home/cloudtest/.nvm/versions/node/v18.15.0/lib/node_modules/@azure-tools/js-sdk-release-tools/dist/llc/generateRLCInPipeline/generateRLCInPipeline.js:209:42
    cmderr	[automation_generate.sh] [ERROR]     at Generator.next (<anonymous>)
    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 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)"
    cmderr	[automation_generate.sh] [ERROR]     at process.processTicksAndRejections (node:internal/process/task_queues:95:5)"
    info	[Changelog]
    error	breakingChangeTracking is enabled, but version or changelogItem is not found in output.
  • @azure/openai [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?

@AzureRestAPISpecReview AzureRestAPISpecReview removed the VersioningReviewRequired <valid label in PR review process>add this label when versioning review is required label Jul 10, 2024
@mssfang mssfang requested a review from trrwilson July 10, 2024 17:33
@mssfang mssfang changed the title [OpenAI] Added a missing GA service version [OpenAI] Added missing GA service versions, 2024-02-01 and 2024-06-01 Jul 10, 2024
@AzureRestAPISpecReview AzureRestAPISpecReview added the VersioningReviewRequired <valid label in PR review process>add this label when versioning review is required label Jul 11, 2024
@lmazuel lmazuel merged commit 46de0ae into main Jul 17, 2024
24 of 31 checks passed
@lmazuel lmazuel deleted the OpenAI-2024-02-01 branch July 17, 2024 17:41
@timotheeguerin
Copy link
Member

This pr was merged with typespec build failing…

zaowang-ms pushed a commit to zaowang-ms/azure-rest-api-specs-public that referenced this pull request Jul 22, 2024
…Azure#29424)

* added a missing GA service version

* add the generated.json 2024-02-01 but looks different to inference.json

* add the 2024-06-01 service API version

* remove self introudced new generated.json from 2024-02-01

* added operation id

* Update specification/ai/Face/tspconfig.yaml

* Ran npx tsv command

* copied from previous examples

* added generated swagger version into readme

* fixed "Missing required property: deployment-id"

* run tsp compile

* generated.json with generated_ prefix json file.

* revert the data-plane changes for inference.json

* add generated.json updates

* suppress spellcheck failures

---------

Co-authored-by: Jose Alvarez <jp.alvarezl@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
data-plane OpenAI OpenAI service TypeSpec Authored with TypeSpec VersioningReviewRequired <valid label in PR review process>add this label when versioning review is required
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants