@azure/ai-form-recognizer 4.0.0-beta.2 → 4.0.0-beta.5

package/README.md

@@ -4,6 +4,7 @@ Azure Cognitive Services [Form Recognizer](https://azure.microsoft.com/services/
 
 - Layout - Extract text, table structures, and selection marks, along with their bounding region coordinates, from documents.
 - Document - Analyze entities, key-value pairs, tables, and selection marks from documents using the general prebuilt document model.
+- Read - Read information about textual elements, such as page words and lines in addition to text language information.
 - Prebuilt - Analyze data from certain types of common documents (such as receipts, invoices, business cards, or identity documents) using prebuilt models.
 - Custom - Build custom models to extract text, field values, selection marks, and table data from documents. Custom models are built with your own data, so they're tailored to your documents.
 
@@ -15,23 +16,23 @@ Azure Cognitive Services [Form Recognizer](https://azure.microsoft.com/services/
 
 #### **_Breaking Change Advisory_ ⚠️**
 
-In version 4 (currently beta), this package introduces a full redesign of the Azure Form Recognizer client library. To leverage features of the newest Form Recognizer service API (version "2021-09-30-preview" and newer), the new SDK is required, and application code must be changed to use the new clients. Please see the [Migration Guide](https://github.com/azure/azure-sdk-for-js/blob/main/sdk/formrecognizer/ai-form-recognizer/MIGRATION-v3_v4.md) for detailed instructions on how to update application code from version 3.x of the Form Recognizer SDK to the new version (4.x). Additionally, the [CHANGELOG](https://github.com/azure/azure-sdk-for-js/blob/main/sdk/formrecognizer/ai-form-recognizer/CHANGELOG.md) contains an outline of the changes. This package targets Azure Form Recognizer service API version `2021-09-30-preview` and newer. To continue to use Form Recognizer API version 2.1, please use major version 3 of the client package (`@azure/ai-form-recognizer@^3.2.0`).
+In version 4 (currently beta), this package introduces a full redesign of the Azure Form Recognizer client library. To leverage features of the newest Form Recognizer service API (version "2022-06-30-preview" and newer), the new SDK is required, and application code must be changed to use the new clients. Please see the [Migration Guide](https://github.com/azure/azure-sdk-for-js/blob/main/sdk/formrecognizer/ai-form-recognizer/MIGRATION-v3_v4.md) for detailed instructions on how to update application code from version 3.x of the Form Recognizer SDK to the new version (4.x). Additionally, the [CHANGELOG](https://github.com/azure/azure-sdk-for-js/blob/main/sdk/formrecognizer/ai-form-recognizer/CHANGELOG.md) contains an outline of the changes. This package targets Azure Form Recognizer service API version `2022-06-30-preview` and newer. To continue to use Form Recognizer API version 2.1, please use major version 3 of the client package (`@azure/ai-form-recognizer@^3.2.0`).
 
 ### Install the `@azure/ai-form-recognizer` Package
 
 Install the Azure Form Recognizer client library for JavaScript with `npm`:
 
 ```bash
-npm install @azure/ai-form-recognizer@4.0.0-beta.2
+npm install @azure/ai-form-recognizer@4.0.0-beta.5
 ```
 
 ## Getting Started
 
 ```javascript
-import { DocumentAnalysisClient } from "@azure/ai-form-recognizer";
-import { DefaultAzureCredential } from "@azure/identity";
+const { DocumentAnalysisClient } = require("@azure/ai-form-recognizer");
+const { DefaultAzureCredential } = require("@azure/identity");
 
-import * as fs from "fs";
+const fs = require("fs");
 
 const credential = new DefaultAzureCredential();
 const client = new DocumentAnalysisClient(
@@ -41,7 +42,7 @@ const client = new DocumentAnalysisClient(
 
 // Form Recognizer supports many different types of files.
 const file = fs.createReadStream("path/to/file.jpg");
-const poller = await client.beginAnalyzeDocuments("<model ID>", file);
+const poller = await client.beginAnalyzeDocument("<model ID>", file);
 
 const { pages, tables, styles, keyValuePairs, entities, documents } = await poller.pollUntilDone();
 ```
@@ -89,7 +90,7 @@ In order to interact with the Form Recognizer service, you'll need to select eit
 You can find the endpoint for your Form Recognizer resource either in the [Azure Portal][azure_portal] or by using the [Azure CLI][azure_cli] snippet below:
 
 ```bash
-az cognitiveservices account show --name <your-resource-name> --resource-group <your-resource-group-name> --query "endpoint"
+az cognitiveservices account show --name <your-resource-name> --resource-group <your-resource-group-name> --query "properties.endpoint"
 ```
 
 #### Using an API Key
@@ -105,7 +106,7 @@ az cognitiveservices account keys list --resource-group <your-resource-group-nam
 Once you have an API key and endpoint, you can use it as follows:
 
 ```js
-import { DocumentAnalysisClient, AzureKeyCredential } from "@azure/ai-form-recognizer";
+const { DocumentAnalysisClient, AzureKeyCredential } = require("@azure/ai-form-recognizer");
 
 const client = new DocumentAnalysisClient("<endpoint>", new AzureKeyCredential("<API key>"));
 ```
@@ -123,8 +124,8 @@ To authenticate using a service principal, you will also need to [register an AA
 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`.
 
 ```js
-import { DocumentAnalysisClient } from "@azure/ai-form-recognizer";
-import { DefaultAzureCredential } from "@azure/identity";
+const { DocumentAnalysisClient } = require("@azure/ai-form-recognizer");
+const { DefaultAzureCredential } = require("@azure/identity");
 
 const client = new DocumentAnalysisClient("<endpoint>", new DefaultAzureCredential());
 ```
@@ -135,9 +136,10 @@ const client = new DocumentAnalysisClient("<endpoint>", new DefaultAzureCredenti
 
 `DocumentAnalysisClient` provides operations for analyzing input documents using custom and prebuilt models. It has three methods:
 
-- `beginAnalyzeDocuments`, which extracts data from an input document using a custom or prebuilt model given by its model ID. For information about the prebuilt models supported in all resources and their model IDs/outputs, please see [the service's documentation of the models][fr-models].
-- `beginExtractLayout`, which uses the "prebuilt-layout" model to extract only the basic layout (OCR) information from the input documents, such as pages and their contents, tables, and observed text styles. This method provides a stronger TypeScript type for the layout result than the `beginAnalyzeDocuments` method.
-- `beginExtractGenericDocument`, which uses the "prebuilt-document" model to extract key-value pairs and entities in addition to the properties of the prebuilt layout model. This method also provides a stronger TypeScript type for the generic document result than the `beginAnalyzeDocuments` method.
+- `beginAnalyzeDocument`, which extracts data from an input document using a custom or prebuilt model given by its model ID. For information about the prebuilt models supported in all resources and their model IDs/outputs, please see [the service's documentation of the models][fr-models].
+- `beginExtractLayout`, which uses the "prebuilt-layout" model to extract only the basic layout (OCR) information from the input documents, such as pages and their contents, tables, and observed text styles. This method provides a stronger TypeScript type for the layout result than the `beginAnalyzeDocument` method.
+- `beginExtractGeneralDocument`, which uses the "prebuilt-document" model to extract key-value pairs and entities in addition to the properties of the prebuilt layout model. This method also provides a stronger TypeScript type for the general document result than the `beginAnalyzeDocument` method.
+- `beginReadDocument`, which uses the "prebuilt-read" model to extract textual elements, such as page words and lines in addition to text language information.
 
 ### `DocumentModelAdministrationClient`
 
@@ -145,7 +147,7 @@ const client = new DocumentAnalysisClient("<endpoint>", new DefaultAzureCredenti
 
 - `beginBuildModel` starts an operation to create a new document model from your own training data set. The created model can extract fields according to a custom schema. The training data are expected to be located in an Azure Storage container and organized according to a particular convention. See the [service's documentation on creating a training data set][fr-build-training-set] for a more detailed explanation of applying labels to a training data set.
 - `beginComposeModel` starts an operation to compose multiple models into a single model. When used for custom form recognition, the new composed model will first perform a classification of the input documents to determine which of its submodels is most appropriate.
-- `beginCopyModel` starts an operation to copy a custom model from one Form Recognizer resource to another (or even to the same Form Recognizer resource). It requires a `CopyAuthorization` from the target Form Recognizer resource, which can be generated using the `getCopyAuthorization` method.
+- `beginCopyModelTo` starts an operation to copy a custom model from one Form Recognizer resource to another (or even to the same Form Recognizer resource). It requires a `CopyAuthorization` from the target Form Recognizer resource, which can be generated using the `getCopyAuthorization` method.
 - `getInfo` retrieves information about the resource's limits, such as the number of custom models and the maximum number of models the resource can support.
 - `getModel`, `listModels`, and `deleteModel` enable managing models in the resource.
 - `getOperation` and `listOperations` enable viewing the status of model creation operations, even those operations that are ongoing or that have failed. Operations are retained for 24 hours.
@@ -166,17 +168,17 @@ The following section provides several JavaScript code snippets illustrating com
 
 - [Analyze a Document with a Model](#analyze-a-document-with-a-model)
 - [Extract Layout](#extract-layout)
-- [Extract Generic Document](#extract-generic-document)
+- [Extract General Document](#extract-general-document)
 - [Use Prebuilt Models](#using-prebuilt-models)
 - [Build a Model](#build-a-model)
 - [Manage Models](#manage-models)
 
 ### Analyze a Document with a Model
 
-The `beginAnalyzeDocuments` method can extract fields and table data from documents. These models are trained with your own data, so they're tailored to your particular documents. A custom model should only be used with documents of the same structure as one of the document types in the model (there may be multiple, such as in a composed model).
+The `beginAnalyzeDocument` method can extract fields and table data from documents. These models are trained with your own data, so they're tailored to your particular documents. A custom model should only be used with documents of the same structure as one of the document types in the model (there may be multiple, such as in a composed model).
 
 ```javascript
-import { DocumentAnalysisClient, AzureKeyCredential } from "@azure/ai-form-recognizer";
+const { DocumentAnalysisClient, AzureKeyCredential } = require("@azure/ai-form-recognizer");
 
 const fs = require("fs");
 
@@ -189,7 +191,7 @@ async function main() {
   const readStream = fs.createReadStream(path);
 
   const client = new DocumentAnalysisClient(endpoint, new AzureKeyCredential(apiKey));
-  const poller = await client.beginAnalyzeDocuments(modelId, readStream, {
+  const poller = await client.beginAnalyzeDocument(modelId, readStream, {
     onProgress: ({ status }) => {
       console.log(`status: ${status}`);
     },
@@ -231,10 +233,13 @@ As an alternative to providing a readable stream, a publicly-accessible URL can
 
 ### Extract Layout
 
+<a id="beginextractlayout-deprecation"></a>
+**Deprecation Warning** ⚠️: The built in `beginExtractLayout` method is deprecated as of version `4.0.0-beta.4`. Prior to a stable release of version 4.0.0, we will remove it and provide a solution that uses the `beginAnalyzeDocument` method instead. This will align the `"prebuilt-layout"` model with the other prebuilt models, enabling us to continue to provide timely updates and ensure stability as the number of supported prebuilt models increases and as their capabilities are enhanced.
+
 The `beginExtractLayout` method extracts only the basic elements of the document, such as pages, (which consist of text words/lines and selection marks), tables, and visual text styles along with their bounding regions and spans within the text content of the input documents.
 
 ```javascript
-import { DocumentAnalysisClient, AzureKeyCredential } from "@azure/ai-form-recognizer";
+const { DocumentAnalysisClient, AzureKeyCredential } = require("@azure/ai-form-recognizer");
 
 const fs = require("fs");
 
@@ -266,14 +271,17 @@ main().catch((err) => {
 });
 ```
 
-_Note_: you may also use the `beginAnalyzeDocuments` method to extract layout information using the prebuilt layout model by providing the model ID `"prebuilt-layout"`. This method provides a weaker TypeScript type for the layout analysis result, but will produce the same information. The `beginExtractLayout` method is available for your convenience.
+_Note_: you may also use the `beginAnalyzeDocument` method to extract layout information using the prebuilt layout model by providing the model ID `"prebuilt-layout"`. This method provides a weaker TypeScript type for the layout analysis result, but will produce the same information. The `beginExtractLayout` method is available for your convenience.
+
+### Extract General Document
 
-### Extract Generic Document
+<a id="beginextractgeneraldocument-deprecation"></a>
+**Deprecation Warning** ⚠️: The built in `beginExtractGeneralDocument` method is deprecated as of version `4.0.0-beta.4`. Prior to a stable release of version 4.0.0, we will remove it and provide a solution that uses the `beginAnalyzeDocument` method instead. This will align the `"prebuilt-document"` model with the other prebuilt models, enabling us to continue to provide timely updates and ensure stability as the number of supported prebuilt models increases and as their capabilities are enhanced.
 
-The `beginExtractGenericDocument` method extracts information about key-value pairs and entities in addition to the properties produced by the layout extraction method. This new prebuilt (generic) document model provides similar functionality to the "unlabeled" custom models found in previous iterations of the Form Recognizer service, but it is now provided as a prebuilt that works with a wide variety of documents.
+The `beginExtractGeneralDocument` method extracts information about key-value pairs and entities in addition to the properties produced by the layout extraction method. This prebuilt (general) document model provides similar functionality to the custom models trained without label information in previous iterations of the Form Recognizer service, but it is now provided as a prebuilt model that works with a wide variety of documents.
 
 ```javascript
-import { DocumentAnalysisClient, AzureKeyCredential } from "@azure/ai-form-recognizer";
+const { DocumentAnalysisClient, AzureKeyCredential } = require("@azure/ai-form-recognizer");
 
 const fs = require("fs");
 
@@ -285,7 +293,7 @@ async function main() {
   const readStream = fs.createReadStream(path);
 
   const client = new DocumentAnalysisClient(endpoint, new AzureKeyCredential(apiKey));
-  const poller = await client.beginExtractLayout(readStream);
+  const poller = await client.beginExtractGeneralDocument(readStream);
 
   // `pages`, `tables` and `styles` are also available as in the "layout" example above, but for the sake of this
   // example we won't show them here.
@@ -320,16 +328,89 @@ main().catch((err) => {
 });
 ```
 
-_Note_: you may also use the `beginAnalyzeDocuments` method to extract generic document information using the prebuilt document model by providing the model ID `"prebuilt-document"`. This method provides a weaker TypeScript type for the layout analysis result, but will produce the same information. The `beginExtractGenericDocument` method is available for your convenience.
+_Note_: you may also use the `beginAnalyzeDocument` method to extract general document information using the prebuilt document model by providing the model ID `"prebuilt-document"`. This method provides a weaker TypeScript type for the layout analysis result, but will produce the same information. The `beginExtractGeneralDocument` method is available for your convenience.
+
+### Read Document
+
+<a id="beginreaddocument-deprecation"></a>
+**Deprecation Warning** ⚠️: The built in `beginReadDocument` method is deprecated as of version `4.0.0-beta.4`. Prior to a stable release of version 4.0.0, we will remove it and provide a solution that uses the `beginAnalyzeDocument` method instead. This will align the `"prebuilt-document"` model with the other prebuilt models, enabling us to continue to provide timely updates and ensure stability as the number of supported prebuilt models increases and as their capabilities are enhanced.
+
+```javascript
+const { DocumentAnalysisClient, AzureKeyCredential } = require("@azure/ai-form-recognizer");
+const fs = require("fs");
+
+async function main() {
+  const endpoint = "<cognitive services endpoint>";
+  const apiKey = "<api key>";
+  const path = "<path to a document>"; // pdf/jpeg/png/tiff formats
+
+  const readStream = fs.createReadStream(path);
+
+  const client = new DocumentAnalysisClient(endpoint, new AzureKeyCredential(apiKey));
+  const poller = await client.beginReadDocument(readStream);
+
+  // The "prebuilt-read" model (`beginReadDocument` method) only extracts information about the textual content of the
+  // document, such as page text elements, text styles, and information about the language of the text.
+  const { content, pages, languages, styles } = await poller.pollUntilDone();
+
+  if (pages.length <= 0) {
+    console.log("No pages were extracted from the document.");
+  } else {
+    console.log("Pages:");
+    for (const page of pages) {
+      console.log("- Page", page.pageNumber, `(unit: ${page.unit})`);
+      console.log(`  ${page.width}x${page.height}, angle: ${page.angle}`);
+      console.log(`  ${page.lines.length} lines, ${page.words.length} words`);
+
+      if (page.lines.length > 0) {
+        console.log("  Lines:");
+
+        for (const line of page.lines) {
+          console.log(`  - "${line.content}"`);
+        }
+      }
+    }
+  }
+
+  if (languages.length <= 0) {
+    console.log("No language spans were extracted from the document.");
+  } else {
+    console.log("Languages:");
+    for (const languageEntry of languages) {
+      console.log(
+        `- Found language: ${languageEntry.languageCode} (confidence: ${languageEntry.confidence})`
+      );
+      for (const text of getTextOfSpans(content, languageEntry.spans)) {
+        const escapedText = text.replace(/\r?\n/g, "\\n").replace(/"/g, '\\"');
+        console.log(`  - "${escapedText}"`);
+      }
+    }
+  }
+}
+
+main().catch((error) => {
+  console.error("An error occurred:", error);
+  process.exit(1);
+});
+```
+
+_Note_: you may also use the `beginAnalyzeDocument` method to read document information using the "read" model by providing the model ID `"prebuilt-read"`. This method provides a weaker TypeScript type for the read result, but will produce the same information. The `beginReadDocument` method is available for your convenience.
 
 ### Using Prebuilt Models
 
-The `beginAnalyzeDocuments` method also supports extracting fields from certain types of common documents such as receipts, invoices, business cards, and identity documents using prebuilt models provided by the Form Recognizer service. The prebuilt models may be provided either as model ID strings (the same as custom document models) or using a `DocumentModel` object. When using a `DocumentModel`, the Form Recognizer SDK for JavaScript provides a much stronger TypeScript type for the resulting extracted documents based on the model's schema, and it will be converted to use JavaScript naming conventions.
+The `beginAnalyzeDocument` method also supports extracting fields from certain types of common documents such as receipts, invoices, business cards, and identity documents using prebuilt models provided by the Form Recognizer service. The prebuilt models may be provided either as model ID strings (the same as custom document models) or using a `DocumentModel` object. When using a `DocumentModel`, the Form Recognizer SDK for JavaScript provides a much stronger TypeScript type for the resulting extracted documents based on the model's schema, and it will be converted to use JavaScript naming conventions.
+
+<a id="prebuiltmodels-deprecation"></a>
+**Deprecation Warning** ⚠️: The built in `PrebuiltModels` are deprecated as of version `4.0.0-beta.4`. Prior to a stable release of version 4.0.0, we will replace `PrebuiltModels` with an out-of-tree solution that provides the same strongly-typed functionality. This will enable us to continue to provide timely updates and ensure stability as the number of supported prebuilt models increases and as their capabilities are enhanced.
 
 For example, the following code shows how to use `PrebuiltModels.Receipt` to extract a strongly-typed receipt object from an input.
 
 ```javascript
-import { DocumentAnalysisClient, PrebuiltModels, AzureKeyCredential } from "@azure/ai-form-recognizer";
+const {
+  DocumentAnalysisClient,
+  PrebuiltModels,
+  AzureKeyCredential,
+} = require("@azure/ai-form-recognizer");
 
 const fs = require("fs");
 
@@ -343,33 +424,32 @@ async function main() {
   const client = new DocumentAnalysisClient(endpoint, new AzureKeyCredential(apiKey));
 
   // The PrebuiltModels.Receipt `DocumentModel` encodes both the model ID and a stronger return type for the operation
-  const poller = await client.beginAnalyzeDocuments(PrebuiltModels.Receipt, readStream, {
-    onProgress: ({status}}) => {
+  const poller = await client.beginAnalyzeDocument(PrebuiltModels.Receipt, readStream, {
+    onProgress: ({ status }) => {
       console.log(`status: ${status}`);
-    }
+    },
   });
 
-  const { documents: [receiptDocument] } = await poller.pollUntilDone();
+  const {
+    documents: [receiptDocument],
+  } = await poller.pollUntilDone();
+
+  // The fields of the document constitute the extracted receipt data.
+  const receipt = receiptDocument.fields;
 
   if (receipt === undefined) {
     throw new Error("Expected at least one receipt in analysis result.");
   }
 
-  // The fields of the document constitute the extracted receipt data.
-  const receipt = receiptDocument.fields;
-
   console.log(`Receipt data (${receiptDocument.docType})`);
-  console.log("  Type:", receipt.receiptType?.value);
   console.log("  Merchant Name:", receipt.merchantName?.value);
-  console.log("  Transaction Date:", receipt.transactionDate?.value);
 
   // The items of the receipt are an example of a `DocumentArrayValue`
   if (receipt.items !== undefined) {
-    console.log("  Items:");
-    for (const itemField of receipt.items.values) {
-      // Just as the fields constitute the receipt data, the item field's properties constitute the item data
-      const item = itemField.properties;
-      console.log("  - Name:", item.name?.value, `(confidence ${itemField.confidence})`);
+    console.log("Items:");
+    for (const { properties: item } of receipt.items.values) {
+      console.log("- Description:", item.description?.value);
+      console.log("  Total Price:", item.totalPrice?.value);
     }
   }
 
@@ -387,10 +467,15 @@ Alternatively, as mentioned above, instead of using `PrebuiltDocuments.Receipt`,
 
 You are not limited to receipts! There are a few prebuilt models to choose from, with more on the way. Each prebuilt model has its own set of supported fields:
 
-- Receipts, using `PrebuiltModels.Receipt` or the prebuilt receipt model ID `"prebuilt-receipt"` (see [the supported fields of the receipt model](https://aka.ms/azsdk/formrecognizer/receiptfieldschema)).
-- Business cards, using `PrebuiltModels.BusinessCard` or its model ID `"prebuilt-businessCard"` (see [the supported fields of the business card model](https://aka.ms/azsdk/formrecognizer/businesscardfieldschema)).
-- Invoices, using `PrebuiltModels.Invoice` or its model ID `"prebuilt-invoice"` (see [the supported fields of the invoice model](https://aka.ms/azsdk/formrecognizer/invoicefieldschema)).
-- Identity Documents (such as driver licenses and passports), using `PrebuiltModels.IdentityDocument` or its model ID `"prebuilt-idDocument"` (see [the supported fields of the identity document model](https://aka.ms/azsdk/formrecognizer/iddocumentfieldschema)).
+- Receipts, using `PrebuiltModels.Receipt` or the prebuilt receipt model ID `"prebuilt-receipt"`.
+- Business cards, using `PrebuiltModels.BusinessCard` or its model ID `"prebuilt-businessCard"`.
+- Invoices, using `PrebuiltModels.Invoice` or its model ID `"prebuilt-invoice"`.
+- Identity Documents (such as driver licenses and passports), using `PrebuiltModels.IdentityDocument` or its model ID `"prebuilt-idDocument"`.
+- W2 Tax Forms (United States), using `PrebuiltModels.TaxUsW2` or its model ID `"prebuilt-tax.us.w2"`.
+- Health Insurance Cards (United States), using `PrebuiltModels.HealthInsuranceCardUs` or its model ID `"prebuilt-healthInsuranceCard.us"`.
+- Vaccination Cards (currently supports US COVID-19 vaccination cards), using `PrebuiltModels.VaccinationCard` or its model ID `"prebuilt-vaccinationCard"`.
+
+For information about the fields of these models, see [the service's documentation of the available prebuilt models](https://aka.ms/azsdk/formrecognizer/models).
 
 The fields of all prebuilt document models may also be accessed programmatically using the `getModel` method (by their model IDs) of `DocumentModelAdministrationClient` and inspecting the `docTypes` field in the result.
 
@@ -401,7 +486,10 @@ The SDK also supports creating models, using `DocumentModelAdministrationClient`
 For example, the following program builds a custom document model using a SAS-encoded URL to a pre-existing Azure Storage container:
 
 ```javascript
-import { DocumentModelAdministrationClient, AzureKeyCredential } from "@azure/ai-form-recognizer";
+const {
+  DocumentModelAdministrationClient,
+  AzureKeyCredential,
+} = require("@azure/ai-form-recognizer");
 
 async function main() {
   const endpoint = "<cognitive services endpoint>";
@@ -415,7 +503,10 @@ async function main() {
 
   // You must provide the model ID. It can be any text that does not start with "prebuilt-".
   // For example, you could provide a randomly generated GUID using the "uuid" package.
-  const poller = await trainingClient.beginBuildModel("<model ID>", containerSasUrl, {
+  // The second parameter is the SAS-encoded URL to an Azure Storage container with the training documents.
+  // The third parameter is the build mode: one of "template" (the only mode prior to 4.0.0-beta.3) or "neural".
+  // See https://aka.ms/azsdk/formrecognizer/buildmode for more information about build modes.
+  const poller = await trainingClient.beginBuildModel("<model ID>", containerSasUrl, "template", {
     // The model description is optional and can be any text.
     description: "This is my new model!",
     onProgress: ({ status }) => {
@@ -458,7 +549,10 @@ main().catch((err) => {
 `DocumentModelAdministrationClient` also provides several methods for managing models. The following example shows how to iterate through the models in a Form Recognizer resource (this will include both custom models in the resource as well as prebuilt models that are common to all resources), get a model by ID, and delete a model.
 
 ```javascript
-import { DocumentModelAdministrationClient, AzureKeyCredential } from "@azure/ai-form-recognizer";
+const {
+  DocumentModelAdministrationClient,
+  AzureKeyCredential,
+} = require("@azure/ai-form-recognizer");
 
 async function main() {
   const endpoint = "<cognitive services endpoint>";
@@ -511,7 +605,7 @@ For information about the error messages and codes produced by the Form Recogniz
 Enabling logging may help uncover useful information about failures. In order to see a log of HTTP requests and responses, set the `AZURE_LOG_LEVEL` environment variable to `info`. Alternatively, logging can be enabled at runtime by calling `setLogLevel` in the `@azure/logger`:
 
 ```javascript
-import { setLogLevel } from "@azure/logger";
+const { setLogLevel } = require("@azure/logger");
 
 setLogLevel("info");
 ```