@azure-rest/ai-document-intelligence 1.0.0-alpha.20250130.1 → 1.0.0-alpha.20250203.1

package/README.md

@@ -68,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"],
@@ -79,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,7 +92,15 @@ const client = DocumentIntelligence(process.env["DOCUMENT_INTELLIGENCE_ENDPOINT"
 
 ### 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({
@@ -106,12 +115,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 filePath = path.join(ASSET_PATH, "forms", "Invoice_1.pdf");
-const base64Source = fs.readFileSync(filePath, { encoding: "base64" });
+const client = DocumentIntelligence(
+  process.env["DOCUMENT_INTELLIGENCE_ENDPOINT"],
+  new DefaultAzureCredential(),
+);
+
+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({
@@ -121,41 +141,29 @@ const initialResponse = await client
     },
     queryParameters: { locale: "en-IN" },
   });
-```
-
-Continue creating the poller from initial response
-
-```ts
-import {
-  getLongRunningPoller,
-  AnalyzeOperationOutput,
-  isUnexpected,
-} from "@azure-rest/ai-document-intelligence";
 
 if (isUnexpected(initialResponse)) {
   throw initialResponse.body.error;
 }
+
 const poller = getLongRunningPoller(client, initialResponse);
 const result = (await poller.pollUntilDone()).body as AnalyzeOperationOutput;
 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'
-//   }
-// }
 ```
 
 ## Batch analysis
 
-```ts
-import { parseResultIdFromResponse, isUnexpected } from "@azure-rest/ai-document-intelligence";
+```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
@@ -164,9 +172,10 @@ const initialResponse = await client
     contentType: "application/json",
     body: {
       azureBlobSource: {
-        containerUrl: batchTrainingFilesContainerUrl(),
+        containerUrl: process.env["DOCUMENT_INTELLIGENCE_BATCH_TRAINING_DATA_CONTAINER_SAS_URL"],
       },
-      resultContainerUrl: batchTrainingFilesResultContainerUrl(),
+      resultContainerUrl:
+        process.env["DOCUMENT_INTELLIGENCE_BATCH_TRAINING_DATA_RESULT_CONTAINER_SAS_URL"],
       resultPrefix: "result",
     },
   });
@@ -174,6 +183,7 @@ const initialResponse = await client
 if (isUnexpected(initialResponse)) {
   throw initialResponse.body.error;
 }
+
 const resultId = parseResultIdFromResponse(initialResponse);
 console.log("resultId: ", resultId);
 
@@ -194,11 +204,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")
@@ -216,7 +229,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: "..." },
@@ -247,18 +268,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: {
@@ -278,33 +305,34 @@ const initialResponse = await client.path("/documentClassifiers:build").post({
 if (isUnexpected(initialResponse)) {
   throw initialResponse.body.error;
 }
+
 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
-const filePath = path.join(ASSET_PATH, "layout-pageobject.pdf");
+```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 base64Source = await fs.readFile(filePath, { encoding: "base64" });
+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")
@@ -338,16 +366,31 @@ if (output.status !== "200" || !output.body) {
 }
 
 const pdfData = await streamToUint8Array(output.body);
-fs.promises.writeFile(`./output.pdf`, pdfData);
-// Or you can consume the NodeJS.ReadableStream directly
+await writeFile(`./output.pdf`, pdfData);
 ```
 
 ## Get the generated cropped image of specified figure from document analysis
 
-```ts
-const filePath = path.join(ASSET_PATH, "layout-pageobject.pdf");
+```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 base64Source = fs.readFileSync(filePath, { encoding: "base64" });
+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")
@@ -363,14 +406,11 @@ if (isUnexpected(initialResponse)) {
   throw initialResponse.body.error;
 }
 
-const poller = getLongRunningPoller(client, initialResponse, { ...testPollingOptions });
+const poller = getLongRunningPoller(client, initialResponse);
 
 const result = (await poller.pollUntilDone()).body as AnalyzeOperationOutput;
 const figures = result.analyzeResult?.figures;
-assert.isArray(figures);
-assert.isNotEmpty(figures?.[0]);
 const figureId = figures?.[0].id || "";
-assert.isDefined(figureId);
 
 const output = await client
   .path(
@@ -387,31 +427,44 @@ if (output.status !== "200" || !output.body) {
 }
 
 const imageData = await streamToUint8Array(output.body);
-fs.promises.writeFile(`./figures/${figureId}.png`, imageData);
-// Or you can consume the NodeJS.ReadableStream directly
+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);
 }
@@ -423,8 +476,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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@azure-rest/ai-document-intelligence",
-  "version": "1.0.0-alpha.20250130.1",
+  "version": "1.0.0-alpha.20250203.1",
   "description": "Document Intelligence Rest Client",
   "engines": {
     "node": ">=18.0.0"
@@ -8,7 +8,7 @@
   "sideEffects": false,
   "autoPublish": false,
   "tshy": {
-    "project": "tsconfig.src.json",
+    "project": "./tsconfig.src.json",
     "exports": {
       "./package.json": "./package.json",
       ".": "./src/index.ts"
@@ -33,11 +33,9 @@
   "author": "Microsoft Corporation",
   "license": "MIT",
   "files": [
-    "dist",
+    "dist/",
     "README.md",
-    "LICENSE",
-    "review/*",
-    "CHANGELOG.md"
+    "LICENSE"
   ],
   "sdk-type": "client",
   "repository": "github:Azure/azure-sdk-for-js",
@@ -57,51 +55,52 @@
   "dependencies": {
     "@azure-rest/core-client": "^2.3.1",
     "@azure/core-auth": "^1.9.0",
-    "@azure/core-rest-pipeline": "^1.18.1",
+    "@azure/core-lro": "^3.1.0",
+    "@azure/core-rest-pipeline": "^1.18.2",
     "@azure/logger": "^1.1.4",
-    "tslib": "^2.8.1",
-    "@azure/core-lro": "^3.1.0"
+    "tslib": "^2.8.1"
   },
   "devDependencies": {
+    "@azure-tools/test-credential": "^2.0.0",
+    "@azure-tools/test-recorder": ">=4.1.0-alpha <4.1.0-alphb",
+    "@azure-tools/test-utils-vitest": ">=1.0.0-alpha <1.0.0-alphb",
     "@azure/abort-controller": "^2.1.2",
-    "dotenv": "^16.0.0",
+    "@azure/dev-tool": ">=1.0.0-alpha <1.0.0-alphb",
+    "@azure/eslint-plugin-azure-sdk": ">=3.0.0-alpha <3.0.0-alphb",
+    "@azure/identity": "^4.6.0",
     "@types/node": "^18.0.0",
-    "eslint": "^9.9.0",
-    "typescript": "~5.7.2",
-    "@azure/identity": "^4.2.1",
     "@vitest/browser": "^3.0.3",
     "@vitest/coverage-istanbul": "^3.0.3",
-    "playwright": "^1.41.2",
-    "vitest": "^3.0.3",
-    "@azure-tools/test-credential": "^2.0.0",
-    "@azure-tools/test-recorder": "^4.0.0",
-    "@azure/dev-tool": ">=1.0.0-alpha <1.0.0-alphb",
-    "@azure/eslint-plugin-azure-sdk": ">=3.0.0-alpha <3.0.0-alphb"
+    "dotenv": "^16.0.0",
+    "eslint": "^9.9.0",
+    "playwright": "^1.50.1",
+    "typescript": "~5.7.2",
+    "vitest": "^3.0.3"
   },
   "scripts": {
-    "clean": "dev-tool run vendored rimraf --glob dist dist-browser dist-esm test-dist temp types *.tgz",
-    "extract-api": "dev-tool run vendored rimraf review && dev-tool run extract-api",
-    "pack": "npm pack 2>&1",
-    "lint": "eslint package.json api-extractor.json src test",
-    "lint:fix": "eslint package.json api-extractor.json src test --fix --fix-type [problem,suggestion]",
-    "unit-test": "npm run unit-test:node && npm run unit-test:browser",
-    "unit-test:browser": "echo skipped",
-    "unit-test:node": "dev-tool run test:vitest --test-proxy-debug",
-    "integration-test": "npm run integration-test:node && npm run integration-test:browser",
-    "integration-test:browser": "echo skipped",
-    "integration-test:node": "dev-tool run test:vitest --esm",
+    "build": "npm run clean && dev-tool run build-package && dev-tool run extract-api",
     "build:samples": "echo skipped",
+    "build:test": "npm run clean && dev-tool run build-package && dev-tool run build-test",
     "check-format": "dev-tool run vendored prettier --list-different --config ../../../.prettierrc.json --ignore-path ../../../.prettierignore \"src/**/*.{ts,cts,mts}\" \"test/**/*.{ts,cts,mts}\" \"*.{js,cjs,mjs,json}\" ",
+    "clean": "dev-tool run vendored rimraf --glob dist dist-browser dist-esm test-dist temp types *.tgz",
     "execute:samples": "echo skipped",
+    "extract-api": "dev-tool run vendored rimraf review && dev-tool run extract-api",
     "format": "dev-tool run vendored prettier --write --config ../../../.prettierrc.json --ignore-path ../../../.prettierignore \"src/**/*.{ts,cts,mts}\" \"test/**/*.{ts,cts,mts}\" \"samples-dev/*.{ts,cts,mts}\" \"*.{js,cjs,mjs,json}\" ",
     "generate:client": "echo skipped",
-    "test:browser": "npm run clean && npm run build:test && npm run unit-test:browser && npm run integration-test:browser",
+    "integration-test": "npm run integration-test:node && npm run integration-test:browser",
+    "integration-test:browser": "echo skipped",
+    "integration-test:node": "dev-tool run test:vitest --esm",
+    "lint": "eslint package.json api-extractor.json src test",
+    "lint:fix": "eslint package.json api-extractor.json src test --fix --fix-type [problem,suggestion]",
     "minify": "dev-tool run vendored uglifyjs -c -m --comments --source-map \"content='./dist/index.js.map'\" -o ./dist/index.min.js ./dist/index.js",
-    "build:test": "npm run clean && dev-tool run build-package && dev-tool run build-test",
-    "build": "npm run clean && dev-tool run build-package && dev-tool run extract-api",
-    "test:node": "npm run clean && dev-tool run build-package && npm run unit-test:node && npm run integration-test:node",
+    "pack": "npm pack 2>&1",
     "test": "npm run clean && dev-tool run build-package && npm run unit-test:node && dev-tool run bundle && npm run unit-test:browser && npm run integration-test",
-    "update-snippets": "echo skipped"
+    "test:browser": "npm run clean && npm run build:test && npm run unit-test:browser && npm run integration-test:browser",
+    "test:node": "npm run clean && dev-tool run build-package && npm run unit-test:node && npm run integration-test:node",
+    "unit-test": "npm run unit-test:node && npm run unit-test:browser",
+    "unit-test:browser": "echo skipped",
+    "unit-test:node": "dev-tool run test:vitest",
+    "update-snippets": "dev-tool run update-snippets"
   },
   "exports": {
     "./package.json": "./package.json",
@@ -135,5 +134,7 @@
       "ai-document-intelligence"
     ],
     "disableDocsMs": true
-  }
+  },
+  "browser": "./dist/browser/index.js",
+  "react-native": "./dist/react-native/index.js"
 }