List File Pages Figures

client.Pipelines.Images.ListPageFigures(ctx, id, query) (*[]PipelineImageListPageFiguresResponse, error)

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

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

ParametersExpand Collapse

id string

query PipelineImageListPageFiguresParams

OrganizationID param.Field[string]optional

ProjectID param.Field[string]optional

ReturnsExpand Collapse

type PipelineImageListPageFiguresResponse []PipelineImageListPageFiguresResponse

Confidence float64

The confidence of the figure

maximum1

minimum0

FigureName string

The name of the figure

FigureSize int64

The size of the figure in bytes

minimum0

FileID string

The ID of the file that the figure was taken from

formatuuid

PageIndex int64

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

minimum0

IsLikelyNoise booloptional

Whether the figure is likely to be noise

Metadata map[string, any]optional

Metadata for the figure

List File Pages Figures

package main

import (
  "context"
  "fmt"

  "github.com/stainless-sdks/llamacloud-prod-go"
  "github.com/stainless-sdks/llamacloud-prod-go/option"
)

func main() {
  client := llamacloudprod.NewClient(
    option.WithAPIKey("My API Key"),
  )
  response, err := client.Pipelines.Images.ListPageFigures(
    context.TODO(),
    "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    llamacloudprod.PipelineImageListPageFiguresParams{

    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", 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"
    }
  }
]