Share via

DocumentModelAdministrationClient.GetDocumentModel Method

  • Reference

Definition

Namespace:
Azure.AI.FormRecognizer.DocumentAnalysis
Assembly:
Azure.AI.FormRecognizer.dll
Package:
Azure.AI.FormRecognizer v4.1.0
Source:
DocumentModelAdministrationClient.cs

Gets information about a model, including the types of documents it can recognize and the fields it will extract for each document type.

public virtual Azure.Response<Azure.AI.FormRecognizer.DocumentAnalysis.DocumentModelDetails> GetDocumentModel (string modelId, System.Threading.CancellationToken cancellationToken = default);
abstract member GetDocumentModel : string * System.Threading.CancellationToken -> Azure.Response<Azure.AI.FormRecognizer.DocumentAnalysis.DocumentModelDetails>
override this.GetDocumentModel : string * System.Threading.CancellationToken -> Azure.Response<Azure.AI.FormRecognizer.DocumentAnalysis.DocumentModelDetails>
Public Overridable Function GetDocumentModel (modelId As String, Optional cancellationToken As CancellationToken = Nothing) As Response(Of DocumentModelDetails)

Parameters

modelId
String

The ID of the model to retrieve.

cancellationToken
CancellationToken

A CancellationToken controlling the request lifetime.

Returns

Response<DocumentModelDetails>

A Response<T> representing the result of the operation. It can be cast to a DocumentModelDetails containing information about the requested model.

Applies to