List File Pages Figures

client.pipelines.images.listPageFigures(, ?, ?): ImageListPageFiguresResponse { confidence, figure_name, figure_size, 4 more }

GET/api/v1/files/{id}/page-figures

List metadata for all figures from all pages of a file.

ParametersExpand Collapse

id: string

query: ImageListPageFiguresParams { organization_id, project_id }

organization_id?: string | null

project_id?: string | null

ReturnsExpand Collapse

ImageListPageFiguresResponse = Array<ImageListPageFiguresResponseItem>

confidence: number

The confidence of the figure

maximum1

minimum0

figure_name: string

The name of the figure

figure_size: number

The size of the figure in bytes

minimum0

file_id: string

The ID of the file that the figure was taken from

formatuuid

page_index: number

The index of the page for which the figure is taken (0-indexed)

minimum0

is_likely_noise?: boolean

Whether the figure is likely to be noise

metadata?: Record<string, unknown> | null

Metadata for the figure

List File Pages Figures

import LlamaCloud from '@llamaindex/llama-cloud';

const client = new LlamaCloud({
  apiKey: process.env['LLAMA_CLOUD_API_KEY'], // This is the default and can be omitted
});

const response = await client.pipelines.images.listPageFigures(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
);

console.log(response);

[
  {
    "confidence": 0,
    "figure_name": "figure_name",
    "figure_size": 0,
    "file_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "page_index": 0,
    "is_likely_noise": true,
    "metadata": {
      "foo": "bar"
    }
  }
]

Returns Examples

[
  {
    "confidence": 0,
    "figure_name": "figure_name",
    "figure_size": 0,
    "file_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "page_index": 0,
    "is_likely_noise": true,
    "metadata": {
      "foo": "bar"
    }
  }
]