[Document Intelligence] Update changelog to include service changes #27874
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
HarshaNalluru
requested review from
bojunehsu,
mayurid,
kinelski,
catalinaperalta,
johanste,
samvaity and
YalinLi0312
|
API change check APIView has identified API level changes in this PR and created following API reviews. |
mssfang
approved these changes
Nov 27, 2023
|
#assign-reviewer:laujan |
bojunehsu
reviewed
Nov 27, 2023
sdk/documentintelligence/ai-document-intelligence-rest/CHANGELOG.md
Outdated
Show resolved
Hide resolved
bojunehsu
reviewed
Nov 27, 2023
sdk/documentintelligence/ai-document-intelligence-rest/CHANGELOG.md
Outdated
Show resolved
Hide resolved
…OG.md Co-authored-by: Paul Hsu <bojunehsu@gmail.com>
YalinLi0312
reviewed
Nov 29, 2023
sdk/documentintelligence/ai-document-intelligence-rest/CHANGELOG.md
Outdated
Show resolved
Hide resolved
YalinLi0312
reviewed
Nov 29, 2023
sdk/documentintelligence/ai-document-intelligence-rest/CHANGELOG.md
Outdated
Show resolved
Hide resolved
…OG.md Co-authored-by: Paul Hsu <bojunehsu@gmail.com>
HarshaNalluru
commented
Nov 29, 2023
sdk/documentintelligence/ai-document-intelligence-rest/CHANGELOG.md
Outdated
Show resolved
Hide resolved
laujan
approved these changes
Nov 30, 2023
bojunehsu
reviewed
Nov 30, 2023
sdk/documentintelligence/ai-document-intelligence-rest/CHANGELOG.md
Outdated
Show resolved
Hide resolved
bojunehsu
reviewed
Nov 30, 2023
| await client.path("/documentModels/{modelId}:analyze", "prebuilt-layout").post({ | ||
| contentType: "application/json", | ||
| body: { urlSource: "..." }, | ||
| queryParameters: { queryFields: ["NumberOfGuests", "StoreNumber"] }, // <-- new query parameter |
There was a problem hiding this comment.
I believe we are missing features: ["queryFields"] (or equivalent syntax) as an additional query parameter, unless the SDK automatically adds it.
There was a problem hiding this comment.
Good catch, Paul.
I had a list of tests to add after the release, those would have caught this.. could you point me to the documents as well to test these features?
bojunehsu
reviewed
Nov 30, 2023
| - `@azure-rest/ai-document-intelligence` is the new package, replacing `@azure/ai-form-recognizer` package. The new package supports a Rest Level Client, which is part of the new generation of Azure SDKs to simplify the development experience. The new package is not compatible with the previous `@azure/ai-form-recognizer` package without necessary changes to your code. | ||
| - **Breaking Changes (with the `@azure/ai-form-recognizer` SDK)** - API shapes have been designed from scratch to support the new Rest Level Client for the Document Intelligence service. Please refer to the [Readme](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/documentintelligence/ai-document-intelligence-rest/README.md) and [Samples](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/documentintelligence/ai-document-intelligence-rest/samples) for more understanding. | ||
|
|
||
| ### `"2023-10-31-preview"` Service API version |
There was a problem hiding this comment.
@laujan Does it make sense to have each SDK list the set of new features/breaking changes at the service level, not SDK level? Perhaps it would be better to have each SDK link to a service level breaking change page in learn.microsoft.com.
There was a problem hiding this comment.
From @laujan:
It's customary to list features/breaking changes at the SDK level and then provide a link to each programming language within the service level documentation.
If so, let's describe the changes from the perspective of the SDK, not the service. For example, we should not use features=keyValuePairs since it is not JS syntax.
|
Hi @paul ***@***.***>,
It's customary to list features/breaking changes at the SDK level and then provide a link to each programming language within the service level documentation.
________________________________
From: Paul Hsu ***@***.***>
Sent: Thursday, November 30, 2023 12:39 PM
To: Azure/azure-sdk-for-js ***@***.***>
Cc: la januari ***@***.***>; Mention ***@***.***>
Subject: Re: [Azure/azure-sdk-for-js] [Document Intelligence] Update changelog to include service changes (PR #27874)
@bojunehsu commented on this pull request.
________________________________
In sdk/documentintelligence/ai-document-intelligence-rest/CHANGELOG.md<#27874 (comment)>:
@@ -14,5 +14,97 @@
### Features Added
…-This marks the first preview of ***@***.***/ai-document-intelligence` Rest Level Client Library for the Azure AI Document Intelligence service (formerly known as Form Recognizer).
-Please refer to the [Readme](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/documentintelligence/ai-document-intelligence-rest/README.md) and samples for more details.
+This marks the first preview of ***@***.***/ai-document-intelligence` Rest Level Client Library for the Azure AI Document Intelligence service (formerly known as Form Recognizer), targeting service API version `"2023-10-31-preview"`.
+
+_**Note: Form Recognizer has been rebranded to Document Intelligence.**_
+
+- Updates all REST API operation paths from `{endpoint}/formrecognizer` to `{endpoint}/documentintelligence`. SDK would handle this change automatically, users would not have to do additional work to support this.
+- ***@***.***/ai-document-intelligence` is the new package, replacing ***@***.***/ai-form-recognizer` package. The new package supports a Rest Level Client, which is part of the new generation of Azure SDKs to simplify the development experience. The new package is not compatible with the previous ***@***.***/ai-form-recognizer` package without necessary changes to your code.
+- **Breaking Changes (with the ***@***.***/ai-form-recognizer` SDK)** - API shapes have been designed from scratch to support the new Rest Level Client for the Document Intelligence service. Please refer to the [Readme](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/documentintelligence/ai-document-intelligence-rest/README.md) and [Samples](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/documentintelligence/ai-document-intelligence-rest/samples) for more understanding.
+
+### `"2023-10-31-preview"` Service API version
@laujan<https://github.com/laujan> Does it make sense to have each SDK list the set of new features/breaking changes at the service level, not SDK level? Perhaps it would be better to have each SDK link to a service level breaking change page in learn.microsoft.com.
—
Reply to this email directly, view it on GitHub<#27874 (review)>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/AMBJMSUQGWAIRX2DU5ZKMKLYHDVJZAVCNFSM6AAAAAA7XAGUVKVHI2DSMVQWIX3LMV43YUDVNRWFEZLROVSXG5CSMV3GSZLXHMYTONJYGQYTKNBWGM>.
You are receiving this because you were mentioned.Message ID: ***@***.***>
|
YalinLi0312
reviewed
Dec 2, 2023
HarshaNalluru
commented
Dec 13, 2023
| @@ -464,7 +464,7 @@ describe("DocumentIntelligenceClient", () => { | |||
| return _model; | |||
| } | |||
|
|
|||
| it("with selection marks", async () => { | |||
| it.skip("with selection marks", async () => { | |||
There was a problem hiding this comment.
Unskip failed unit test in followup PR.
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.
As requested by La Januari, updating the changelog for
1.0.0-beta.1version to also convey the service updates and breaking changes as we move from@azure/ai-form-recognizerto@azure-rest/ai-document-intelligence