JavaScript(v3.1)

Azure AI Document Intelligence client library samples for JavaScript

• Code samples for each language's SDK are in the links below. The first step is to click to choose one (default JavaScript).

Python	.NET	Java	JavaScript

• The contents of this folder apply to the version: v3.1 (2023-07-31-GA) .
• You can select v4.0 (2024-02-29-preview) to view the latest version.

Table of Contents

• Features
• Prerequisites
• Setup
• Run the samples
• Next steps

Features

Azure AI Document Intelligence is a cloud-based Azure AI service that enables you to build intelligent document processing solutions. Massive amounts of data, spanning a wide variety of data types, are stored in forms and documents. Document Intelligence enables you to effectively manage the velocity at which data is collected and processed and is key to improved operations, informed data-driven decisions, and enlightened innovation.

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:

• Azure Cognitive Services account

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

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

3. 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

Run the samples

These sample programs show how to use the JavaScript client libraries for Azure AI Document Intelligence 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
listClassifiers.js	iterate over the classifiers in a resource
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 and the following Azure resources to run these sample programs:

• Azure Cognitive Services account

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

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

3. 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

For more samples, see Azure SDK for JavaScript.