azure-sdk-for-js icon indicating copy to clipboard operation
azure-sdk-for-js copied to clipboard

Generate and implement Face SDK via TypeSpec

Open chungshengfu opened this issue 9 months ago • 1 comments

Packages impacted by this PR

@azure-rest/ai-vision-face

Issues associated with this PR

Describe the problem that is addressed by this PR

Generate and implement Face SDK via TypeSpec.

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?

Are there test cases added in this PR? (If not, why?)

Provide a list of related PRs (if any)

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 repository and link it here)
  • [ ] Added a changelog (if necessary)

chungshengfu avatar May 02 '24 06:05 chungshengfu

Thank you for your contribution @chungshengfu! We will review the pull request and get back to you soon.

github-actions[bot] avatar May 02 '24 06:05 github-actions[bot]

/azp run prepare-pipelines

qiaozha avatar May 06 '24 08:05 qiaozha

Azure Pipelines successfully started running 1 pipeline(s).

azure-pipelines[bot] avatar May 06 '24 08:05 azure-pipelines[bot]

/azp run js - face - ci

qiaozha avatar May 06 '24 08:05 qiaozha

Azure Pipelines successfully started running 1 pipeline(s).

azure-pipelines[bot] avatar May 06 '24 08:05 azure-pipelines[bot]

should we have asset.json checked in after the test recordings are uploaded?

qiaozha avatar May 06 '24 10:05 qiaozha

the ci is failing for various reasons, please follow the step here to make sure you have done everything after the generation. https://github.com/Azure/azure-sdk-for-js/blob/main/documentation/steps-after-generations.md. I notice this step is missing

  1. image

And about the link verification, please finish the above step then follow the instructions here https://github.com/Azure/azure-sdk-for-js/blob/main/documentation/Troubleshoot-ci-failure.md#broken-links to fix the problem, thanks

qiaozha avatar May 06 '24 10:05 qiaozha

should we have asset.json checked in after the test recordings are uploaded?

Thanks for reminder. I will check the process.

the ci is failing for various reasons, please follow the step here to make sure you have done everything after the generation.

The generated samples was intentionally removed. Let me put it back.

There seems to be custom code mixed in with the generated code. Could you help me understand what is custom and the reasons we need it?

The customization includes the followings:

  • Make detectionModel, recognitionModel, returnFaceId of DetectFromUrlQueryParamProperties and DetectQueryParamProperties mandatory. API definition says they are optional, but we want the invocation to be more explicit.
  • Classify FaceAttributeType by the supporting detection/recognition models to reduce the cost of misusing these constants.
  • Give filename of CreateLivenessWithVerifySessionContentVerifyImagePartDescriptor a default value. It's required by backend but makes no sense to clients.

If we really need custom code, let's follow the customization guide. But I would like to make sure that we really need it, usually Rest Level Clients don't need customization

I didn't find the customization guide. Could you please share it with me? Thanks.

chungshengfu avatar May 07 '24 02:05 chungshengfu

/azp run js - face - ci

MaryGao avatar May 09 '24 04:05 MaryGao

Pull request contains merge conflicts.

azure-pipelines[bot] avatar May 09 '24 04:05 azure-pipelines[bot]

/azp run js - face - ci

MaryGao avatar May 09 '24 09:05 MaryGao

No pipelines are associated with this pull request.

azure-pipelines[bot] avatar May 09 '24 09:05 azure-pipelines[bot]

/azp run prepare-pipelines

MaryGao avatar May 09 '24 09:05 MaryGao

Azure Pipelines successfully started running 1 pipeline(s).

azure-pipelines[bot] avatar May 09 '24 09:05 azure-pipelines[bot]

/azp run js - face - ci

MaryGao avatar May 09 '24 09:05 MaryGao

Azure Pipelines successfully started running 1 pipeline(s).

azure-pipelines[bot] avatar May 09 '24 09:05 azure-pipelines[bot]

API change check

APIView has identified API level changes in this PR and created following API reviews.

@azure-rest/ai-vision-face

azure-sdk avatar May 09 '24 09:05 azure-sdk

LGTM

Han-msft avatar May 10 '24 02:05 Han-msft

Thanks for this pr! I left some comments and I think I could give the approval once them addressed.

MaryGao avatar May 10 '24 05:05 MaryGao

@MaryGao @chungshengfu please checkout "extraFiles" in "//sampleConfiguration"` section to see if it helps

https://github.com/Azure/azure-sdk-for-js/blob/4a102992b453f41e41977754966ece992eca4b87/sdk/formrecognizer/ai-form-recognizer/package.json#L149-L178

jeremymeng avatar May 10 '24 16:05 jeremymeng