Skip to main content
The Extract response returns top-level request metadata and a result object. The result object contains the extracted data in extracted_schema and can also include citations, page-level fields, stamp results, and usage metadata.

Top-level response

The entity_extraction endpoint returns the following top-level structure:

Top-level fields

part_durations fields

Observed fields in part_durations include: All duration values are reported in milliseconds.

The result object

The result object can include the following fields:

The extracted_schema object

The result.extracted_schema object contains the extracted data in the structure defined by your schema.

Field behavior

  • String fields that cannot be extracted may be returned as empty strings.
  • Array fields that cannot be extracted may be returned as empty arrays.
  • The current response format does not force missing fields to return null.
  • Number and integer fields are returned according to the schema type when a value is extracted successfully.
  • Enum fields return one of the predefined values defined in the schema when a value is extracted successfully.

Example: full response with extracted_schema

Citations

The result.citations object identifies the source location of extracted values. When citation output is enabled, the response can include a citations object keyed by field name.

Example: full response with citations

Citation fields

Bounding region fields

Coordinate format

Citation positions use four-point bounding boxes:
The four points are ordered as:

Pages

The result.pages field contains page-level processing metadata. Observed page fields include:

Example: pages metadata

Stamps

The result.stamps field is returned as an array when stamp output is enabled. If no stamps are detected, the field may be returned as an empty array:
When stamp results are returned, each item can include the following fields:

Usage

The result.usage field contains usage metadata returned by the service. Observed fields include:

Example: usage metadata

Extract-specific errors

Most authentication, file, and request validation errors are shared across Parse and Extract. See Errors for the full common error reference. The following errors are specific to Extract:

Extract Quickstart

Extract your first document.

Schema Guide

Create extraction schemas.

Best Practices

Improve extraction accuracy.

Errors

Review common error codes.

Supported Files & Limits

Review supported formats and limits.