Azure AI Vision - Image Analysis TypeSpec files #26146

dargilco · 2023-10-09T22:40:10Z

Data Plane API - Pull Request

We are creating new auto-generated SDKs for Image Analysis REST APIs 4.0, currently in public preview (link to REST spec and public docs). This is the first draft PR for checking in the relevant TypeSpec files. I will publish the PR after addressing any errors/warnings.

API Info: The Basics

Most of the information about your service should be captured in the issue that serves as your API Spec engagement record.

Link to API Spec engagement record issue: I will provide the link once I have one.

Is this review for (select one):

a private preview
a public preview
GA release

Change Scope

^{This section will help us focus on the specific parts of your API that are new or have been modified.
Please share a link to the design document for the new APIs, a link to the previous API Spec document (if applicable), and the root paths that have been updated.}

Design Document: We don't have on.
Previous API Spec Doc: None.
Updated paths: This is a new SDK. All new TypeSpec files.

Viewing API changes

For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the Generated ApiView comment added to this PR. You can use ApiView to show API versions diff.

Suppressing failures

If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the
Swagger-Suppression-Process to get approval.

❔Got questions? Need additional info?? We are here to help!

Contact us!

The Azure API Review Board is dedicated to helping you create amazing APIs. You can read about our mission and learn more about our process on our wiki.

💬 Teams Channel
💌 email

Click here for links to tools, specs, guidelines & other good stuff

Tooling

Open API validation tools were run on this PR. Go here to see how to fix errors
Spectral Linting
Open API Hub

Guidelines & Specifications

Helpful Links

Azure DevTools Wiki

openapi-pipeline-app · 2023-10-09T22:40:13Z

Next Steps to Merge

✔️ All automated merging requirements have been met! Refer to step 4 in the PR workflow diagram (even if your PR is for data plane, not ARM).

openapi-pipeline-app · 2023-10-09T22:40:14Z

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]

There are no breaking changes.

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

There are no breaking changes.

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

There is no credential detected.

️⚠️LintDiff: 11 Warnings warning [Detail]

compared tags (via openapi-validator v2.1.6)	new version	base version
package-2023-10-01	package-2023-10-01(bb44cbd)	default(main)
default	default(bb44cbd)	default(main)

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

Rule	Message	Related RPC [For API reviewers]
⚠️ SecurityDefinitionDescription	Security definition should have a description. Location: ImageAnalysis/stable/2023-10-01/generated.json#L42
⚠️ OperationId	OperationId should be of the form 'Noun_Verb' Location: ImageAnalysis/stable/2023-10-01/generated.json#L52
⚠️ 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: ImageAnalysis/stable/2023-10-01/generated.json#L133
⚠️ ParameterNamesConvention	Parameter name 'gender-neutral-caption' should be camel case. Location: ImageAnalysis/stable/2023-10-01/generated.json#L134
⚠️ ParameterNamesConvention	Parameter name 'smartcrops-aspect-ratios' should be camel case. Location: ImageAnalysis/stable/2023-10-01/generated.json#L143
⚠️ ParameterNamesConvention	Parameter name 'model-version' should be camel case. Location: ImageAnalysis/stable/2023-10-01/generated.json#L156
⚠️ MsPaths	Don't use x-ms-paths except where necessary to support legacy APIs. Location: ImageAnalysis/stable/2023-10-01/generated.json#L206
⚠️ 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: ImageAnalysis/stable/2023-10-01/generated.json#L287
⚠️ SchemaNamesConvention	Schema name should be Pascal case. Location: ImageAnalysis/stable/2023-10-01/generated.json#L360
⚠️ SchemaNamesConvention	Schema name should be Pascal case. Location: ImageAnalysis/stable/2023-10-01/generated.json#L394
⚠️ SchemaNamesConvention	Schema name should be Pascal case. Location: ImageAnalysis/stable/2023-10-01/generated.json#L407

️️✔️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 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 · 2023-10-09T22:40:15Z

Swagger Generation Artifacts

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

 Please click here to preview with your @microsoft account.

️️✔️SDK Breaking Change Tracking succeeded [Detail] [Expand]

Breaking Changes Tracking

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

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

command	sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json
cmderr	[automation_init.sh] WARNING: azure-devtools 1.2.1 does not provide the extra 'ci-tools'
cmderr	[automation_init.sh] WARNING: azure-devtools 1.2.1 does not provide the extra 'ci-tools'
cmderr	[automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed.
warn		specification/ai/readme.md skipped due to azure-sdk-for-python not found in swagger-to-sdk
warn		specification/ai/data-plane/ImageAnalysis/readme.md skipped due to azure-sdk-for-python not found in swagger-to-sdk
command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
cmderr	[automation_generate.sh] npm notice
cmderr	[automation_generate.sh] npm notice New patch version of npm available! 10.2.3 -> 10.2.5
cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.2.5>
cmderr	[automation_generate.sh] npm notice Run `npm install -g npm@10.2.5` to update!
cmderr	[automation_generate.sh] npm notice

️✔️azure-ai-vision-imageanalysis [View full logs] [Preview SDK Changes]
- azure-ai-vision-imageanalysis-1.0.0b1.zip
- azure_ai_vision_imageanalysis-1.0.0b1-py3-none-any.whl
```
info	[Changelog] data-plan skip changelog generation temporarily
```

️⚠️ azure-sdk-for-net-track2 warning [Detail]

⚠️Warning [Logs] Generate from a504270eb280dd5f8452dbd22b6a2e508ffc8618. 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/ai/readme.md skipped due to azure-sdk-for-net-track2 not found in swagger-to-sdk
warn		specification/ai/data-plane/ImageAnalysis/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] WARN EBADENGINE Unsupported engine {
cmderr	[Invoke-GenerateAndBuildV2.ps1] npm WARN EBADENGINE   package: '@azure-tools/typespec-azure-core@0.36.0',
cmderr	[Invoke-GenerateAndBuildV2.ps1] npm WARN EBADENGINE   required: { node: '>=18.0.0' },
cmderr	[Invoke-GenerateAndBuildV2.ps1] npm WARN EBADENGINE   current: { node: 'v16.20.2', npm: '8.19.4' }
cmderr	[Invoke-GenerateAndBuildV2.ps1] npm WARN EBADENGINE }
cmderr	[Invoke-GenerateAndBuildV2.ps1] npm WARN EBADENGINE Unsupported engine {
cmderr	[Invoke-GenerateAndBuildV2.ps1] npm WARN EBADENGINE   package: '@azure-tools/typespec-client-generator-core@0.36.1',
cmderr	[Invoke-GenerateAndBuildV2.ps1] npm WARN EBADENGINE   required: { node: '>=18.0.0' },
cmderr	[Invoke-GenerateAndBuildV2.ps1] npm WARN EBADENGINE   current: { node: 'v16.20.2', npm: '8.19.4' }
cmderr	[Invoke-GenerateAndBuildV2.ps1] npm WARN EBADENGINE }
cmderr	[Invoke-GenerateAndBuildV2.ps1] EBADENGINE Unsupported engine {
cmderr	[Invoke-GenerateAndBuildV2.ps1] npm WARN EBADENGINE   package: '@typespec/compiler@0.50.0',
cmderr	[Invoke-GenerateAndBuildV2.ps1] npm WARN EBADENGINE   required: { node: '>=18.0.0' },
cmderr	[Invoke-GenerateAndBuildV2.ps1] npm WARN EBADENGINE   current: { node: 'v16.20.2', npm: '8.19.4' }
cmderr	[Invoke-GenerateAndBuildV2.ps1] npm WARN EBADENGINE }
cmderr	[Invoke-GenerateAndBuildV2.ps1] npm WARN EBADENGINE Unsupported engine {
cmderr	[Invoke-GenerateAndBuildV2.ps1] npm WARN EBADENGINE   package: '@typespec/http@0.50.0',
cmderr	[Invoke-GenerateAndBuildV2.ps1] npm WARN EBADENGINE   required: { node: '>=18.0.0' },
cmderr	[Invoke-GenerateAndBuildV2.ps1] npm WARN EBADENGINE   current: { node: 'v16.20.2', npm: '8.19.4' }
cmderr	[Invoke-GenerateAndBuildV2.ps1] npm WARN EBADENGINE }
cmderr	[Invoke-GenerateAndBuildV2.ps1] npm WARN EBADENGINE Unsupported engine {
cmderr	[Invoke-GenerateAndBuildV2.ps1] npm WARN EBADENGINE   package: '@typespec/rest@0.50.0',
cmderr	[Invoke-GenerateAndBuildV2.ps1] npm WARN EBADENGINE   required: { node: '>=18.0.0' },
cmderr	[Invoke-GenerateAndBuildV2.ps1] npm WARN EBADENGINE   current: { node: 'v16.20.2', npm: '8.19.4' }
cmderr	[Invoke-GenerateAndBuildV2.ps1] npm WARN EBADENGINE }
cmderr	[Invoke-GenerateAndBuildV2.ps1] npm WARN EBADENGINE Unsupported engine {
cmderr	[Invoke-GenerateAndBuildV2.ps1] npm WARN EBADENGINE   package: '@typespec/versioning@0.50.0',
cmderr	[Invoke-GenerateAndBuildV2.ps1] npm WARN EBADENGINE   required: { node: '>=18.0.0' },
cmderr	[Invoke-GenerateAndBuildV2.ps1] npm WARN EBADENGINE   current: { node: 'v16.20.2', npm: '8.19.4' }
cmderr	[Invoke-GenerateAndBuildV2.ps1] npm WARN EBADENGINE }
cmderr	[Invoke-GenerateAndBuildV2.ps1]
cmderr	[Invoke-GenerateAndBuildV2.ps1] npm notice New major version of npm available! 8.19.4 -> 10.2.5
cmderr	[Invoke-GenerateAndBuildV2.ps1] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.2.5>
cmderr	[Invoke-GenerateAndBuildV2.ps1] npm notice Run `npm install -g npm@10.2.5` to update!
cmderr	[Invoke-GenerateAndBuildV2.ps1] npm notice

️✔️Azure.AI.Vision.ImageAnalysis [View full logs] [Preview SDK Changes]
- Azure.AI.Vision.ImageAnalysis.1.0.0-alpha.20231215.1.nupkg
```
info	[Changelog]
```

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

⚠️Warning [Logs] Generate from a504270eb280dd5f8452dbd22b6a2e508ffc8618. 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 -> 23.3.1
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 -> 23.3.1
cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
warn		specification/ai/readme.md skipped due to azure-sdk-for-java not found in swagger-to-sdk
warn		specification/ai/data-plane/ImageAnalysis/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] WARN EBADENGINE Unsupported engine {
cmderr	[generate.py] npm WARN EBADENGINE   package: '@typespec/compiler@0.51.0',
cmderr	[generate.py] npm WARN EBADENGINE   required: { node: '>=18.0.0' },
cmderr	[generate.py] npm WARN EBADENGINE   current: { node: 'v16.20.2', npm: '8.19.4' }
cmderr	[generate.py] npm WARN EBADENGINE }
cmderr	[generate.py] npm WARN EBADENGINE Unsupported engine {
cmderr	[generate.py] npm WARN EBADENGINE   package: '@typespec/http@0.51.0',
cmderr	[generate.py] npm WARN EBADENGINE   required: { node: '>=18.0.0' },
cmderr	[generate.py] npm WARN EBADENGINE   current: { node: 'v16.20.2', npm: '8.19.4' }
cmderr	[generate.py] npm WARN EBADENGINE }
cmderr	[generate.py] npm WARN EBADENGINE Unsupported engine {
cmderr	[generate.py] npm WARN EBADENGINE   package: '@typespec/rest@0.51.0',
cmderr	[generate.py] npm WARN EBADENGINE   required: { node: '>=18.0.0' },
cmderr	[generate.py] npm WARN EBADENGINE   current: { node: 'v16.20.2', npm: '8.19.4' }
cmderr	[generate.py] npm WARN EBADENGINE }
cmderr	[generate.py] npm WARN EBADENGINE Unsupported engine {
cmderr	[generate.py] npm WARN EBADENGINE   package: '@typespec/openapi@0.51.0',
cmderr	[generate.py] npm WARN EBADENGINE   required: { node: '>=18.0.0' },
cmderr	[generate.py] npm WARN EBADENGINE   current: { node: 'v16.20.2', npm: '8.19.4' }
cmderr	[generate.py] npm WARN EBADENGINE }
cmderr	[generate.py] npm WARN EBADENGINE Unsupported engine {
cmderr	[generate.py] npm WARN EBADENGINE   package: '@typespec/versioning@0.51.0',
cmderr	[generate.py] npm WARN EBADENGINE   required: { node: '>=18.0.0' },
cmderr	[generate.py] npm WARN EBADENGINE   current: { node: 'v16.20.2', npm: '8.19.4' }
cmderr	[generate.py] npm WARN EBADENGINE }
cmderr	[generate.py] npm WARN EBADENGINE Unsupported engine {
cmderr	[generate.py] npm WARN EBADENGINE   package: '@azure-tools/typespec-azure-core@0.37.1',
cmderr	[generate.py] npm WARN EBADENGINE   required: { node: '>=18.0.0' },
cmderr	[generate.py] npm WARN EBADENGINE   current: { node: 'v16.20.2', npm: '8.19.4' }
cmderr	[generate.py] npm WARN EBADENGINE }
cmderr	[generate.py] npm WARN EBADENGINE Unsupported engine {
cmderr	[generate.py] npm WARN EBADENGINE   package: '@azure-tools/typespec-client-generator-core@0.37.0',
cmderr	[generate.py] npm WARN EBADENGINE   required: { node: '>=18.0.0' },
cmderr	[generate.py] npm WARN EBADENGINE   current: { node: 'v16.20.2', npm: '8.19.4' }
cmderr	[generate.py] npm WARN EBADENGINE }
cmderr	[generate.py]
cmderr	[generate.py] npm notice New major version of npm available! 8.19.4 -> 10.2.5
cmderr	[generate.py] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.2.5>
cmderr	[generate.py] npm notice Run `npm install -g npm@10.2.5` to update!
cmderr	[generate.py] npm notice
cmderr	[generate.py] warning: in the working copy of 'sdk/vision/azure-ai-vision-imageanalysis/pom.xml', CRLF will be replaced by LF the next time Git touches it

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

️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]

️✔️Succeeded [Logs] Generate from a504270eb280dd5f8452dbd22b6a2e508ffc8618. 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/ai/readme.md skipped due to azure-sdk-for-js not found in swagger-to-sdk
warn		specification/ai/data-plane/ImageAnalysis/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

️✔️@azure/imageAnalysis [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 · 2023-10-09T22:40:16Z

Generated ApiView

Language	Package Name	ApiView Link
Python	azure-ai-vision-imageanalysis	https://apiview.dev/Assemblies/Review/89d915fdeaef4214b46d319768424e7a?revisionId=dfb014314c3a490f842e04d14e99fcab
Java	azure-ai-vision-imageanalysis	https://apiview.dev/Assemblies/Review/b2df77670f9b49208d1d16a57d510db9?revisionId=d3f4e89d4ae74b3ca011d28d12aadf12
.Net	Azure.AI.Vision.ImageAnalysis	https://apiview.dev/Assemblies/Review/4234e029f4c54593abc8a2549a97a6e2
JavaScript	@azure/imageAnalysis	https://apiview.dev/Assemblies/Review/b208c643b5be431eb8b2fa04143b936f?revisionId=628456ec923d4b86a0265c628eea1380
Swagger	ai-data-plane-ImageAnalysis	https://apiview.dev/Assemblies/Review/428c51053a9b4530bc6df4b7646d7d19?revisionId=759fd70cd6a2481989b49f0919f36a28
TypeSpec	ImageAnalysis	https://apiview.dev/Assemblies/Review/d08bf8271270488ab6ce3429bb791385?revisionId=1373ddd9be1141ddb1c678890fc4f1b1

...ion/cognitiveservices/data-plane/ImageAnalysis/preview/2023-04-01-preview/ImageAnalysis.json

mikeharder

Please delete redundant file ImageAnalysis.json

openapi-pipeline-app · 2023-10-11T23:00:05Z

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]

There are no breaking changes.

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

There are no breaking changes.

️⌛CredScan pending [Detail]

️⚠️LintDiff: 14 Warnings warning [Detail]

compared tags (via openapi-validator v2.1.6)	new version	base version
package-2023-04-01-preview	package-2023-04-01-preview(e59b62b)	default(main)

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

Rule	Message	Related RPC [For API reviewers]
⚠️ SecurityDefinitionDescription	Security definition should have a description. Location: ImageAnalysis/preview/2023-04-01-preview/ImageAnalysis.json#L42
⚠️ PathCharacters	Path contains non-recommended characters. Location: ImageAnalysis/preview/2023-04-01-preview/ImageAnalysis.json#L50
⚠️ OperationId	OperationId should be of the form 'Noun_Verb' Location: ImageAnalysis/preview/2023-04-01-preview/ImageAnalysis.json#L52
⚠️ ParameterNamesConvention	Parameter name 'gender-neutral-caption' should be camel case. Location: ImageAnalysis/preview/2023-04-01-preview/ImageAnalysis.json#L67
⚠️ ParameterNamesConvention	Parameter name 'smartcrops-aspect-ratios' should be camel case. Location: ImageAnalysis/preview/2023-04-01-preview/ImageAnalysis.json#L70
⚠️ ParameterNamesConvention	Parameter name 'model-name' should be camel case. Location: ImageAnalysis/preview/2023-04-01-preview/ImageAnalysis.json#L73
⚠️ PathCharacters	Path contains non-recommended characters. Location: ImageAnalysis/preview/2023-04-01-preview/ImageAnalysis.json#L116
⚠️ OperationId	OperationId should be of the form 'Noun_Verb' Location: ImageAnalysis/preview/2023-04-01-preview/ImageAnalysis.json#L118
⚠️ SchemaNamesConvention	Schema name should be Pascal case. Location: ImageAnalysis/preview/2023-04-01-preview/ImageAnalysis.json#L177
⚠️ SchemaNamesConvention	Schema name should be Pascal case. Location: ImageAnalysis/preview/2023-04-01-preview/ImageAnalysis.json#L211
⚠️ SchemaNamesConvention	Schema name should be Pascal case. Location: ImageAnalysis/preview/2023-04-01-preview/ImageAnalysis.json#L224
⚠️ 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: ImageAnalysis/preview/2023-04-01-preview/ImageAnalysis.json#L548
⚠️ SchemaNamesConvention	Schema name should be Pascal case. Location: ImageAnalysis/preview/2023-04-01-preview/ImageAnalysis.json#L793
⚠️ 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: ImageAnalysis/preview/2023-04-01-preview/ImageAnalysis.json#L859

️️✔️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: 1 Errors, 0 Warnings failed [Detail]

Rule	Message
`❌` OBJECT_ADDITIONAL_PROPERTIES	Additional properties not allowed: $ref JsonUrl: ImageAnalysis/preview/2023-04-01-preview/ImageAnalysis.json

️⌛PoliCheck pending [Detail]

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

Rule	Message
`❌` HowToFix	Code style issues found path: ImageAnalysis/preview/2023-04-01-preview/ImageAnalysis.json
`❌` HowToFix	Code style issues found path: preview/2023-04-01-preview/examples/AnalyzeFromUrl_MaximumSet_Gen.json
`❌` HowToFix	Code style issues found path: preview/2023-04-01-preview/examples/AnalyzeFromUrl_MinimumSet_Gen.json
`❌` HowToFix	Code style issues found path: preview/2023-04-01-preview/examples/SegmentFromStream_MaximumSet_Gen.json
`❌` HowToFix	Code style issues found path: preview/2023-04-01-preview/examples/SegmentFromStream_MinimumSet_Gen.json

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

Validation passes for SpellCheck.

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

Validation passes for Lint(RPaaS).

️⌛PR Summary pending [Detail]

️⌛Automated merging requirements met pending [Detail]

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

openapi-pipeline-app · 2023-10-11T23:00:12Z

Swagger Generation Artifacts

️🔄ApiDocPreview inProgress [Detail]

️️✔️SDK Breaking Change Tracking succeeded [Detail] [Expand]

Breaking Changes Tracking

️⌛ azure-sdk-for-python pending [Detail]

️🔄 azure-sdk-for-net-track2 inProgress [Detail]

️🔄 azure-sdk-for-java inProgress [Detail]

️🔄 azure-sdk-for-js inProgress [Detail]

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

iscai-msft · 2023-10-23T19:28:11Z

/azp run SDK azure-sdk-for-python

azure-pipelines · 2023-10-23T19:28:17Z

No pipelines are associated with this pull request.

iscai-msft · 2023-10-23T19:30:33Z

/azp run openapi-pipeline-app

azure-pipelines · 2023-10-23T19:30:39Z

No pipelines are associated with this pull request.

mikeharder · 2023-10-23T19:56:40Z

/azp run

…is-typespec

dargilco · 2023-12-12T23:29:11Z

/azp run

azure-pipelines · 2023-12-12T23:29:25Z

Azure Pipelines successfully started running 3 pipeline(s).

mikeharder · 2023-12-13T19:44:45Z

/azp run

azure-pipelines · 2023-12-13T19:45:05Z

Azure Pipelines successfully started running 3 pipeline(s).

…eason)

dargilco · 2023-12-14T19:48:05Z

@yangyuan @MushMal ready for your review. Thanks!

specification/ai/ImageAnalysis/main.tsp

allenjzhang · 2023-12-15T00:15:56Z

/azp run

azure-pipelines · 2023-12-15T00:16:15Z

Azure Pipelines successfully started running 3 pipeline(s).

### Packages impacted by this PR @Azure/imageAnalysis ### Issues associated with this PR N/A ### Describe the problem that is addressed by this PR Initial add of ImageAnalysis RLC, opening PR to get gates run to start knocking those problems down... ### What are the possible designs available to address the problem? If there are more than one possible design, why was the one in this PR chosen? A DPG client... ### Are there test cases added in this PR? _(If not, why?)_ Yes ### Provide a list of related PRs _(if any)_ TyepSpec PR: Azure/azure-rest-api-specs#26146 ### Command used to generate this PR:**_(Applicable only to SDK release request PRs)_ ### Checklists - [ ] Added impacted package name to the issue description - [ ] Does this PR needs any fixes in the SDK Generator?** _(If so, create an Issue in the [Autorest/typescript](https://github.com/Azure/autorest.typescript) repository and link it here)_ - [ ] Added a changelog (if necessary)

@action

* First version * Add x-ms-examples to Swagger file * Rename OpenAPI file, add readme.md * Add generated.json * Another fix to overcome tool bug? * Referene genereted.json in readme.md (will be removed later on) * Remove 'Swagger to SDK' section in readme.md' * rename generated.json and don't reference it in readme.md * Fixes after running `npx prettier` - new line at end of files * Attempt to fix error in SemanticValidation --> AzureApiValication * Attempt to fix another SemanticValidation -> AzureApiValidation error * Return definition of visualFeatures, but without description field * No luck, revert last commit. I still get an error * Remove two ?api-version={apiVersion} * Copy examples from data-plane to Vision.ImageAnalysis * Fix error by adding linter line to tspconfig.yaml * Fix error by adding doc element to shared query in models.tsp * remove examples folder due to Java emitter bug * Remove manual fixing of auto-gen swagger * Check in generated.json. Remove duplicate examples * Fix TypeSpec Validation errors * Add examples folder in the TypeSpec folder. Not real one, for now, just a copy of the auto-gen min/max examples from data-plane folder * Fix another TypeSpec Validation error * More TypeSpec Validation errors * More TypeSpec Validation fixes * More * Recreate generated.json following Swagger update * overcome bug in OAV example generation tool * Add client.tsp to enable operator overloads in C# * Add new line at end of file * change SDK output folder to sdk/vision instead of sdk/cognitiveservices * Generate tests and metadata * set `partial-update: true` for Java * Move TypeSpec files to \vision\image-analysis * change folder from image-analysis to ImageAnalysis * Forgot to fix folder name in tspconfig.yaml * Fix casing in segmentationMode * Remove @action and @actionSeparator, per ask from Johan Stenberg * Update generated autorest with typespec hotfixes * Add Python SDK version * Remove package-version from tspconfig.yml. Use alias instead of model for shared query params * tsp format * Update generated autorest * Add missing examples * Fix imageContent in example * npx prettier * Update generated swagger * Fix examples * Update generated swagger * npx prettier * Workaround bug in oav generating examples * Remove redundant package-mode field * Update name of method argument from `mode` to `segmentationMode`, to match the object type name * Update generated autorest * Add min/max values. Update service name * Fix confidence values in examples to be in the range [0,1] * Change to RLC * Don't gen metadata and tests every time * Generate metadata and dummy tests * Post first SDK review: Update some property names. Add model-version query param * New auto-generated swagger * Updated swagger examples * Add min length to string query params * Update examples * Fix swagger validation failure * Updates after running 'npx prettier --write **/*.json` * Use @@access instead of @@internal in client.tsp * reg-ex for model-version * Fix examples * Forgot to copy examples... * More example fixes * More fixes to examples * Remove custom-model & segmentation * Update with example * update * Another attempt * Move restoring internal model classes to the TSP * Replace analyzeFromStream with analyzeFromBuffer * Add examples * Move to an internal visual features enum to enable a flags enum in C# * Add/update ref-doc comments * Ref-doc fix * Move location of TypeSpec files under ai\ImageAnalysis * TypeSpec updates to support new OCR result * Update service API version * Add generated.json * Add swagger examples * npx prettier --write **/*.json * Make Java models public again. Replace pages with blocks * Update example * After running npx prettier --write **/*.json * Sort @@access by a b c * TypeSpec validation fixes * Remove metadata section from TypeScript section to let magic happen * Update to GA endpoint * Generate examples * Fix examples * Fix TypeSpec validation * Fix Avocado error * Add analyzeFromUrl example (it was not automaticly created for some reason) * Fix title in new example * Fix from npx prettier * Use real example * Copy new examples to ImageAnalysis/examples/2023-10-01 * Fixes from npx --no tsv specification/ai/ImageAnalysis --------- Co-authored-by: Ryan Hurey <rhurey@microsoft.com> Co-authored-by: Mike Harder <mharder@microsoft.com>

dargilco requested a review from rhurey October 9, 2023 22:41

dargilco self-assigned this Oct 9, 2023

AzureRestAPISpecReview added the data-plane label Oct 11, 2023

dargilco mentioned this pull request Oct 11, 2023

oav generate-examples generated.json fails to parse x-ms-paths Azure/oav#1006

Open

mikeharder reviewed Oct 11, 2023

View reviewed changes

...ion/cognitiveservices/data-plane/ImageAnalysis/preview/2023-04-01-preview/ImageAnalysis.json Outdated Show resolved Hide resolved

mikeharder reviewed Oct 11, 2023

View reviewed changes

dargilco force-pushed the dargilco/image-analysis-typespec branch from 6e310f9 to 96ac4dc Compare October 11, 2023 22:18

dargilco force-pushed the dargilco/image-analysis-typespec branch 2 times, most recently from 92f8c8d to 1136817 Compare October 13, 2023 14:55

dargilco mentioned this pull request Oct 13, 2023

Crash in Java emitter "@azure-tools/typespec-java" Azure/autorest.java#2345

Closed

dargilco force-pushed the dargilco/image-analysis-typespec branch 2 times, most recently from 8a44ec4 to a485ff0 Compare October 20, 2023 23:12

dargilco marked this pull request as ready for review October 20, 2023 23:31

dargilco requested a review from yangyuan as a code owner October 20, 2023 23:31

dargilco changed the title ~~[Draft] Azure AI Image Analysis TypeSpec files~~ Azure AI Vision - Image Analysis TypeSpec files Oct 20, 2023

azure-sdk mentioned this pull request Oct 23, 2023

[AutoPR azure-ai-vision-imageanalysis] Azure AI Vision - Image Analysis TypeSpec files azure-sdk/azure-sdk-for-python#5049

Closed

rhurey mentioned this pull request Dec 9, 2023

Create new ImageAnalysis RLC package Azure/azure-sdk-for-js#28027

Merged

3 tasks

dargilco added 7 commits December 11, 2023 16:48

Merge remote-tracking branch 'origin/main' into dargilco/image-analys…

f247860

…is-typespec

Update to GA endpoint

9a2a827

Generate examples

95537fe

Fix examples

daf8e65

Fix TypeSpec validation

1aacda3

Fix Avocado error

f286100

Merge remote-tracking branch 'origin/main' into dargilco/image-analys…

d48703c

…is-typespec

This was referenced Dec 13, 2023

Image Analysis SDK for Java Azure/azure-sdk-for-java#38041

Merged

Image Analysis Python SDK Azure/azure-sdk-for-python#33487

Merged

dargilco added 6 commits December 14, 2023 07:35

Add analyzeFromUrl example (it was not automaticly created for some r…

fa10cc1

…eason)

Fix title in new example

ccc0e50

Fix from npx prettier

9fa207b

Use real example

7c6d4a9

Copy new examples to ImageAnalysis/examples/2023-10-01

401887f

Fixes from npx --no tsv specification/ai/ImageAnalysis

bb44cbd

mikeharder approved these changes Dec 14, 2023

View reviewed changes

allenjzhang reviewed Dec 14, 2023

View reviewed changes

specification/ai/ImageAnalysis/main.tsp Show resolved Hide resolved

allenjzhang merged commit 91f4459 into main Dec 15, 2023
30 checks passed

allenjzhang deleted the dargilco/image-analysis-typespec branch December 15, 2023 01:56

azure-sdk mentioned this pull request Dec 19, 2023

Azure SDK Review - [Cognitive Services Computer Vision API] Azure/azure-sdk#7072

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Azure AI Vision - Image Analysis TypeSpec files #26146

Azure AI Vision - Image Analysis TypeSpec files #26146

dargilco commented Oct 9, 2023

openapi-pipeline-app bot commented Oct 9, 2023 •

edited

openapi-pipeline-app bot commented Oct 9, 2023 •

edited

openapi-pipeline-app bot commented Oct 9, 2023 •

edited

Breaking Changes Tracking

openapi-pipeline-app bot commented Oct 9, 2023 •

edited

mikeharder left a comment

openapi-pipeline-app bot commented Oct 11, 2023

openapi-pipeline-app bot commented Oct 11, 2023

Breaking Changes Tracking

iscai-msft commented Oct 23, 2023

azure-pipelines bot commented Oct 23, 2023

iscai-msft commented Oct 23, 2023

azure-pipelines bot commented Oct 23, 2023

mikeharder commented Oct 23, 2023

dargilco commented Dec 12, 2023

azure-pipelines bot commented Dec 12, 2023

mikeharder commented Dec 13, 2023

azure-pipelines bot commented Dec 13, 2023

dargilco commented Dec 14, 2023

allenjzhang commented Dec 15, 2023

azure-pipelines bot commented Dec 15, 2023

Azure AI Vision - Image Analysis TypeSpec files #26146

Azure AI Vision - Image Analysis TypeSpec files #26146

Conversation

dargilco commented Oct 9, 2023

Data Plane API - Pull Request

API Info: The Basics

Change Scope

Viewing API changes

Suppressing failures

❔Got questions? Need additional info?? We are here to help!

Tooling

Guidelines & Specifications

Helpful Links

openapi-pipeline-app bot commented Oct 9, 2023 • edited

Next Steps to Merge

openapi-pipeline-app bot commented Oct 9, 2023 • edited

Swagger Validation Report

openapi-pipeline-app bot commented Oct 9, 2023 • edited

Swagger Generation Artifacts

Breaking Changes Tracking

openapi-pipeline-app bot commented Oct 9, 2023 • edited

Generated ApiView

mikeharder left a comment

Choose a reason for hiding this comment

openapi-pipeline-app bot commented Oct 11, 2023

Swagger Validation Report

openapi-pipeline-app bot commented Oct 11, 2023

Swagger Generation Artifacts

Breaking Changes Tracking

iscai-msft commented Oct 23, 2023

azure-pipelines bot commented Oct 23, 2023

iscai-msft commented Oct 23, 2023

azure-pipelines bot commented Oct 23, 2023

mikeharder commented Oct 23, 2023

dargilco commented Dec 12, 2023

azure-pipelines bot commented Dec 12, 2023

mikeharder commented Dec 13, 2023

azure-pipelines bot commented Dec 13, 2023

dargilco commented Dec 14, 2023

allenjzhang commented Dec 15, 2023

azure-pipelines bot commented Dec 15, 2023

openapi-pipeline-app bot commented Oct 9, 2023 •

edited

openapi-pipeline-app bot commented Oct 9, 2023 •

edited

openapi-pipeline-app bot commented Oct 9, 2023 •

edited

openapi-pipeline-app bot commented Oct 9, 2023 •

edited