Skip to content

Commit

Permalink
[Document Intelligence] Add changelog and release updates (Azure#39090)
Browse files Browse the repository at this point in the history
  • Loading branch information
samvaity committed Mar 6, 2024
1 parent 916c208 commit fb3b146
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 10 deletions.
Original file line number Diff line number Diff line change
@@ -1,14 +1,23 @@
# Release History

## 1.0.0-beta.2 (Unreleased)
## 1.0.0-beta.2 (2024-03-06)

### Features Added
- Support `retry-header` in `DocumentIntelligenceAdministrationClient` and `DocumentIntelligenceClient` for retrying failed polling operations.
- Added a property, `baseClassifierId` to `BuildDocumentClassfiierOptions` to specify the base classifier id to build upon.
- Added a property, `baseClassifierId` to `DocumentClassifierDetails` to specify the base classfier if on top of which the classifier was trained.
- Added a property, `warnings`, to `DocumentModelDetails` and `DocumentClassifierDetails`, to represent the list of warnings encountered when building the model.
- Added a property, `valueSelectionGroup` to `DocumentField` model.

### Breaking Changes

### Bugs Fixed
- The Azure Document Intelligence Client Library, now targets the Azure AI Document Intelligence service API version `"2024-02-29-preview"`.
Please note that support for `2023-10-31-preview` has been discontinued.

### Other Changes
#### Dependency Updates

- Upgraded `azure-core-http-netty` from `1.14.0` to version `1.14.1`.
- Upgraded `azure-core` from `1.46.0` to version `1.47.0`.

## 1.0.0-beta.1 (2023-11-16)

Expand Down
15 changes: 8 additions & 7 deletions sdk/documentintelligence/azure-ai-documentintelligence/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,22 +32,23 @@ It includes the following main features:
```
[//]: # ({x-version-update-end})

> Note: This version of the client library defaults to the `"2023-10-31-preview"` version of the service.
> Note: This version of the client library defaults to the `"2024-02-29-preview"` version of the service.
This table shows the relationship between SDK versions and supported API versions of the service:

| SDK version | Supported API version of service |
|--------------|----------------------------------|
| 1.0.0-beta.1 | 2023-10-31-preview |
| 1.0.0-beta.2 | 2024-02-29-preview |

> Note: Please rely on the older `azure-ai-formrecognizer` library through the older service API versions for retired
> models, such as `"prebuilt-businessCard"` and `"prebuilt-document"`. For more information, see [Changelog][changelog].
> The below table describes the relationship of each client and its supported API version(s):
| API version | Supported clients |
|--------------------|-----------------------------------------------------------------------------------------------|
| 2023-10-31-preview | DocumentIntelligenceClient and DocumentIntelligenceAsyncClient |
| 2023-07-31 | DocumentAnalysisClient and DocumentModelAdministrationClient in `azure-ai-formrecognizer` SDK |
| API version | Supported clients |
|----------------------------------------|-----------------------------------------------------------------------------------------------|
| 2023-10-31-preview, 2024-02-29-preview | DocumentIntelligenceClient and DocumentIntelligenceAsyncClient |
| 2023-07-31 | DocumentAnalysisClient and DocumentModelAdministrationClient in `azure-ai-formrecognizer` SDK |

Please see the [Migration Guide][migration_guide] for more information about migrating from `azure-ai-formrecognizer` to `azure-ai-documentintelligence`.

Expand Down Expand Up @@ -89,7 +90,7 @@ Authentication with AAD requires some initial setup:
<dependency>
<groupId>com.azure</groupId>
<artifactId>azure-identity</artifactId>
<version>1.11.2</version>
<version>1.11.3</version>
</dependency>
```
[//]: # ({x-version-update-end})
Expand Down Expand Up @@ -443,7 +444,7 @@ For details on contributing to this repository, see the [contributing guide](htt
[aad_authorization]: https://docs.microsoft.com/azure/cognitive-services/authentication#authenticate-with-azure-active-directory
[azure_key_credential]: https://github.com/Azure/azure-sdk-for-java/blob/main/sdk/core/azure-core/src/main/java/com/azure/core/credential/AzureKeyCredential.java
[key]: https://docs.microsoft.com/azure/cognitive-services/cognitive-services-apis-create-account?tabs=multiservice%2Cwindows#get-the-keys-for-your-resource
[api_reference_doc]: https://azure.github.io/azure-sdk-for-java
[api_reference_doc]: https://learn.microsoft.com/java/api/overview/azure/ai-documentintelligence-readme?view=azure-java-preview
[form_recognizer_doc]: https://aka.ms/azsdk-java-documentintelligence-ref-doc
[azure_identity_credential_type]: https://github.com/Azure/azure-sdk-for-java/tree/main/sdk/identity/azure-identity#credentials
[azure_cli]: https://docs.microsoft.com/azure/cognitive-services/cognitive-services-apis-create-account-cli?tabs=windows
Expand Down

0 comments on commit fb3b146

Please sign in to comment.