ocrapi
  1. Schemas
ocrapi
  • ImageOcr
    • Convert a scanned image into words with location
      POST
    • Convert a scanned image into words with location
      POST
    • Convert a scanned image into text
      POST
    • Recognize a photo of a business card, extract key business information
      POST
    • Recognize a photo of a form, extract key fields and business information
      POST
    • Recognize a photo of a form, extract key fields using stored templates
      POST
    • Recognize a photo of a receipt, extract key business information
      POST
    • Convert a photo of a document or receipt into words with location
      POST
    • Convert a photo of a document into text
      POST
  • PdfOcr
    • Convert a PDF into text lines with location
    • Convert a PDF into words with location
    • Converts an uploaded PDF file into text via Optical Character Recognition.
  • Preprocessing
    • Convert an image of text into a binarized (light and dark) view
    • Convert an image of text into a binary (light and dark) view with ML
    • Get the angle of the page / document / receipt
    • Detect and unrotate a document image
    • Detect and unrotate a document image (advanced)
    • Detect and unskew a photo of a document
  • Receipts
    • Convert a photo of a receipt into a CSV file containing structured information from the receipt
  • Schemas
    • Schemas
      • BusinessCardRecognitionResult
      • FieldResult
      • FormDefinitionTemplate
      • FormFieldDefinition
      • FormRecognitionResult
      • FormTableColumnDefinition
      • FormTableDefinition
      • GetPageAngleResult
      • ImageToLinesWithLocationResult
      • ImageToTextResponse
      • ImageToWordsWithLocationResult
      • OcrLineElement
      • OcrPageResult
      • OcrPageResultWithLinesWithLocation
      • OcrPageResultWithWordsWithLocation
      • OcrPhotoTextElement
      • OcrWordElement
      • PdfToLinesWithLocationResult
      • PdfToTextResponse
      • PdfToWordsWithLocationResult
      • PhotoToWordsWithLocationResult
      • Point
      • ReceiptLineItem
      • ReceiptRecognitionResult
      • TableCellResult
      • TableResult
      • TableRowResult
  1. Schemas

FieldResult

A pairing target field and actual value read from form

{
    "FieldValues": [
        {
            "BoundingPoints": [
                {
                    "X": 0,
                    "Y": 0
                }
            ],
            "ConfidenceLevel": 0,
            "Height": 0,
            "Text": "string",
            "Width": 0,
            "XLeft": 0,
            "YTop": 0
        }
    ],
    "TargetField": {
        "AllowNumericDigits": true,
        "AlternateAnchor": "string",
        "AnchorMode": "string",
        "BottomAnchor": "string",
        "DataType": "string",
        "FieldID": "string",
        "HorizontalAlignmentType": "string",
        "Ignore": [
            "string"
        ],
        "LeftAnchor": "string",
        "MinimumCharacterCount": 0,
        "Options": "string",
        "TargetDigitCount": 0,
        "TargetFieldHeight_Relative": 0,
        "TargetFieldHorizontalAdjustment": 0,
        "TargetFieldVerticalAdjustment": 0,
        "TargetFieldWidth_Relative": 0,
        "TopAnchor": "string",
        "VerticalAlignmentType": "string"
    }
}
Built with