@azure/ai-form-recognizer 5.0.0-alpha.20250227.1 → 5.0.0-alpha.20250303.1

package/dist/commonjs/documentModelAdministrationClient.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"documentModelAdministrationClient.d.ts","sourceRoot":"","sources":["../../src/documentModelAdministrationClient.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,aAAa,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AACvE,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,oBAAoB,CAAC;AAIrE,OAAO,KAAK,EACV,iBAAiB,EAEjB,eAAe,EACf,oBAAoB,EACpB,oBAAoB,EACpB,gBAAgB,EAChB,gBAAgB,EAChB,yBAAyB,EAC1B,MAAM,sBAAsB,CAAC;AAE9B,OAAO,KAAK,EAGV,mBAAmB,EAGnB,wBAAwB,EAEzB,MAAM,yBAAyB,CAAC;AAIjC,OAAO,KAAK,EACV,qBAAqB,EACrB,0BAA0B,EAC1B,wCAAwC,EACxC,2BAA2B,EAC3B,yBAAyB,EACzB,eAAe,EACf,mBAAmB,EACnB,iBAAiB,EACjB,qBAAqB,EAEtB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,KAAK,EAAE,mCAAmC,EAAE,MAAM,6CAA6C,CAAC;AACvG,OAAO,KAAK,EACV,8BAA8B,EAC9B,gCAAgC,EAChC,sBAAsB,EACvB,MAAM,gCAAgC,CAAC;AAExC,OAAO,KAAK,EAAyB,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAClF,OAAO,KAAK,EACV,mBAAmB,EACnB,qCAAqC,EAEtC,MAAM,mBAAmB,CAAC;AAE3B;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,qBAAa,iCAAiC;IAC5C,OAAO,CAAC,WAAW,CAAkB;IACrC,OAAO,CAAC,QAAQ,CAAgB;IAEhC;;;;;;;;;;;;;;;;;;;;;OAqBG;gBAED,QAAQ,EAAE,MAAM,EAChB,UAAU,EAAE,eAAe,EAC3B,OAAO,CAAC,EAAE,wCAAwC;IAEpD;;;;;;;;;;;;;;;;;;OAkBG;gBAED,QAAQ,EAAE,MAAM,EAChB,UAAU,EAAE,aAAa,EACzB,OAAO,CAAC,EAAE,wCAAwC;IAEpD;;OAEG;gBAED,QAAQ,EAAE,MAAM,EAChB,UAAU,EAAE,aAAa,GAAG,eAAe,EAC3C,OAAO,CAAC,EAAE,wCAAwC;IAiBpD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyCG;IACU,uBAAuB,CAClC,OAAO,EAAE,MAAM,EACf,YAAY,EAAE,MAAM,EACpB,SAAS,EAAE,sBAAsB,EACjC,OAAO,CAAC,EAAE,8BAA8B,GACvC,OAAO,CAAC,mBAAmB,CAAC;IAE/B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACU,uBAAuB,CAClC,OAAO,EAAE,MAAM,EACf,aAAa,EAAE,mBAAmB,EAClC,SAAS,EAAE,sBAAsB,EACjC,OAAO,CAAC,EAAE,8BAA8B,GACvC,OAAO,CAAC,mBAAmB,CAAC;IAwC/B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsCG;IACU,yBAAyB,CACpC,OAAO,EAAE,MAAM,EACf,iBAAiB,EAAE,QAAQ,CAAC,MAAM,CAAC,EACnC,OAAO,GAAE,gCAAqC,GAC7C,OAAO,CAAC,mBAAmB,CAAC;IA0B/B;;;;;;;;;;;;;;;;;OAiBG;IACU,oBAAoB,CAC/B,kBAAkB,EAAE,MAAM,EAC1B,OAAO,GAAE,2BAAgC,GACxC,OAAO,CAAC,iBAAiB,CAAC;IAgB7B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoCG;IACU,gBAAgB,CAC3B,aAAa,EAAE,MAAM,EACrB,aAAa,EAAE,iBAAiB,EAEhC,OAAO,GAAE,qBAA0B,GAClC,OAAO,CAAC,mBAAmB,CAAC;IAiB/B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiEG;IACU,4BAA4B,CACvC,YAAY,EAAE,MAAM,EACpB,cAAc,EAAE,qCAAqC,EACrD,OAAO,GAAE,mCAAwC,GAChD,OAAO,CAAC,wBAAwB,CAAC;IAsBpC;;;;;;;OAOG;YACW,0BAA0B;IAyIxC;;;;;;;;;;;;;;;;;;;OAmBG;IACI,kBAAkB,CAAC,OAAO,GAAE,yBAA8B,GAAG,OAAO,CAAC,eAAe,CAAC;IAQ5F;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyCG;IACI,gBAAgB,CACrB,OAAO,EAAE,MAAM,EAEf,OAAO,GAAE,eAAoB,GAC5B,OAAO,CAAC,oBAAoB,CAAC;IAQhC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsDG;IACI,kBAAkB,CAEvB,OAAO,GAAE,iBAAsB,GAC9B,0BAA0B,CAAC,oBAAoB,CAAC;IAInD;;;;;;;;;;;OAWG;IACI,mBAAmB,CACxB,OAAO,EAAE,MAAM,EACf,OAAO,GAAE,0BAA+B,GACvC,OAAO,CAAC,IAAI,CAAC;IAYhB;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACI,qBAAqB,CAC1B,YAAY,EAAE,MAAM,EACpB,OAAO,GAAE,gBAAqB,GAC7B,OAAO,CAAC,yBAAyB,CAAC;IASrC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACI,uBAAuB,CAE5B,OAAO,GAAE,iBAAsB,GAC9B,0BAA0B,CAAC,yBAAyB,CAAC;IAIxD;;;;;;;;;;;OAWG;IACI,wBAAwB,CAC7B,YAAY,EAAE,MAAM,EACpB,OAAO,GAAE,gBAAqB,GAC7B,OAAO,CAAC,IAAI,CAAC;IAahB;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACI,YAAY,CACjB,WAAW,EAAE,MAAM,EACnB,OAAO,GAAE,mBAAwB,GAChC,OAAO,CAAC,gBAAgB,CAAC;IAQ5B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsCG;IACI,cAAc,CACnB,OAAO,GAAE,qBAA0B,GAClC,0BAA0B,CAAC,gBAAgB,CAAC;CAKhD"}
+{"version":3,"file":"documentModelAdministrationClient.d.ts","sourceRoot":"","sources":["../../src/documentModelAdministrationClient.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,aAAa,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AACvE,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,oBAAoB,CAAC;AAIrE,OAAO,KAAK,EACV,iBAAiB,EAEjB,eAAe,EACf,oBAAoB,EACpB,oBAAoB,EACpB,gBAAgB,EAChB,gBAAgB,EAChB,yBAAyB,EAC1B,MAAM,sBAAsB,CAAC;AAE9B,OAAO,KAAK,EAGV,mBAAmB,EAGnB,wBAAwB,EAEzB,MAAM,yBAAyB,CAAC;AAIjC,OAAO,KAAK,EACV,qBAAqB,EACrB,0BAA0B,EAC1B,wCAAwC,EACxC,2BAA2B,EAC3B,yBAAyB,EACzB,eAAe,EACf,mBAAmB,EACnB,iBAAiB,EACjB,qBAAqB,EAEtB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,KAAK,EAAE,mCAAmC,EAAE,MAAM,6CAA6C,CAAC;AACvG,OAAO,KAAK,EACV,8BAA8B,EAC9B,gCAAgC,EAChC,sBAAsB,EACvB,MAAM,gCAAgC,CAAC;AAExC,OAAO,KAAK,EAAyB,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAClF,OAAO,KAAK,EACV,mBAAmB,EACnB,qCAAqC,EAEtC,MAAM,mBAAmB,CAAC;AAE3B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,qBAAa,iCAAiC;IAC5C,OAAO,CAAC,WAAW,CAAkB;IACrC,OAAO,CAAC,QAAQ,CAAgB;IAEhC;;;;;;;;;;;;;;;;;;;;;;OAsBG;gBAED,QAAQ,EAAE,MAAM,EAChB,UAAU,EAAE,eAAe,EAC3B,OAAO,CAAC,EAAE,wCAAwC;IAEpD;;;;;;;;;;;;;;;;;;;OAmBG;gBAED,QAAQ,EAAE,MAAM,EAChB,UAAU,EAAE,aAAa,EACzB,OAAO,CAAC,EAAE,wCAAwC;IAEpD;;OAEG;gBAED,QAAQ,EAAE,MAAM,EAChB,UAAU,EAAE,aAAa,GAAG,eAAe,EAC3C,OAAO,CAAC,EAAE,wCAAwC;IAiBpD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsEG;IACU,uBAAuB,CAClC,OAAO,EAAE,MAAM,EACf,YAAY,EAAE,MAAM,EACpB,SAAS,EAAE,sBAAsB,EACjC,OAAO,CAAC,EAAE,8BAA8B,GACvC,OAAO,CAAC,mBAAmB,CAAC;IAE/B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAwEG;IACU,uBAAuB,CAClC,OAAO,EAAE,MAAM,EACf,aAAa,EAAE,mBAAmB,EAClC,SAAS,EAAE,sBAAsB,EACjC,OAAO,CAAC,EAAE,8BAA8B,GACvC,OAAO,CAAC,mBAAmB,CAAC;IAwC/B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0CG;IACU,yBAAyB,CACpC,OAAO,EAAE,MAAM,EACf,iBAAiB,EAAE,QAAQ,CAAC,MAAM,CAAC,EACnC,OAAO,GAAE,gCAAqC,GAC7C,OAAO,CAAC,mBAAmB,CAAC;IA0B/B;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACU,oBAAoB,CAC/B,kBAAkB,EAAE,MAAM,EAC1B,OAAO,GAAE,2BAAgC,GACxC,OAAO,CAAC,iBAAiB,CAAC;IAgB7B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4CG;IACU,gBAAgB,CAC3B,aAAa,EAAE,MAAM,EACrB,aAAa,EAAE,iBAAiB,EAEhC,OAAO,GAAE,qBAA0B,GAClC,OAAO,CAAC,mBAAmB,CAAC;IAiB/B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0EG;IACU,4BAA4B,CACvC,YAAY,EAAE,MAAM,EACpB,cAAc,EAAE,qCAAqC,EACrD,OAAO,GAAE,mCAAwC,GAChD,OAAO,CAAC,wBAAwB,CAAC;IAsBpC;;;;;;;OAOG;YACW,0BAA0B;IAyIxC;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACI,kBAAkB,CAAC,OAAO,GAAE,yBAA8B,GAAG,OAAO,CAAC,eAAe,CAAC;IAQ5F;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkDG;IACI,gBAAgB,CACrB,OAAO,EAAE,MAAM,EAEf,OAAO,GAAE,eAAoB,GAC5B,OAAO,CAAC,oBAAoB,CAAC;IAQhC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4DG;IACI,kBAAkB,CAEvB,OAAO,GAAE,iBAAsB,GAC9B,0BAA0B,CAAC,oBAAoB,CAAC;IAInD;;;;;;;;;;;;;;;;;;;;OAoBG;IACI,mBAAmB,CACxB,OAAO,EAAE,MAAM,EACf,OAAO,GAAE,0BAA+B,GACvC,OAAO,CAAC,IAAI,CAAC;IAYhB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;IACI,qBAAqB,CAC1B,YAAY,EAAE,MAAM,EACpB,OAAO,GAAE,gBAAqB,GAC7B,OAAO,CAAC,yBAAyB,CAAC;IASrC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0CG;IACI,uBAAuB,CAE5B,OAAO,GAAE,iBAAsB,GAC9B,0BAA0B,CAAC,yBAAyB,CAAC;IAIxD;;;;;;;;;;;;;;;;;;;;OAoBG;IACI,wBAAwB,CAC7B,YAAY,EAAE,MAAM,EACpB,OAAO,GAAE,gBAAqB,GAC7B,OAAO,CAAC,IAAI,CAAC;IAahB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACI,YAAY,CACjB,WAAW,EAAE,MAAM,EACnB,OAAO,GAAE,mBAAwB,GAChC,OAAO,CAAC,gBAAgB,CAAC;IAQ5B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2CG;IACI,cAAc,CACnB,OAAO,GAAE,qBAA0B,GAClC,0BAA0B,CAAC,gBAAgB,CAAC;CAKhD"}

package/dist/commonjs/documentModelAdministrationClient.js

@@ -17,25 +17,27 @@ const util_js_1 = require("./util.js");
  *
  * #### Azure Active Directory
  *
- * ```typescript
- * import { DocumentModelAdministrationClient } from "@azure/ai-form-recognizer";
+ * ```ts snippet:ReadmeSampleAdministrationClient_TokenCredential
  * import { DefaultAzureCredential } from "@azure/identity";
+ * import { DocumentModelAdministrationClient } from "@azure/ai-form-recognizer";
  *
- * const endpoint = "https://<resource name>.cognitiveservices.azure.com";
  * const credential = new DefaultAzureCredential();
- *
- * const client = new DocumentModelAdministrationClient(endpoint, credential);
+ * const client = new DocumentModelAdministrationClient(
+ *   "https://<resource name>.cognitiveservices.azure.com",
+ *   credential,
+ * );
  * ```
  *
  * #### API Key (Subscription Key)
  *
- * ```typescript
- * import { DocumentModelAdministrationClient, AzureKeyCredential } from "@azure/ai-form-recognizer";
- *
- * const endpoint = "https://<resource name>.cognitiveservices.azure.com";
- * const credential = new AzureKeyCredential("<api key>");
+ * ```ts snippet:ReadmeSampleAdministrationClient_KeyCredential
+ * import { AzureKeyCredential, DocumentModelAdministrationClient } from "@azure/ai-form-recognizer";
  *
- * const client = new DocumentModelAdministrationClient(endpoint, credential);
+ * const credential = new AzureKeyCredential("<API key>");
+ * const client = new DocumentModelAdministrationClient(
+ *   "https://<resource name>.cognitiveservices.azure.com",
+ *   credential,
+ * );
  * ```
  */
 class DocumentModelAdministrationClient {
@@ -68,20 +70,24 @@ class DocumentModelAdministrationClient {
      *
      * ### Example
      *
-     * ```javascript
-     * const modelId = "aNewComposedModel";
-     * const subModelIds = [
-     *   "documentType1Model",
-     *   "documentType2Model",
-     *   "documentType3Model"
-     * ];
+     * ```ts snippet:ReadmeSampleComposeModel
+     * import { DefaultAzureCredential } from "@azure/identity";
+     * import { DocumentModelAdministrationClient } from "@azure/ai-form-recognizer";
+     *
+     * const credential = new DefaultAzureCredential();
+     * const client = new DocumentModelAdministrationClient(
+     *   "https://<resource name>.cognitiveservices.azure.com",
+     *   credential,
+     * );
+     *
+     * const composeModelId = "aNewComposedModel";
+     * const subModelIds = ["documentType1Model", "documentType2Model", "documentType3Model"];
      *
      * // The resulting composed model can classify and extract data from documents
      * // conforming to any of the above document types
-     * const poller = await client.beginComposeDocumentModel(modelId, subModelIds, {
-     *   description: "This is a composed model that can handle several document types."
+     * const poller = await client.beginComposeDocumentModel(composeModelId, subModelIds, {
+     *   description: "This is a composed model that can handle several document types.",
      * });
-     *
      * // Model composition, like all other model creation operations, returns a poller that eventually produces a
      * // ModelDetails object
      * const modelDetails = await poller.pollUntilDone();
@@ -90,7 +96,7 @@ class DocumentModelAdministrationClient {
      *   modelId, // identical to the modelId given when creating the model
      *   description, // identical to the description given when creating the model
      *   createdOn, // the Date (timestamp) that the model was created
-     *   docTypes // information about the document types of the composed submodels
+     *   docTypes, // information about the document types of the composed submodels
      * } = modelDetails;
      * ```
      *
@@ -120,7 +126,16 @@ class DocumentModelAdministrationClient {
      *
      * ### Example
      *
-     * ```javascript
+     * ```ts snippet:ReadmeSampleGetCopyAuthorization
+     * import { DefaultAzureCredential } from "@azure/identity";
+     * import { DocumentModelAdministrationClient } from "@azure/ai-form-recognizer";
+     *
+     * const credential = new DefaultAzureCredential();
+     * const client = new DocumentModelAdministrationClient(
+     *   "https://<resource name>.cognitiveservices.azure.com",
+     *   credential,
+     * );
+     *
      * // The copyAuthorization data structure stored below grants any cognitive services resource the right to copy a
      * // model into the client's resource with the given destination model ID.
      * const copyAuthorization = await client.getCopyAuthorization("<destination model ID>");
@@ -144,18 +159,26 @@ class DocumentModelAdministrationClient {
      *
      * ### Example
      *
-     * ```javascript
-     * // We need a client for the source model's resource
-     * const sourceEndpoint = "https://<source resource name>.cognitiveservices.azure.com";
-     * const sourceCredential = new AzureKeyCredential("<source api key>");
-     * const sourceClient = new DocumentModelAdministrationClient(sourceEndpoint, sourceCredential);
+     * ```ts snippet:ReadmeSampleCopyModel
+     * import { DefaultAzureCredential } from "@azure/identity";
+     * import { DocumentModelAdministrationClient, AzureKeyCredential } from "@azure/ai-form-recognizer";
+     *
+     * const credential = new DefaultAzureCredential();
+     * const client = new DocumentModelAdministrationClient(
+     *   "https://<resource name>.cognitiveservices.azure.com",
+     *   credential,
+     * );
      *
      * // We create the copy authorization using a client authenticated with the destination resource. Note that these two
      * // resources can be the same (you can copy a model to a new ID in the same resource).
      * const copyAuthorization = await client.getCopyAuthorization("<destination model ID>");
      *
      * // Finally, use the _source_ client to copy the model and await the copy operation
-     * const poller = await sourceClient.beginCopyModelTo("<source model ID>");
+     * // We need a client for the source model's resource
+     * const sourceEndpoint = "https://<source resource name>.cognitiveservices.azure.com";
+     * const sourceCredential = new AzureKeyCredential("<source api key>");
+     * const sourceClient = new DocumentModelAdministrationClient(sourceEndpoint, sourceCredential);
+     * const poller = await sourceClient.beginCopyModelTo("<source model ID>", copyAuthorization);
      *
      * // Model copying, like all other model creation operations, returns a poller that eventually produces a ModelDetails
      * // object
@@ -165,7 +188,7 @@ class DocumentModelAdministrationClient {
      *   modelId, // identical to the modelId given when creating the copy authorization
      *   description, // identical to the description given when creating the copy authorization
      *   createdOn, // the Date (timestamp) that the model was created
-     *   docTypes // information about the document types of the model (identical to the original, source model)
+     *   docTypes, // information about the document types of the model (identical to the original, source model)
      * } = modelDetails;
      * ```
      *
@@ -204,32 +227,41 @@ class DocumentModelAdministrationClient {
      *
      * ### Example
      *
-     * ```javascript
-     * const classifierId = "aNewClassifier";
+     * ```ts snippet:ReadmeSampleBuildClassifier
+     * import { DefaultAzureCredential } from "@azure/identity";
+     * import { DocumentModelAdministrationClient } from "@azure/ai-form-recognizer";
+     *
+     * const credential = new DefaultAzureCredential();
+     * const client = new DocumentModelAdministrationClient(
+     *   "https://<resource name>.cognitiveservices.azure.com",
+     *   credential,
+     * );
+     *
+     * const newClassifiedId = "aNewClassifier";
      * const containerUrl1 = "<training data container SAS URL 1>";
      * const containerUrl2 = "<training data container SAS URL 2>";
      *
      * const poller = await client.beginBuildDocumentClassifier(
-     *   classifierId,
+     *   newClassifiedId,
      *   {
      *     // The document types. Each entry in this object should map a document type name to a
      *     // `ClassifierDocumentTypeDetails` object
-     *     "formX": {
+     *     formX: {
      *       azureBlobSource: {
      *         containerUrl: containerUrl1,
-     *       }
+     *       },
      *     },
-     *     "formY": {
+     *     formY: {
      *       azureBlobFileListSource: {
      *         containerUrl: containerUrl2,
-     *         fileList: "path/to/fileList.jsonl"
-     *       }
+     *         fileList: "path/to/fileList.jsonl",
+     *       },
      *     },
      *   },
      *   {
      *     // Optionally, a text description may be attached to the classifier
-     *     description: "This is an example classifier!"
-     *   }
+     *     description: "This is an example classifier!",
+     *   },
      * );
      *
      * // Classifier building, like model creation operations, returns a poller that eventually produces a
@@ -240,7 +272,7 @@ class DocumentModelAdministrationClient {
      *   classifierId, // identical to the classifierId given when creating the classifier
      *   description, // identical to the description given when creating the classifier (if any)
      *   createdOn, // the Date (timestamp) that the classifier was created
-     *   docTypes // information about the document types in the classifier and their details
+     *   docTypes, // information about the document types in the classifier and their details
      * } = classifierDetails;
      * ```
      *
@@ -354,15 +386,24 @@ class DocumentModelAdministrationClient {
      *
      * ### Example
      *
-     * ```javascript
+     * ```ts snippet:ReadmeSampleGetResourceDetails
+     * import { DefaultAzureCredential } from "@azure/identity";
+     * import { DocumentModelAdministrationClient } from "@azure/ai-form-recognizer";
+     *
+     * const credential = new DefaultAzureCredential();
+     * const client = new DocumentModelAdministrationClient(
+     *   "https://<resource name>.cognitiveservices.azure.com",
+     *   credential,
+     * );
+     *
      * const {
      *   // Information about the custom models in the current resource
-     *   customDocumentModelDetails: {
+     *   customDocumentModels: {
      *     // The number of custom models in the current resource
      *     count,
      *     // The maximum number of models that the current resource can support
-     *     limit
-     *   }
+     *     limit,
+     *   },
      * } = await client.getResourceDetails();
      * ```
      *
@@ -386,9 +427,18 @@ class DocumentModelAdministrationClient {
      *
      * ### Example
      *
-     * ```javascript
+     * ```ts snippet:ReadmeSampleGetModel
+     * import { DefaultAzureCredential } from "@azure/identity";
+     * import { DocumentModelAdministrationClient } from "@azure/ai-form-recognizer";
+     *
+     * const credential = new DefaultAzureCredential();
+     * const client = new DocumentModelAdministrationClient(
+     *   "https://<resource name>.cognitiveservices.azure.com",
+     *   credential,
+     * );
+     *
      * // The ID of the prebuilt business card model
-     * const modelId = "prebuilt-businessCard";
+     * const prebuiltModelId = "prebuilt-businessCard";
      *
      * const {
      *   modelId, // identical to the modelId given when calling `getDocumentModel`
@@ -399,15 +449,15 @@ class DocumentModelAdministrationClient {
      *     // the document type of the prebuilt business card model
      *     "prebuilt:businesscard": {
      *       // an optional, textual description of this document type
-     *       description,
+     *       description: businessCardDescription,
      *       // the schema of the fields in this document type, see the FieldSchema type
      *       fieldSchema,
      *       // the service's confidences in the fields (an object with field names as properties and numeric confidence
      *       // values)
-     *       fieldConfidence
-     *     }
-     *   }
-     * } = await client.getDocumentModel(modelId);
+     *       fieldConfidence,
+     *     },
+     *   },
+     * } = await client.getDocumentModel(prebuiltModelId);
      * ```
      *
      * @param modelId - the unique ID of the model to query
@@ -439,7 +489,17 @@ class DocumentModelAdministrationClient {
      *
      * #### Async Iteration
      *
-     * ```javascript
+     * ```ts snippet:ReadmeSampleListModels
+     * import { DefaultAzureCredential } from "@azure/identity";
+     * import { DocumentModelAdministrationClient } from "@azure/ai-form-recognizer";
+     *
+     * const credential = new DefaultAzureCredential();
+     * const client = new DocumentModelAdministrationClient(
+     *   "https://<resource name>.cognitiveservices.azure.com",
+     *   credential,
+     * );
+     *
+     * // Iterate over all models in the current resource
      * for await (const summary of client.listDocumentModels()) {
      *   const {
      *     modelId, // The model's unique ID
@@ -449,17 +509,13 @@ class DocumentModelAdministrationClient {
      *   // You can get the full model info using `getDocumentModel`
      *   const model = await client.getDocumentModel(modelId);
      * }
-     * ```
-     *
-     * #### By Page
      *
-     * ```javascript
      * // The listDocumentModels method is paged, and you can iterate by page using the `byPage` method.
      * const pages = client.listDocumentModels().byPage();
      *
      * for await (const page of pages) {
      *   // Each page is an array of models and can be iterated synchronously
-     *   for (const model of page) {
+     *   for (const summary of page) {
      *     const {
      *       modelId, // The model's unique ID
      *       description, // a textual description of the model, if provided during model creation
@@ -484,8 +540,17 @@ class DocumentModelAdministrationClient {
      *
      * ### Example
      *
-     * ```javascript
-     * await client.deleteDocumentModel("<model ID to delete>"));
+     * ```ts snippet:ReadmeSampleDeleteModel
+     * import { DefaultAzureCredential } from "@azure/identity";
+     * import { DocumentModelAdministrationClient } from "@azure/ai-form-recognizer";
+     *
+     * const credential = new DefaultAzureCredential();
+     * const client = new DocumentModelAdministrationClient(
+     *   "https://<resource name>.cognitiveservices.azure.com",
+     *   credential,
+     * );
+     *
+     * await client.deleteDocumentModel("<model ID to delete>");
      * ```
      *
      * @param modelId - the unique ID of the model to delete from the resource
@@ -501,21 +566,30 @@ class DocumentModelAdministrationClient {
      *
      * ### Example
      *
-     * ```javascript
-     * const classifierId = "<classifier ID";
+     * ```ts snippet:ReadmeSampleGetClassifier
+     * import { DefaultAzureCredential } from "@azure/identity";
+     * import { DocumentModelAdministrationClient } from "@azure/ai-form-recognizer";
+     *
+     * const credential = new DefaultAzureCredential();
+     * const client = new DocumentModelAdministrationClient(
+     *   "https://<resource name>.cognitiveservices.azure.com",
+     *   credential,
+     * );
+     *
+     * const foundClassifier = "<classifier ID>";
      *
      * const {
      *   classifierId, // identical to the ID given when calling `getDocumentClassifier`
      *   description, // a textual description of the classifier, if provided during classifier creation
      *   createdOn, // the Date (timestamp) that the classifier was created
      *   // information about the document types in the classifier and their corresponding traning data
-     *   docTypes
-     * } = await client.getDocumentClassifier(classifierId);
+     *   docTypes,
+     * } = await client.getDocumentClassifier(foundClassifier);
      *
      * // The `docTypes` property is a map of document type names to information about the training data
      * // for that document type.
      * for (const [docTypeName, classifierDocTypeDetails] of Object.entries(docTypes)) {
-     *  console.log(`- '${docTypeName}': `, classifierDocTypeDetails);
+     *   console.log(`- '${docTypeName}': `, classifierDocTypeDetails);
      * }
      * ```
      *
@@ -533,7 +607,16 @@ class DocumentModelAdministrationClient {
      *
      * #### Async Iteration
      *
-     * ```javascript
+     * ```ts snippet:ReadmeSampleListClassifiers
+     * import { DefaultAzureCredential } from "@azure/identity";
+     * import { DocumentModelAdministrationClient } from "@azure/ai-form-recognizer";
+     *
+     * const credential = new DefaultAzureCredential();
+     * const client = new DocumentModelAdministrationClient(
+     *   "https://<resource name>.cognitiveservices.azure.com",
+     *   credential,
+     * );
+     *
      * for await (const details of client.listDocumentClassifiers()) {
      *   const {
      *     classifierId, // The classifier's unique ID
@@ -541,11 +624,7 @@ class DocumentModelAdministrationClient {
      *     docTypes, // information about the document types in the classifier and their corresponding traning data
      *   } = details;
      * }
-     * ```
      *
-     * #### By Page
-     *
-     * ```javascript
      * // The listDocumentClassifiers method is paged, and you can iterate by page using the `byPage` method.
      * const pages = client.listDocumentClassifiers().byPage();
      *
@@ -574,8 +653,17 @@ class DocumentModelAdministrationClient {
      *
      * ### Example
      *
-     * ```javascript
-     * await client.deleteDocumentClassifier("<classifier ID to delete>"));
+     * ```ts snippet:ReadmeSampleDeleteClassifier
+     * import { DefaultAzureCredential } from "@azure/identity";
+     * import { DocumentModelAdministrationClient } from "@azure/ai-form-recognizer";
+     *
+     * const credential = new DefaultAzureCredential();
+     * const client = new DocumentModelAdministrationClient(
+     *   "https://<resource name>.cognitiveservices.azure.com",
+     *   credential,
+     * );
+     *
+     * await client.deleteDocumentClassifier("<classifier ID to delete>");
      * ```
      *
      * @param classifierId - the unique ID of the classifier to delete from the resource
@@ -597,9 +685,18 @@ class DocumentModelAdministrationClient {
      *
      * ### Example
      *
-     * ```javascript
+     * ```ts snippet:ReadmeSampleGetOperation
+     * import { DefaultAzureCredential } from "@azure/identity";
+     * import { DocumentModelAdministrationClient } from "@azure/ai-form-recognizer";
+     *
+     * const credential = new DefaultAzureCredential();
+     * const client = new DocumentModelAdministrationClient(
+     *   "https://<resource name>.cognitiveservices.azure.com",
+     *   credential,
+     * );
+     *
      * // The ID of the operation, which should be a GUID
-     * const operationId = "<operation GUID>";
+     * const findOperationId = "<operation GUID>";
      *
      * const {
      *   operationId, // identical to the operationId given when calling `getOperation`
@@ -608,7 +705,7 @@ class DocumentModelAdministrationClient {
      *   percentCompleted, // a number between 0 and 100 representing the progress of the operation
      *   createdOn, // a Date object that reflects the time when the operation was started
      *   lastUpdatedOn, // a Date object that reflects the time when the operation state was last modified
-     * } = await client.getOperation(operationId);
+     * } = await client.getOperation(findOperationId);
      * ```
      */
     getOperation(operationId, options = {}) {
@@ -622,19 +719,24 @@ class DocumentModelAdministrationClient {
      *
      * #### Async Iteration
      *
-     * ```javascript
+     * ```ts snippet:ReadmeSampleListOperations
+     * import { DefaultAzureCredential } from "@azure/identity";
+     * import { DocumentModelAdministrationClient } from "@azure/ai-form-recognizer";
+     *
+     * const credential = new DefaultAzureCredential();
+     * const client = new DocumentModelAdministrationClient(
+     *   "https://<resource name>.cognitiveservices.azure.com",
+     *   credential,
+     * );
+     *
      * for await (const operation of client.listOperations()) {
      *   const {
      *     operationId, // the operation's GUID
      *     status, // the operation status, one of "notStarted", "running", "succeeded", "failed", or "canceled"
-     *     percentCompleted // the progress of the operation, from 0 to 100
+     *     percentCompleted, // the progress of the operation, from 0 to 100
      *   } = operation;
      * }
-     * ```
-     *
-     * #### By Page
      *
-     * ```javascript
      * // The listOperations method is paged, and you can iterate by page using the `byPage` method.
      * const pages = client.listOperations().byPage();
      *
@@ -644,7 +746,7 @@ class DocumentModelAdministrationClient {
      *     const {
      *       operationId, // the operation's GUID
      *       status, // the operation status, one of "notStarted", "running", "succeeded", "failed", or "canceled"
-     *       percentCompleted // the progress of the operation, from 0 to 100
+     *       percentCompleted, // the progress of the operation, from 0 to 100
      *     } = operation;
      *   }
      * }