@azure/cognitiveservices-formrecognizer package

Classes

FormRecognizerClient

FormRecognizerClientContext

Interfaces

AnalyzeResult	Analyze API call result.
BatchReadReceiptHeaders	Defines headers for BatchReadReceipt operation.
BatchReadReceiptInStreamHeaders	Defines headers for BatchReadReceiptInStream operation.
ComputerVisionError	Details about the API request error.
ElementReference	Reference to an OCR word.
ErrorInformation	An interface representing ErrorInformation.
ErrorResponse	An interface representing ErrorResponse.
ExtractedKeyValuePair	Representation of a key-value pair as a list of key and value tokens.
ExtractedPage	Extraction information of a single page in a with a document.
ExtractedTable	Extraction information about a table contained in a page.
ExtractedTableColumn	Extraction information of a column in a table.
ExtractedToken	Canonical representation of single extracted text.
FieldValue	Base class representing a recognized field value.
FormDocumentReport	An interface representing FormDocumentReport.
FormOperationError	Error reported during an operation.
FormRecognizerClientAnalyzeWithCustomModelOptionalParams	Optional Parameters.
ImageUrl	An interface representing ImageUrl.
InnerError	An interface representing InnerError.
KeysResult	Result of an operation to get the keys extracted by a model.
Line	An object representing a recognized text line.
ModelResult	Result of a model status query operation.
ModelsResult	Result of query operation to fetch multiple models.
NumberValue	Recognized numeric field value.
ReadReceiptResult	Analysis result of the 'Batch Read Receipt' operation.
StringValue	Recognized string field value.
TextRecognitionResult	An object representing a recognized text region
TrainRequest	Contract to initiate a train request.
TrainResult	Response of the Train API call.
TrainSourceFilter	Filters to be applied when traversing a data source.
UnderstandingResult	A set of extracted fields corresponding to a semantic object, such as a receipt, in the input document.
Word	An object representing a recognized word.

Type Aliases

AnalyzeWithCustomModelResponse	Contains response data for the analyzeWithCustomModel operation.
BatchReadReceiptInStreamResponse	Contains response data for the batchReadReceiptInStream operation.
BatchReadReceiptResponse	Contains response data for the batchReadReceipt operation.
FieldValueUnion	Contains the possible cases for FieldValue.
GetCustomModelResponse	Contains response data for the getCustomModel operation.
GetCustomModelsResponse	Contains response data for the getCustomModels operation.
GetExtractedKeysResponse	Contains response data for the getExtractedKeys operation.
GetReadReceiptResultResponse	Contains response data for the getReadReceiptResult operation.
Status	Defines values for Status. Possible values include: 'success', 'partialSuccess', 'failure'
Status1	Defines values for Status1. Possible values include: 'created', 'ready', 'invalid'
Status2	Defines values for Status2. Possible values include: 'success', 'partialSuccess', 'failure'
TextOperationStatusCodes	Defines values for TextOperationStatusCodes. Possible values include: 'Not Started', 'Running', 'Failed', 'Succeeded'
TextRecognitionResultConfidenceClass	Defines values for TextRecognitionResultConfidenceClass. Possible values include: 'High', 'Low'
TextRecognitionResultDimensionUnit	Defines values for TextRecognitionResultDimensionUnit. Possible values include: 'pixel', 'inch'
TrainCustomModelResponse	Contains response data for the trainCustomModel operation.