Sheets
Create Spreadsheet Job
List Spreadsheet Jobs
Get Spreadsheet Job
Get Result Region
Delete Spreadsheet Job
ModelsExpand Collapse
class SheetsJob: …
A spreadsheet parsing job
id: str
The ID of the job
Configuration for the parsing job
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]
Whether to generate additional metadata (title, description) for each extracted region.
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]
Optional specialization mode for domain-specific extraction. Supported values: 'financial-standard', 'financial-enhanced', 'financial-precise'. Default None uses the general-purpose pipeline.
table_merge_sensitivity: Optional[Literal["strong", "weak"]]
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).
use_experimental_processing: Optional[bool]
Enables experimental processing. Accuracy may be impacted.
created_at: str
When the job was created
file_id: Optional[str]
The ID of the input file
project_id: str
The ID of the project
The status of the parsing job
updated_at: str
When the job was last updated
user_id: str
The ID of the user
errors: Optional[List[str]]
Any errors encountered
Deprecatedfile: Optional[File]
Schema for a file.
id: str
Unique identifier
project_id: str
The ID of the project that the file belongs to
created_at: Optional[datetime]
Creation datetime
data_source_id: Optional[str]
The ID of the data source that the file belongs to
expires_at: Optional[datetime]
The expiration date for the file. Files past this date can be deleted.
external_file_id: Optional[str]
The ID of the file in the external system
file_size: Optional[int]
Size of the file in bytes
file_type: Optional[str]
File type (e.g. pdf, docx, etc.)
last_modified_at: Optional[datetime]
The last modified time of the file
permission_info: Optional[Dict[str, Union[Dict[str, object], List[object], str, 3 more]]]
Permission information for the file
purpose: Optional[str]
The intended purpose of the file (e.g., 'user_data', 'parse', 'extract', 'split', 'classify')
resource_info: Optional[Dict[str, Union[Dict[str, object], List[object], str, 3 more]]]
Resource information for the file
updated_at: Optional[datetime]
Update datetime
regions: Optional[List[Region]]
All extracted regions (populated when job is complete)
location: str
Location of the region in the spreadsheet
region_type: str
Type of the extracted region
sheet_name: str
Worksheet name where region was found
description: Optional[str]
Generated description for the region
region_id: Optional[str]
Unique identifier for this region within the file
title: Optional[str]
Generated title for the region
success: Optional[bool]
Whether the job completed successfully
worksheet_metadata: Optional[List[WorksheetMetadata]]
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]
Whether to generate additional metadata (title, description) for each extracted region.
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]
Optional specialization mode for domain-specific extraction. Supported values: 'financial-standard', 'financial-enhanced', 'financial-precise'. Default None uses the general-purpose pipeline.
table_merge_sensitivity: Optional[Literal["strong", "weak"]]
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).
use_experimental_processing: Optional[bool]
Enables experimental processing. Accuracy may be impacted.