@azure-rest/ai-document-intelligence 1.0.0-beta.3 → 1.1.0-alpha.20250513.1

package/CHANGELOG.md

@@ -1,5 +1,142 @@
+<!-- dev-tool snippets ignore -->
+
 # Release History
 
+## 1.1.0 (2025-05-08)
+
+### Features Added
+
+- Supports alternative cloud environments (Azure United States Government and Azure China Cloud). To use an alternative cloud environment, provide a value for the `scopes` field of `DocumentIntelligenceClientOptions#credentials` to configure the client to authenticate within a [Sovereign Cloud](https://learn.microsoft.com/entra/identity-platform/authentication-national-cloud).
+  Import and use `KnownDocumentIntelligenceAudience` to get the correct values for a given cloud environment. The currently supported cloud environments are:
+
+  - `KnownDocumentIntelligenceAudience.AzureChina` (`"https://cognitiveservices.azure.cn"`),
+  - `KnownDocumentIntelligenceAudience.AzureGovernment` (`"https://cognitiveservices.azure.us"`),
+  - `KnownDocumentIntelligenceAudience.AzurePublicCloud` (`"https://cognitiveservices.azure.com"`),
+
+  ```js
+    const client = DocumentIntelligence(
+      "<cognitive services endpoint>",
+      <--credential-->,
+      { credentials: { scopes: [ KnownDocumentIntelligenceAudience.AzureGovernment ] } }
+    );
+  ```
+
+  If `scopes` is undefined, the default value is suitable for the Azure Public Cloud `https://cognitiveservices.azure.com`.
+
+## 1.0.0 (2024-12-16)
+
+### Features Added
+
+- Adds `streamToUint8Array`, a convenience function that buffers a `NodeJS.ReadableStream` in a `Uint8Array`. It can be used to read the pdf and png responses from the results of an analysis.
+
+  ```ts
+  import DocumentIntelligence from "@azure-rest/ai-document-intelligence";
+  import { streamToUint8Array } from "@azure-rest/ai-document-intelligence";
+
+  const client = DocumentIntelligence("<DOCUMENT_INTELLIGENCE_ENDPOINT>", {
+    key: "<DOCUMENT_INTELLIGENCE_API_KEY>",
+  });
+
+  // Do analysis on you document and get the resultId, figureId
+
+  // Example for the figures api that provides an image output
+  const output = await client
+    .path(
+      "/documentModels/{modelId}/analyzeResults/{resultId}/figures/{figureId}",
+      "prebuilt-layout",
+      resultId,
+      figureId,
+    )
+    .get()
+    .asNodeStream(); // output.body would be NodeJS.ReadableStream
+
+  if (output.status !== "200" || !output.body) {
+    throw new Error("The response was unexpected, expected NodeJS.ReadableStream in the body.");
+  }
+
+  const imageData = await streamToUint8Array(output.body);
+  fs.promises.writeFile(`./figures/${figureId}.png`, imageData); // Or you can consume the NodeJS.ReadableStream directly
+  ```
+
+- Adds `parseResultIdFromResponse`, a convenience function that extracts the `operationId` from the batch analysis response.
+
+  ```js
+  // Example
+  const initialResponse = await client
+    .path("/documentModels/{modelId}:analyzeBatch", "prebuilt-layout")
+    .post({
+      contentType: "application/json",
+      body: {
+        azureBlobSource: {
+          containerUrl: batchTrainingFilesContainerUrl(),
+        },
+        resultContainerUrl: batchTrainingFilesResultContainerUrl(),
+        resultPrefix: "result",
+      },
+    });
+
+  if (isUnexpected(initialResponse)) {
+    throw initialResponse.body.error;
+  }
+  const batchResultId = parseResultIdFromResponse(initialResponse);
+
+  const response = await client
+    .path(
+      "/documentModels/{modelId}/analyzeBatchResults/{resultId}",
+      "prebuilt-layout",
+      batchResultId,
+    )
+    .get();
+  ```
+
+- Changes the following interfaces as follows:
+
+  - `AnalyzeBatchDocumentsBodyParam`:
+    - Updates `body` to be required.
+  - `AnalyzeBatchOperationOutput`:
+    - Adds `resultId`.
+  - `AnalyzeDocumentBodyParam`:
+    - Changes `body` from optional to required.
+  - `DocumentClassifierDetailsOutput`:
+    - Adds `modifiedDateTime`.
+  - `DocumentModelDetailsOutput`:
+    - Adds `modifiedDateTime`.
+
+- Introduces new interfaces to define query parameters for document analysis requests, allowing customizable `style` and `explode` options:
+  - **AnalyzeBatchDocumentsFeaturesQueryParam**: Accepts DocumentAnalysisFeature[] values.
+  - **AnalyzeBatchDocumentsOutputQueryParam**: Accepts AnalyzeOutputOption[] values.
+  - **AnalyzeBatchDocumentsQueryFieldsQueryParam**: Accepts string[] values.
+  - **AnalyzeDocumentFeaturesQueryParam**: Accepts DocumentAnalysisFeature[] values.
+  - **AnalyzeDocumentFromStreamFeaturesQueryParam**: Accepts DocumentAnalysisFeature[] values.
+
+### Breaking Changes
+
+- Removes the `poller.getOperationId()` for a given polling operation. Use `parseResultIdFromResponse` to extract the `operationId` directly.
+- `getLongRunningPoller` function is not async anymore, do not `await` on it.
+
+### Other Changes
+
+The following types are renamed
+
+- `CopyAuthorization` to `ModelCopyAuthorization`
+- `ErrorResponseOutput` to `DocumentIntelligenceErrorResponseOutput`
+- `ErrorModelOutput` to `DocumentIntelligenceErrorOutput`
+- `InnerErrorOutput` to `DocumentIntelligenceInnerErrorOutput`
+- `WarningOutput` to `DocumentIntelligenceWarningOutput`
+- `ContentFormat` to `DocumentContentFormat`
+- `ContentFormatOutput` to `DocumentContentFormatOutput`
+- `OperationDetailsOutputParent` to `DocumentIntelligenceOperationDetailsOutputParent`
+- `OperationDetailsOutput` to `DocumentIntelligenceOperationDetailsOutput`
+- `OperationStatusOutput` to `DocumentIntelligenceOperationStatusOutput`
+- `ResourceDetailsOutput` to `DocumentIntelligenceResourceDetailsOutput`
+- `PagedOperationDetailsOutput` to `PagedDocumentIntelligenceOperationDetailsOutput`
+- `GetResourceInfo` to `GetResourceDetails`
+- `AnalyzeResultOperationOutput` to `AnalyzeOperationOutput`
+- `FontWeightOutput` to `DocumentFontWeightOutput`
+- `FontStyleOutput` to `DocumentFontStyleOutput`
+- `DocumentOutput` to `AnalyzedDocumentOutput`
+- `CopyAuthorizationOutput` to `ModelCopyAuthorizationOutput`
+
 ## 1.0.0-beta.3 (2024-08-20)
 
 ### Features Added

package/LICENSE

@@ -1,6 +1,6 @@
-The MIT License (MIT)
+Copyright (c) Microsoft Corporation.
 
-Copyright (c) 2024 Microsoft
+MIT License
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -12,10 +12,10 @@ furnished to do so, subject to the following conditions:
 The above copyright notice and this permission notice shall be included in all
 copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+SOFTWARE.

package/README.md

@@ -10,32 +10,28 @@ Key links:
 
 - [Source code](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/documentintelligence/ai-document-intelligence-rest)
 - [Package (NPM)](https://www.npmjs.com/package/@azure-rest/ai-document-intelligence)
-- [API reference documentation](https://docs.microsoft.com/javascript/api/@azure-rest/ai-document-intelligence?view=azure-node-preview)
+- [API reference documentation](https://learn.microsoft.com/javascript/api/@azure-rest/ai-document-intelligence?view=azure-node-preview)
 - [Samples](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/documentintelligence/ai-document-intelligence-rest/samples)
 - [Changelog](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/documentintelligence/ai-document-intelligence-rest/CHANGELOG.md)
 - [Migration Guide from Form Recognizer](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/documentintelligence/ai-document-intelligence-rest/MIGRATION-FR_v4-DI_v1.md)
 
-> This version of the client library defaults to the `"2024-07-31-preview"` version of the service.
+> This version of the client library defaults to the `"2024-11-30"` 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.3 | 2024-07-31-preview               |
-| 1.0.0-beta.2 | 2024-02-29-preview               |
-| 1.0.0-beta.1 | 2023-10-31-preview               |
+| SDK version | Supported API version of service |
+| ----------- | -------------------------------- |
+| 1.0.0       | 2024-11-30                       |
 
 > Please rely on the older `@azure/ai-form-recognizer` library through the older service API versions for retired models, such as `"prebuilt-businessCard"` and `"prebuilt-document"`. For more information, see [Changelog](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/documentintelligence/ai-document-intelligence-rest/CHANGELOG.md).
 
 The below table describes the relationship of each client and its supported API version(s):
 
-| Service API version | Supported clients                                            | Package                                                       |
-| ------------------- | ------------------------------------------------------------ | ------------------------------------------------------------- |
-| 2024-07-31-preview  | DocumentIntelligenceClient                                   | `@azure-rest/ai-document-intelligence` version `1.0.0-beta.3` |
-| 2024-02-29-preview  | DocumentIntelligenceClient                                   | `@azure-rest/ai-document-intelligence` version `1.0.0-beta.2` |
-| 2023-10-31-preview  | DocumentIntelligenceClient                                   | `@azure-rest/ai-document-intelligence` version `1.0.0-beta.1` |
-| 2023-07-31          | DocumentAnalysisClient and DocumentModelAdministrationClient | `@azure/ai-form-recognizer` version `^5.0.0`                  |
-| 2022-08-01          | DocumentAnalysisClient and DocumentModelAdministrationClient | `@azure/ai-form-recognizer` version `^4.0.0`                  |
+| Service API version | Supported clients                                            | Package                                                |
+| ------------------- | ------------------------------------------------------------ | ------------------------------------------------------ |
+| 2024-11-30          | DocumentIntelligenceClient                                   | `@azure-rest/ai-document-intelligence` version `^1.0.0` |
+| 2023-07-31          | DocumentAnalysisClient and DocumentModelAdministrationClient | `@azure/ai-form-recognizer` version `^5.0.0`           |
+| 2022-08-01          | DocumentAnalysisClient and DocumentModelAdministrationClient | `@azure/ai-form-recognizer` version `^4.0.0`           |
 
 ## Getting started
 
@@ -72,8 +68,9 @@ AZURE_CLIENT_ID, AZURE_TENANT_ID, AZURE_CLIENT_SECRET
 
 ### Using a Token Credential
 
-```ts
+```ts snippet:ReadmeSampleCreateClient_TokenCredential
 import DocumentIntelligence from "@azure-rest/ai-document-intelligence";
+import { DefaultAzureCredential } from "@azure/identity";
 
 const client = DocumentIntelligence(
   process.env["DOCUMENT_INTELLIGENCE_ENDPOINT"],
@@ -83,7 +80,7 @@ const client = DocumentIntelligence(
 
 ### Using an API KEY
 
-```ts
+```ts snippet:ReadmeSampleCreateClient_APIKey
 import DocumentIntelligence from "@azure-rest/ai-document-intelligence";
 
 const client = DocumentIntelligence(process.env["DOCUMENT_INTELLIGENCE_ENDPOINT"], {
@@ -91,11 +88,41 @@ const client = DocumentIntelligence(process.env["DOCUMENT_INTELLIGENCE_ENDPOINT"
 });
 ```
 
+### Sovereign Clouds
+
+Connect to alternative Azure cloud environments (such as Azure China or Azure Government) by specifying the `scopes` field in the `credentials` option and use the appropriate value from `KnownDocumentIntelligenceAudience`.
+
+```ts
+import DocumentIntelligence, { KnownDocumentIntelligenceAudience } from "@azure-rest/ai-document-intelligence";
+import { DefaultAzureCredential } from "@azure/identity";
+
+const client = DocumentIntelligence(
+  process.env["DOCUMENT_INTELLIGENCE_ENDPOINT"],
+  new DefaultAzureCredential(),
+  {
+    credentials: {
+      // Use the correct audience for your cloud environment
+      scopes: [KnownDocumentIntelligenceAudience.AzureGovernment]
+    }
+  }
+);
+```
+
+If you do not specify `scopes`, the client will default to the Azure Public Cloud (`https://cognitiveservices.azure.com`).
+
 ## Document Models
 
 ### Analyze prebuilt-layout (urlSource)
 
-```ts
+```ts snippet:ReadmeSampleAnalyzePrebuiltLayoutUrlSource
+import DocumentIntelligence from "@azure-rest/ai-document-intelligence";
+import { DefaultAzureCredential } from "@azure/identity";
+
+const client = DocumentIntelligence(
+  process.env["DOCUMENT_INTELLIGENCE_ENDPOINT"],
+  new DefaultAzureCredential(),
+);
+
 const initialResponse = await client
   .path("/documentModels/{modelId}:analyze", "prebuilt-layout")
   .post({
@@ -110,12 +137,23 @@ const initialResponse = await client
 
 ### Analyze prebuilt-layout (base64Source)
 
-```ts
-import fs from "fs";
-import path from "path";
+```ts snippet:ReadmeSampleAnalyzePrebuiltLayoutBase64Source
+import DocumentIntelligence, {
+  isUnexpected,
+  getLongRunningPoller,
+  AnalyzeOperationOutput,
+} from "@azure-rest/ai-document-intelligence";
+import { DefaultAzureCredential } from "@azure/identity";
+import { join } from "node:path";
+import { readFile } from "node:fs/promises";
+
+const client = DocumentIntelligence(
+  process.env["DOCUMENT_INTELLIGENCE_ENDPOINT"],
+  new DefaultAzureCredential(),
+);
 
-const filePath = path.join(ASSET_PATH, "forms", "Invoice_1.pdf");
-const base64Source = fs.readFileSync(filePath, { encoding: "base64" });
+const filePath = join("./assets", "forms", "Invoice_1.pdf");
+const base64Source = await readFile(filePath, { encoding: "base64" });
 const initialResponse = await client
   .path("/documentModels/{modelId}:analyze", "prebuilt-layout")
   .post({
@@ -125,35 +163,61 @@ const initialResponse = await client
     },
     queryParameters: { locale: "en-IN" },
   });
+
+if (isUnexpected(initialResponse)) {
+  throw initialResponse.body.error;
+}
+
+const poller = getLongRunningPoller(client, initialResponse);
+const result = (await poller.pollUntilDone()).body as AnalyzeOperationOutput;
+console.log(result);
 ```
 
-Continue creating the poller from initial response
+## Batch analysis
 
-```ts
-import {
-  getLongRunningPoller,
-  AnalyzeResultOperationOutput,
+```ts snippet:ReadmeSampleAnalyzeBatch
+import DocumentIntelligence, {
   isUnexpected,
+  parseResultIdFromResponse,
 } from "@azure-rest/ai-document-intelligence";
+import { DefaultAzureCredential } from "@azure/identity";
+
+const client = DocumentIntelligence(
+  process.env["DOCUMENT_INTELLIGENCE_ENDPOINT"],
+  new DefaultAzureCredential(),
+);
+
+// 1. Analyze a batch of documents
+const initialResponse = await client
+  .path("/documentModels/{modelId}:analyzeBatch", "prebuilt-layout")
+  .post({
+    contentType: "application/json",
+    body: {
+      azureBlobSource: {
+        containerUrl: process.env["DOCUMENT_INTELLIGENCE_BATCH_TRAINING_DATA_CONTAINER_SAS_URL"],
+      },
+      resultContainerUrl:
+        process.env["DOCUMENT_INTELLIGENCE_BATCH_TRAINING_DATA_RESULT_CONTAINER_SAS_URL"],
+      resultPrefix: "result",
+    },
+  });
 
 if (isUnexpected(initialResponse)) {
   throw initialResponse.body.error;
 }
-const poller = await getLongRunningPoller(client, initialResponse);
-const result = (await poller.pollUntilDone()).body as AnalyzeResultOperationOutput;
-console.log(result);
-// {
-//   status: 'succeeded',
-//   createdDateTime: '2023-11-10T13:31:31Z',
-//   lastUpdatedDateTime: '2023-11-10T13:31:34Z',
-//   analyzeResult: {
-//     apiVersion: '2023-10-31-preview',
-//     .
-//     .
-//     .
-//     contentFormat: 'text'
-//   }
-// }
+
+const resultId = parseResultIdFromResponse(initialResponse);
+console.log("resultId: ", resultId);
+
+// (Optional) You can poll for the batch analysis result but be aware that a job may take unexpectedly long time, and polling could incur additional costs.
+// const poller = getLongRunningPoller(client, initialResponse);
+// await poller.pollUntilDone();
+
+// 2. At a later time, you can retrieve the operation result using the resultId
+const output = await client
+  .path("/documentModels/{modelId}/analyzeResults/{resultId}", "prebuilt-layout", resultId)
+  .get();
+console.log(output);
 ```
 
 ### Markdown content format
@@ -162,11 +226,14 @@ Supports output with Markdown content format along with the default plain _text_
 
 Service follows the GFM spec ([GitHub Flavored Markdown](https://github.github.com/gfm/)) for the Markdown format. Also introduces a new _contentFormat_ property with value "text" or "markdown" to indicate the result content format.
 
-```ts
+```ts snippet:ReadmeSampleAnalyzeMarkdownContentFormat
 import DocumentIntelligence from "@azure-rest/ai-document-intelligence";
-const client = DocumentIntelligence(process.env["DOCUMENT_INTELLIGENCE_ENDPOINT"], {
-  key: process.env["DOCUMENT_INTELLIGENCE_API_KEY"],
-});
+import { DefaultAzureCredential } from "@azure/identity";
+
+const client = DocumentIntelligence(
+  process.env["DOCUMENT_INTELLIGENCE_ENDPOINT"],
+  new DefaultAzureCredential(),
+);
 
 const initialResponse = await client
   .path("/documentModels/{modelId}:analyze", "prebuilt-layout")
@@ -184,7 +251,15 @@ const initialResponse = await client
 
 When this feature flag is specified, the service will further extract the values of the fields specified via the queryFields query parameter to supplement any existing fields defined by the model as fallback.
 
-```ts
+```ts snippet:ReadmeSampleAnalyzeQueryFields
+import DocumentIntelligence from "@azure-rest/ai-document-intelligence";
+import { DefaultAzureCredential } from "@azure/identity";
+
+const client = DocumentIntelligence(
+  process.env["DOCUMENT_INTELLIGENCE_ENDPOINT"],
+  new DefaultAzureCredential(),
+);
+
 await client.path("/documentModels/{modelId}:analyze", "prebuilt-layout").post({
   contentType: "application/json",
   body: { urlSource: "..." },
@@ -215,18 +290,24 @@ To enable a wider set of scenarios, service introduces a "split" query parameter
 
 ## Document Classifiers #Build
 
-```ts
-import {
-  DocumentClassifierBuildOperationDetailsOutput,
-  getLongRunningPoller,
+```ts snippet:ReadmeSampleDocumentClassifierBuild
+import DocumentIntelligence, {
   isUnexpected,
+  getLongRunningPoller,
+  DocumentClassifierBuildOperationDetailsOutput,
 } from "@azure-rest/ai-document-intelligence";
+import { DefaultAzureCredential } from "@azure/identity";
+
+const client = DocumentIntelligence(
+  process.env["DOCUMENT_INTELLIGENCE_ENDPOINT"],
+  new DefaultAzureCredential(),
+);
 
 const containerSasUrl = (): string =>
   process.env["DOCUMENT_INTELLIGENCE_TRAINING_CONTAINER_SAS_URL"];
 const initialResponse = await client.path("/documentClassifiers:build").post({
   body: {
-    classifierId: `customClassifier${getRandomNumber()}`,
+    classifierId: `customClassifier-12345`,
     description: "Custom classifier description",
     docTypes: {
       foo: {
@@ -246,48 +327,166 @@ const initialResponse = await client.path("/documentClassifiers:build").post({
 if (isUnexpected(initialResponse)) {
   throw initialResponse.body.error;
 }
-const poller = await getLongRunningPoller(client, initialResponse);
+
+const poller = getLongRunningPoller(client, initialResponse);
 const response = (await poller.pollUntilDone())
   .body as DocumentClassifierBuildOperationDetailsOutput;
 console.log(response);
-//  {
-//    operationId: '31466834048_f3ee629e-73fb-48ab-993b-1d55d73ca460',
-//    kind: 'documentClassifierBuild',
-//    status: 'succeeded',
-//    .
-//    .
-//    result: {
-//      classifierId: 'customClassifier10978',
-//      createdDateTime: '2023-11-09T12:45:56Z',
-//      .
-//      .
-//      description: 'Custom classifier description'
-//    },
-//    apiVersion: '2023-10-31-preview'
-//  }
+```
+
+## Get the generated PDF output from document analysis
+
+```ts snippet:ReadmeSampleGetPdfOutput
+import DocumentIntelligence, {
+  isUnexpected,
+  getLongRunningPoller,
+  parseResultIdFromResponse,
+  streamToUint8Array,
+} from "@azure-rest/ai-document-intelligence";
+import { DefaultAzureCredential } from "@azure/identity";
+import { join } from "node:path";
+import { readFile, writeFile } from "node:fs/promises";
+
+const client = DocumentIntelligence(
+  process.env["DOCUMENT_INTELLIGENCE_ENDPOINT"],
+  new DefaultAzureCredential(),
+);
+
+const filePath = join("./assets", "layout-pageobject.pdf");
+
+const base64Source = await readFile(filePath, { encoding: "base64" });
+
+const initialResponse = await client
+  .path("/documentModels/{modelId}:analyze", "prebuilt-read")
+  .post({
+    contentType: "application/json",
+    body: {
+      base64Source,
+    },
+    queryParameters: { output: ["pdf"] },
+  });
+
+if (isUnexpected(initialResponse)) {
+  throw initialResponse.body.error;
+}
+
+const poller = getLongRunningPoller(client, initialResponse);
+
+await poller.pollUntilDone();
+
+const output = await client
+  .path(
+    "/documentModels/{modelId}/analyzeResults/{resultId}/pdf",
+    "prebuilt-read",
+    parseResultIdFromResponse(initialResponse),
+  )
+  .get()
+  .asNodeStream(); // output.body would be NodeJS.ReadableStream
+
+if (output.status !== "200" || !output.body) {
+  throw new Error("The response was unexpected, expected NodeJS.ReadableStream in the body.");
+}
+
+const pdfData = await streamToUint8Array(output.body);
+await writeFile(`./output.pdf`, pdfData);
+```
+
+## Get the generated cropped image of specified figure from document analysis
+
+```ts snippet:ReadmeSampleGetFigureImage
+import DocumentIntelligence, {
+  isUnexpected,
+  getLongRunningPoller,
+  AnalyzeOperationOutput,
+  parseResultIdFromResponse,
+  streamToUint8Array,
+} from "@azure-rest/ai-document-intelligence";
+import { DefaultAzureCredential } from "@azure/identity";
+import { join } from "node:path";
+import { readFile, writeFile } from "node:fs/promises";
+
+const client = DocumentIntelligence(
+  process.env["DOCUMENT_INTELLIGENCE_ENDPOINT"],
+  new DefaultAzureCredential(),
+);
+
+const filePath = join("./assets", "layout-pageobject.pdf");
+
+const base64Source = await readFile(filePath, { encoding: "base64" });
+
+const initialResponse = await client
+  .path("/documentModels/{modelId}:analyze", "prebuilt-layout")
+  .post({
+    contentType: "application/json",
+    body: {
+      base64Source,
+    },
+    queryParameters: { output: ["figures"] },
+  });
+
+if (isUnexpected(initialResponse)) {
+  throw initialResponse.body.error;
+}
+
+const poller = getLongRunningPoller(client, initialResponse);
+
+const result = (await poller.pollUntilDone()).body as AnalyzeOperationOutput;
+const figures = result.analyzeResult?.figures;
+const figureId = figures?.[0].id || "";
+
+const output = await client
+  .path(
+    "/documentModels/{modelId}/analyzeResults/{resultId}/figures/{figureId}",
+    "prebuilt-layout",
+    parseResultIdFromResponse(initialResponse),
+    figureId,
+  )
+  .get()
+  .asNodeStream(); // output.body would be NodeJS.ReadableStream
+
+if (output.status !== "200" || !output.body) {
+  throw new Error("The response was unexpected, expected NodeJS.ReadableStream in the body.");
+}
+
+const imageData = await streamToUint8Array(output.body);
+await writeFile(`./figures/${figureId}.png`, imageData);
 ```
 
 ## Get Info
 
-```ts
+```ts snippet:ReadmeSampleGetInfo
+import DocumentIntelligence, { isUnexpected } from "@azure-rest/ai-document-intelligence";
+import { DefaultAzureCredential } from "@azure/identity";
+
+const client = DocumentIntelligence(
+  process.env["DOCUMENT_INTELLIGENCE_ENDPOINT"],
+  new DefaultAzureCredential(),
+);
+
 const response = await client.path("/info").get();
 if (isUnexpected(response)) {
   throw response.body.error;
 }
+
 console.log(response.body.customDocumentModels.limit);
-// 20000
 ```
 
 ## List Document Models
 
-```ts
-import { paginate } from "@azure-rest/ai-document-intelligence";
+```ts snippet:ReadmeSampleListDocumentModels
+import DocumentIntelligence, { isUnexpected, paginate } from "@azure-rest/ai-document-intelligence";
+import { DefaultAzureCredential } from "@azure/identity";
+
+const client = DocumentIntelligence(
+  process.env["DOCUMENT_INTELLIGENCE_ENDPOINT"],
+  new DefaultAzureCredential(),
+);
+
 const response = await client.path("/documentModels").get();
 if (isUnexpected(response)) {
   throw response.body.error;
 }
 
-const modelsInAccount: string[] = [];
 for await (const model of paginate(client, response)) {
   console.log(model.modelId);
 }
@@ -299,8 +498,8 @@ for await (const model of paginate(client, response)) {
 
 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
-const { setLogLevel } = require("@azure/logger");
+```ts snippet:SetLogLevel
+import { setLogLevel } from "@azure/logger";
 
 setLogLevel("info");
 ```

package/dist/browser/audience.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Defines the known cloud audiences for Document Intelligence.
+ *
+ * To authenticate with Entra Id (using a `TokenCredential`) in a [Sovereign Cloud](https://learn.microsoft.com/en-us/entra/identity-platform/authentication-national-cloud)
+ * environment, provide the appropriate value below as the `audience` option when creating a
+ * `Document Intelligence` client.
+ *
+ * The default value is suitable for Document Intelligence resources created in the Azure Public Cloud, so this value
+ * is only required to use Document Intelligence in a different cloud environment.
+ */
+export declare enum KnownDocumentIntelligenceAudience {
+    /** Azure China */
+    AzureChina = "https://cognitiveservices.azure.cn",
+    /** Azure Government */
+    AzureGovernment = "https://cognitiveservices.azure.us",
+    /** Azure Public Cloud */
+    AzurePublicCloud = "https://cognitiveservices.azure.com"
+}
+//# sourceMappingURL=audience.d.ts.map

package/dist/browser/audience.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"audience.d.ts","sourceRoot":"","sources":["../../src/audience.ts"],"names":[],"mappings":"AAGA;;;;;;;;;GASG;AACH,oBAAY,iCAAiC;IAC3C,kBAAkB;IAClB,UAAU,uCAAuC;IACjD,uBAAuB;IACvB,eAAe,uCAAuC;IACtD,yBAAyB;IACzB,gBAAgB,wCAAwC;CACzD"}