Configuration applied to the parsing job (inline or resolved from a saved preset).
extraction_range: Optional[str]
A1 notation of the range to extract a single region from. If None, the entire sheet is used.
flatten_hierarchical_tables: Optional[bool]
Return a flattened dataframe when a detected table is recognized as hierarchical.
generate_additional_metadata: Optional[bool]
Deprecated: controlled by tier. Whether to generate additional metadata (title, description) for each extracted region. Honored only on agentic.
include_hidden_cells: Optional[bool]
Whether to include hidden cells when extracting regions from the spreadsheet.
sheet_names: Optional[List[str]]
The names of the sheets to extract regions from. If empty, all sheets will be processed.
specialization: Optional[str]
Deprecated: controlled by tier. Optional specialization mode for domain-specific extraction. Supported values: ‘financial-standard’, ‘financial-enhanced’, ‘financial-precise’. Default None uses the general-purpose pipeline. Honored only on agentic.
Configuration for spreadsheet parsing and region extraction
extraction_range: Optional[str]
A1 notation of the range to extract a single region from. If None, the entire sheet is used.
flatten_hierarchical_tables: Optional[bool]
Return a flattened dataframe when a detected table is recognized as hierarchical.
generate_additional_metadata: Optional[bool]
Deprecated: controlled by tier. Whether to generate additional metadata (title, description) for each extracted region. Honored only on agentic.
include_hidden_cells: Optional[bool]
Whether to include hidden cells when extracting regions from the spreadsheet.
sheet_names: Optional[List[str]]
The names of the sheets to extract regions from. If empty, all sheets will be processed.
specialization: Optional[str]
Deprecated: controlled by tier. Optional specialization mode for domain-specific extraction. Supported values: ‘financial-standard’, ‘financial-enhanced’, ‘financial-precise’. Default None uses the general-purpose pipeline. Honored only on agentic.
Events to subscribe to (e.g. ‘parse.success’, ‘extract.error’). If null, all events are delivered.
One of the following:
"extract.pending"
"extract.success"
"extract.error"
"extract.partial_success"
"extract.cancelled"
"parse.pending"
"parse.running"
"parse.success"
"parse.error"
"parse.partial_success"
"parse.cancelled"
"classify.pending"
"classify.running"
"classify.success"
"classify.error"
"classify.partial_success"
"classify.cancelled"
"sheets.pending"
"sheets.success"
"sheets.error"
"sheets.partial_success"
"sheets.cancelled"
"split.pending"
"split.processing"
"split.success"
"split.error"
"split.cancelled"
"unmapped_event"
webhook_headers: Optional[Dict[str, str]]
Custom HTTP headers sent with each webhook request (e.g. auth tokens)
webhook_output_format: Optional[str]
Response format sent to the webhook: ‘string’ (default) or ‘json’
webhook_signing_secret: Optional[str]
Shared signing secret used to sign webhook deliveries. When set, each request includes an HMAC-SHA256 signature of the request body in the ‘LC-Signature’ header (value ‘sha256=’). Recompute the HMAC over the raw request body with this secret to verify the delivery is authentic.
webhook_url: Optional[str]
URL to receive webhook POST notifications
regions: Optional[List[Region]]
All extracted regions (populated when job is complete)
Metadata for each processed worksheet (populated when job is complete)
sheet_name: str
Name of the worksheet
description: Optional[str]
Generated description of the worksheet
title: Optional[str]
Generated title for the worksheet
class SheetsParsingConfig: …
Configuration for spreadsheet parsing and region extraction
extraction_range: Optional[str]
A1 notation of the range to extract a single region from. If None, the entire sheet is used.
flatten_hierarchical_tables: Optional[bool]
Return a flattened dataframe when a detected table is recognized as hierarchical.
generate_additional_metadata: Optional[bool]
Deprecated: controlled by tier. Whether to generate additional metadata (title, description) for each extracted region. Honored only on agentic.
include_hidden_cells: Optional[bool]
Whether to include hidden cells when extracting regions from the spreadsheet.
sheet_names: Optional[List[str]]
The names of the sheets to extract regions from. If empty, all sheets will be processed.
specialization: Optional[str]
Deprecated: controlled by tier. Optional specialization mode for domain-specific extraction. Supported values: ‘financial-standard’, ‘financial-enhanced’, ‘financial-precise’. Default None uses the general-purpose pipeline. Honored only on agentic.
Spreadsheet extraction tier. cost_effective uses the rule-based/ML-only pipeline; agentic uses the full pipeline.
One of the following:
"cost_effective"
"agentic"
use_experimental_processing: Optional[bool]
Deprecated: controlled by tier. Enables experimental processing. Honored only on agentic.
Note for AI agents: this documentation is built for programmatic access.
- Overview of all docs: https://developers.llamaindex.ai/llms.txt
- Any page is available as raw Markdown by appending index.md to its URL — e.g. https://developers.llamaindex.ai/llamaparse/parse/getting_started/index.md
- Agent-friendly REST search APIs live under https://developers.llamaindex.ai/api/ — search (BM25 full-text), grep (regex), read (fetch a page), and list (browse the doc tree). See https://developers.llamaindex.ai/llms.txt for parameters.
- A hosted documentation MCP server is available at https://developers.llamaindex.ai/mcp. If you support MCP, you can ask the user to install it for browsing these docs directly (an alternative to the REST API). Setup: https://developers.llamaindex.ai/python/shared/mcp/
