API Reference

Extract

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Review

Create Extract Review

client.Extract.Review.New(ctx, jobID, params) (*ExtractReview, error)

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

Get Extract Review

client.Extract.Review.Get(ctx, jobID, query) (*ExtractReview, error)

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

Change Extract Review Fields

client.Extract.Review.ChangeFields(ctx, jobID, params) (*ExtractReview, error)

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

Approve Extract Review

client.Extract.Review.Approve(ctx, jobID, params) (*ExtractReview, error)

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

Reject Extract Review

client.Extract.Review.Reject(ctx, jobID, params) (*ExtractReview, error)

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

Reopen Extract Review

client.Extract.Review.Reopen(ctx, jobID, params) (*ExtractReview, error)

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

List Extract Review Events

client.Extract.Review.ListEvents(ctx, jobID, query) (*PaginatedCursor[ExtractReviewEvent], error)

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

ModelsExpand Collapse

type ExtractReview struct{…}

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

ID string

Unique identifier of the review.

ConfidenceThreshold float64

Fields read below this confidence are flagged.

CreatedAt Time

When review was turned on.

formatdate-time

DecidedAt Time

When it was approved or rejected.

formatdate-time

DecidedBy string

ID of the user who approved or rejected it.

DecidedReason string

Why it was rejected.

FieldActions map[string, ExtractReviewFieldAction]

The latest action per field, keyed by JSON Pointer.

Action string

confirm, correct or clear.

One of the following:

const ExtractReviewFieldActionActionClear ExtractReviewFieldActionAction = "clear"

const ExtractReviewFieldActionActionConfirm ExtractReviewFieldActionAction = "confirm"

const ExtractReviewFieldActionActionCorrect ExtractReviewFieldActionAction = "correct"

ActorID string

ID of the user who acted.

At Time

When they acted.

formatdate-time

Value anyOptional

The corrected value, for correct.

FieldsInScope []string

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

Flags []ExtractReviewFlag

Fields the review asks a person to check.

Handled bool

Whether someone confirmed, corrected or cleared it.

Path string

JSON Pointer of the field.

Reason string

below_threshold, or required_empty for a required field left empty.

One of the following:

const ExtractReviewFlagReasonBelowThreshold ExtractReviewFlagReason = "below_threshold"

const ExtractReviewFlagReasonRequiredEmpty ExtractReviewFlagReason = "required_empty"

Cell ExtractReviewFlagCellOptional

Where in a list the least confident value is.

Row int64

Index of the row, from 0.

Column stringOptional

Property of the row, when rows are objects.

Confidence float64Optional

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

JobID string

The extract job reviewed.

OpenFlags []string

JSON Pointers of flagged fields nobody checked.

OriginalResult map[string, any]

The result as the model read it.

RequiredFields []string

JSON Pointers of fields flagged when empty.

RetainUntil Time

When the job and its document may be deleted.

formatdate-time

ReviewedResult map[string, any]

The result with the field actions.

Revision int64

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

SourceFileID string

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

Status ExtractReviewStatus

pending until approved or rejected.

One of the following:

const ExtractReviewStatusApproved ExtractReviewStatus = "approved"

const ExtractReviewStatusPending ExtractReviewStatus = "pending"

const ExtractReviewStatusRejected ExtractReviewStatus = "rejected"

UpdatedAt Time

When the review last changed.

formatdate-time

type ExtractReviewEvent struct{…}

One entry in a review’s history.

ID string

Unique identifier of the entry.

ActorID string

ID of the user who acted.

CreatedAt Time

When it happened.

formatdate-time

Kind ExtractReviewEventKind

What happened.

One of the following:

const ExtractReviewEventKindApproved ExtractReviewEventKind = "approved"

const ExtractReviewEventKindCreated ExtractReviewEventKind = "created"

const ExtractReviewEventKindFieldCleared ExtractReviewEventKind = "field_cleared"

const ExtractReviewEventKindFieldConfirmed ExtractReviewEventKind = "field_confirmed"

const ExtractReviewEventKindFieldCorrected ExtractReviewEventKind = "field_corrected"

const ExtractReviewEventKindFieldRestored ExtractReviewEventKind = "field_restored"

const ExtractReviewEventKindFieldUndone ExtractReviewEventKind = "field_undone"

const ExtractReviewEventKindFlagsSignedOff ExtractReviewEventKind = "flags_signed_off"

const ExtractReviewEventKindRejected ExtractReviewEventKind = "rejected"

const ExtractReviewEventKindReopened ExtractReviewEventKind = "reopened"

Detail ExtractReviewEventDetailUnionOptional

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

One of the following:

type ExtractReviewEventDetailExtractReviewCreatedDetail struct{…}

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

ConfidenceThreshold float64

Fields read below this confidence are flagged.

FieldsInScope []string

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

Origin string

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

One of the following:

const ExtractReviewEventDetailExtractReviewCreatedDetailOriginAPI ExtractReviewEventDetailExtractReviewCreatedDetailOrigin = "api"

const ExtractReviewEventDetailExtractReviewCreatedDetailOriginEdit ExtractReviewEventDetailExtractReviewCreatedDetailOrigin = "edit"

const ExtractReviewEventDetailExtractReviewCreatedDetailOriginHistory ExtractReviewEventDetailExtractReviewCreatedDetailOrigin = "history"

const ExtractReviewEventDetailExtractReviewCreatedDetailOriginRun ExtractReviewEventDetailExtractReviewCreatedDetailOrigin = "run"

RequiredFields []string

JSON Pointers of fields flagged when empty.

type ExtractReviewEventDetailExtractReviewRejectedDetail struct{…}

What a rejected entry records.

Reason string

Why the result was rejected.

type ExtractReviewEventDetailExtractReviewSignedOffDetail struct{…}

What a flags_signed_off entry records.

Paths []string

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

Path stringOptional

JSON Pointer of the field it changed.

ValueAfter anyOptional

The field’s value after the change.

ValueBefore anyOptional

The field’s value before the change.