[Document Intelligence] Typespec Generated Code

.vscode/cspell.json

@@ -451,6 +451,14 @@
         "Whois",
         "whois"
       ]
+    },
+    {
+      "filename": "sdk/documentintelligence/ai-document-intelligence-rest/review/ai-document-intelligence.api.md",
+      "words": [
+        "wordprocessingml",
+        "spreadsheetml",
+        "presentationml"
+      ]
     }
   ]
 }

rush.json

@@ -310,6 +310,11 @@
       "projectFolder": "sdk/agrifood/agrifood-farming-rest",
       "versionPolicyName": "client"
     },
+    {
+      "packageName": "@azure-rest/ai-document-intelligence",
+      "projectFolder": "sdk/documentintelligence/ai-document-intelligence-rest",
+      "versionPolicyName": "client"
+    },
     {
       "packageName": "@azure-rest/purview-administration",
       "projectFolder": "sdk/purview/purview-administration-rest",

sdk/documentintelligence/ai-document-intelligence-rest/.eslintrc.json

@@ -0,0 +1,11 @@
+{
+  "plugins": ["@azure/azure-sdk"],
+  "extends": ["plugin:@azure/azure-sdk/azure-sdk-base"],
+  "rules": {
+    "@azure/azure-sdk/ts-modules-only-named": "warn",
+    "@azure/azure-sdk/ts-apiextractor-json-types": "warn",
+    "@azure/azure-sdk/ts-package-json-types": "warn",
+    "@azure/azure-sdk/ts-package-json-engine-is-present": "warn",
+    "tsdoc/syntax": "warn"
+  }
+}

sdk/documentintelligence/ai-document-intelligence-rest/CHANGELOG.md

@@ -0,0 +1,8 @@
+# Release History
+
+## 1.0.0-beta.1 (2023-11-16)
+
+### Features Added
+
+This marks the first preview of `@azure-rest/ai-document-intelligence` Rest Level Client Library for the Azure AI Document Intelligence service (formerly known as Form Recognizer).
+Please refer to the [Readme](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/documentintelligence/ai-document-intelligence-rest/README.md) and samples for more details.

sdk/documentintelligence/ai-document-intelligence-rest/README.md

@@ -0,0 +1,224 @@
+# Azure DocumentIntelligence (formerly FormRecognizer) REST client library for JavaScript
+
+Extracts content, layout, and structured data from documents.
+
+**Please rely heavily on our [REST client docs](https://github.com/Azure/azure-sdk-for-js/blob/main/documentation/rest-clients.md) to use this library**
+
+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)
+- [Samples](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/documentintelligence/ai-document-intelligence-rest/samples)
+
+## Getting started
+
+### Currently supported environments
+
+- LTS versions of Node.js
+
+### Prerequisites
+
+- You must have an [Azure subscription](https://azure.microsoft.com/free/) to use this package.
+
+### Install the `@azure-rest/ai-document-intelligence` package
+
+Install the Azure DocumentIntelligence(formerlyFormRecognizer) REST client REST client library for JavaScript with `npm`:
+
+```bash
+npm install @azure-rest/ai-document-intelligence
+```
+
+### Create and authenticate a `DocumentIntelligenceClient`
+
+To use an [Azure Active Directory (AAD) token credential](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/identity/identity/samples/AzureIdentityExamples.md#authenticating-with-a-pre-fetched-access-token),
+provide an instance of the desired credential type obtained from the
+[@azure/identity](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity#credentials) library.
+
+To authenticate with AAD, you must first `npm` install [`@azure/identity`](https://www.npmjs.com/package/@azure/identity)
+
+After setup, you can choose which type of [credential](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity#credentials) from `@azure/identity` to use.
+As an example, [DefaultAzureCredential](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity#defaultazurecredential)
+can be used to authenticate the client.
+
+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
+
+### Using a Token Credential
+
+```ts
+import DocumentIntelligence from "@azure-rest/ai-document-intelligence";
+
+const client = DocumentIntelligence(
+  process.env["DOCUMENT_INTELLIGENCE_ENDPOINT"],
+  new DefaultAzureCredential()
+);
+```
+
+### Using an API KEY
+
+```ts
+import DocumentIntelligence from "@azure-rest/ai-document-intelligence";
+
+const client = DocumentIntelligence(process.env["DOCUMENT_INTELLIGENCE_ENDPOINT"], {
+  key: process.env["DOCUMENT_INTELLIGENCE_API_KEY"],
+});
+```
+
+## Get Info
+
+```ts
+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";
+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);
+}
+```
+
+## Document Models
+
+### Analyze prebuilt-layout (urlSource)
+
+```ts
+const initialResponse = await client
+  .path("/documentModels/{modelId}:analyze", "prebuilt-layout")
+  .post({
+    contentType: "application/json",
+    body: {
+      urlSource:
+        "https://raw.githubusercontent.com/Azure/azure-sdk-for-js/6704eff082aaaf2d97c1371a28461f512f8d748a/sdk/formrecognizer/ai-form-recognizer/assets/forms/Invoice_1.pdf",
+    },
+    queryParameters: { locale: "en-IN" },
+  });
+```
+
+### Analyze prebuilt-layout (base64Source)
+
+```ts
+import fs from "fs";
+import path from "path";
+
+const filePath = path.join(ASSET_PATH, "forms", "Invoice_1.pdf");
+const base64Source = fs.readFileSync(filePath, { encoding: "base64" });
+const initialResponse = await client
+  .path("/documentModels/{modelId}:analyze", "prebuilt-layout")
+  .post({
+    contentType: "application/json",
+    body: {
+      base64Source,
+    },
+    queryParameters: { locale: "en-IN" },
+  });
+```
+
+Continue creating the poller from initial response
+
+```ts
+import {
+  getLongRunningPoller,
+  AnalyzeResultOperationOutput,
+  isUnexpected,
+} from "@azure-rest/ai-document-intelligence";
+
+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'
+//   }
+// }
+```
+
+## Document Classifiers #Build
+
+```ts
+import {
+  DocumentClassifierBuildOperationDetailsOutput,
+  getLongRunningPoller,
+  isUnexpected,
+} from "@azure-rest/ai-document-intelligence";
+
+const containerSasUrl = (): string =>
+  process.env["DOCUMENT_INTELLIGENCE_TRAINING_CONTAINER_SAS_URL"];
+const initialResponse = await client.path("/documentClassifiers:build").post({
+  body: {
+    classifierId: `customClassifier${getRandomNumber()}`,
+    description: "Custom classifier description",
+    docTypes: {
+      foo: {
+        azureBlobSource: {
+          containerUrl: containerSasUrl(),
+        },
+      },
+      bar: {
+        azureBlobSource: {
+          containerUrl: containerSasUrl(),
+        },
+      },
+    },
+  },
+});
+
+if (isUnexpected(initialResponse)) {
+  throw initialResponse.body.error;
+}
+const poller = await 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'
+//  }
+```
+
+## Troubleshooting
+
+### Logging
+
+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");
+
+setLogLevel("info");
+```
+
+For more detailed instructions on how to enable logs, you can look at the [@azure/logger package docs](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/core/logger).