Annotation

Search text

Search for a phrase in the document.

get/api/v1/annotations/{annotationID}/search

Request

Base URL
https://example.rossum.app
Auth
HTTP bearer
TypeScript
https://skmtc.dev/rossum/apis/rossum-api/docs/api/v1/annotations/:annotationID/search/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

phrasestring required

A phrase to search for.

toleranceinteger

Allowed Edit distance from the search phrase (number of removal, insertion or substitution operations that need to be performed for strings to match). Only used for OCR invoices (images, such as png or PDF with scanned images). Default value is computed as length(phrase)/4.

Response

Example response

{
  "results": [
    {
      "rectangle": [
        67.15157010915198,
        545.9286363906203,
        87.99106633081445,
        563.4617583852776
      ],
      "page": 1
    }
  ]
}

Changes

No recorded changes to this operation across all 14 revisions of this API.