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

package/dist/commonjs/documentModelAdministrationClient.d.ts

@@ -15,25 +15,27 @@ import type { DocumentModelSource, DocumentClassifierDocumentTypeSources } from
  *
  * #### 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";
+ * ```ts snippet:ReadmeSampleAdministrationClient_KeyCredential
+ * import { AzureKeyCredential, DocumentModelAdministrationClient } from "@azure/ai-form-recognizer";
  *
- * const endpoint = "https://<resource name>.cognitiveservices.azure.com";
- * const credential = new AzureKeyCredential("<api key>");
- *
- * const client = new DocumentModelAdministrationClient(endpoint, credential);
+ * const credential = new AzureKeyCredential("<API key>");
+ * const client = new DocumentModelAdministrationClient(
+ *   "https://<resource name>.cognitiveservices.azure.com",
+ *   credential,
+ * );
  * ```
  */
 export declare class DocumentModelAdministrationClient {
@@ -47,14 +49,15 @@ export declare class DocumentModelAdministrationClient {
      *
      * ### Example:
      *
-     * ```javascript
-     * 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,
+     * );
      * ```
      *
      * @param endpoint - the endpoint URL of an Azure Cognitive Services instance
@@ -68,13 +71,14 @@ export declare class DocumentModelAdministrationClient {
      *
      * ### Example:
      *
-     * ```javascript
-     * 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,
+     * );
      * ```
      *
      * @param endpoint - the endpoint URL of an Azure Cognitive Services instance
@@ -101,25 +105,54 @@ export declare class DocumentModelAdministrationClient {
      *
      * ### Example
      *
-     * ```javascript
-     * const modelId = "aNewModel";
-     * const containerUrl = "<training data container SAS URL>";
+     * ```ts snippet:ReadmeSampleBuildModel
+     * import { DefaultAzureCredential } from "@azure/identity";
+     * import { DocumentModelAdministrationClient } from "@azure/ai-form-recognizer";
      *
-     * const poller = await client.beginBuildDocumentModel(modelId, containerUrl, {
-     *   // Optionally, a text description may be attached to the model
-     *   description: "This is an example model!"
+     * const credential = new DefaultAzureCredential();
+     * const client = new DocumentModelAdministrationClient(
+     *   "https://<resource name>.cognitiveservices.azure.com",
+     *   credential,
+     * );
+     *
+     * const containerSasUrl = "<SAS url to the blob container storing training documents>";
+     *
+     * // 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.
+     * // 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 client.beginBuildDocumentModel("<model ID>", containerSasUrl, "template", {
+     *   // The model description is optional and can be any text.
+     *   description: "This is my new model!",
+     *   onProgress: ({ status }) => {
+     *     console.log(`operation status: ${status}`);
+     *   },
      * });
+     * const model = await poller.pollUntilDone();
      *
-     * // Model building, like all other model creation operations, returns a poller that eventually produces a ModelDetails
-     * // object
-     * const modelDetails = await poller.pollUntilDone();
+     * console.log(`Model ID: ${model.modelId}`);
+     * console.log(`Description: ${model.description}`);
+     * console.log(`Created: ${model.createdOn}`);
      *
-     * const {
-     *   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 in the model and their field schemas
-     * } = modelDetails;
+     * // A model may contain several document types, which describe the possible object structures of fields extracted using
+     * // this model
+     *
+     * console.log("Document Types:");
+     * for (const [docType, { description, fieldSchema: schema }] of Object.entries(
+     *   model.docTypes ?? {},
+     * )) {
+     *   console.log(`- Name: "${docType}"`);
+     *   console.log(`  Description: "${description}"`);
+     *
+     *   // For simplicity, this example will only show top-level field names
+     *   console.log("  Fields:");
+     *
+     *   for (const [fieldName, fieldSchema] of Object.entries(schema)) {
+     *     console.log(`  - "${fieldName}" (${fieldSchema.type})`);
+     *     console.log(`    ${fieldSchema.description ?? "<no description>"}`);
+     *   }
+     * }
      * ```
      *
      * @param modelId - the unique ID of the model to create
@@ -141,24 +174,59 @@ export declare class DocumentModelAdministrationClient {
      *
      * ### Example
      *
-     * ```javascript
-     * const modelId = "aNewModel";
+     * ```ts snippet:ReadmeSampleBuildModel_Container
+     * import { DefaultAzureCredential } from "@azure/identity";
+     * import { DocumentModelAdministrationClient } from "@azure/ai-form-recognizer";
      *
-     * const poller = await client.beginBuildDocumentModel(modelId, { containerUrl: "<SAS-encoded blob container URL>" }, {
-     *   // Optionally, a text description may be attached to the model
-     *   description: "This is an example model!"
-     * });
+     * const credential = new DefaultAzureCredential();
+     * const client = new DocumentModelAdministrationClient(
+     *   "https://<resource name>.cognitiveservices.azure.com",
+     *   credential,
+     * );
      *
-     * // Model building, like all other model creation operations, returns a poller that eventually produces a ModelDetails
-     * // object
-     * const modelDetails = await poller.pollUntilDone();
+     * const containerSasUrl = "<SAS url to the blob container storing training documents>";
+     *
+     * // 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.
+     * // 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 client.beginBuildDocumentModel(
+     *   "<model ID>",
+     *   { azureBlobSource: { containerUrl: containerSasUrl } },
+     *   "template",
+     *   {
+     *     // The model description is optional and can be any text.
+     *     description: "This is my new model!",
+     *     onProgress: ({ status }) => {
+     *       console.log(`operation status: ${status}`);
+     *     },
+     *   },
+     * );
+     * const model = await poller.pollUntilDone();
      *
-     * const {
-     *   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 in the model and their field schemas
-     * } = modelDetails;
+     * console.log(`Model ID: ${model.modelId}`);
+     * console.log(`Description: ${model.description}`);
+     * console.log(`Created: ${model.createdOn}`);
+     *
+     * // A model may contain several document types, which describe the possible object structures of fields extracted using
+     * // this model
+     *
+     * console.log("Document Types:");
+     * for (const [docType, { description, fieldSchema: schema }] of Object.entries(
+     *   model.docTypes ?? {},
+     * )) {
+     *   console.log(`- Name: "${docType}"`);
+     *   console.log(`  Description: "${description}"`);
+     *
+     *   // For simplicity, this example will only show top-level field names
+     *   console.log("  Fields:");
+     *
+     *   for (const [fieldName, fieldSchema] of Object.entries(schema)) {
+     *     console.log(`  - "${fieldName}" (${fieldSchema.type})`);
+     *     console.log(`    ${fieldSchema.description ?? "<no description>"}`);
+     *   }
+     * }
      * ```
      *
      * @param modelId - the unique ID of the model to create
@@ -176,20 +244,24 @@ export declare 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();
@@ -198,7 +270,7 @@ export declare 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;
      * ```
      *
@@ -216,7 +288,16 @@ export declare 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>");
@@ -234,18 +315,26 @@ export declare 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
@@ -255,7 +344,7 @@ export declare 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;
      * ```
      *
@@ -285,32 +374,41 @@ export declare 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
@@ -321,7 +419,7 @@ export declare 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;
      * ```
      *
@@ -346,15 +444,24 @@ export declare 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();
      * ```
      *
@@ -376,9 +483,18 @@ export declare 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`
@@ -389,15 +505,15 @@ export declare 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
@@ -425,7 +541,17 @@ export declare 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
@@ -435,17 +561,13 @@ export declare 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
@@ -466,8 +588,17 @@ export declare 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
@@ -479,21 +610,30 @@ export declare 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);
      * }
      * ```
      *
@@ -509,7 +649,16 @@ export declare 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
@@ -517,11 +666,7 @@ export declare 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();
      *
@@ -546,8 +691,17 @@ export declare 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
@@ -565,9 +719,18 @@ export declare 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`
@@ -576,7 +739,7 @@ export declare 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: string, options?: GetOperationOptions): Promise<OperationDetails>;
@@ -588,19 +751,24 @@ export declare 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();
      *
@@ -610,7 +778,7 @@ export declare 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;
      *   }
      * }