DocumentModelAdministrationClient Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
The client to use to connect with the Form Recognizer Azure Cognitive Service to build models from custom documents. It also supports listing, copying, and deleting models, creating composed models, and accessing account properties.
public class DocumentModelAdministrationClienttype DocumentModelAdministrationClient = classPublic Class DocumentModelAdministrationClient- Inheritance
-
DocumentModelAdministrationClient
Remarks
This client only supports V2022_08_31 and newer. To use an older service version, see FormTrainingClient.
Constructors
| DocumentModelAdministrationClient() |
Initializes a new instance of the DocumentModelAdministrationClient class. |
| DocumentModelAdministrationClient(Uri, AzureKeyCredential, DocumentAnalysisClientOptions) |
Initializes a new instance of the DocumentModelAdministrationClient class. |
| DocumentModelAdministrationClient(Uri, AzureKeyCredential) |
Initializes a new instance of the DocumentModelAdministrationClient class. |
| DocumentModelAdministrationClient(Uri, TokenCredential, DocumentAnalysisClientOptions) |
Initializes a new instance of the DocumentModelAdministrationClient class. |
| DocumentModelAdministrationClient(Uri, TokenCredential) |
Initializes a new instance of the DocumentModelAdministrationClient class. |
Methods
| BuildDocumentClassifier(WaitUntil, IDictionary<String,ClassifierDocumentTypeDetails>, String, String, CancellationToken) |
Builds a document classifier from training data stored in an Azure Blob Storage container. |
| BuildDocumentClassifierAsync(WaitUntil, IDictionary<String,ClassifierDocumentTypeDetails>, String, String, CancellationToken) |
Builds a document classifier from training data stored in an Azure Blob Storage container. |
| BuildDocumentModel(WaitUntil, DocumentContentSource, DocumentBuildMode, String, BuildDocumentModelOptions, CancellationToken) |
Build a custom model from a collection of documents in an Azure Blob Storage container. |
| BuildDocumentModel(WaitUntil, Uri, DocumentBuildMode, String, String, BuildDocumentModelOptions, CancellationToken) |
Build a custom document analysis model from a collection of documents in an Azure Blob Storage container. |
| BuildDocumentModelAsync(WaitUntil, DocumentContentSource, DocumentBuildMode, String, BuildDocumentModelOptions, CancellationToken) |
Build a custom model from a collection of documents in an Azure Blob Storage container. |
| BuildDocumentModelAsync(WaitUntil, Uri, DocumentBuildMode, String, String, BuildDocumentModelOptions, CancellationToken) |
Build a custom model from a collection of documents in an Azure Blob Storage container. |
| ComposeDocumentModel(WaitUntil, IEnumerable<String>, String, String, IDictionary<String,String>, CancellationToken) |
Composes a model from a collection of existing models. A model built by composition allows multiple models to be called with a single model ID. When a document is submitted to be analyzed with its model ID, a classification step is first performed to route it to the correct custom model. |
| ComposeDocumentModelAsync(WaitUntil, IEnumerable<String>, String, String, IDictionary<String,String>, CancellationToken) |
Composes a model from a collection of existing models. A model built by composition allows multiple models to be called with a single model ID. When a document is submitted to be analyzed with its model ID, a classification step is first performed to route it to the correct custom model. |
| CopyDocumentModelTo(WaitUntil, String, DocumentModelCopyAuthorization, CancellationToken) |
Copy a custom model stored in this resource (the source) to the user specified target Form Recognizer resource. |
| CopyDocumentModelToAsync(WaitUntil, String, DocumentModelCopyAuthorization, CancellationToken) |
Copy a custom model stored in this resource (the source) to the user specified target Form Recognizer resource. |
| DeleteDocumentClassifier(String, CancellationToken) |
Deletes the document classifier with the specified classifier ID. |
| DeleteDocumentClassifierAsync(String, CancellationToken) |
Deletes the document classifier with the specified classifier ID. |
| DeleteDocumentModel(String, CancellationToken) |
Deletes the model with the specified model ID. |
| DeleteDocumentModelAsync(String, CancellationToken) |
Deletes the model with the specified model ID. |
| GetCopyAuthorization(String, String, IDictionary<String,String>, CancellationToken) |
Generate authorization for copying a custom model into the target Form Recognizer resource. |
| GetCopyAuthorizationAsync(String, String, IDictionary<String,String>, CancellationToken) |
Generate authorization for copying a custom model into the target Form Recognizer resource. |
| GetDocumentClassifier(String, CancellationToken) |
Gets information about a document classifier, including the types of documents it can identify. |
| GetDocumentClassifierAsync(String, CancellationToken) |
Gets information about a document classifier, including the types of documents it can identify. |
| GetDocumentClassifiers(CancellationToken) |
Gets a collection of items describing the document classifiers available on this Form Recognizer resource. |
| GetDocumentClassifiersAsync(CancellationToken) |
Gets a collection of items describing the document classifiers available on this Form Recognizer resource. |
| GetDocumentModel(String, CancellationToken) |
Gets information about a model, including the types of documents it can recognize and the fields it will extract for each document type. |
| GetDocumentModelAsync(String, CancellationToken) |
Gets information about a model, including the types of documents it can recognize and the fields it will extract for each document type. |
| GetDocumentModels(CancellationToken) |
Gets a collection of items describing the models available on this Form Recognizer resource. |
| GetDocumentModelsAsync(CancellationToken) |
Gets a collection of items describing the models available on this Form Recognizer resource. |
| GetOperation(String, CancellationToken) |
Get a document model operation by its ID. Note that operation information only persists for 24 hours. |
| GetOperationAsync(String, CancellationToken) |
Get a document model operation by its ID. Note that operation information only persists for 24 hours. |
| GetOperations(CancellationToken) |
Lists all document model operations associated with the Form Recognizer resource. Note that operation information only persists for 24 hours. |
| GetOperationsAsync(CancellationToken) |
Lists all document model operations associated with the Form Recognizer resource. Note that operation information only persists for 24 hours. |
| GetResourceDetails(CancellationToken) |
Gets the number of built models on this Form Recognizer resource and the resource limits. |
| GetResourceDetailsAsync(CancellationToken) |
Gets the number of built models on this Form Recognizer resource and the resource limits. |
