@azure/ai-form-recognizer 5.0.0 → 5.1.0

package/dist/commonjs/documentModelAdministrationClient.d.ts

@@ -0,0 +1,792 @@
+import type { KeyCredential, TokenCredential } from "@azure/core-auth";
+import type { PagedAsyncIterableIterator } from "@azure/core-paging";
+import type { CopyAuthorization, ResourceDetails, DocumentModelDetails, DocumentModelSummary, OperationSummary, OperationDetails, DocumentClassifierDetails } from "./generated/index.js";
+import type { DocumentModelPoller, DocumentClassifierPoller } from "./lro/administration.js";
+import type { BeginCopyModelOptions, DeleteDocumentModelOptions, DocumentModelAdministrationClientOptions, GetCopyAuthorizationOptions, GetResourceDetailsOptions, GetModelOptions, GetOperationOptions, ListModelsOptions, ListOperationsOptions } from "./options/index.js";
+import type { BeginBuildDocumentClassifierOptions } from "./options/BuildDocumentClassifierOptions.js";
+import type { BeginBuildDocumentModelOptions, BeginComposeDocumentModelOptions, DocumentModelBuildMode } from "./options/BuildModelOptions.js";
+import type { OperationOptions } from "@azure/core-client";
+import type { DocumentModelSource, DocumentClassifierDocumentTypeSources } from "./models/index.js";
+/**
+ * A client for interacting with the Form Recognizer service's model management features, such as creating, reading,
+ * listing, deleting, and copying models.
+ *
+ * ### Examples:
+ *
+ * #### Azure Active Directory
+ *
+ * ```ts snippet:ReadmeSampleAdministrationClient_TokenCredential
+ * 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,
+ * );
+ * ```
+ *
+ * #### API Key (Subscription Key)
+ *
+ * ```ts snippet:ReadmeSampleAdministrationClient_KeyCredential
+ * import { AzureKeyCredential, DocumentModelAdministrationClient } from "@azure/ai-form-recognizer";
+ *
+ * const credential = new AzureKeyCredential("<API key>");
+ * const client = new DocumentModelAdministrationClient(
+ *   "https://<resource name>.cognitiveservices.azure.com",
+ *   credential,
+ * );
+ * ```
+ */
+export declare class DocumentModelAdministrationClient {
+    private _restClient;
+    private _tracing;
+    /**
+     * Create a DocumentModelAdministrationClient instance from a resource endpoint and a an Azure Identity `TokenCredential`.
+     *
+     * See the [`@azure/identity`](https://npmjs.com/package/\@azure/identity) package for more information about
+     * authenticating with Azure Active Directory.
+     *
+     * ### Example:
+     *
+     * ```ts snippet:ReadmeSampleAdministrationClient_TokenCredential
+     * 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,
+     * );
+     * ```
+     *
+     * @param endpoint - the endpoint URL of an Azure Cognitive Services instance
+     * @param credential - a TokenCredential instance from the `@azure/identity` package
+     * @param options - optional settings for configuring all methods in the client
+     */
+    constructor(endpoint: string, credential: TokenCredential, options?: DocumentModelAdministrationClientOptions);
+    /**
+     * Create a DocumentModelAdministrationClient instance from a resource endpoint and a static API key
+     * (`KeyCredential`),
+     *
+     * ### Example:
+     *
+     * ```ts snippet:ReadmeSampleAdministrationClient_KeyCredential
+     * import { AzureKeyCredential, DocumentModelAdministrationClient } from "@azure/ai-form-recognizer";
+     *
+     * 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
+     * @param credential - a KeyCredential containing the Cognitive Services instance subscription key
+     * @param options - optional settings for configuring all methods in the client
+     */
+    constructor(endpoint: string, credential: KeyCredential, options?: DocumentModelAdministrationClientOptions);
+    /**
+     * @hidden
+     */
+    constructor(endpoint: string, credential: KeyCredential | TokenCredential, options?: DocumentModelAdministrationClientOptions);
+    /**
+     * Build a new model with a given ID from a set of input documents and labeled fields.
+     *
+     * The Model ID can consist of any text, so long as it does not begin with "prebuilt-" (as these models refer to
+     * prebuilt Form Recognizer models that are common to all resources), and so long as it does not already exist within
+     * the resource.
+     *
+     * The Form Recognizer service reads the training data set from an Azure Storage container, given as a URL to the
+     * container with a SAS token that allows the service backend to communicate with the container. At a minimum, the
+     * "read" and "list" permissions are required. In addition, the data in the given container must be organized
+     * according to a particular convention, which is documented in [the service's documentation for building custom
+     * models](https://aka.ms/form-recognizer/custom).
+     *
+     * ### Example
+     *
+     * ```ts snippet:ReadmeSampleBuildModel
+     * 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 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();
+     *
+     * 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
+     * @param containerUrl - SAS-encoded URL to an Azure Storage container holding the training data set
+     * @param buildMode - the mode to use when building the model (see `DocumentModelBuildMode`)
+     * @param options - optional settings for the model build operation
+     * @returns a long-running operation (poller) that will eventually produce the created model information or an error
+     */
+    beginBuildDocumentModel(modelId: string, containerUrl: string, buildMode: DocumentModelBuildMode, options?: BeginBuildDocumentModelOptions): Promise<DocumentModelPoller>;
+    /**
+     * Build a new model with a given ID from a model content source.
+     *
+     * The Model ID can consist of any text, so long as it does not begin with "prebuilt-" (as these models refer to
+     * prebuilt Form Recognizer models that are common to all resources), and so long as it does not already exist within
+     * the resource.
+     *
+     * The content source describes the mechanism the service will use to read the input training data. See the
+     * {@link DocumentModelContentSource} type for more information.
+     *
+     * ### Example
+     *
+     * ```ts snippet:ReadmeSampleBuildModel_Container
+     * 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 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();
+     *
+     * 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
+     * @param contentSource - a content source that provides the training data for this model
+     * @param buildMode - the mode to use when building the model (see `DocumentModelBuildMode`)
+     * @param options - optional settings for the model build operation
+     * @returns a long-running operation (poller) that will eventually produce the created model information or an error
+     */
+    beginBuildDocumentModel(modelId: string, contentSource: DocumentModelSource, buildMode: DocumentModelBuildMode, options?: BeginBuildDocumentModelOptions): Promise<DocumentModelPoller>;
+    /**
+     * Creates a single composed model from several pre-existing submodels.
+     *
+     * The resulting composed model combines the document types of its component models, and inserts a classification step
+     * into the extraction pipeline to determine which of its component submodels is most appropriate for the given input.
+     *
+     * ### Example
+     *
+     * ```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(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();
+     *
+     * 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 of the composed submodels
+     * } = modelDetails;
+     * ```
+     *
+     * @param modelId - the unique ID of the model to create
+     * @param componentModelIds - an Iterable of strings representing the unique model IDs of the models to compose
+     * @param options - optional settings for model creation
+     * @returns a long-running operation (poller) that will eventually produce the created model information or an error
+     */
+    beginComposeDocumentModel(modelId: string, componentModelIds: Iterable<string>, options?: BeginComposeDocumentModelOptions): Promise<DocumentModelPoller>;
+    /**
+     * Creates an authorization to copy a model into the resource, used with the `beginCopyModelTo` method.
+     *
+     * The `CopyAuthorization` grants another cognitive service resource the right to create a model in this client's
+     * resource with the model ID and optional description that are encoded into the authorization.
+     *
+     * ### Example
+     *
+     * ```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>");
+     * ```
+     *
+     * @param destinationModelId - the unique ID of the destination model (the ID to copy the model into)
+     * @param options - optional settings for creating the copy authorization
+     * @returns a copy authorization that encodes the given modelId and optional description
+     */
+    getCopyAuthorization(destinationModelId: string, options?: GetCopyAuthorizationOptions): Promise<CopyAuthorization>;
+    /**
+     * Copies a model with the given ID into the resource and model ID encoded by a given copy authorization.
+     *
+     * See {@link CopyAuthorization} and {@link getCopyAuthorization}.
+     *
+     * ### Example
+     *
+     * ```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
+     * // 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
+     * const modelDetails = await poller.pollUntilDone();
+     *
+     * const {
+     *   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)
+     * } = modelDetails;
+     * ```
+     *
+     * @param sourceModelId - the unique ID of the source model that will be copied
+     * @param authorization - an authorization to copy the model, created using the {@link getCopyAuthorization}
+     * @param options - optional settings for
+     * @returns a long-running operation (poller) that will eventually produce the copied model information or an error
+     */
+    beginCopyModelTo(sourceModelId: string, authorization: CopyAuthorization, options?: BeginCopyModelOptions): Promise<DocumentModelPoller>;
+    /**
+     * Build a new document classifier with the given classifier ID and document types.
+     *
+     * The classifier ID must be unique among classifiers within the resource.
+     *
+     * The document types are given as an object that maps the name of the document type to the training data set for that
+     * document type. Two training data input methods are supported:
+     *
+     * - `azureBlobSource`, which trains a classifier using the data in the given Azure Blob Storage container.
+     * - `azureBlobFileListSource`, which is similar to `azureBlobSource` but allows for more fine-grained control over
+     *   the files that are included in the training data set by using a JSONL-formatted file list.
+     *
+     * The Form Recognizer service reads the training data set from an Azure Storage container, given as a URL to the
+     * container with a SAS token that allows the service backend to communicate with the container. At a minimum, the
+     * "read" and "list" permissions are required. In addition, the data in the given container must be organized
+     * according to a particular convention, which is documented in [the service's documentation for building custom
+     * document classifiers](https://aka.ms/azsdk/formrecognizer/buildclassifiermodel).
+     *
+     * ### Example
+     *
+     * ```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(
+     *   newClassifiedId,
+     *   {
+     *     // The document types. Each entry in this object should map a document type name to a
+     *     // `ClassifierDocumentTypeDetails` object
+     *     formX: {
+     *       azureBlobSource: {
+     *         containerUrl: containerUrl1,
+     *       },
+     *     },
+     *     formY: {
+     *       azureBlobFileListSource: {
+     *         containerUrl: containerUrl2,
+     *         fileList: "path/to/fileList.jsonl",
+     *       },
+     *     },
+     *   },
+     *   {
+     *     // Optionally, a text description may be attached to the classifier
+     *     description: "This is an example classifier!",
+     *   },
+     * );
+     *
+     * // Classifier building, like model creation operations, returns a poller that eventually produces a
+     * // DocumentClassifierDetails object
+     * const classifierDetails = await poller.pollUntilDone();
+     *
+     * const {
+     *   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
+     * } = classifierDetails;
+     * ```
+     *
+     * @param classifierId - the unique ID of the classifier to create
+     * @param docTypeSources - the document types to include in the classifier and their sources (a map of document type
+     *                         names to `ClassifierDocumentTypeDetails`)
+     * @param options - optional settings for the classifier build operation
+     * @returns a long-running operation (poller) that will eventually produce the created classifier details or an error
+     */
+    beginBuildDocumentClassifier(classifierId: string, docTypeSources: DocumentClassifierDocumentTypeSources, options?: BeginBuildDocumentClassifierOptions): Promise<DocumentClassifierPoller>;
+    /**
+     * Create an LRO poller that handles model creation operations.
+     *
+     * This is the meat of the above model creation operations.
+     *
+     * @param definition - operation definition (start operation method, request options)
+     * @returns a model poller (produces a ModelDetails)
+     */
+    private createAdministrationPoller;
+    /**
+     * Retrieve basic information about this client's resource.
+     *
+     * ### Example
+     *
+     * ```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
+     *   customDocumentModels: {
+     *     // The number of custom models in the current resource
+     *     count,
+     *     // The maximum number of models that the current resource can support
+     *     limit,
+     *   },
+     * } = await client.getResourceDetails();
+     * ```
+     *
+     * @param options - optional settings for the request
+     * @returns basic information about this client's resource
+     */
+    getResourceDetails(options?: GetResourceDetailsOptions): Promise<ResourceDetails>;
+    /**
+     * Retrieves information about a model ({@link DocumentModelDetails}) by ID.
+     *
+     * This method can retrieve information about custom as well as prebuilt models.
+     *
+     * ### **Breaking Change**
+     *
+     * In previous versions of the Form Recognizer REST API and SDK, the `getModel` method could return any model, even
+     * one that failed to create due to errors. In the new service versions, `getDocumentModel` and `listDocumentModels`
+     * _only produce successfully created models_ (i.e. models that are "ready" for use). Failed models are now retrieved
+     * through the "operations" APIs, see {@link getOperation} and {@link listOperations}.
+     *
+     * ### Example
+     *
+     * ```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 prebuiltModelId = "prebuilt-businessCard";
+     *
+     * const {
+     *   modelId, // identical to the modelId given when calling `getDocumentModel`
+     *   description, // a textual description of the model, if provided during model creation
+     *   createdOn, // the Date (timestamp) that the model was created
+     *   // information about the document types in the model and their field schemas
+     *   docTypes: {
+     *     // the document type of the prebuilt business card model
+     *     "prebuilt:businesscard": {
+     *       // an optional, textual description of this document type
+     *       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(prebuiltModelId);
+     * ```
+     *
+     * @param modelId - the unique ID of the model to query
+     * @param options - optional settings for the request
+     * @returns information about the model with the given ID
+     */
+    getDocumentModel(modelId: string, options?: GetModelOptions): Promise<DocumentModelDetails>;
+    /**
+     * List summaries of models in the resource. Custom as well as prebuilt models will be included. This operation
+     * supports paging.
+     *
+     * The model summary ({@link DocumentModelSummary}) includes only the basic information about the model, and does not include
+     * information about the document types in the model (such as the field schemas and confidence values).
+     *
+     * To access the full information about the model, use {@link getDocumentModel}.
+     *
+     * ### **Breaking Change**
+     *
+     * In previous versions of the Form Recognizer REST API and SDK, the `listModels` method would return all models, even
+     * those that failed to create due to errors. In the new service versions, `listDocumentModels` and `getDocumentModel`
+     * _only produce successfully created models_ (i.e. models that are "ready" for use). Failed models are now retrieved
+     * through the "operations" APIs, see {@link getOperation} and {@link listOperations}.
+     *
+     * ### Examples
+     *
+     * #### Async Iteration
+     *
+     * ```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
+     *     description, // a textual description of the model, if provided during model creation
+     *   } = summary;
+     *
+     *   // You can get the full model info using `getDocumentModel`
+     *   const model = await client.getDocumentModel(modelId);
+     * }
+     *
+     * // 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 summary of page) {
+     *     const {
+     *       modelId, // The model's unique ID
+     *       description, // a textual description of the model, if provided during model creation
+     *     } = summary;
+     *
+     *     // You can get the full model info using `getDocumentModel`
+     *     const model = await client.getDocumentModel(modelId);
+     *   }
+     * }
+     * ```
+     *
+     * @param options - optional settings for the model requests
+     * @returns an async iterable of model summaries that supports paging
+     */
+    listDocumentModels(options?: ListModelsOptions): PagedAsyncIterableIterator<DocumentModelSummary>;
+    /**
+     * Deletes a model with the given ID from the client's resource, if it exists. This operation CANNOT be reverted.
+     *
+     * ### Example
+     *
+     * ```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
+     * @param options - optional settings for the request
+     */
+    deleteDocumentModel(modelId: string, options?: DeleteDocumentModelOptions): Promise<void>;
+    /**
+     * Retrieves information about a classifier ({@link DocumentClassifierDetails}) by ID.
+     *
+     * ### Example
+     *
+     * ```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(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);
+     * }
+     * ```
+     *
+     * @param classifierId - the unique ID of the classifier to query
+     * @param options - optional settings for the request
+     * @returns information about the classifier with the given ID
+     */
+    getDocumentClassifier(classifierId: string, options?: OperationOptions): Promise<DocumentClassifierDetails>;
+    /**
+     * List details about classifiers in the resource. This operation supports paging.
+     *
+     * ### Examples
+     *
+     * #### Async Iteration
+     *
+     * ```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
+     *     description, // a textual description of the classifier, if provided during creation
+     *     docTypes, // information about the document types in the classifier and their corresponding traning data
+     *   } = details;
+     * }
+     *
+     * // The listDocumentClassifiers method is paged, and you can iterate by page using the `byPage` method.
+     * const pages = client.listDocumentClassifiers().byPage();
+     *
+     * for await (const page of pages) {
+     *   // Each page is an array of classifiers and can be iterated synchronously
+     *   for (const details of page) {
+     *     const {
+     *       classifierId, // The classifier's unique ID
+     *       description, // a textual description of the classifier, if provided during creation
+     *       docTypes, // information about the document types in the classifier and their corresponding traning data
+     *     } = details;
+     *   }
+     * }
+     * ```
+     *
+     * @param options - optional settings for the classifier requests
+     * @returns an async iterable of classifier details that supports paging
+     */
+    listDocumentClassifiers(options?: ListModelsOptions): PagedAsyncIterableIterator<DocumentClassifierDetails>;
+    /**
+     * Deletes a classifier with the given ID from the client's resource, if it exists. This operation CANNOT be reverted.
+     *
+     * ### Example
+     *
+     * ```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
+     * @param options - optional settings for the request
+     */
+    deleteDocumentClassifier(classifierId: string, options?: OperationOptions): Promise<void>;
+    /**
+     * Retrieves information about an operation (`OperationDetails`) by its ID.
+     *
+     * Operations represent non-analysis tasks, such as building, composing, or copying a model.
+     *
+     * @param operationId - the ID of the operation to query
+     * @param options - optional settings for the request
+     * @returns information about the operation with the given ID
+     *
+     * ### Example
+     *
+     * ```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 findOperationId = "<operation GUID>";
+     *
+     * const {
+     *   operationId, // identical to the operationId given when calling `getOperation`
+     *   kind, // the operation kind, one of "documentModelBuild", "documentModelCompose", or "documentModelCopyTo"
+     *   status, // the status of the operation, one of "notStarted", "running", "failed", "succeeded", or "canceled"
+     *   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(findOperationId);
+     * ```
+     */
+    getOperation(operationId: string, options?: GetOperationOptions): Promise<OperationDetails>;
+    /**
+     * List model creation operations in the resource. This will produce all operations, including operations that failed
+     * to create models successfully. This operation supports paging.
+     *
+     * ### Examples
+     *
+     * #### Async Iteration
+     *
+     * ```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
+     *   } = operation;
+     * }
+     *
+     * // The listOperations method is paged, and you can iterate by page using the `byPage` method.
+     * const pages = client.listOperations().byPage();
+     *
+     * for await (const page of pages) {
+     *   // Each page is an array of operation info objects and can be iterated synchronously
+     *   for (const operation of page) {
+     *     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
+     *     } = operation;
+     *   }
+     * }
+     * ```
+     *
+     * @param options - optional settings for the operation requests
+     * @returns an async iterable of operation information objects that supports paging
+     */
+    listOperations(options?: ListOperationsOptions): PagedAsyncIterableIterator<OperationSummary>;
+}
+//# sourceMappingURL=documentModelAdministrationClient.d.ts.map