LogoLogo
About
  • Home
  • Guides
  • BDK
  • REST API
  • Release Notes
  • OpenAI
    • Overview
  • Ask Koncierge
  • Ask Koncierge To Extract Information From A Document
  • Extract Data
  • Extract Pages
  • Extract a Subdocument
  • Extract Subdocuments
  • Extract Tables
  • Identify Elements in a Text
Powered by GitBook
On this page
  • Overview
  • Syntax
  • Data
  • Components
  • Values
  • Examples

Was this helpful?

Export as PDF

Extract Pages

This procedure extracts individual pages from a document or file.

Last updated 1 day ago

Was this helpful?

📘 Prerequisites

Ensure you have the Document Processing Book before using this operation. After learning the Book, make sure to publish your Agent and create a new Playground for it to take effect.

Overview

This operation extracts individual pages from a document or file, creating a separate document for each page.

Syntax

Default

By default, all pages in the document are extracted as separate pages:

extract pages from the document

Specifying a Page Range (optional)

Optionally, you can specify a range of pages for extraction:

extract pages from the document
    the start page is {start}
    the end page is {end}

Note:

  • Providing only the start page extracts from that page to the last page.

  • Providing only the end page extracts from the first page to that page.

  • Providing both the start page and the end page will extract the pages within that range.

Data

Components

This table lists the names of the data components in this operation and their properties.

Label
Renamable
Required

the document

Yes

Required

the start page

No

Optional

the end page

No

Optional

Values

The table below lists the parameters in the operation. Parameters are placeholders for data values. In the operation's syntax, replace the parameters with your own data values as needed.

Parameter
Description
Example Value
Required

start

The starting page number. Defaults to the first page.

2

Optional

end

The ending page number. Defaults to the last page.

5

Optional

Examples

1. Extracting all pages

In this example, no start or end pages are specified, so all pages will be extracted.

extract pages from the file

2. Specifying the start page

extract pages from the document
    the start page is 3

3. Specifying the end page

extract pages from the document
    the end page is 10

4. Specifying start and end pages

extract pages from the document
    the start page is 2
    the end page is 5
learned