ModelsExpand Collapse A spreadsheet parsing job.
Configuration applied to the parsing job (inline or resolved from a saved preset).
A1 notation of the range to extract a single region from. If None, the entire sheet is used.
FlattenHierarchicalTables bool optional
Return a flattened dataframe when a detected table is recognized as hierarchical.
Whether to generate additional metadata (title, description) for each extracted region.
IncludeHiddenCells bool optional
Whether to include hidden cells when extracting regions from the spreadsheet.
SheetNames [] string optional
The names of the sheets to extract regions from. If empty, all sheets will be processed.
Specialization string optional
Optional specialization mode for domain-specific extraction. Supported values: ‘financial-standard’, ‘financial-enhanced’, ‘financial-precise’. Default None uses the general-purpose pipeline.
TableMergeSensitivity SheetsParsingConfigTableMergeSensitivity optional
Influences how likely similar-looking regions are merged into a single table. Useful for spreadsheets that either have sparse tables (strong merging) or many distinct tables close together (weak merging).
One of the following:
const SheetsParsingConfigTableMergeSensitivityStrong SheetsParsingConfigTableMergeSensitivity = "strong"
const SheetsParsingConfigTableMergeSensitivityWeak SheetsParsingConfigTableMergeSensitivity = "weak"
UseExperimentalProcessing bool optional
Enables experimental processing. Accuracy may be impacted.
The status of the parsing job
One of the following:
const SheetsJobStatusPending SheetsJobStatus = "PENDING"
const SheetsJobStatusSuccess SheetsJobStatus = "SUCCESS"
const SheetsJobStatusError SheetsJobStatus = "ERROR"
const SheetsJobStatusPartialSuccess SheetsJobStatus = "PARTIAL_SUCCESS"
const SheetsJobStatusCancelled SheetsJobStatus = "CANCELLED"
When the job was last updated
Configuration for spreadsheet parsing and region extraction
A1 notation of the range to extract a single region from. If None, the entire sheet is used.
FlattenHierarchicalTables bool optional
Return a flattened dataframe when a detected table is recognized as hierarchical.
Whether to generate additional metadata (title, description) for each extracted region.
IncludeHiddenCells bool optional
Whether to include hidden cells when extracting regions from the spreadsheet.
SheetNames [] string optional
The names of the sheets to extract regions from. If empty, all sheets will be processed.
Specialization string optional
Optional specialization mode for domain-specific extraction. Supported values: ‘financial-standard’, ‘financial-enhanced’, ‘financial-precise’. Default None uses the general-purpose pipeline.
TableMergeSensitivity SheetsParsingConfigTableMergeSensitivity optional
Influences how likely similar-looking regions are merged into a single table. Useful for spreadsheets that either have sparse tables (strong merging) or many distinct tables close together (weak merging).
One of the following:
const SheetsParsingConfigTableMergeSensitivityStrong SheetsParsingConfigTableMergeSensitivity = "strong"
const SheetsParsingConfigTableMergeSensitivityWeak SheetsParsingConfigTableMergeSensitivity = "weak"
UseExperimentalProcessing bool optional
Enables experimental processing. Accuracy may be impacted.
ConfigurationID string optional
The saved product configuration ID used at create time, if any.
Deprecated File File optional The ID of the project that the file belongs to
DataSourceID string optional
The ID of the data source that the file belongs to
The expiration date for the file. Files past this date can be deleted.
ExternalFileID string optional
The ID of the file in the external system
Size of the file in bytes
File type (e.g. pdf, docx, etc.)
LastModifiedAt Time optional
The last modified time of the file
PermissionInfo map [ string , FilePermissionInfoUnion ] optional
Permission information for the file
One of the following:
type FilePermissionInfoMap map [ string , any ]
type FilePermissionInfoArray [] any
The intended purpose of the file (e.g., ‘user_data’, ‘parse’, ‘extract’, ‘split’, ‘classify’)
ResourceInfo map [ string , FileResourceInfoUnion ] optional
Resource information for the file
One of the following:
type FileResourceInfoMap map [ string , any ]
type FileResourceInfoArray [] any
Per-status entry timestamps. Returned only when requested via ?expand=metadata_state_transitions.
Parameters SheetsJobParameters optional
Job-time parameters such as webhook configurations.
WebhookConfigurations [] SheetsJobParametersWebhookConfiguration optional
Webhook configurations for job status notifications.
WebhookEvents [] string optional
Events to subscribe to (e.g. ‘parse.success’, ‘extract.error’). If null, all events are delivered.
One of the following:
const SheetsJobParametersWebhookConfigurationWebhookEventExtractPending SheetsJobParametersWebhookConfigurationWebhookEvent = "extract.pending"
const SheetsJobParametersWebhookConfigurationWebhookEventExtractSuccess SheetsJobParametersWebhookConfigurationWebhookEvent = "extract.success"
const SheetsJobParametersWebhookConfigurationWebhookEventExtractError SheetsJobParametersWebhookConfigurationWebhookEvent = "extract.error"
const SheetsJobParametersWebhookConfigurationWebhookEventExtractPartialSuccess SheetsJobParametersWebhookConfigurationWebhookEvent = "extract.partial_success"
const SheetsJobParametersWebhookConfigurationWebhookEventExtractCancelled SheetsJobParametersWebhookConfigurationWebhookEvent = "extract.cancelled"
const SheetsJobParametersWebhookConfigurationWebhookEventParsePending SheetsJobParametersWebhookConfigurationWebhookEvent = "parse.pending"
const SheetsJobParametersWebhookConfigurationWebhookEventParseRunning SheetsJobParametersWebhookConfigurationWebhookEvent = "parse.running"
const SheetsJobParametersWebhookConfigurationWebhookEventParseSuccess SheetsJobParametersWebhookConfigurationWebhookEvent = "parse.success"
const SheetsJobParametersWebhookConfigurationWebhookEventParseError SheetsJobParametersWebhookConfigurationWebhookEvent = "parse.error"
const SheetsJobParametersWebhookConfigurationWebhookEventParsePartialSuccess SheetsJobParametersWebhookConfigurationWebhookEvent = "parse.partial_success"
const SheetsJobParametersWebhookConfigurationWebhookEventParseCancelled SheetsJobParametersWebhookConfigurationWebhookEvent = "parse.cancelled"
const SheetsJobParametersWebhookConfigurationWebhookEventClassifyPending SheetsJobParametersWebhookConfigurationWebhookEvent = "classify.pending"
const SheetsJobParametersWebhookConfigurationWebhookEventClassifyRunning SheetsJobParametersWebhookConfigurationWebhookEvent = "classify.running"
const SheetsJobParametersWebhookConfigurationWebhookEventClassifySuccess SheetsJobParametersWebhookConfigurationWebhookEvent = "classify.success"
const SheetsJobParametersWebhookConfigurationWebhookEventClassifyError SheetsJobParametersWebhookConfigurationWebhookEvent = "classify.error"
const SheetsJobParametersWebhookConfigurationWebhookEventClassifyPartialSuccess SheetsJobParametersWebhookConfigurationWebhookEvent = "classify.partial_success"
const SheetsJobParametersWebhookConfigurationWebhookEventClassifyCancelled SheetsJobParametersWebhookConfigurationWebhookEvent = "classify.cancelled"
const SheetsJobParametersWebhookConfigurationWebhookEventSheetsPending SheetsJobParametersWebhookConfigurationWebhookEvent = "sheets.pending"
const SheetsJobParametersWebhookConfigurationWebhookEventSheetsSuccess SheetsJobParametersWebhookConfigurationWebhookEvent = "sheets.success"
const SheetsJobParametersWebhookConfigurationWebhookEventSheetsError SheetsJobParametersWebhookConfigurationWebhookEvent = "sheets.error"
const SheetsJobParametersWebhookConfigurationWebhookEventSheetsPartialSuccess SheetsJobParametersWebhookConfigurationWebhookEvent = "sheets.partial_success"
const SheetsJobParametersWebhookConfigurationWebhookEventSheetsCancelled SheetsJobParametersWebhookConfigurationWebhookEvent = "sheets.cancelled"
const SheetsJobParametersWebhookConfigurationWebhookEventSplitPending SheetsJobParametersWebhookConfigurationWebhookEvent = "split.pending"
const SheetsJobParametersWebhookConfigurationWebhookEventSplitProcessing SheetsJobParametersWebhookConfigurationWebhookEvent = "split.processing"
const SheetsJobParametersWebhookConfigurationWebhookEventSplitSuccess SheetsJobParametersWebhookConfigurationWebhookEvent = "split.success"
const SheetsJobParametersWebhookConfigurationWebhookEventSplitError SheetsJobParametersWebhookConfigurationWebhookEvent = "split.error"
const SheetsJobParametersWebhookConfigurationWebhookEventSplitCancelled SheetsJobParametersWebhookConfigurationWebhookEvent = "split.cancelled"
const SheetsJobParametersWebhookConfigurationWebhookEventUnmappedEvent SheetsJobParametersWebhookConfigurationWebhookEvent = "unmapped_event"
Custom HTTP headers sent with each webhook request (e.g. auth tokens)
Response format sent to the webhook: ‘string’ (default) or ‘json’
WebhookSigningSecret string optional
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.
WebhookURL string optional
URL to receive webhook POST notifications
Regions [] SheetsJobRegion optional
All extracted regions (populated when job is complete)
Location of the region in the spreadsheet
Type of the extracted region
Worksheet name where region was found
Description string optional
Generated description for the region
Unique identifier for this region within the file
Generated title for the region
Whether the job completed successfully
Metadata for each processed worksheet (populated when job is complete)
Generated description of the worksheet
Generated title for the worksheet
type SheetsParsingConfig struct{…}
Configuration for spreadsheet parsing and region extraction
A1 notation of the range to extract a single region from. If None, the entire sheet is used.
FlattenHierarchicalTables bool optional
Return a flattened dataframe when a detected table is recognized as hierarchical.
Whether to generate additional metadata (title, description) for each extracted region.
IncludeHiddenCells bool optional
Whether to include hidden cells when extracting regions from the spreadsheet.
SheetNames [] string optional
The names of the sheets to extract regions from. If empty, all sheets will be processed.
Specialization string optional
Optional specialization mode for domain-specific extraction. Supported values: ‘financial-standard’, ‘financial-enhanced’, ‘financial-precise’. Default None uses the general-purpose pipeline.
TableMergeSensitivity SheetsParsingConfigTableMergeSensitivity optional
Influences how likely similar-looking regions are merged into a single table. Useful for spreadsheets that either have sparse tables (strong merging) or many distinct tables close together (weak merging).
One of the following:
const SheetsParsingConfigTableMergeSensitivityStrong SheetsParsingConfigTableMergeSensitivity = "strong"
const SheetsParsingConfigTableMergeSensitivityWeak SheetsParsingConfigTableMergeSensitivity = "weak"
UseExperimentalProcessing bool optional
Enables experimental processing. Accuracy may be impacted.
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/
