API Reference

Extract

Review

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Approve Extract Review

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

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

Beta: answers 403 until extract review is enabled for the caller and their organization.

Approve the reviewed result.

While flagged fields nobody checked remain, answers 409 with code: open_flags and their paths, unless sign_off confirms them as part of approving. A job that has not completed answers 409 with code: job_not_reviewable. A revision other than the review’s latest answers 409 with code: stale_revision and the latest revision.

ParametersExpand Collapse

ReviewApproveParams params

Optional<String> jobId

Optional<String> organizationId

Optional<String> projectId

long revision

The review’s revision as the caller last read it.

minimum0

Optional<Boolean> signOff

Confirm the flagged fields nobody checked as part of approving.

ReturnsExpand 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

Approve Extract Review

Java

HTTP

TypeScript

Python

Go

Java

C#

CLI Tool

package ai.llamaindex.llamacloud.example;

import ai.llamaindex.llamacloud.client.LlamaCloudClient;
import ai.llamaindex.llamacloud.client.okhttp.LlamaCloudOkHttpClient;
import ai.llamaindex.llamacloud.models.extract.review.ExtractReview;
import ai.llamaindex.llamacloud.models.extract.review.ReviewApproveParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        LlamaCloudClient client = LlamaCloudOkHttpClient.fromEnv();

        ReviewApproveParams params = ReviewApproveParams.builder()
            .jobId("job_id")
            .revision(0L)
            .build();
        ExtractReview extractReview = client.extract().review().approve(params);
    }
}

200 example

{
  "id": "id",
  "confidence_threshold": 0,
  "created_at": "2019-12-27T18:11:19.117Z",
  "decided_at": "2019-12-27T18:11:19.117Z",
  "decided_by": "decided_by",
  "decided_reason": "decided_reason",
  "field_actions": {
    "foo": {
      "action": "clear",
      "actor_id": "actor_id",
      "at": "2019-12-27T18:11:19.117Z",
      "value": {}
    }
  },
  "fields_in_scope": [
    "string"
  ],
  "flags": [
    {
      "handled": true,
      "path": "path",
      "reason": "below_threshold",
      "cell": {
        "row": 0,
        "column": "column"
      },
      "confidence": 0
    }
  ],
  "job_id": "job_id",
  "open_flags": [
    "string"
  ],
  "original_result": {
    "foo": "bar"
  },
  "required_fields": [
    "string"
  ],
  "retain_until": "2019-12-27T18:11:19.117Z",
  "reviewed_result": {
    "foo": "bar"
  },
  "revision": 0,
  "source_file_id": "source_file_id",
  "status": "approved",
  "updated_at": "2019-12-27T18:11:19.117Z"
}

Returns Examples

200 example

{
  "id": "id",
  "confidence_threshold": 0,
  "created_at": "2019-12-27T18:11:19.117Z",
  "decided_at": "2019-12-27T18:11:19.117Z",
  "decided_by": "decided_by",
  "decided_reason": "decided_reason",
  "field_actions": {
    "foo": {
      "action": "clear",
      "actor_id": "actor_id",
      "at": "2019-12-27T18:11:19.117Z",
      "value": {}
    }
  },
  "fields_in_scope": [
    "string"
  ],
  "flags": [
    {
      "handled": true,
      "path": "path",
      "reason": "below_threshold",
      "cell": {
        "row": 0,
        "column": "column"
      },
      "confidence": 0
    }
  ],
  "job_id": "job_id",
  "open_flags": [
    "string"
  ],
  "original_result": {
    "foo": "bar"
  },
  "required_fields": [
    "string"
  ],
  "retain_until": "2019-12-27T18:11:19.117Z",
  "reviewed_result": {
    "foo": "bar"
  },
  "revision": 0,
  "source_file_id": "source_file_id",
  "status": "approved",
  "updated_at": "2019-12-27T18:11:19.117Z"
}