The primary reason that we added `dev-tool run vendored` command is to manage dependencies centrally. Now we can achieve that with pnpm workspace/catalog feature. This PR removes most of the `dev-tool run vendored` usages from individual packages and replace them with direct tool calls. Those tools are also added to individual package's dev dependencies per Pnpm recommendation.
6.3 KiB
Azure Document Intelligence Rest Client client library samples for JavaScript
These sample programs show how to use the JavaScript client libraries for Azure Document Intelligence Rest Client in some common scenarios.
| File Name | Description |
|---|---|
| composeModel.js | create a composed model from several individual labeled models |
| analyzeDocumentByModelId.js | analyze a document using a model by ID |
| analyzeReceiptByModelId.js | use the "prebuilt-receipt" model ID to extract data from a receipt document (weakly-typed) |
| buildClassifier.js | build a classifier from a training data set |
| buildModel.js | build a model with a single document type from a training data set |
| classifyDocument.js | use a custom classifier to classify a document |
| copyModel.js | copy a model from one resource to another |
| getClassifier.js | get information about a classifier by its ID |
| getInfo.js | get information about the count and limit of custom models in the resource |
| getModel.js | get information about a model by its ID |
| listModels.js | iterate over the models in a resource |
| readDocument.js | use the prebuilt "read" model to extract information about the text content of a document |
Prerequisites
The sample programs are compatible with LTS versions of Node.js.
You need an Azure subscription to run these sample programs.
Samples retrieve credentials to access the service endpoint from environment variables. Alternatively, edit the source code to include the appropriate credentials. See each individual sample for details on which environment variables/credentials it requires to function.
Adapting the samples to run in the browser may require some additional consideration. For details, please see the package README.
Setup
To run the samples using the published version of the package:
- Install the dependencies using
npm:
npm install
-
Edit the file
sample.env, adding the correct credentials to access the Azure service and run the samples. Then rename the file fromsample.envto just.env. The sample programs will read this file automatically. -
Run whichever samples you like (note that some samples may require additional setup, see the table above):
node composeModel.js
Alternatively, run a single sample with the correct environment variables set (setting up the .env file is not required if you do this), for example (cross-platform):
cross-env DOCUMENT_INTELLIGENCE_ENDPOINT="<document intelligence endpoint>" PURCHASE_ORDER_SUPPLIES_SAS_URL="<purchase order supplies sas url>" PURCHASE_ORDER_EQUIPMENT_SAS_URL="<purchase order equipment sas url>" PURCHASE_ORDER_FURNITURE_SAS_URL="<purchase order furniture sas url>" PURCHASE_ORDER_CLEANING_SUPPLIES_SAS_URL="<purchase order cleaning supplies sas url>" node composeModel.js
Next Steps
Take a look at our API Documentation for more information about the APIs that are available in the clients.