API Reference

Extract

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Review

Create Extract Review

ExtractReview extract().review().create(ReviewCreateParamsparams = ReviewCreateParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

POST/api/v2/extract/{job_id}/review

Get Extract Review

ExtractReview extract().review().get(ReviewGetParamsparams = ReviewGetParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

GET/api/v2/extract/{job_id}/review

Change Extract Review Fields

ExtractReview extract().review().changeFields(ReviewChangeFieldsParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

POST/api/v2/extract/{job_id}/review/fields

Approve Extract Review

ExtractReview extract().review().approve(ReviewApproveParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

POST/api/v2/extract/{job_id}/review/approve

Reject Extract Review

ExtractReview extract().review().reject(ReviewRejectParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

POST/api/v2/extract/{job_id}/review/reject

Reopen Extract Review

ExtractReview extract().review().reopen(ReviewReopenParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

POST/api/v2/extract/{job_id}/review/reopen

List Extract Review Events

ReviewListEventsPage extract().review().listEvents(ReviewListEventsParamsparams = ReviewListEventsParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

GET/api/v2/extract/{job_id}/review/events

ModelsExpand Collapse

class ExtractReview:

An extract job’s review: its settings, flags, field actions and decision, with the result as read and as reviewed.

String id

Unique identifier of the review.

double confidenceThreshold

Fields read below this confidence are flagged.

LocalDateTime createdAt

When review was turned on.

formatdate-time

Optional<LocalDateTime> decidedAt

When it was approved or rejected.

formatdate-time

Optional<String> decidedBy

ID of the user who approved or rejected it.

Optional<String> decidedReason

Why it was rejected.

FieldActions fieldActions

The latest action per field, keyed by JSON Pointer.

Action action

confirm, correct or clear.

One of the following:

CLEAR("clear")

CONFIRM("confirm")

CORRECT("correct")

String actorId

ID of the user who acted.

LocalDateTime at

When they acted.

formatdate-time

Optional<JsonValue> value

The corrected value, for correct.

List<String> fieldsInScope

JSON Pointers of the fields the threshold applies to; empty means all.

List<Flag> flags

Fields the review asks a person to check.

boolean handled

Whether someone confirmed, corrected or cleared it.

String path

JSON Pointer of the field.

Reason reason

below_threshold, or required_empty for a required field left empty.

One of the following:

BELOW_THRESHOLD("below_threshold")

REQUIRED_EMPTY("required_empty")

Optional<Cell> cell

Where in a list the least confident value is.

long row

Index of the row, from 0.

Optional<String> column

Property of the row, when rows are objects.

Optional<Double> confidence

The field’s confidence; for a list, its least confident value.

String jobId

The extract job reviewed.

List<String> openFlags

JSON Pointers of flagged fields nobody checked.

Optional<OriginalResult> originalResult

The result as the model read it.

List<String> requiredFields

JSON Pointers of fields flagged when empty.

LocalDateTime retainUntil

When the job and its document may be deleted.

formatdate-time

ReviewedResult reviewedResult

The result with the field actions.

long revision

Bumped by every change; actions name the one they saw.

Optional<String> sourceFileId

The file the job read, or the file behind the parse job it read; null for a URL.

Status status

pending until approved or rejected.

One of the following:

APPROVED("approved")

PENDING("pending")

REJECTED("rejected")

LocalDateTime updatedAt

When the review last changed.

formatdate-time

class ExtractReviewEvent:

One entry in a review’s history.

String id

Unique identifier of the entry.

String actorId

ID of the user who acted.

LocalDateTime createdAt

When it happened.

formatdate-time

Kind kind

What happened.

One of the following:

APPROVED("approved")

CREATED("created")

FIELD_CLEARED("field_cleared")

FIELD_CONFIRMED("field_confirmed")

FIELD_CORRECTED("field_corrected")

FIELD_RESTORED("field_restored")

FIELD_UNDONE("field_undone")

FLAGS_SIGNED_OFF("flags_signed_off")

REJECTED("rejected")

REOPENED("reopened")

Optional<Detail> detail

The settings for created, the reason for rejected, and the fields for flags_signed_off; null for the rest.

One of the following:

class ExtractReviewCreatedDetail:

What a created entry records: where review was turned on, and its settings.

double confidenceThreshold

Fields read below this confidence are flagged.

List<String> fieldsInScope

JSON Pointers of the fields the threshold applies to; empty means all.

Origin origin

Turned on as the job ran, from History, by a first edit, or by the API.

One of the following:

API("api")

EDIT("edit")

HISTORY("history")

RUN("run")

List<String> requiredFields

JSON Pointers of fields flagged when empty.

class ExtractReviewRejectedDetail:

What a rejected entry records.

String reason

Why the result was rejected.

class ExtractReviewSignedOffDetail:

What a flags_signed_off entry records.

List<String> paths

JSON Pointers of the flagged fields confirmed as part of approving.

Optional<String> path

JSON Pointer of the field it changed.

Optional<JsonValue> valueAfter

The field’s value after the change.

Optional<JsonValue> valueBefore

The field’s value before the change.