Update docs metadata
This commit is contained in:
azure-sdk
Родитель
5ab07e98d8
Коммит
20794cd60a
|
|
@ -1,12 +1,12 @@
|
|||
---
|
||||
title: Azure DocumentIntelligence client library for Java
|
||||
keywords: Azure, java, SDK, API, azure-ai-documentintelligence, documentintelligence
|
||||
ms.date: 11/17/2023
|
||||
ms.date: 03/06/2024
|
||||
ms.topic: reference
|
||||
ms.devlang: java
|
||||
ms.service: documentintelligence
|
||||
---
|
||||
# Azure DocumentIntelligence client library for Java - version 1.0.0-beta.1
|
||||
# Azure DocumentIntelligence client library for Java - version 1.0.0-beta.2
|
||||
|
||||
|
||||
Azure Document Intelligence ([previously known as Form Recognizer][service-rename]) is a cloud service that uses machine
|
||||
|
|
@ -41,6 +41,26 @@ It includes the following main features:
|
|||
```
|
||||
[//]: # ({x-version-update-end})
|
||||
|
||||
> 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, 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`.
|
||||
|
||||
### Authentication
|
||||
|
||||
In order to interact with the Azure Document Intelligence Service you'll need to create an instance of client class,
|
||||
|
|
@ -79,12 +99,12 @@ Authentication with AAD requires some initial setup:
|
|||
<dependency>
|
||||
<groupId>com.azure</groupId>
|
||||
<artifactId>azure-identity</artifactId>
|
||||
<version>1.10.4</version>
|
||||
<version>1.11.3</version>
|
||||
</dependency>
|
||||
```
|
||||
[//]: # ({x-version-update-end})
|
||||
|
||||
After setup, you can choose which type of [credential][azure_identity_credential_type] from azure.identity to use.
|
||||
After setup, you can choose which type of [credential][azure_identity_credential_type] from azure-identity to use.
|
||||
As an example, [DefaultAzureCredential][wiki_identity] can be used to authenticate the client:
|
||||
Set the values of the client ID, tenant ID, and client secret of the AAD application as environment variables:
|
||||
`AZURE_CLIENT_ID`, `AZURE_TENANT_ID`, `AZURE_CLIENT_SECRET`.
|
||||
|
|
@ -138,7 +158,7 @@ Callers should wait for the operation to be completed by calling `getFinalResult
|
|||
|
||||
The following section provides several code snippets covering some of the most common Document Intelligence tasks, including:
|
||||
|
||||
* [Analyze Layout](#extract-layout "Analyze Layout")
|
||||
* [Analyze Layout](#analyze-layout "Analyze Layout")
|
||||
* [Use Prebuilt Models](#use-prebuilt-models)
|
||||
* [Build a Document Model](#build-a-document-model "Build a Document Model")
|
||||
* [Analyze Documents using a Custom Model](#analyze-documents-using-a-custom-model "Analyze Documents using a Custom Model")
|
||||
|
|
@ -421,24 +441,24 @@ reduce the dependency size, refer to the [performance tuning][performance_tuning
|
|||
|
||||
## Contributing
|
||||
|
||||
For details on contributing to this repository, see the [contributing guide](https://github.com/Azure/azure-sdk-for-java/blob/azure-ai-documentintelligence_1.0.0-beta.1/CONTRIBUTING.md).
|
||||
For details on contributing to this repository, see the [contributing guide](https://github.com/Azure/azure-sdk-for-java/blob/azure-ai-documentintelligence_1.0.0-beta.2/CONTRIBUTING.md).
|
||||
|
||||
1. Fork it
|
||||
1. Create your feature branch (`git checkout -b my-new-feature`)
|
||||
1. Commit your changes (`git commit -am 'Add some feature'`)
|
||||
1. Push to the branch (`git push origin my-new-feature`)
|
||||
1. Create new Pull Request
|
||||
2. Create your feature branch (`git checkout -b my-new-feature`)
|
||||
3. Commit your changes (`git commit -am 'Add some feature'`)
|
||||
4. Push to the branch (`git push origin my-new-feature`)
|
||||
5. Create new Pull Request
|
||||
|
||||
<!-- LINKS -->
|
||||
[aad_authorization]: /azure/cognitive-services/authentication#authenticate-with-azure-active-directory
|
||||
[azure_key_credential]: https://github.com/Azure/azure-sdk-for-java/blob/azure-ai-documentintelligence_1.0.0-beta.1/sdk/core/azure-core/src/main/java/com/azure/core/credential/AzureKeyCredential.java
|
||||
[azure_key_credential]: https://github.com/Azure/azure-sdk-for-java/blob/azure-ai-documentintelligence_1.0.0-beta.2/sdk/core/azure-core/src/main/java/com/azure/core/credential/AzureKeyCredential.java
|
||||
[key]: /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/azure-ai-documentintelligence_1.0.0-beta.1/sdk/identity/azure-identity#credentials
|
||||
[azure_identity_credential_type]: https://github.com/Azure/azure-sdk-for-java/tree/azure-ai-documentintelligence_1.0.0-beta.2/sdk/identity/azure-identity#credentials
|
||||
[azure_cli]: /azure/cognitive-services/cognitive-services-apis-create-account-cli?tabs=windows
|
||||
[azure_cli_endpoint]: /cli/azure/cognitiveservices/account?view=azure-cli-latest#az-cognitiveservices-account-show
|
||||
[azure_identity]: https://github.com/Azure/azure-sdk-for-java/tree/azure-ai-documentintelligence_1.0.0-beta.1/sdk/identity/azure-identity#credentials
|
||||
[azure_identity]: https://github.com/Azure/azure-sdk-for-java/tree/azure-ai-documentintelligence_1.0.0-beta.2/sdk/identity/azure-identity#credentials
|
||||
[azure_portal]: https://ms.portal.azure.com
|
||||
[azure_subscription]: https://azure.microsoft.com/free
|
||||
[cla]: https://cla.microsoft.com
|
||||
|
|
@ -449,35 +469,37 @@ For details on contributing to this repository, see the [contributing guide](htt
|
|||
[form_recognizer_account]: /azure/cognitive-services/cognitive-services-apis-create-account?tabs=multiservice%2Cwindows
|
||||
[grant_access]: /azure/cognitive-services/authentication#assign-a-role-to-a-service-principal
|
||||
[http_clients_wiki]: https://github.com/Azure/azure-sdk-for-java/wiki/HTTP-clients
|
||||
[http_response_exception]: https://github.com/Azure/azure-sdk-for-java/blob/azure-ai-documentintelligence_1.0.0-beta.1/sdk/core/azure-core/src/main/java/com/azure/core/exception/HttpResponseException.java
|
||||
[http_response_exception]: https://github.com/Azure/azure-sdk-for-java/blob/azure-ai-documentintelligence_1.0.0-beta.2/sdk/core/azure-core/src/main/java/com/azure/core/exception/HttpResponseException.java
|
||||
[jdk_link]: /java/azure/jdk/?view=azure-java-stable
|
||||
[logging]: https://github.com/Azure/azure-sdk-for-java/wiki/Logging-with-Azure-SDK
|
||||
[logLevels]: https://github.com/Azure/azure-sdk-for-java/blob/azure-ai-documentintelligence_1.0.0-beta.2/sdk/core/azure-core/src/main/java/com/azure/core/util/logging/ClientLogger.java
|
||||
[package]: https://central.sonatype.com/artifact/com.azure/azure-ai-documentintelligence
|
||||
[performance_tuning]: https://github.com/Azure/azure-sdk-for-java/wiki/Performance-Tuning
|
||||
[product_documentation]: /azure/cognitive-services/form-recognizer/overview
|
||||
[register_AAD_application]: /azure/cognitive-services/authentication#assign-a-role-to-a-service-principal
|
||||
[fr-studio]: https://aka.ms/azsdk/formrecognizer/documentintelligencestudio
|
||||
[fr_build_training_set]: https://aka.ms/azsdk/formrecognizer/buildcustommodel
|
||||
[sample_examples]: https://github.com/Azure/azure-sdk-for-java/tree/azure-ai-documentintelligence_1.0.0-beta.1/sdk/documentintelligence/azure-ai-documentintelligence/src/samples#examples
|
||||
[sample_readme]: https://github.com/Azure/azure-sdk-for-java/tree/azure-ai-documentintelligence_1.0.0-beta.1/sdk/documentintelligence/azure-ai-documentintelligence/src/samples#readme
|
||||
[migration_guide]: https://github.com/Azure/azure-sdk-for-java/tree/azure-ai-documentintelligence_1.0.0-beta.1/sdk/documentintelligence/azure-ai-documentintelligence/migration-guide.md
|
||||
[changelog]: https://github.com/Azure/azure-sdk-for-java/blob/azure-ai-documentintelligence_1.0.0-beta.1/sdk/documentintelligence/azure-ai-documentintelligence/CHANGELOG.md
|
||||
[sample_examples]: https://github.com/Azure/azure-sdk-for-java/tree/azure-ai-documentintelligence_1.0.0-beta.2/sdk/documentintelligence/azure-ai-documentintelligence/src/samples#examples
|
||||
[samples_readme]: https://github.com/Azure/azure-sdk-for-java/tree/azure-ai-documentintelligence_1.0.0-beta.2/sdk/documentintelligence/azure-ai-documentintelligence/src/samples#readme
|
||||
[migration_guide]: https://github.com/Azure/azure-sdk-for-java/tree/azure-ai-documentintelligence_1.0.0-beta.2/sdk/documentintelligence/azure-ai-documentintelligence/MIGRATION_GUIDE.md
|
||||
[changelog]: https://github.com/Azure/azure-sdk-for-java/blob/azure-ai-documentintelligence_1.0.0-beta.2/sdk/documentintelligence/azure-ai-documentintelligence/CHANGELOG.md
|
||||
|
||||
[sample_readme]: https://github.com/Azure/azure-sdk-for-java/blob/azure-ai-documentintelligence_1.0.0-beta.1/sdk/documentintelligence/azure-ai-documentintelligence/src/samples/
|
||||
[document_analysis_async_client]: https://github.com/Azure/azure-sdk-for-java/blob/azure-ai-documentintelligence_1.0.0-beta.1/sdk/documentintelligence/azure-ai-documentintelligence/src/main/java/com/azure/ai/documentintelligence/DocumentIntelligenceAsyncClient.java
|
||||
[document_analysis_sync_client]: https://github.com/Azure/azure-sdk-for-java/blob/azure-ai-documentintelligence_1.0.0-beta.1/sdk/documentintelligence/azure-ai-documentintelligence/src/main/java/com/azure/ai/documentintelligence/DocumentIntelligenceClient.java
|
||||
[document_model_admin_async_client]: https://github.com/Azure/azure-sdk-for-java/blob/azure-ai-documentintelligence_1.0.0-beta.1/sdk/documentintelligence/azure-ai-documentintelligence/src/main/java/com/azure/ai/documentintelligence/DocumentIntelligenceAdministrationAsyncClient.java
|
||||
[document_model_admin_sync_client]: https://github.com/Azure/azure-sdk-for-java/blob/azure-ai-documentintelligence_1.0.0-beta.1/sdk/documentintelligence/azure-ai-documentintelligence/src/main/java/com/azure/ai/documentintelligence/DocumentIntelligenceAdministrationClient.java
|
||||
[document_analysis_client_builder]: https://github.com/Azure/azure-sdk-for-java/blob/azure-ai-documentintelligence_1.0.0-beta.1/sdk/documentintelligence/azure-ai-documentintelligence/src/main/java/com/azure/ai/documentintelligence/DocumentIntelligenceClientBuilder.java
|
||||
[manage_custom_models]: https://github.com/Azure/azure-sdk-for-java/blob/azure-ai-documentintelligence_1.0.0-beta.1/sdk/documentintelligence/azure-ai-documentintelligence/src/samples/java/com/azure/ai/documentintelligence/administration/ManageCustomModels.java
|
||||
[manage_custom_models_async]: https://github.com/Azure/azure-sdk-for-java/blob/azure-ai-documentintelligence_1.0.0-beta.1/sdk/documentintelligence/azure-ai-documentintelligence/src/samples/java/com/azure/ai/documentintelligence/administration/ManageCustomModelsAsync.java
|
||||
[build_model]: https://github.com/Azure/azure-sdk-for-java/blob/azure-ai-documentintelligence_1.0.0-beta.1/sdk/documentintelligence/azure-ai-documentintelligence/src/samples/java/com/azure/ai/documentintelligence/administration/BuildDocumentModel.java
|
||||
[build_model_async]: https://github.com/Azure/azure-sdk-for-java/blob/azure-ai-documentintelligence_1.0.0-beta.1/sdk/documentintelligence/azure-ai-documentintelligence/src/samples/java/com/azure/ai/documentintelligence/administration/BuildDocumentModelAsync.java
|
||||
[build_document_classifier]: https://github.com/Azure/azure-sdk-for-java/blob/azure-ai-documentintelligence_1.0.0-beta.1/sdk/documentintelligence/azure-ai-documentintelligence/src/samples/java/com/azure/ai/documentintelligence/administration/BuildDocumentClassifier.java
|
||||
[build_document_classifier_async]: https://github.com/Azure/azure-sdk-for-java/blob/azure-ai-documentintelligence_1.0.0-beta.1/sdk/documentintelligence/azure-ai-documentintelligence/src/samples/java/com/azure/ai/documentintelligence/administration/BuildDocumentClassifierAsync.java
|
||||
[analyze_identity_documents_from_url]: https://github.com/Azure/azure-sdk-for-java/blob/azure-ai-documentintelligence_1.0.0-beta.1/sdk/documentintelligence/azure-ai-documentintelligence/src/samples/java/com/azure/ai/documentintelligence/AnalyzeIdentityDocumentsFromUrl.java
|
||||
[analyze_identity_documents_from_url_async]: https://github.com/Azure/azure-sdk-for-java/blob/azure-ai-documentintelligence_1.0.0-beta.1/sdk/documentintelligence/azure-ai-documentintelligence/src/samples/java/com/azure/ai/documentintelligence/AnalyzeIdentityDocumentsFromUrlAsync.java
|
||||
[analyze_invoices_from_url]: https://github.com/Azure/azure-sdk-for-java/blob/azure-ai-documentintelligence_1.0.0-beta.1/sdk/documentintelligence/azure-ai-documentintelligence/src/samples/java/com/azure/ai/documentintelligence/AnalyzeInvoicesFromUrl.java
|
||||
[analyze_receipts_from_url]: https://github.com/Azure/azure-sdk-for-java/blob/azure-ai-documentintelligence_1.0.0-beta.1/sdk/documentintelligence/azure-ai-documentintelligence/src/samples/java/com/azure/ai/documentintelligence/AnalyzeReceiptsFromUrl.java
|
||||
[sample_readme]: https://github.com/Azure/azure-sdk-for-java/blob/azure-ai-documentintelligence_1.0.0-beta.2/sdk/documentintelligence/azure-ai-documentintelligence/src/samples/
|
||||
[document_analysis_async_client]: https://github.com/Azure/azure-sdk-for-java/blob/azure-ai-documentintelligence_1.0.0-beta.2/sdk/documentintelligence/azure-ai-documentintelligence/src/main/java/com/azure/ai/documentintelligence/DocumentIntelligenceAsyncClient.java
|
||||
[document_analysis_sync_client]: https://github.com/Azure/azure-sdk-for-java/blob/azure-ai-documentintelligence_1.0.0-beta.2/sdk/documentintelligence/azure-ai-documentintelligence/src/main/java/com/azure/ai/documentintelligence/DocumentIntelligenceClient.java
|
||||
[document_model_admin_async_client]: https://github.com/Azure/azure-sdk-for-java/blob/azure-ai-documentintelligence_1.0.0-beta.2/sdk/documentintelligence/azure-ai-documentintelligence/src/main/java/com/azure/ai/documentintelligence/DocumentIntelligenceAdministrationAsyncClient.java
|
||||
[document_model_admin_sync_client]: https://github.com/Azure/azure-sdk-for-java/blob/azure-ai-documentintelligence_1.0.0-beta.2/sdk/documentintelligence/azure-ai-documentintelligence/src/main/java/com/azure/ai/documentintelligence/DocumentIntelligenceAdministrationClient.java
|
||||
[document_analysis_client_builder]: https://github.com/Azure/azure-sdk-for-java/blob/azure-ai-documentintelligence_1.0.0-beta.2/sdk/documentintelligence/azure-ai-documentintelligence/src/main/java/com/azure/ai/documentintelligence/DocumentIntelligenceClientBuilder.java
|
||||
[manage_custom_models]: https://github.com/Azure/azure-sdk-for-java/blob/azure-ai-documentintelligence_1.0.0-beta.2/sdk/documentintelligence/azure-ai-documentintelligence/src/samples/java/com/azure/ai/documentintelligence/administration/ManageCustomModels.java
|
||||
[manage_custom_models_async]: https://github.com/Azure/azure-sdk-for-java/blob/azure-ai-documentintelligence_1.0.0-beta.2/sdk/documentintelligence/azure-ai-documentintelligence/src/samples/java/com/azure/ai/documentintelligence/administration/ManageCustomModelsAsync.java
|
||||
[build_model]: https://github.com/Azure/azure-sdk-for-java/blob/azure-ai-documentintelligence_1.0.0-beta.2/sdk/documentintelligence/azure-ai-documentintelligence/src/samples/java/com/azure/ai/documentintelligence/administration/BuildDocumentModel.java
|
||||
[build_model_async]: https://github.com/Azure/azure-sdk-for-java/blob/azure-ai-documentintelligence_1.0.0-beta.2/sdk/documentintelligence/azure-ai-documentintelligence/src/samples/java/com/azure/ai/documentintelligence/administration/BuildDocumentModelAsync.java
|
||||
[build_document_classifier]: https://github.com/Azure/azure-sdk-for-java/blob/azure-ai-documentintelligence_1.0.0-beta.2/sdk/documentintelligence/azure-ai-documentintelligence/src/samples/java/com/azure/ai/documentintelligence/administration/BuildDocumentClassifier.java
|
||||
[build_document_classifier_async]: https://github.com/Azure/azure-sdk-for-java/blob/azure-ai-documentintelligence_1.0.0-beta.2/sdk/documentintelligence/azure-ai-documentintelligence/src/samples/java/com/azure/ai/documentintelligence/administration/BuildDocumentClassifierAsync.java
|
||||
[analyze_identity_documents_from_url]: https://github.com/Azure/azure-sdk-for-java/blob/azure-ai-documentintelligence_1.0.0-beta.2/sdk/documentintelligence/azure-ai-documentintelligence/src/samples/java/com/azure/ai/documentintelligence/AnalyzeIdentityDocumentsFromUrl.java
|
||||
[analyze_identity_documents_from_url_async]: https://github.com/Azure/azure-sdk-for-java/blob/azure-ai-documentintelligence_1.0.0-beta.2/sdk/documentintelligence/azure-ai-documentintelligence/src/samples/java/com/azure/ai/documentintelligence/AnalyzeIdentityDocumentsFromUrlAsync.java
|
||||
[analyze_invoices_from_url]: https://github.com/Azure/azure-sdk-for-java/blob/azure-ai-documentintelligence_1.0.0-beta.2/sdk/documentintelligence/azure-ai-documentintelligence/src/samples/java/com/azure/ai/documentintelligence/AnalyzeInvoicesFromUrl.java
|
||||
[analyze_receipts_from_url]: https://github.com/Azure/azure-sdk-for-java/blob/azure-ai-documentintelligence_1.0.0-beta.2/sdk/documentintelligence/azure-ai-documentintelligence/src/samples/java/com/azure/ai/documentintelligence/AnalyzeReceiptsFromUrl.java
|
||||
|
||||
[fr_models]: https://aka.ms/azsdk/formrecognizer/models
|
||||
[service_access]: /azure/cognitive-services/cognitive-services-apis-create-account?tabs=multiservice%2Cwindows
|
||||
|
|
@ -486,7 +508,7 @@ For details on contributing to this repository, see the [contributing guide](htt
|
|||
[service_analyze_receipt_fields]: https://aka.ms/azsdk/formrecognizer/receiptfieldschema
|
||||
[service_analyze_w2_documents_fields]: https://aka.ms/azsdk/formrecognizer/taxusw2fieldschema
|
||||
[service-rename]: https://techcommunity.microsoft.com/t5/azure-ai-services-blog/azure-form-recognizer-is-now-azure-ai-document-intelligence-with/ba-p/3875765
|
||||
[source_code]: https://github.com/Azure/azure-sdk-for-java/blob/azure-ai-documentintelligence_1.0.0-beta.1/sdk/documentintelligence/azure-ai-documentintelligence/src
|
||||
[source_code]: https://github.com/Azure/azure-sdk-for-java/blob/azure-ai-documentintelligence_1.0.0-beta.2/sdk/documentintelligence/azure-ai-documentintelligence/src
|
||||
[quickstart_training]: https://learn.microsoft.com/azure/applied-ai-services/form-recognizer/quickstarts/get-started-sdks-rest-api?view=form-recog-3.0.0&pivots=programming-language-java
|
||||
[wiki_identity]: https://github.com/Azure/azure-sdk-for-java/wiki/Identity-and-Authentication
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
{
|
||||
"Name": "azure-ai-documentintelligence",
|
||||
"Version": "1.0.0-beta.1",
|
||||
"Version": "1.0.0-beta.2",
|
||||
"DevVersion": null,
|
||||
"DirectoryPath": "sdk/documentintelligence/azure-ai-documentintelligence",
|
||||
"ServiceDirectory": "documentintelligence",
|
||||
|
|
@ -10,5 +10,5 @@
|
|||
"SdkType": "client",
|
||||
"IsNewSdk": true,
|
||||
"ArtifactName": "azure-ai-documentintelligence",
|
||||
"ReleaseStatus": "2023-11-16"
|
||||
"ReleaseStatus": "2024-03-06"
|
||||
}
|
||||
|
|
|
|||
Загрузка…
Ссылка в новой задаче