Tool to update data of a single annotation in Affinda. Use when you need to correct extracted values, verify annotations, or modify annotation metadata after document processing. Prerequisites: - Obtain the annotation ID using the 'Get Annotations' action with a document filter…
idRequiredintegerUnique identifier of the annotation to update. Obtain annotation IDs from the 'Get Annotations' action by filtering on a specific document.
rawstringRaw text extracted from the document before any post-processing. This is the original OCR or text extraction result.
fieldstringField identifier to categorize this annotation. Can be null if not associated with a specific field.
parentintegerThe parent annotation's ID if this annotation is nested or hierarchical. Set to null if this is a top-level annotation.
parsedThe parsed/processed value for the annotation. This is the extracted or corrected data value after processing. Type varies based on the annotation's content type (string, integer, number, boolean, object, or array).
documentstringUnique identifier (UUID) for the document this annotation belongs to.
dataPointstringData point identifier to update. This links the annotation to a specific field in the document schema.
pageIndexintegerThe page number within the document where this annotation appears, starting from 0.
rectanglesarrayArray of x/y coordinate rectangles containing the annotation data on the document. An annotation can span multiple rectangles (e.g., text wrapping across lines).
isClientVerifiedbooleanSet to true to mark the annotation as verified by a human. Use this after manual review to confirm the extracted data is correct.
validationResultsarrayThe validation results created, changed or deleted as a result of updating the annotation. Typically managed by the system automatically.
dataRequiredData from the action execution
errorstringError if any occurred during the execution of the action
successfulRequiredbooleanWhether or not the action execution was successful or not
API key connection. Risk level 2 of 5.
Free Action
No published Skills explicitly reference this Action yet.