API Reference

Extract

Review

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

List Extract Review Events

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

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

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

List a review’s history, newest first.

ParametersExpand Collapse

ReviewListEventsParams params

Optional<String> jobId

Optional<String> organizationId

Optional<Long> pageSize

Events per page.

maximum200

minimum1

Optional<String> pageToken

Token from the previous page.

Optional<String> projectId

ReturnsExpand Collapse

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.

List Extract Review Events

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.ReviewListEventsPage;
import ai.llamaindex.llamacloud.models.extract.review.ReviewListEventsParams;

public final class Main {
    private Main() {}

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

        ReviewListEventsPage page = client.extract().review().listEvents("job_id");
    }
}

200 example

{
  "items": [
    {
      "id": "id",
      "actor_id": "actor_id",
      "created_at": "2019-12-27T18:11:19.117Z",
      "kind": "approved",
      "detail": {
        "confidence_threshold": 0,
        "fields_in_scope": [
          "string"
        ],
        "origin": "api",
        "required_fields": [
          "string"
        ]
      },
      "path": "path",
      "value_after": {},
      "value_before": {}
    }
  ],
  "next_page_token": "next_page_token",
  "total_size": 0
}

Returns Examples

200 example

{
  "items": [
    {
      "id": "id",
      "actor_id": "actor_id",
      "created_at": "2019-12-27T18:11:19.117Z",
      "kind": "approved",
      "detail": {
        "confidence_threshold": 0,
        "fields_in_scope": [
          "string"
        ],
        "origin": "api",
        "required_fields": [
          "string"
        ]
      },
      "path": "path",
      "value_after": {},
      "value_before": {}
    }
  ],
  "next_page_token": "next_page_token",
  "total_size": 0
}