Skip to content

Latest commit

 

History

History
81 lines (60 loc) · 5.73 KB

README.md

File metadata and controls

81 lines (60 loc) · 5.73 KB
Raw
page_type languages products urlFragment
sample
javascript
azure
azure-cognitive-services
azure-form-recognizer
ai-form-recognizer-javascript

Azure Form Recognizer client library samples for JavaScript

These sample programs show how to use the JavaScript client libraries for Azure Form Recognizer 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)
buildModel.js build a model with a single document type from a training data set
copyModel.js copy a model from one resource to another
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

Prerequisites

The sample programs are compatible with LTS versions of Node.js.

You need an Azure subscription and the following Azure resources 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:

  1. Install the dependencies using npm:
npm install

  1. Edit the file sample.env, adding the correct credentials to access the Azure service and run the samples. Then rename the file from sample.env to just .env. The sample programs will read this file automatically.

  2. 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):

npx cross-env FORM_RECOGNIZER_ENDPOINT="<form recognizer endpoint>" FORM_RECOGNIZER_API_KEY="<form recognizer api key>" 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.