# Extract ## Create Extract Job `client.Extract.New(ctx, params) (*ExtractV2Job, error)` **post** `/api/v2/extract` Create an extraction job. Extracts structured data from a document using either a saved configuration or an inline JSON Schema. ## Input Provide exactly one of: - `configuration_id` — reference a saved extraction config - `configuration` — inline configuration with a `data_schema` ## Document input Set `file_input` to a file ID (`dfl-...`) or a completed parse job ID (`pjb-...`). The job runs asynchronously. Poll `GET /extract/{job_id}` or register a webhook to monitor completion. ### Parameters - `params ExtractNewParams` - `ExtractV2JobCreate param.Field[ExtractV2JobCreate]` Body param: Request to create an extraction job. Provide configuration_id or inline configuration. - `OrganizationID param.Field[string]` Query param - `ProjectID param.Field[string]` Query param ### Returns - `type ExtractV2Job struct{…}` An extraction job. - `ID string` Unique job identifier (job_id) - `CreatedAt Time` Creation timestamp - `FileInput string` File ID or parse job ID that was extracted - `ProjectID string` Project this job belongs to - `Status string` Current job status. - `PENDING` — queued, not yet started - `RUNNING` — actively processing - `COMPLETED` — finished successfully - `FAILED` — terminated with an error - `CANCELLED` — cancelled by user - `UpdatedAt Time` Last update timestamp - `Configuration ExtractConfiguration` Extract configuration combining parse and extract settings. - `DataSchema map[string, ExtractConfigurationDataSchemaUnion]` JSON Schema defining the fields to extract. Validate with the /schema/validate endpoint first. - `type ExtractConfigurationDataSchemaMap map[string, any]` - `type ExtractConfigurationDataSchemaArray []any` - `string` - `float64` - `bool` - `CiteSources bool` Include citations in results - `ConfidenceScores bool` Include confidence scores in results - `ExtractVersion string` Extract algorithm version. Use 'latest' for the default pipeline or a date string (e.g. '2026-01-08') to pin to a specific release. - `ExtractionTarget ExtractConfigurationExtractionTarget` Granularity of extraction: per_doc returns one object per document, per_page returns one object per page, per_table_row returns one object per table row - `const ExtractConfigurationExtractionTargetPerDoc ExtractConfigurationExtractionTarget = "per_doc"` - `const ExtractConfigurationExtractionTargetPerPage ExtractConfigurationExtractionTarget = "per_page"` - `const ExtractConfigurationExtractionTargetPerTableRow ExtractConfigurationExtractionTarget = "per_table_row"` - `MaxPages int64` Maximum number of pages to process. Omit for no limit. - `ParseConfigID string` Saved parse configuration ID to control how the document is parsed before extraction - `ParseTier string` Parse tier to use before extraction. Defaults to the extract tier if not specified. - `SystemPrompt string` Custom system prompt to guide extraction behavior - `TargetPages string` Comma-separated page numbers or ranges to process (1-based). Omit to process all pages. - `Tier ExtractConfigurationTier` Extract tier: cost_effective (5 credits/page) or agentic (15 credits/page) - `const ExtractConfigurationTierCostEffective ExtractConfigurationTier = "cost_effective"` - `const ExtractConfigurationTierAgentic ExtractConfigurationTier = "agentic"` - `ConfigurationID string` Saved extract configuration ID used for this job, if any - `ErrorMessage string` Error details when status is FAILED - `ExtractMetadata ExtractJobMetadata` Extraction metadata. - `FieldMetadata ExtractedFieldMetadata` Metadata for extracted fields including document, page, and row level info. - `DocumentMetadata map[string, ExtractedFieldMetadataDocumentMetadataUnion]` Per-field metadata keyed by field name from your schema. Scalar fields (e.g. `vendor`) map to a FieldMetadataEntry with citation and confidence. Array fields (e.g. `items`) map to a list where each element contains per-sub-field FieldMetadataEntry objects, indexed by array position. Nested objects contain sub-field entries recursively. - `type ExtractedFieldMetadataDocumentMetadataMap map[string, any]` - `type ExtractedFieldMetadataDocumentMetadataArray []any` - `string` - `float64` - `bool` - `PageMetadata []map[string, ExtractedFieldMetadataPageMetadataUnion]` Per-page metadata when extraction_target is per_page - `type ExtractedFieldMetadataPageMetadataMap map[string, any]` - `type ExtractedFieldMetadataPageMetadataArray []any` - `string` - `float64` - `bool` - `RowMetadata []map[string, ExtractedFieldMetadataRowMetadataUnion]` Per-row metadata when extraction_target is per_table_row - `type ExtractedFieldMetadataRowMetadataMap map[string, any]` - `type ExtractedFieldMetadataRowMetadataArray []any` - `string` - `float64` - `bool` - `ParseJobID string` Reference to the ParseJob ID used for parsing - `ParseTier string` Parse tier used for parsing the document - `ExtractResult ExtractV2JobExtractResultUnion` Extracted data conforming to the data_schema. Returns a single object for per_doc, or an array for per_page / per_table_row. - `type ExtractV2JobExtractResultMap map[string, ExtractV2JobExtractResultMapItemUnion]` - `type ExtractV2JobExtractResultMapItemMap map[string, any]` - `type ExtractV2JobExtractResultMapItemArray []any` - `string` - `float64` - `bool` - `type ExtractV2JobExtractResultArray []map[string, ExtractV2JobExtractResultArrayItemUnion]` - `type ExtractV2JobExtractResultArrayItemMap map[string, any]` - `type ExtractV2JobExtractResultArrayItemArray []any` - `string` - `float64` - `bool` - `Metadata ExtractV2JobMetadata` Job-level metadata. - `Usage ExtractJobUsage` Extraction usage metrics. - `NumDocumentTokens int64` Number of document tokens - `NumOutputTokens int64` Number of output tokens - `NumPagesExtracted int64` Number of pages extracted ### Example ```go 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"), ) extractV2Job, err := client.Extract.New(context.TODO(), llamacloudprod.ExtractNewParams{ ExtractV2JobCreate: llamacloudprod.ExtractV2JobCreateParam{ FileInput: "dfl-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", }, }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", extractV2Job.ID) } ``` #### Response ```json { "id": "ext-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "created_at": "2019-12-27T18:11:19.117Z", "file_input": "dfl-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "project_id": "prj-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "status": "COMPLETED", "updated_at": "2019-12-27T18:11:19.117Z", "configuration": { "data_schema": { "foo": { "foo": "bar" } }, "cite_sources": true, "confidence_scores": true, "extract_version": "latest", "extraction_target": "per_doc", "max_pages": 10, "parse_config_id": "cfg-11111111-2222-3333-4444-555555555555", "parse_tier": "fast", "system_prompt": "Extract all monetary values in USD. If a currency is not specified, assume USD.", "target_pages": "1,3,5-7", "tier": "cost_effective" }, "configuration_id": "cfg-11111111-2222-3333-4444-555555555555", "error_message": "error_message", "extract_metadata": { "field_metadata": { "document_metadata": { "items": [ { "amount": { "citation": [ { "matching_text": "$10.00", "page": 1 } ], "confidence": 1 }, "description": { "citation": [ { "matching_text": "$10/month", "page": 1 } ], "confidence": 0.998 } } ], "total": { "citation": "bar", "confidence": "bar" }, "vendor": { "citation": "bar", "confidence": "bar", "extraction_confidence": "bar", "parsing_confidence": "bar" } }, "page_metadata": [ { "foo": { "foo": "bar" } } ], "row_metadata": [ { "foo": { "foo": "bar" } } ] }, "parse_job_id": "parse_job_id", "parse_tier": "parse_tier" }, "extract_result": { "foo": { "foo": "bar" } }, "metadata": { "usage": { "num_document_tokens": 0, "num_output_tokens": 0, "num_pages_extracted": 0 } } } ``` ## List Extract Jobs `client.Extract.List(ctx, query) (*PaginatedCursor[ExtractV2Job], error)` **get** `/api/v2/extract` List extraction jobs with optional filtering and pagination. Filter by `configuration_id`, `status`, `file_input`, or creation date range. Results are returned newest-first. Use `expand=configuration` to include the full configuration used, and `expand=extract_metadata` for per-field metadata. ### Parameters - `query ExtractListParams` - `ConfigurationID param.Field[string]` Filter by configuration ID - `CreatedAtOnOrAfter param.Field[Time]` Include items created at or after this timestamp (inclusive) - `CreatedAtOnOrBefore param.Field[Time]` Include items created at or before this timestamp (inclusive) - `DocumentInputType param.Field[string]` Filter by document input type (file_id or parse_job_id) - `DocumentInputValue param.Field[string]` Deprecated: use file_input instead - `Expand param.Field[[]string]` Additional fields to include: configuration, extract_metadata - `FileInput param.Field[string]` Filter by file input value - `JobIDs param.Field[[]string]` Filter by specific job IDs - `OrganizationID param.Field[string]` - `PageSize param.Field[int64]` Number of items per page - `PageToken param.Field[string]` Token for pagination - `ProjectID param.Field[string]` - `Status param.Field[ExtractListParamsStatus]` Filter by status - `const ExtractListParamsStatusPending ExtractListParamsStatus = "PENDING"` - `const ExtractListParamsStatusThrottled ExtractListParamsStatus = "THROTTLED"` - `const ExtractListParamsStatusRunning ExtractListParamsStatus = "RUNNING"` - `const ExtractListParamsStatusCompleted ExtractListParamsStatus = "COMPLETED"` - `const ExtractListParamsStatusFailed ExtractListParamsStatus = "FAILED"` - `const ExtractListParamsStatusCancelled ExtractListParamsStatus = "CANCELLED"` ### Returns - `type ExtractV2Job struct{…}` An extraction job. - `ID string` Unique job identifier (job_id) - `CreatedAt Time` Creation timestamp - `FileInput string` File ID or parse job ID that was extracted - `ProjectID string` Project this job belongs to - `Status string` Current job status. - `PENDING` — queued, not yet started - `RUNNING` — actively processing - `COMPLETED` — finished successfully - `FAILED` — terminated with an error - `CANCELLED` — cancelled by user - `UpdatedAt Time` Last update timestamp - `Configuration ExtractConfiguration` Extract configuration combining parse and extract settings. - `DataSchema map[string, ExtractConfigurationDataSchemaUnion]` JSON Schema defining the fields to extract. Validate with the /schema/validate endpoint first. - `type ExtractConfigurationDataSchemaMap map[string, any]` - `type ExtractConfigurationDataSchemaArray []any` - `string` - `float64` - `bool` - `CiteSources bool` Include citations in results - `ConfidenceScores bool` Include confidence scores in results - `ExtractVersion string` Extract algorithm version. Use 'latest' for the default pipeline or a date string (e.g. '2026-01-08') to pin to a specific release. - `ExtractionTarget ExtractConfigurationExtractionTarget` Granularity of extraction: per_doc returns one object per document, per_page returns one object per page, per_table_row returns one object per table row - `const ExtractConfigurationExtractionTargetPerDoc ExtractConfigurationExtractionTarget = "per_doc"` - `const ExtractConfigurationExtractionTargetPerPage ExtractConfigurationExtractionTarget = "per_page"` - `const ExtractConfigurationExtractionTargetPerTableRow ExtractConfigurationExtractionTarget = "per_table_row"` - `MaxPages int64` Maximum number of pages to process. Omit for no limit. - `ParseConfigID string` Saved parse configuration ID to control how the document is parsed before extraction - `ParseTier string` Parse tier to use before extraction. Defaults to the extract tier if not specified. - `SystemPrompt string` Custom system prompt to guide extraction behavior - `TargetPages string` Comma-separated page numbers or ranges to process (1-based). Omit to process all pages. - `Tier ExtractConfigurationTier` Extract tier: cost_effective (5 credits/page) or agentic (15 credits/page) - `const ExtractConfigurationTierCostEffective ExtractConfigurationTier = "cost_effective"` - `const ExtractConfigurationTierAgentic ExtractConfigurationTier = "agentic"` - `ConfigurationID string` Saved extract configuration ID used for this job, if any - `ErrorMessage string` Error details when status is FAILED - `ExtractMetadata ExtractJobMetadata` Extraction metadata. - `FieldMetadata ExtractedFieldMetadata` Metadata for extracted fields including document, page, and row level info. - `DocumentMetadata map[string, ExtractedFieldMetadataDocumentMetadataUnion]` Per-field metadata keyed by field name from your schema. Scalar fields (e.g. `vendor`) map to a FieldMetadataEntry with citation and confidence. Array fields (e.g. `items`) map to a list where each element contains per-sub-field FieldMetadataEntry objects, indexed by array position. Nested objects contain sub-field entries recursively. - `type ExtractedFieldMetadataDocumentMetadataMap map[string, any]` - `type ExtractedFieldMetadataDocumentMetadataArray []any` - `string` - `float64` - `bool` - `PageMetadata []map[string, ExtractedFieldMetadataPageMetadataUnion]` Per-page metadata when extraction_target is per_page - `type ExtractedFieldMetadataPageMetadataMap map[string, any]` - `type ExtractedFieldMetadataPageMetadataArray []any` - `string` - `float64` - `bool` - `RowMetadata []map[string, ExtractedFieldMetadataRowMetadataUnion]` Per-row metadata when extraction_target is per_table_row - `type ExtractedFieldMetadataRowMetadataMap map[string, any]` - `type ExtractedFieldMetadataRowMetadataArray []any` - `string` - `float64` - `bool` - `ParseJobID string` Reference to the ParseJob ID used for parsing - `ParseTier string` Parse tier used for parsing the document - `ExtractResult ExtractV2JobExtractResultUnion` Extracted data conforming to the data_schema. Returns a single object for per_doc, or an array for per_page / per_table_row. - `type ExtractV2JobExtractResultMap map[string, ExtractV2JobExtractResultMapItemUnion]` - `type ExtractV2JobExtractResultMapItemMap map[string, any]` - `type ExtractV2JobExtractResultMapItemArray []any` - `string` - `float64` - `bool` - `type ExtractV2JobExtractResultArray []map[string, ExtractV2JobExtractResultArrayItemUnion]` - `type ExtractV2JobExtractResultArrayItemMap map[string, any]` - `type ExtractV2JobExtractResultArrayItemArray []any` - `string` - `float64` - `bool` - `Metadata ExtractV2JobMetadata` Job-level metadata. - `Usage ExtractJobUsage` Extraction usage metrics. - `NumDocumentTokens int64` Number of document tokens - `NumOutputTokens int64` Number of output tokens - `NumPagesExtracted int64` Number of pages extracted ### Example ```go 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"), ) page, err := client.Extract.List(context.TODO(), llamacloudprod.ExtractListParams{ }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", page) } ``` #### Response ```json { "items": [ { "id": "ext-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "created_at": "2019-12-27T18:11:19.117Z", "file_input": "dfl-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "project_id": "prj-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "status": "COMPLETED", "updated_at": "2019-12-27T18:11:19.117Z", "configuration": { "data_schema": { "foo": { "foo": "bar" } }, "cite_sources": true, "confidence_scores": true, "extract_version": "latest", "extraction_target": "per_doc", "max_pages": 10, "parse_config_id": "cfg-11111111-2222-3333-4444-555555555555", "parse_tier": "fast", "system_prompt": "Extract all monetary values in USD. If a currency is not specified, assume USD.", "target_pages": "1,3,5-7", "tier": "cost_effective" }, "configuration_id": "cfg-11111111-2222-3333-4444-555555555555", "error_message": "error_message", "extract_metadata": { "field_metadata": { "document_metadata": { "items": [ { "amount": { "citation": [ { "matching_text": "$10.00", "page": 1 } ], "confidence": 1 }, "description": { "citation": [ { "matching_text": "$10/month", "page": 1 } ], "confidence": 0.998 } } ], "total": { "citation": "bar", "confidence": "bar" }, "vendor": { "citation": "bar", "confidence": "bar", "extraction_confidence": "bar", "parsing_confidence": "bar" } }, "page_metadata": [ { "foo": { "foo": "bar" } } ], "row_metadata": [ { "foo": { "foo": "bar" } } ] }, "parse_job_id": "parse_job_id", "parse_tier": "parse_tier" }, "extract_result": { "foo": { "foo": "bar" } }, "metadata": { "usage": { "num_document_tokens": 0, "num_output_tokens": 0, "num_pages_extracted": 0 } } } ], "next_page_token": "next_page_token", "total_size": 0 } ``` ## Get Extract Job `client.Extract.Get(ctx, jobID, query) (*ExtractV2Job, error)` **get** `/api/v2/extract/{job_id}` Get a single extraction job by ID. Returns the job status and results when complete. Use `expand=configuration` to include the full configuration used, and `expand=extract_metadata` for per-field metadata. ### Parameters - `jobID string` - `query ExtractGetParams` - `Expand param.Field[[]string]` Additional fields to include: configuration, extract_metadata - `OrganizationID param.Field[string]` - `ProjectID param.Field[string]` ### Returns - `type ExtractV2Job struct{…}` An extraction job. - `ID string` Unique job identifier (job_id) - `CreatedAt Time` Creation timestamp - `FileInput string` File ID or parse job ID that was extracted - `ProjectID string` Project this job belongs to - `Status string` Current job status. - `PENDING` — queued, not yet started - `RUNNING` — actively processing - `COMPLETED` — finished successfully - `FAILED` — terminated with an error - `CANCELLED` — cancelled by user - `UpdatedAt Time` Last update timestamp - `Configuration ExtractConfiguration` Extract configuration combining parse and extract settings. - `DataSchema map[string, ExtractConfigurationDataSchemaUnion]` JSON Schema defining the fields to extract. Validate with the /schema/validate endpoint first. - `type ExtractConfigurationDataSchemaMap map[string, any]` - `type ExtractConfigurationDataSchemaArray []any` - `string` - `float64` - `bool` - `CiteSources bool` Include citations in results - `ConfidenceScores bool` Include confidence scores in results - `ExtractVersion string` Extract algorithm version. Use 'latest' for the default pipeline or a date string (e.g. '2026-01-08') to pin to a specific release. - `ExtractionTarget ExtractConfigurationExtractionTarget` Granularity of extraction: per_doc returns one object per document, per_page returns one object per page, per_table_row returns one object per table row - `const ExtractConfigurationExtractionTargetPerDoc ExtractConfigurationExtractionTarget = "per_doc"` - `const ExtractConfigurationExtractionTargetPerPage ExtractConfigurationExtractionTarget = "per_page"` - `const ExtractConfigurationExtractionTargetPerTableRow ExtractConfigurationExtractionTarget = "per_table_row"` - `MaxPages int64` Maximum number of pages to process. Omit for no limit. - `ParseConfigID string` Saved parse configuration ID to control how the document is parsed before extraction - `ParseTier string` Parse tier to use before extraction. Defaults to the extract tier if not specified. - `SystemPrompt string` Custom system prompt to guide extraction behavior - `TargetPages string` Comma-separated page numbers or ranges to process (1-based). Omit to process all pages. - `Tier ExtractConfigurationTier` Extract tier: cost_effective (5 credits/page) or agentic (15 credits/page) - `const ExtractConfigurationTierCostEffective ExtractConfigurationTier = "cost_effective"` - `const ExtractConfigurationTierAgentic ExtractConfigurationTier = "agentic"` - `ConfigurationID string` Saved extract configuration ID used for this job, if any - `ErrorMessage string` Error details when status is FAILED - `ExtractMetadata ExtractJobMetadata` Extraction metadata. - `FieldMetadata ExtractedFieldMetadata` Metadata for extracted fields including document, page, and row level info. - `DocumentMetadata map[string, ExtractedFieldMetadataDocumentMetadataUnion]` Per-field metadata keyed by field name from your schema. Scalar fields (e.g. `vendor`) map to a FieldMetadataEntry with citation and confidence. Array fields (e.g. `items`) map to a list where each element contains per-sub-field FieldMetadataEntry objects, indexed by array position. Nested objects contain sub-field entries recursively. - `type ExtractedFieldMetadataDocumentMetadataMap map[string, any]` - `type ExtractedFieldMetadataDocumentMetadataArray []any` - `string` - `float64` - `bool` - `PageMetadata []map[string, ExtractedFieldMetadataPageMetadataUnion]` Per-page metadata when extraction_target is per_page - `type ExtractedFieldMetadataPageMetadataMap map[string, any]` - `type ExtractedFieldMetadataPageMetadataArray []any` - `string` - `float64` - `bool` - `RowMetadata []map[string, ExtractedFieldMetadataRowMetadataUnion]` Per-row metadata when extraction_target is per_table_row - `type ExtractedFieldMetadataRowMetadataMap map[string, any]` - `type ExtractedFieldMetadataRowMetadataArray []any` - `string` - `float64` - `bool` - `ParseJobID string` Reference to the ParseJob ID used for parsing - `ParseTier string` Parse tier used for parsing the document - `ExtractResult ExtractV2JobExtractResultUnion` Extracted data conforming to the data_schema. Returns a single object for per_doc, or an array for per_page / per_table_row. - `type ExtractV2JobExtractResultMap map[string, ExtractV2JobExtractResultMapItemUnion]` - `type ExtractV2JobExtractResultMapItemMap map[string, any]` - `type ExtractV2JobExtractResultMapItemArray []any` - `string` - `float64` - `bool` - `type ExtractV2JobExtractResultArray []map[string, ExtractV2JobExtractResultArrayItemUnion]` - `type ExtractV2JobExtractResultArrayItemMap map[string, any]` - `type ExtractV2JobExtractResultArrayItemArray []any` - `string` - `float64` - `bool` - `Metadata ExtractV2JobMetadata` Job-level metadata. - `Usage ExtractJobUsage` Extraction usage metrics. - `NumDocumentTokens int64` Number of document tokens - `NumOutputTokens int64` Number of output tokens - `NumPagesExtracted int64` Number of pages extracted ### Example ```go 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"), ) extractV2Job, err := client.Extract.Get( context.TODO(), "job_id", llamacloudprod.ExtractGetParams{ }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", extractV2Job.ID) } ``` #### Response ```json { "id": "ext-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "created_at": "2019-12-27T18:11:19.117Z", "file_input": "dfl-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "project_id": "prj-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "status": "COMPLETED", "updated_at": "2019-12-27T18:11:19.117Z", "configuration": { "data_schema": { "foo": { "foo": "bar" } }, "cite_sources": true, "confidence_scores": true, "extract_version": "latest", "extraction_target": "per_doc", "max_pages": 10, "parse_config_id": "cfg-11111111-2222-3333-4444-555555555555", "parse_tier": "fast", "system_prompt": "Extract all monetary values in USD. If a currency is not specified, assume USD.", "target_pages": "1,3,5-7", "tier": "cost_effective" }, "configuration_id": "cfg-11111111-2222-3333-4444-555555555555", "error_message": "error_message", "extract_metadata": { "field_metadata": { "document_metadata": { "items": [ { "amount": { "citation": [ { "matching_text": "$10.00", "page": 1 } ], "confidence": 1 }, "description": { "citation": [ { "matching_text": "$10/month", "page": 1 } ], "confidence": 0.998 } } ], "total": { "citation": "bar", "confidence": "bar" }, "vendor": { "citation": "bar", "confidence": "bar", "extraction_confidence": "bar", "parsing_confidence": "bar" } }, "page_metadata": [ { "foo": { "foo": "bar" } } ], "row_metadata": [ { "foo": { "foo": "bar" } } ] }, "parse_job_id": "parse_job_id", "parse_tier": "parse_tier" }, "extract_result": { "foo": { "foo": "bar" } }, "metadata": { "usage": { "num_document_tokens": 0, "num_output_tokens": 0, "num_pages_extracted": 0 } } } ``` ## Delete Extract Job `client.Extract.Delete(ctx, jobID, body) (*ExtractDeleteResponse, error)` **delete** `/api/v2/extract/{job_id}` Delete an extraction job and its results. ### Parameters - `jobID string` - `body ExtractDeleteParams` - `OrganizationID param.Field[string]` - `ProjectID param.Field[string]` ### Returns - `type ExtractDeleteResponse interface{…}` ### Example ```go 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"), ) extract, err := client.Extract.Delete( context.TODO(), "job_id", llamacloudprod.ExtractDeleteParams{ }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", extract) } ``` #### Response ```json {} ``` ## Validate Extraction Schema `client.Extract.ValidateSchema(ctx, body) (*ExtractV2SchemaValidateResponse, error)` **post** `/api/v2/extract/schema/validation` Validate a JSON schema for extraction. ### Parameters - `body ExtractValidateSchemaParams` - `ExtractV2SchemaValidateRequest param.Field[ExtractV2SchemaValidateRequest]` Request schema for validating an extraction schema. ### Returns - `type ExtractV2SchemaValidateResponse struct{…}` Response schema for schema validation. - `DataSchema map[string, ExtractV2SchemaValidateResponseDataSchemaUnion]` Validated JSON Schema, ready for use in extract jobs - `type ExtractV2SchemaValidateResponseDataSchemaMap map[string, any]` - `type ExtractV2SchemaValidateResponseDataSchemaArray []any` - `string` - `float64` - `bool` ### Example ```go 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"), ) extractV2SchemaValidateResponse, err := client.Extract.ValidateSchema(context.TODO(), llamacloudprod.ExtractValidateSchemaParams{ ExtractV2SchemaValidateRequest: llamacloudprod.ExtractV2SchemaValidateRequestParam{ DataSchema: map[string]llamacloudprod.ExtractV2SchemaValidateRequestDataSchemaUnionParam{ "properties": llamacloudprod.ExtractV2SchemaValidateRequestDataSchemaUnionParam{ OfAnyMap: map[string]any{ "vendor_name": "bar", "invoice_number": "bar", "total_amount": "bar", "line_items": "bar", }, }, "required": llamacloudprod.ExtractV2SchemaValidateRequestDataSchemaUnionParam{ OfAnyArray: []any{"vendor_name", "invoice_number", "total_amount"}, }, "type": llamacloudprod.ExtractV2SchemaValidateRequestDataSchemaUnionParam{ OfString: llamacloudprod.String("object"), }, }, }, }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", extractV2SchemaValidateResponse.DataSchema) } ``` #### Response ```json { "data_schema": { "foo": { "foo": "bar" } } } ``` ## Generate Extraction Schema `client.Extract.GenerateSchema(ctx, params) (*ConfigurationCreate, error)` **post** `/api/v2/extract/schema/generate` Generate a JSON schema and return a product configuration request. ### Parameters - `params ExtractGenerateSchemaParams` - `ExtractV2SchemaGenerateRequest param.Field[ExtractV2SchemaGenerateRequest]` Body param: Request schema for generating an extraction schema. - `OrganizationID param.Field[string]` Query param - `ProjectID param.Field[string]` Query param ### Returns - `type ConfigurationCreate struct{…}` Request body for creating a product configuration. - `Name string` Human-readable name for this configuration. - `Parameters ConfigurationCreateParametersUnion` Product-specific configuration parameters. - `type SplitV1ParametersResp struct{…}` Typed parameters for a *split v1* product configuration. - `Categories []SplitCategory` Categories to split documents into. - `Name string` Name of the category. - `Description string` Optional description of what content belongs in this category. - `ProductType SplitV1` Product type. - `const SplitV1SplitV1 SplitV1 = "split_v1"` - `SplittingStrategy SplitV1ParametersSplittingStrategyResp` Strategy for splitting documents. - `AllowUncategorized string` Controls handling of pages that don't match any category. 'include': pages can be grouped as 'uncategorized' and included in results. 'forbid': all pages must be assigned to a defined category. 'omit': pages can be classified as 'uncategorized' but are excluded from results. - `const SplitV1ParametersSplittingStrategyAllowUncategorizedInclude SplitV1ParametersSplittingStrategyAllowUncategorized = "include"` - `const SplitV1ParametersSplittingStrategyAllowUncategorizedForbid SplitV1ParametersSplittingStrategyAllowUncategorized = "forbid"` - `const SplitV1ParametersSplittingStrategyAllowUncategorizedOmit SplitV1ParametersSplittingStrategyAllowUncategorized = "omit"` - `type ExtractV2ParametersResp struct{…}` Typed parameters for an *extract v2* product configuration. - `DataSchema map[string, ExtractV2ParametersDataSchemaUnionResp]` JSON Schema defining the fields to extract. Validate with the /schema/validate endpoint first. - `type ExtractV2ParametersDataSchemaMap map[string, any]` - `type ExtractV2ParametersDataSchemaArray []any` - `string` - `float64` - `bool` - `ProductType ExtractV2` Product type. - `const ExtractV2ExtractV2 ExtractV2 = "extract_v2"` - `CiteSources bool` Include citations in results - `ConfidenceScores bool` Include confidence scores in results - `ExtractVersion string` Extract algorithm version. Use 'latest' for the default pipeline or a date string (e.g. '2026-01-08') to pin to a specific release. - `ExtractionTarget ExtractV2ParametersExtractionTarget` Granularity of extraction: per_doc returns one object per document, per_page returns one object per page, per_table_row returns one object per table row - `const ExtractV2ParametersExtractionTargetPerDoc ExtractV2ParametersExtractionTarget = "per_doc"` - `const ExtractV2ParametersExtractionTargetPerPage ExtractV2ParametersExtractionTarget = "per_page"` - `const ExtractV2ParametersExtractionTargetPerTableRow ExtractV2ParametersExtractionTarget = "per_table_row"` - `MaxPages int64` Maximum number of pages to process. Omit for no limit. - `ParseConfigID string` Saved parse configuration ID to control how the document is parsed before extraction - `ParseTier string` Parse tier to use before extraction. Defaults to the extract tier if not specified. - `SystemPrompt string` Custom system prompt to guide extraction behavior - `TargetPages string` Comma-separated page numbers or ranges to process (1-based). Omit to process all pages. - `Tier ExtractV2ParametersTier` Extract tier: cost_effective (5 credits/page) or agentic (15 credits/page) - `const ExtractV2ParametersTierCostEffective ExtractV2ParametersTier = "cost_effective"` - `const ExtractV2ParametersTierAgentic ExtractV2ParametersTier = "agentic"` - `type ClassifyV2ParametersResp struct{…}` Typed parameters for a *classify v2* product configuration. - `ProductType ClassifyV2` Product type. - `const ClassifyV2ClassifyV2 ClassifyV2 = "classify_v2"` - `Rules []ClassifyV2ParametersRuleResp` Classify rules to evaluate against the document (at least one required) - `Description string` Natural language criteria for matching this rule - `Type string` Document type to assign when rule matches - `Mode ClassifyV2ParametersMode` Classify execution mode - `const ClassifyV2ParametersModeFast ClassifyV2ParametersMode = "FAST"` - `ParsingConfiguration ClassifyV2ParametersParsingConfigurationResp` Parsing configuration for classify jobs. - `Lang string` ISO 639-1 language code for the document - `MaxPages int64` Maximum number of pages to process. Omit for no limit. - `TargetPages string` Comma-separated page numbers or ranges to process (1-based). Omit to process all pages. - `type ParseV2ParametersResp struct{…}` Configuration for LlamaParse v2 document parsing. Includes tier selection, processing options, output formatting, page targeting, and webhook delivery. Refer to the LlamaParse documentation for details on each field. - `ProductType ParseV2` Product type. - `const ParseV2ParseV2 ParseV2 = "parse_v2"` - `Tier ParseV2ParametersTier` Parsing tier: 'fast' (rule-based, cheapest), 'cost_effective' (balanced), 'agentic' (AI-powered with custom prompts), or 'agentic_plus' (premium AI with highest accuracy) - `const ParseV2ParametersTierFast ParseV2ParametersTier = "fast"` - `const ParseV2ParametersTierCostEffective ParseV2ParametersTier = "cost_effective"` - `const ParseV2ParametersTierAgentic ParseV2ParametersTier = "agentic"` - `const ParseV2ParametersTierAgenticPlus ParseV2ParametersTier = "agentic_plus"` - `Version ParseV2ParametersVersion` Tier version. Use 'latest' for the current stable version, or specify a specific version (e.g., '1.0', '2.0') for reproducible results - `type ParseV2ParametersVersion string` Tier version. Use 'latest' for the current stable version, or specify a specific version (e.g., '1.0', '2.0') for reproducible results - `const ParseV2ParametersVersion2025_12_11 ParseV2ParametersVersion = "2025-12-11"` - `const ParseV2ParametersVersion2025_12_18 ParseV2ParametersVersion = "2025-12-18"` - `const ParseV2ParametersVersion2025_12_31 ParseV2ParametersVersion = "2025-12-31"` - `const ParseV2ParametersVersion2026_01_08 ParseV2ParametersVersion = "2026-01-08"` - `const ParseV2ParametersVersion2026_01_09 ParseV2ParametersVersion = "2026-01-09"` - `const ParseV2ParametersVersion2026_01_16 ParseV2ParametersVersion = "2026-01-16"` - `const ParseV2ParametersVersion2026_01_21 ParseV2ParametersVersion = "2026-01-21"` - `const ParseV2ParametersVersion2026_01_22 ParseV2ParametersVersion = "2026-01-22"` - `const ParseV2ParametersVersion2026_01_24 ParseV2ParametersVersion = "2026-01-24"` - `const ParseV2ParametersVersion2026_01_29 ParseV2ParametersVersion = "2026-01-29"` - `const ParseV2ParametersVersion2026_01_30 ParseV2ParametersVersion = "2026-01-30"` - `const ParseV2ParametersVersion2026_02_03 ParseV2ParametersVersion = "2026-02-03"` - `const ParseV2ParametersVersion2026_02_18 ParseV2ParametersVersion = "2026-02-18"` - `const ParseV2ParametersVersion2026_02_20 ParseV2ParametersVersion = "2026-02-20"` - `const ParseV2ParametersVersion2026_02_24 ParseV2ParametersVersion = "2026-02-24"` - `const ParseV2ParametersVersion2026_02_26 ParseV2ParametersVersion = "2026-02-26"` - `const ParseV2ParametersVersion2026_03_02 ParseV2ParametersVersion = "2026-03-02"` - `const ParseV2ParametersVersion2026_03_03 ParseV2ParametersVersion = "2026-03-03"` - `const ParseV2ParametersVersion2026_03_04 ParseV2ParametersVersion = "2026-03-04"` - `const ParseV2ParametersVersion2026_03_05 ParseV2ParametersVersion = "2026-03-05"` - `const ParseV2ParametersVersion2026_03_09 ParseV2ParametersVersion = "2026-03-09"` - `const ParseV2ParametersVersion2026_03_10 ParseV2ParametersVersion = "2026-03-10"` - `const ParseV2ParametersVersion2026_03_11 ParseV2ParametersVersion = "2026-03-11"` - `const ParseV2ParametersVersion2026_03_12 ParseV2ParametersVersion = "2026-03-12"` - `const ParseV2ParametersVersion2026_03_17 ParseV2ParametersVersion = "2026-03-17"` - `const ParseV2ParametersVersion2026_03_19 ParseV2ParametersVersion = "2026-03-19"` - `const ParseV2ParametersVersion2026_03_20 ParseV2ParametersVersion = "2026-03-20"` - `const ParseV2ParametersVersion2026_03_22 ParseV2ParametersVersion = "2026-03-22"` - `const ParseV2ParametersVersion2026_03_23 ParseV2ParametersVersion = "2026-03-23"` - `const ParseV2ParametersVersion2026_03_24 ParseV2ParametersVersion = "2026-03-24"` - `const ParseV2ParametersVersion2026_03_25 ParseV2ParametersVersion = "2026-03-25"` - `const ParseV2ParametersVersion2026_03_26 ParseV2ParametersVersion = "2026-03-26"` - `const ParseV2ParametersVersion2026_03_27 ParseV2ParametersVersion = "2026-03-27"` - `const ParseV2ParametersVersion2026_03_30 ParseV2ParametersVersion = "2026-03-30"` - `const ParseV2ParametersVersion2026_03_31 ParseV2ParametersVersion = "2026-03-31"` - `const ParseV2ParametersVersion2026_04_02 ParseV2ParametersVersion = "2026-04-02"` - `const ParseV2ParametersVersion2026_04_06 ParseV2ParametersVersion = "2026-04-06"` - `const ParseV2ParametersVersion2026_04_09 ParseV2ParametersVersion = "2026-04-09"` - `const ParseV2ParametersVersion2026_04_14 ParseV2ParametersVersion = "2026-04-14"` - `const ParseV2ParametersVersion2026_04_19 ParseV2ParametersVersion = "2026-04-19"` - `const ParseV2ParametersVersion2026_04_22 ParseV2ParametersVersion = "2026-04-22"` - `const ParseV2ParametersVersion2026_04_27 ParseV2ParametersVersion = "2026-04-27"` - `const ParseV2ParametersVersionLatest ParseV2ParametersVersion = "latest"` - `string` - `AgenticOptions ParseV2ParametersAgenticOptionsResp` Options for AI-powered parsing tiers (cost_effective, agentic, agentic_plus). These options customize how the AI processes and interprets document content. Only applicable when using non-fast tiers. - `CustomPrompt string` Custom instructions for the AI parser. Use to guide extraction behavior, specify output formatting, or provide domain-specific context. Example: 'Extract financial tables with currency symbols. Format dates as YYYY-MM-DD.' - `ClientName string` Identifier for the client/application making the request. Used for analytics and debugging. Example: 'my-app-v2' - `CropBox ParseV2ParametersCropBoxResp` Crop boundaries to process only a portion of each page. Values are ratios 0-1 from page edges - `Bottom float64` Bottom boundary as ratio (0-1). 0=top edge, 1=bottom edge. Content below this line is excluded - `Left float64` Left boundary as ratio (0-1). 0=left edge, 1=right edge. Content left of this line is excluded - `Right float64` Right boundary as ratio (0-1). 0=left edge, 1=right edge. Content right of this line is excluded - `Top float64` Top boundary as ratio (0-1). 0=top edge, 1=bottom edge. Content above this line is excluded - `DisableCache bool` Bypass result caching and force re-parsing. Use when document content may have changed or you need fresh results - `FastOptions any` Options for fast tier parsing (rule-based, no AI). Fast tier uses deterministic algorithms for text extraction without AI enhancement. It's the fastest and most cost-effective option, best suited for simple documents with standard layouts. Currently has no configurable options but reserved for future expansion. - `InputOptions ParseV2ParametersInputOptionsResp` Format-specific options (HTML, PDF, spreadsheet, presentation). Applied based on detected input file type - `HTML ParseV2ParametersInputOptionsHTMLResp` HTML/web page parsing options (applies to .html, .htm files) - `MakeAllElementsVisible bool` Force all HTML elements to be visible by overriding CSS display/visibility properties. Useful for parsing pages with hidden content or collapsed sections - `RemoveFixedElements bool` Remove fixed-position elements (headers, footers, floating buttons) that appear on every page render - `RemoveNavigationElements bool` Remove navigation elements (nav bars, sidebars, menus) to focus on main content - `Pdf any` PDF-specific parsing options (applies to .pdf files) - `Presentation ParseV2ParametersInputOptionsPresentationResp` Presentation parsing options (applies to .pptx, .ppt, .odp, .key files) - `OutOfBoundsContent bool` Extract content positioned outside the visible slide area. Some presentations have hidden notes or content that extends beyond slide boundaries - `SkipEmbeddedData bool` Skip extraction of embedded chart data tables. When true, only the visual representation of charts is captured, not the underlying data - `Spreadsheet ParseV2ParametersInputOptionsSpreadsheetResp` Spreadsheet parsing options (applies to .xlsx, .xls, .csv, .ods files) - `DetectSubTablesInSheets bool` Detect and extract multiple tables within a single sheet. Useful when spreadsheets contain several data regions separated by blank rows/columns - `ForceFormulaComputationInSheets bool` Compute formula results instead of extracting formula text. Use when you need calculated values rather than formula definitions - `IncludeHiddenSheets bool` Parse hidden sheets in addition to visible ones. By default, hidden sheets are skipped - `OutputOptions ParseV2ParametersOutputOptionsResp` Output formatting options for markdown, text, and extracted images - `ExtractPrintedPageNumber bool` Extract the printed page number as it appears in the document (e.g., 'Page 5 of 10', 'v', 'A-3'). Useful for referencing original page numbers - `ImagesToSave []string` Image categories to extract and save. Options: 'screenshot' (full page renders useful for visual QA), 'embedded' (images found within the document), 'layout' (cropped regions from layout detection like figures and diagrams). Empty list saves no images - `const ParseV2ParametersOutputOptionsImagesToSaveScreenshot ParseV2ParametersOutputOptionsImagesToSave = "screenshot"` - `const ParseV2ParametersOutputOptionsImagesToSaveEmbedded ParseV2ParametersOutputOptionsImagesToSave = "embedded"` - `const ParseV2ParametersOutputOptionsImagesToSaveLayout ParseV2ParametersOutputOptionsImagesToSave = "layout"` - `Markdown ParseV2ParametersOutputOptionsMarkdownResp` Markdown formatting options including table styles and link annotations - `AnnotateLinks bool` Add link annotations to markdown output in the format [text](url). When false, only the link text is included - `InlineImages bool` Embed images directly in markdown as base64 data URIs instead of extracting them as separate files. Useful for self-contained markdown output - `Tables ParseV2ParametersOutputOptionsMarkdownTablesResp` Table formatting options including markdown vs HTML format and merging behavior - `CompactMarkdownTables bool` Remove extra whitespace padding in markdown table cells for more compact output - `MarkdownTableMultilineSeparator string` Separator string for multiline cell content in markdown tables. Example: '
' to preserve line breaks, ' ' to join with spaces - `MergeContinuedTables bool` Automatically merge tables that span multiple pages into a single table. The merged table appears on the first page with merged_from_pages metadata - `OutputTablesAsMarkdown bool` Output tables as markdown pipe tables instead of HTML tags. Markdown tables are simpler but cannot represent complex structures like merged cells - `SpatialText ParseV2ParametersOutputOptionsSpatialTextResp` Spatial text output options for preserving document layout structure - `DoNotUnrollColumns bool` Keep multi-column layouts intact instead of linearizing columns into sequential text. Automatically enabled for non-fast tiers - `PreserveLayoutAlignmentAcrossPages bool` Maintain consistent text column alignment across page boundaries. Automatically enabled for document-level parsing modes - `PreserveVerySmallText bool` Include text below the normal size threshold. Useful for footnotes, watermarks, or fine print that might otherwise be filtered out - `TablesAsSpreadsheet ParseV2ParametersOutputOptionsTablesAsSpreadsheetResp` Options for exporting tables as XLSX spreadsheets - `Enable bool` Whether this option is enabled - `GuessSheetName bool` Automatically generate descriptive sheet names from table context (headers, surrounding text) instead of using generic names like 'Table_1' - `PageRanges ParseV2ParametersPageRangesResp` Page selection: limit total pages or specify exact pages to process - `MaxPages int64` Maximum number of pages to process. Pages are processed in order starting from page 1. If both max_pages and target_pages are set, target_pages takes precedence - `TargetPages string` Comma-separated list of specific pages to process using 1-based indexing. Supports individual pages and ranges. Examples: '1,3,5' (pages 1, 3, 5), '1-5' (pages 1 through 5 inclusive), '1,3,5-8,10' (pages 1, 3, 5-8, and 10). Pages are sorted and deduplicated automatically. Duplicate pages cause an error - `ProcessingControl ParseV2ParametersProcessingControlResp` Job execution controls including timeouts and failure thresholds - `JobFailureConditions ParseV2ParametersProcessingControlJobFailureConditionsResp` Quality thresholds that determine when a job should fail vs complete with partial results - `AllowedPageFailureRatio float64` Maximum ratio of pages allowed to fail before the job fails (0-1). Example: 0.1 means job fails if more than 10% of pages fail. Default is 0.05 (5%) - `FailOnBuggyFont bool` Fail the job if a problematic font is detected that may cause incorrect text extraction. Buggy fonts can produce garbled or missing characters - `FailOnImageExtractionError bool` Fail the entire job if any embedded image cannot be extracted. By default, image extraction errors are logged but don't fail the job - `FailOnImageOcrError bool` Fail the entire job if OCR fails on any image. By default, OCR errors result in empty text for that image - `FailOnMarkdownReconstructionError bool` Fail the entire job if markdown cannot be reconstructed for any page. By default, failed pages use fallback text extraction - `Timeouts ParseV2ParametersProcessingControlTimeoutsResp` Timeout settings for job execution. Increase for large or complex documents - `BaseInSeconds int64` Base timeout for the job in seconds (max 1800 = 30 minutes). This is the minimum time allowed regardless of document size - `ExtraTimePerPageInSeconds int64` Additional timeout per page in seconds (max 300 = 5 minutes). Total timeout = base + (this value × page count) - `ProcessingOptions ParseV2ParametersProcessingOptionsResp` Document processing options including OCR, table extraction, and chart parsing - `AggressiveTableExtraction bool` Use aggressive heuristics to detect table boundaries, even without visible borders. Useful for documents with borderless or complex tables - `AutoModeConfiguration []ParseV2ParametersProcessingOptionsAutoModeConfigurationResp` Conditional processing rules that apply different parsing options based on page content, document structure, or filename patterns. Each entry defines trigger conditions and the parsing configuration to apply when triggered - `ParsingConf ParseV2ParametersProcessingOptionsAutoModeConfigurationParsingConfResp` Parsing configuration to apply when trigger conditions are met - `AdaptiveLongTable bool` Whether to use adaptive long table handling - `AggressiveTableExtraction bool` Whether to use aggressive table extraction - `CropBox ParseV2ParametersProcessingOptionsAutoModeConfigurationParsingConfCropBoxResp` Crop box options for auto mode parsing configuration. - `Bottom float64` Bottom boundary of crop box as ratio (0-1) - `Left float64` Left boundary of crop box as ratio (0-1) - `Right float64` Right boundary of crop box as ratio (0-1) - `Top float64` Top boundary of crop box as ratio (0-1) - `CustomPrompt string` Custom AI instructions for matched pages. Overrides the base custom_prompt - `ExtractLayout bool` Whether to extract layout information - `HighResOcr bool` Whether to use high resolution OCR - `Ignore ParseV2ParametersProcessingOptionsAutoModeConfigurationParsingConfIgnoreResp` Ignore options for auto mode parsing configuration. - `IgnoreDiagonalText bool` Whether to ignore diagonal text in the document - `IgnoreHiddenText bool` Whether to ignore hidden text in the document - `Language string` Primary language of the document - `OutlinedTableExtraction bool` Whether to use outlined table extraction - `Presentation ParseV2ParametersProcessingOptionsAutoModeConfigurationParsingConfPresentationResp` Presentation-specific options for auto mode parsing configuration. - `OutOfBoundsContent bool` Extract out of bounds content in presentation slides - `SkipEmbeddedData bool` Skip extraction of embedded data for charts in presentation slides - `SpatialText ParseV2ParametersProcessingOptionsAutoModeConfigurationParsingConfSpatialTextResp` Spatial text options for auto mode parsing configuration. - `DoNotUnrollColumns bool` Keep column structure intact without unrolling - `PreserveLayoutAlignmentAcrossPages bool` Preserve text alignment across page boundaries - `PreserveVerySmallText bool` Include very small text in spatial output - `SpecializedChartParsing string` Enable specialized chart parsing with the specified mode - `const ParseV2ParametersProcessingOptionsAutoModeConfigurationParsingConfSpecializedChartParsingAgenticPlus ParseV2ParametersProcessingOptionsAutoModeConfigurationParsingConfSpecializedChartParsing = "agentic_plus"` - `const ParseV2ParametersProcessingOptionsAutoModeConfigurationParsingConfSpecializedChartParsingAgentic ParseV2ParametersProcessingOptionsAutoModeConfigurationParsingConfSpecializedChartParsing = "agentic"` - `const ParseV2ParametersProcessingOptionsAutoModeConfigurationParsingConfSpecializedChartParsingEfficient ParseV2ParametersProcessingOptionsAutoModeConfigurationParsingConfSpecializedChartParsing = "efficient"` - `Tier string` Override the parsing tier for matched pages. Must be paired with version - `const ParseV2ParametersProcessingOptionsAutoModeConfigurationParsingConfTierFast ParseV2ParametersProcessingOptionsAutoModeConfigurationParsingConfTier = "fast"` - `const ParseV2ParametersProcessingOptionsAutoModeConfigurationParsingConfTierCostEffective ParseV2ParametersProcessingOptionsAutoModeConfigurationParsingConfTier = "cost_effective"` - `const ParseV2ParametersProcessingOptionsAutoModeConfigurationParsingConfTierAgentic ParseV2ParametersProcessingOptionsAutoModeConfigurationParsingConfTier = "agentic"` - `const ParseV2ParametersProcessingOptionsAutoModeConfigurationParsingConfTierAgenticPlus ParseV2ParametersProcessingOptionsAutoModeConfigurationParsingConfTier = "agentic_plus"` - `Version string` Tier version when overriding tier. Required when tier is specified - `string` - `const ParseV2ParametersProcessingOptionsAutoModeConfigurationParsingConfVersion2025_12_11 ParseV2ParametersProcessingOptionsAutoModeConfigurationParsingConfVersion = "2025-12-11"` - `const ParseV2ParametersProcessingOptionsAutoModeConfigurationParsingConfVersion2025_12_18 ParseV2ParametersProcessingOptionsAutoModeConfigurationParsingConfVersion = "2025-12-18"` - `const ParseV2ParametersProcessingOptionsAutoModeConfigurationParsingConfVersion2025_12_31 ParseV2ParametersProcessingOptionsAutoModeConfigurationParsingConfVersion = "2025-12-31"` - `const ParseV2ParametersProcessingOptionsAutoModeConfigurationParsingConfVersion2026_01_08 ParseV2ParametersProcessingOptionsAutoModeConfigurationParsingConfVersion = "2026-01-08"` - `const ParseV2ParametersProcessingOptionsAutoModeConfigurationParsingConfVersion2026_01_09 ParseV2ParametersProcessingOptionsAutoModeConfigurationParsingConfVersion = "2026-01-09"` - `const ParseV2ParametersProcessingOptionsAutoModeConfigurationParsingConfVersion2026_01_16 ParseV2ParametersProcessingOptionsAutoModeConfigurationParsingConfVersion = "2026-01-16"` - `const ParseV2ParametersProcessingOptionsAutoModeConfigurationParsingConfVersion2026_01_21 ParseV2ParametersProcessingOptionsAutoModeConfigurationParsingConfVersion = "2026-01-21"` - `const ParseV2ParametersProcessingOptionsAutoModeConfigurationParsingConfVersion2026_01_22 ParseV2ParametersProcessingOptionsAutoModeConfigurationParsingConfVersion = "2026-01-22"` - `const ParseV2ParametersProcessingOptionsAutoModeConfigurationParsingConfVersion2026_01_24 ParseV2ParametersProcessingOptionsAutoModeConfigurationParsingConfVersion = "2026-01-24"` - `const ParseV2ParametersProcessingOptionsAutoModeConfigurationParsingConfVersion2026_01_29 ParseV2ParametersProcessingOptionsAutoModeConfigurationParsingConfVersion = "2026-01-29"` - `const ParseV2ParametersProcessingOptionsAutoModeConfigurationParsingConfVersion2026_01_30 ParseV2ParametersProcessingOptionsAutoModeConfigurationParsingConfVersion = "2026-01-30"` - `const ParseV2ParametersProcessingOptionsAutoModeConfigurationParsingConfVersion2026_02_03 ParseV2ParametersProcessingOptionsAutoModeConfigurationParsingConfVersion = "2026-02-03"` - `const ParseV2ParametersProcessingOptionsAutoModeConfigurationParsingConfVersion2026_02_18 ParseV2ParametersProcessingOptionsAutoModeConfigurationParsingConfVersion = "2026-02-18"` - `const ParseV2ParametersProcessingOptionsAutoModeConfigurationParsingConfVersion2026_02_20 ParseV2ParametersProcessingOptionsAutoModeConfigurationParsingConfVersion = "2026-02-20"` - `const ParseV2ParametersProcessingOptionsAutoModeConfigurationParsingConfVersion2026_02_24 ParseV2ParametersProcessingOptionsAutoModeConfigurationParsingConfVersion = "2026-02-24"` - `const ParseV2ParametersProcessingOptionsAutoModeConfigurationParsingConfVersion2026_02_26 ParseV2ParametersProcessingOptionsAutoModeConfigurationParsingConfVersion = "2026-02-26"` - `const ParseV2ParametersProcessingOptionsAutoModeConfigurationParsingConfVersion2026_03_02 ParseV2ParametersProcessingOptionsAutoModeConfigurationParsingConfVersion = "2026-03-02"` - `const ParseV2ParametersProcessingOptionsAutoModeConfigurationParsingConfVersion2026_03_03 ParseV2ParametersProcessingOptionsAutoModeConfigurationParsingConfVersion = "2026-03-03"` - `const ParseV2ParametersProcessingOptionsAutoModeConfigurationParsingConfVersion2026_03_04 ParseV2ParametersProcessingOptionsAutoModeConfigurationParsingConfVersion = "2026-03-04"` - `const ParseV2ParametersProcessingOptionsAutoModeConfigurationParsingConfVersion2026_03_05 ParseV2ParametersProcessingOptionsAutoModeConfigurationParsingConfVersion = "2026-03-05"` - `const ParseV2ParametersProcessingOptionsAutoModeConfigurationParsingConfVersion2026_03_09 ParseV2ParametersProcessingOptionsAutoModeConfigurationParsingConfVersion = "2026-03-09"` - `const ParseV2ParametersProcessingOptionsAutoModeConfigurationParsingConfVersion2026_03_10 ParseV2ParametersProcessingOptionsAutoModeConfigurationParsingConfVersion = "2026-03-10"` - `const ParseV2ParametersProcessingOptionsAutoModeConfigurationParsingConfVersion2026_03_11 ParseV2ParametersProcessingOptionsAutoModeConfigurationParsingConfVersion = "2026-03-11"` - `const ParseV2ParametersProcessingOptionsAutoModeConfigurationParsingConfVersion2026_03_12 ParseV2ParametersProcessingOptionsAutoModeConfigurationParsingConfVersion = "2026-03-12"` - `const ParseV2ParametersProcessingOptionsAutoModeConfigurationParsingConfVersion2026_03_17 ParseV2ParametersProcessingOptionsAutoModeConfigurationParsingConfVersion = "2026-03-17"` - `const ParseV2ParametersProcessingOptionsAutoModeConfigurationParsingConfVersion2026_03_19 ParseV2ParametersProcessingOptionsAutoModeConfigurationParsingConfVersion = "2026-03-19"` - `const ParseV2ParametersProcessingOptionsAutoModeConfigurationParsingConfVersion2026_03_20 ParseV2ParametersProcessingOptionsAutoModeConfigurationParsingConfVersion = "2026-03-20"` - `const ParseV2ParametersProcessingOptionsAutoModeConfigurationParsingConfVersion2026_03_22 ParseV2ParametersProcessingOptionsAutoModeConfigurationParsingConfVersion = "2026-03-22"` - `const ParseV2ParametersProcessingOptionsAutoModeConfigurationParsingConfVersion2026_03_23 ParseV2ParametersProcessingOptionsAutoModeConfigurationParsingConfVersion = "2026-03-23"` - `const ParseV2ParametersProcessingOptionsAutoModeConfigurationParsingConfVersion2026_03_24 ParseV2ParametersProcessingOptionsAutoModeConfigurationParsingConfVersion = "2026-03-24"` - `const ParseV2ParametersProcessingOptionsAutoModeConfigurationParsingConfVersion2026_03_25 ParseV2ParametersProcessingOptionsAutoModeConfigurationParsingConfVersion = "2026-03-25"` - `const ParseV2ParametersProcessingOptionsAutoModeConfigurationParsingConfVersion2026_03_26 ParseV2ParametersProcessingOptionsAutoModeConfigurationParsingConfVersion = "2026-03-26"` - `const ParseV2ParametersProcessingOptionsAutoModeConfigurationParsingConfVersion2026_03_27 ParseV2ParametersProcessingOptionsAutoModeConfigurationParsingConfVersion = "2026-03-27"` - `const ParseV2ParametersProcessingOptionsAutoModeConfigurationParsingConfVersion2026_03_30 ParseV2ParametersProcessingOptionsAutoModeConfigurationParsingConfVersion = "2026-03-30"` - `const ParseV2ParametersProcessingOptionsAutoModeConfigurationParsingConfVersion2026_03_31 ParseV2ParametersProcessingOptionsAutoModeConfigurationParsingConfVersion = "2026-03-31"` - `const ParseV2ParametersProcessingOptionsAutoModeConfigurationParsingConfVersion2026_04_02 ParseV2ParametersProcessingOptionsAutoModeConfigurationParsingConfVersion = "2026-04-02"` - `const ParseV2ParametersProcessingOptionsAutoModeConfigurationParsingConfVersion2026_04_06 ParseV2ParametersProcessingOptionsAutoModeConfigurationParsingConfVersion = "2026-04-06"` - `const ParseV2ParametersProcessingOptionsAutoModeConfigurationParsingConfVersion2026_04_09 ParseV2ParametersProcessingOptionsAutoModeConfigurationParsingConfVersion = "2026-04-09"` - `const ParseV2ParametersProcessingOptionsAutoModeConfigurationParsingConfVersion2026_04_14 ParseV2ParametersProcessingOptionsAutoModeConfigurationParsingConfVersion = "2026-04-14"` - `const ParseV2ParametersProcessingOptionsAutoModeConfigurationParsingConfVersion2026_04_19 ParseV2ParametersProcessingOptionsAutoModeConfigurationParsingConfVersion = "2026-04-19"` - `const ParseV2ParametersProcessingOptionsAutoModeConfigurationParsingConfVersion2026_04_22 ParseV2ParametersProcessingOptionsAutoModeConfigurationParsingConfVersion = "2026-04-22"` - `const ParseV2ParametersProcessingOptionsAutoModeConfigurationParsingConfVersion2026_04_27 ParseV2ParametersProcessingOptionsAutoModeConfigurationParsingConfVersion = "2026-04-27"` - `const ParseV2ParametersProcessingOptionsAutoModeConfigurationParsingConfVersionLatest ParseV2ParametersProcessingOptionsAutoModeConfigurationParsingConfVersion = "latest"` - `string` - `FilenameMatchGlob string` Single glob pattern to match against filename - `FilenameMatchGlobList []string` List of glob patterns to match against filename - `FilenameRegexp string` Regex pattern to match against filename - `FilenameRegexpMode string` Regex mode flags (e.g., 'i' for case-insensitive) - `FullPageImageInPage bool` Trigger if page contains a full-page image (scanned page detection) - `FullPageImageInPageThreshold ParseV2ParametersProcessingOptionsAutoModeConfigurationFullPageImageInPageThresholdUnionResp` Threshold for full page image detection (0.0-1.0, default 0.8) - `float64` - `string` - `ImageInPage bool` Trigger if page contains non-screenshot images - `LayoutElementInPage string` Trigger if page contains this layout element type - `LayoutElementInPageConfidenceThreshold ParseV2ParametersProcessingOptionsAutoModeConfigurationLayoutElementInPageConfidenceThresholdUnionResp` Confidence threshold for layout element detection - `float64` - `string` - `PageContainsAtLeastNCharts ParseV2ParametersProcessingOptionsAutoModeConfigurationPageContainsAtLeastNChartsUnionResp` Trigger if page has more than N charts - `int64` - `string` - `PageContainsAtLeastNImages ParseV2ParametersProcessingOptionsAutoModeConfigurationPageContainsAtLeastNImagesUnionResp` Trigger if page has more than N images - `int64` - `string` - `PageContainsAtLeastNLayoutElements ParseV2ParametersProcessingOptionsAutoModeConfigurationPageContainsAtLeastNLayoutElementsUnionResp` Trigger if page has more than N layout elements - `int64` - `string` - `PageContainsAtLeastNLines ParseV2ParametersProcessingOptionsAutoModeConfigurationPageContainsAtLeastNLinesUnionResp` Trigger if page has more than N lines - `int64` - `string` - `PageContainsAtLeastNLinks ParseV2ParametersProcessingOptionsAutoModeConfigurationPageContainsAtLeastNLinksUnionResp` Trigger if page has more than N links - `int64` - `string` - `PageContainsAtLeastNNumbers ParseV2ParametersProcessingOptionsAutoModeConfigurationPageContainsAtLeastNNumbersUnionResp` Trigger if page has more than N numeric words - `int64` - `string` - `PageContainsAtLeastNPercentNumbers ParseV2ParametersProcessingOptionsAutoModeConfigurationPageContainsAtLeastNPercentNumbersUnionResp` Trigger if page has more than N% numeric words - `int64` - `string` - `PageContainsAtLeastNTables ParseV2ParametersProcessingOptionsAutoModeConfigurationPageContainsAtLeastNTablesUnionResp` Trigger if page has more than N tables - `int64` - `string` - `PageContainsAtLeastNWords ParseV2ParametersProcessingOptionsAutoModeConfigurationPageContainsAtLeastNWordsUnionResp` Trigger if page has more than N words - `int64` - `string` - `PageContainsAtMostNCharts ParseV2ParametersProcessingOptionsAutoModeConfigurationPageContainsAtMostNChartsUnionResp` Trigger if page has fewer than N charts - `int64` - `string` - `PageContainsAtMostNImages ParseV2ParametersProcessingOptionsAutoModeConfigurationPageContainsAtMostNImagesUnionResp` Trigger if page has fewer than N images - `int64` - `string` - `PageContainsAtMostNLayoutElements ParseV2ParametersProcessingOptionsAutoModeConfigurationPageContainsAtMostNLayoutElementsUnionResp` Trigger if page has fewer than N layout elements - `int64` - `string` - `PageContainsAtMostNLines ParseV2ParametersProcessingOptionsAutoModeConfigurationPageContainsAtMostNLinesUnionResp` Trigger if page has fewer than N lines - `int64` - `string` - `PageContainsAtMostNLinks ParseV2ParametersProcessingOptionsAutoModeConfigurationPageContainsAtMostNLinksUnionResp` Trigger if page has fewer than N links - `int64` - `string` - `PageContainsAtMostNNumbers ParseV2ParametersProcessingOptionsAutoModeConfigurationPageContainsAtMostNNumbersUnionResp` Trigger if page has fewer than N numeric words - `int64` - `string` - `PageContainsAtMostNPercentNumbers ParseV2ParametersProcessingOptionsAutoModeConfigurationPageContainsAtMostNPercentNumbersUnionResp` Trigger if page has fewer than N% numeric words - `int64` - `string` - `PageContainsAtMostNTables ParseV2ParametersProcessingOptionsAutoModeConfigurationPageContainsAtMostNTablesUnionResp` Trigger if page has fewer than N tables - `int64` - `string` - `PageContainsAtMostNWords ParseV2ParametersProcessingOptionsAutoModeConfigurationPageContainsAtMostNWordsUnionResp` Trigger if page has fewer than N words - `int64` - `string` - `PageLongerThanNChars ParseV2ParametersProcessingOptionsAutoModeConfigurationPageLongerThanNCharsUnionResp` Trigger if page has more than N characters - `int64` - `string` - `PageMdError bool` Trigger on pages with markdown extraction errors - `PageShorterThanNChars ParseV2ParametersProcessingOptionsAutoModeConfigurationPageShorterThanNCharsUnionResp` Trigger if page has fewer than N characters - `int64` - `string` - `RegexpInPage string` Regex pattern to match in page content - `RegexpInPageMode string` Regex mode flags for regexp_in_page - `TableInPage bool` Trigger if page contains a table - `TextInPage string` Trigger if page text/markdown contains this string - `TriggerMode string` How to combine multiple trigger conditions: 'and' (all conditions must match, this is the default) or 'or' (any single condition can trigger) - `CostOptimizer ParseV2ParametersProcessingOptionsCostOptimizerResp` Cost optimizer configuration for reducing parsing costs on simpler pages. When enabled, the parser analyzes each page and routes simpler pages to faster, cheaper processing while preserving quality for complex pages. Only works with 'agentic' or 'agentic_plus' tiers. - `Enable bool` Enable cost-optimized parsing. Routes simpler pages to faster processing while complex pages use full AI analysis. May reduce speed on some documents. IMPORTANT: Only available with 'agentic' or 'agentic_plus' tiers - `DisableHeuristics bool` Disable automatic heuristics including outlined table extraction and adaptive long table handling. Use when heuristics produce incorrect results - `Ignore ParseV2ParametersProcessingOptionsIgnoreResp` Options for ignoring specific text types (diagonal, hidden, text in images) - `IgnoreDiagonalText bool` Skip text rotated at an angle (not horizontal/vertical). Useful for ignoring watermarks or decorative angled text - `IgnoreHiddenText bool` Skip text marked as hidden in the document structure. Some PDFs contain invisible text layers used for accessibility or search indexing - `IgnoreTextInImage bool` Skip OCR text extraction from embedded images. Use when images contain irrelevant text (watermarks, logos) that shouldn't be in the output - `OcrParameters ParseV2ParametersProcessingOptionsOcrParametersResp` OCR configuration including language detection settings - `Languages []ParsingLanguages` Languages to use for OCR text recognition. Specify multiple languages if document contains mixed-language content. Order matters - put primary language first. Example: ['en', 'es'] for English with Spanish - `const ParsingLanguagesAf ParsingLanguages = "af"` - `const ParsingLanguagesAz ParsingLanguages = "az"` - `const ParsingLanguagesBs ParsingLanguages = "bs"` - `const ParsingLanguagesCs ParsingLanguages = "cs"` - `const ParsingLanguagesCy ParsingLanguages = "cy"` - `const ParsingLanguagesDa ParsingLanguages = "da"` - `const ParsingLanguagesDe ParsingLanguages = "de"` - `const ParsingLanguagesEn ParsingLanguages = "en"` - `const ParsingLanguagesEs ParsingLanguages = "es"` - `const ParsingLanguagesEt ParsingLanguages = "et"` - `const ParsingLanguagesFr ParsingLanguages = "fr"` - `const ParsingLanguagesGa ParsingLanguages = "ga"` - `const ParsingLanguagesHr ParsingLanguages = "hr"` - `const ParsingLanguagesHu ParsingLanguages = "hu"` - `const ParsingLanguagesID ParsingLanguages = "id"` - `const ParsingLanguagesIs ParsingLanguages = "is"` - `const ParsingLanguagesIt ParsingLanguages = "it"` - `const ParsingLanguagesKu ParsingLanguages = "ku"` - `const ParsingLanguagesLa ParsingLanguages = "la"` - `const ParsingLanguagesLt ParsingLanguages = "lt"` - `const ParsingLanguagesLv ParsingLanguages = "lv"` - `const ParsingLanguagesMi ParsingLanguages = "mi"` - `const ParsingLanguagesMs ParsingLanguages = "ms"` - `const ParsingLanguagesMt ParsingLanguages = "mt"` - `const ParsingLanguagesNl ParsingLanguages = "nl"` - `const ParsingLanguagesNo ParsingLanguages = "no"` - `const ParsingLanguagesOc ParsingLanguages = "oc"` - `const ParsingLanguagesPi ParsingLanguages = "pi"` - `const ParsingLanguagesPl ParsingLanguages = "pl"` - `const ParsingLanguagesPt ParsingLanguages = "pt"` - `const ParsingLanguagesRo ParsingLanguages = "ro"` - `const ParsingLanguagesRsLatin ParsingLanguages = "rs_latin"` - `const ParsingLanguagesSk ParsingLanguages = "sk"` - `const ParsingLanguagesSl ParsingLanguages = "sl"` - `const ParsingLanguagesSq ParsingLanguages = "sq"` - `const ParsingLanguagesSv ParsingLanguages = "sv"` - `const ParsingLanguagesSw ParsingLanguages = "sw"` - `const ParsingLanguagesTl ParsingLanguages = "tl"` - `const ParsingLanguagesTr ParsingLanguages = "tr"` - `const ParsingLanguagesUz ParsingLanguages = "uz"` - `const ParsingLanguagesVi ParsingLanguages = "vi"` - `const ParsingLanguagesAr ParsingLanguages = "ar"` - `const ParsingLanguagesFa ParsingLanguages = "fa"` - `const ParsingLanguagesUg ParsingLanguages = "ug"` - `const ParsingLanguagesUr ParsingLanguages = "ur"` - `const ParsingLanguagesBn ParsingLanguages = "bn"` - `const ParsingLanguagesAs ParsingLanguages = "as"` - `const ParsingLanguagesMni ParsingLanguages = "mni"` - `const ParsingLanguagesRu ParsingLanguages = "ru"` - `const ParsingLanguagesRsCyrillic ParsingLanguages = "rs_cyrillic"` - `const ParsingLanguagesBe ParsingLanguages = "be"` - `const ParsingLanguagesBg ParsingLanguages = "bg"` - `const ParsingLanguagesUk ParsingLanguages = "uk"` - `const ParsingLanguagesMn ParsingLanguages = "mn"` - `const ParsingLanguagesAbq ParsingLanguages = "abq"` - `const ParsingLanguagesAdy ParsingLanguages = "ady"` - `const ParsingLanguagesKbd ParsingLanguages = "kbd"` - `const ParsingLanguagesAva ParsingLanguages = "ava"` - `const ParsingLanguagesDar ParsingLanguages = "dar"` - `const ParsingLanguagesInh ParsingLanguages = "inh"` - `const ParsingLanguagesChe ParsingLanguages = "che"` - `const ParsingLanguagesLbe ParsingLanguages = "lbe"` - `const ParsingLanguagesLez ParsingLanguages = "lez"` - `const ParsingLanguagesTab ParsingLanguages = "tab"` - `const ParsingLanguagesTjk ParsingLanguages = "tjk"` - `const ParsingLanguagesHi ParsingLanguages = "hi"` - `const ParsingLanguagesMr ParsingLanguages = "mr"` - `const ParsingLanguagesNe ParsingLanguages = "ne"` - `const ParsingLanguagesBh ParsingLanguages = "bh"` - `const ParsingLanguagesMai ParsingLanguages = "mai"` - `const ParsingLanguagesAng ParsingLanguages = "ang"` - `const ParsingLanguagesBho ParsingLanguages = "bho"` - `const ParsingLanguagesMah ParsingLanguages = "mah"` - `const ParsingLanguagesSck ParsingLanguages = "sck"` - `const ParsingLanguagesNew ParsingLanguages = "new"` - `const ParsingLanguagesGom ParsingLanguages = "gom"` - `const ParsingLanguagesSa ParsingLanguages = "sa"` - `const ParsingLanguagesBgc ParsingLanguages = "bgc"` - `const ParsingLanguagesTh ParsingLanguages = "th"` - `const ParsingLanguagesChSim ParsingLanguages = "ch_sim"` - `const ParsingLanguagesChTra ParsingLanguages = "ch_tra"` - `const ParsingLanguagesJa ParsingLanguages = "ja"` - `const ParsingLanguagesKo ParsingLanguages = "ko"` - `const ParsingLanguagesTa ParsingLanguages = "ta"` - `const ParsingLanguagesTe ParsingLanguages = "te"` - `const ParsingLanguagesKn ParsingLanguages = "kn"` - `SpecializedChartParsing string` Enable AI-powered chart analysis. Modes: 'efficient' (fast, lower cost), 'agentic' (balanced), 'agentic_plus' (highest accuracy). Automatically enables extract_layout and precise_bounding_box when set - `const ParseV2ParametersProcessingOptionsSpecializedChartParsingAgenticPlus ParseV2ParametersProcessingOptionsSpecializedChartParsing = "agentic_plus"` - `const ParseV2ParametersProcessingOptionsSpecializedChartParsingAgentic ParseV2ParametersProcessingOptionsSpecializedChartParsing = "agentic"` - `const ParseV2ParametersProcessingOptionsSpecializedChartParsingEfficient ParseV2ParametersProcessingOptionsSpecializedChartParsing = "efficient"` - `WebhookConfigurations []ParseV2ParametersWebhookConfigurationResp` Webhook endpoints for job status notifications. Multiple webhooks can be configured for different events or services - `WebhookEvents []string` Events that trigger this webhook. Options: 'parse.success' (job completed), 'parse.failure' (job failed), 'parse.partial' (some pages failed). If not specified, webhook fires for all events - `WebhookHeaders map[string, any]` Custom HTTP headers to include in webhook requests. Use for authentication tokens or custom routing. Example: {'Authorization': 'Bearer xyz'} - `WebhookURL string` HTTPS URL to receive webhook POST requests. Must be publicly accessible - `type ConfigurationCreateParametersSpreadsheetV1 struct{…}` Typed parameters for a *spreadsheet v1* product configuration. - `ProductType SpreadsheetV1` Product type. - `const SpreadsheetV1SpreadsheetV1 SpreadsheetV1 = "spreadsheet_v1"` - `ExtractionRange string` A1 notation of the range to extract a single region from. If None, the entire sheet is used. - `FlattenHierarchicalTables bool` Return a flattened dataframe when a detected table is recognized as hierarchical. - `GenerateAdditionalMetadata bool` Whether to generate additional metadata (title, description) for each extracted region. - `IncludeHiddenCells bool` Whether to include hidden cells when extracting regions from the spreadsheet. - `SheetNames []string` The names of the sheets to extract regions from. If empty, all sheets will be processed. - `Specialization string` Optional specialization mode for domain-specific extraction. Supported values: 'financial-standard', 'financial-enhanced', 'financial-precise'. Default None uses the general-purpose pipeline. - `TableMergeSensitivity string` 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). - `const ConfigurationCreateParametersSpreadsheetV1TableMergeSensitivityStrong ConfigurationCreateParametersSpreadsheetV1TableMergeSensitivity = "strong"` - `const ConfigurationCreateParametersSpreadsheetV1TableMergeSensitivityWeak ConfigurationCreateParametersSpreadsheetV1TableMergeSensitivity = "weak"` - `UseExperimentalProcessing bool` Enables experimental processing. Accuracy may be impacted. - `type UntypedParametersResp struct{…}` Catch-all for configurations without a dedicated typed schema. Accepts arbitrary JSON fields alongside `product_type`. - `ProductType Unknown` Product type. - `const UnknownUnknown Unknown = "unknown"` ### Example ```go 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"), ) configurationCreate, err := client.Extract.GenerateSchema(context.TODO(), llamacloudprod.ExtractGenerateSchemaParams{ ExtractV2SchemaGenerateRequest: llamacloudprod.ExtractV2SchemaGenerateRequestParam{ }, }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", configurationCreate.Name) } ``` #### Response ```json { "name": "x", "parameters": { "categories": [ { "name": "x", "description": "x" } ], "product_type": "split_v1", "splitting_strategy": { "allow_uncategorized": "include" } } } ``` ## Domain Types ### Extract Configuration - `type ExtractConfiguration struct{…}` Extract configuration combining parse and extract settings. - `DataSchema map[string, ExtractConfigurationDataSchemaUnion]` JSON Schema defining the fields to extract. Validate with the /schema/validate endpoint first. - `type ExtractConfigurationDataSchemaMap map[string, any]` - `type ExtractConfigurationDataSchemaArray []any` - `string` - `float64` - `bool` - `CiteSources bool` Include citations in results - `ConfidenceScores bool` Include confidence scores in results - `ExtractVersion string` Extract algorithm version. Use 'latest' for the default pipeline or a date string (e.g. '2026-01-08') to pin to a specific release. - `ExtractionTarget ExtractConfigurationExtractionTarget` Granularity of extraction: per_doc returns one object per document, per_page returns one object per page, per_table_row returns one object per table row - `const ExtractConfigurationExtractionTargetPerDoc ExtractConfigurationExtractionTarget = "per_doc"` - `const ExtractConfigurationExtractionTargetPerPage ExtractConfigurationExtractionTarget = "per_page"` - `const ExtractConfigurationExtractionTargetPerTableRow ExtractConfigurationExtractionTarget = "per_table_row"` - `MaxPages int64` Maximum number of pages to process. Omit for no limit. - `ParseConfigID string` Saved parse configuration ID to control how the document is parsed before extraction - `ParseTier string` Parse tier to use before extraction. Defaults to the extract tier if not specified. - `SystemPrompt string` Custom system prompt to guide extraction behavior - `TargetPages string` Comma-separated page numbers or ranges to process (1-based). Omit to process all pages. - `Tier ExtractConfigurationTier` Extract tier: cost_effective (5 credits/page) or agentic (15 credits/page) - `const ExtractConfigurationTierCostEffective ExtractConfigurationTier = "cost_effective"` - `const ExtractConfigurationTierAgentic ExtractConfigurationTier = "agentic"` ### Extract Job Metadata - `type ExtractJobMetadata struct{…}` Extraction metadata. - `FieldMetadata ExtractedFieldMetadata` Metadata for extracted fields including document, page, and row level info. - `DocumentMetadata map[string, ExtractedFieldMetadataDocumentMetadataUnion]` Per-field metadata keyed by field name from your schema. Scalar fields (e.g. `vendor`) map to a FieldMetadataEntry with citation and confidence. Array fields (e.g. `items`) map to a list where each element contains per-sub-field FieldMetadataEntry objects, indexed by array position. Nested objects contain sub-field entries recursively. - `type ExtractedFieldMetadataDocumentMetadataMap map[string, any]` - `type ExtractedFieldMetadataDocumentMetadataArray []any` - `string` - `float64` - `bool` - `PageMetadata []map[string, ExtractedFieldMetadataPageMetadataUnion]` Per-page metadata when extraction_target is per_page - `type ExtractedFieldMetadataPageMetadataMap map[string, any]` - `type ExtractedFieldMetadataPageMetadataArray []any` - `string` - `float64` - `bool` - `RowMetadata []map[string, ExtractedFieldMetadataRowMetadataUnion]` Per-row metadata when extraction_target is per_table_row - `type ExtractedFieldMetadataRowMetadataMap map[string, any]` - `type ExtractedFieldMetadataRowMetadataArray []any` - `string` - `float64` - `bool` - `ParseJobID string` Reference to the ParseJob ID used for parsing - `ParseTier string` Parse tier used for parsing the document ### Extract Job Usage - `type ExtractJobUsage struct{…}` Extraction usage metrics. - `NumDocumentTokens int64` Number of document tokens - `NumOutputTokens int64` Number of output tokens - `NumPagesExtracted int64` Number of pages extracted ### Extract V2 Job - `type ExtractV2Job struct{…}` An extraction job. - `ID string` Unique job identifier (job_id) - `CreatedAt Time` Creation timestamp - `FileInput string` File ID or parse job ID that was extracted - `ProjectID string` Project this job belongs to - `Status string` Current job status. - `PENDING` — queued, not yet started - `RUNNING` — actively processing - `COMPLETED` — finished successfully - `FAILED` — terminated with an error - `CANCELLED` — cancelled by user - `UpdatedAt Time` Last update timestamp - `Configuration ExtractConfiguration` Extract configuration combining parse and extract settings. - `DataSchema map[string, ExtractConfigurationDataSchemaUnion]` JSON Schema defining the fields to extract. Validate with the /schema/validate endpoint first. - `type ExtractConfigurationDataSchemaMap map[string, any]` - `type ExtractConfigurationDataSchemaArray []any` - `string` - `float64` - `bool` - `CiteSources bool` Include citations in results - `ConfidenceScores bool` Include confidence scores in results - `ExtractVersion string` Extract algorithm version. Use 'latest' for the default pipeline or a date string (e.g. '2026-01-08') to pin to a specific release. - `ExtractionTarget ExtractConfigurationExtractionTarget` Granularity of extraction: per_doc returns one object per document, per_page returns one object per page, per_table_row returns one object per table row - `const ExtractConfigurationExtractionTargetPerDoc ExtractConfigurationExtractionTarget = "per_doc"` - `const ExtractConfigurationExtractionTargetPerPage ExtractConfigurationExtractionTarget = "per_page"` - `const ExtractConfigurationExtractionTargetPerTableRow ExtractConfigurationExtractionTarget = "per_table_row"` - `MaxPages int64` Maximum number of pages to process. Omit for no limit. - `ParseConfigID string` Saved parse configuration ID to control how the document is parsed before extraction - `ParseTier string` Parse tier to use before extraction. Defaults to the extract tier if not specified. - `SystemPrompt string` Custom system prompt to guide extraction behavior - `TargetPages string` Comma-separated page numbers or ranges to process (1-based). Omit to process all pages. - `Tier ExtractConfigurationTier` Extract tier: cost_effective (5 credits/page) or agentic (15 credits/page) - `const ExtractConfigurationTierCostEffective ExtractConfigurationTier = "cost_effective"` - `const ExtractConfigurationTierAgentic ExtractConfigurationTier = "agentic"` - `ConfigurationID string` Saved extract configuration ID used for this job, if any - `ErrorMessage string` Error details when status is FAILED - `ExtractMetadata ExtractJobMetadata` Extraction metadata. - `FieldMetadata ExtractedFieldMetadata` Metadata for extracted fields including document, page, and row level info. - `DocumentMetadata map[string, ExtractedFieldMetadataDocumentMetadataUnion]` Per-field metadata keyed by field name from your schema. Scalar fields (e.g. `vendor`) map to a FieldMetadataEntry with citation and confidence. Array fields (e.g. `items`) map to a list where each element contains per-sub-field FieldMetadataEntry objects, indexed by array position. Nested objects contain sub-field entries recursively. - `type ExtractedFieldMetadataDocumentMetadataMap map[string, any]` - `type ExtractedFieldMetadataDocumentMetadataArray []any` - `string` - `float64` - `bool` - `PageMetadata []map[string, ExtractedFieldMetadataPageMetadataUnion]` Per-page metadata when extraction_target is per_page - `type ExtractedFieldMetadataPageMetadataMap map[string, any]` - `type ExtractedFieldMetadataPageMetadataArray []any` - `string` - `float64` - `bool` - `RowMetadata []map[string, ExtractedFieldMetadataRowMetadataUnion]` Per-row metadata when extraction_target is per_table_row - `type ExtractedFieldMetadataRowMetadataMap map[string, any]` - `type ExtractedFieldMetadataRowMetadataArray []any` - `string` - `float64` - `bool` - `ParseJobID string` Reference to the ParseJob ID used for parsing - `ParseTier string` Parse tier used for parsing the document - `ExtractResult ExtractV2JobExtractResultUnion` Extracted data conforming to the data_schema. Returns a single object for per_doc, or an array for per_page / per_table_row. - `type ExtractV2JobExtractResultMap map[string, ExtractV2JobExtractResultMapItemUnion]` - `type ExtractV2JobExtractResultMapItemMap map[string, any]` - `type ExtractV2JobExtractResultMapItemArray []any` - `string` - `float64` - `bool` - `type ExtractV2JobExtractResultArray []map[string, ExtractV2JobExtractResultArrayItemUnion]` - `type ExtractV2JobExtractResultArrayItemMap map[string, any]` - `type ExtractV2JobExtractResultArrayItemArray []any` - `string` - `float64` - `bool` - `Metadata ExtractV2JobMetadata` Job-level metadata. - `Usage ExtractJobUsage` Extraction usage metrics. - `NumDocumentTokens int64` Number of document tokens - `NumOutputTokens int64` Number of output tokens - `NumPagesExtracted int64` Number of pages extracted ### Extract V2 Job Create - `type ExtractV2JobCreate struct{…}` Request to create an extraction job. Provide configuration_id or inline configuration. - `FileInput string` File ID or parse job ID to extract from - `Configuration ExtractConfiguration` Extract configuration combining parse and extract settings. - `DataSchema map[string, ExtractConfigurationDataSchemaUnion]` JSON Schema defining the fields to extract. Validate with the /schema/validate endpoint first. - `type ExtractConfigurationDataSchemaMap map[string, any]` - `type ExtractConfigurationDataSchemaArray []any` - `string` - `float64` - `bool` - `CiteSources bool` Include citations in results - `ConfidenceScores bool` Include confidence scores in results - `ExtractVersion string` Extract algorithm version. Use 'latest' for the default pipeline or a date string (e.g. '2026-01-08') to pin to a specific release. - `ExtractionTarget ExtractConfigurationExtractionTarget` Granularity of extraction: per_doc returns one object per document, per_page returns one object per page, per_table_row returns one object per table row - `const ExtractConfigurationExtractionTargetPerDoc ExtractConfigurationExtractionTarget = "per_doc"` - `const ExtractConfigurationExtractionTargetPerPage ExtractConfigurationExtractionTarget = "per_page"` - `const ExtractConfigurationExtractionTargetPerTableRow ExtractConfigurationExtractionTarget = "per_table_row"` - `MaxPages int64` Maximum number of pages to process. Omit for no limit. - `ParseConfigID string` Saved parse configuration ID to control how the document is parsed before extraction - `ParseTier string` Parse tier to use before extraction. Defaults to the extract tier if not specified. - `SystemPrompt string` Custom system prompt to guide extraction behavior - `TargetPages string` Comma-separated page numbers or ranges to process (1-based). Omit to process all pages. - `Tier ExtractConfigurationTier` Extract tier: cost_effective (5 credits/page) or agentic (15 credits/page) - `const ExtractConfigurationTierCostEffective ExtractConfigurationTier = "cost_effective"` - `const ExtractConfigurationTierAgentic ExtractConfigurationTier = "agentic"` - `ConfigurationID string` Saved configuration ID - `WebhookConfigurations []ExtractV2JobCreateWebhookConfiguration` Outbound webhook endpoints to notify on job status changes - `WebhookEvents []string` Events to subscribe to (e.g. 'parse.success', 'extract.error'). If null, all events are delivered. - `const ExtractV2JobCreateWebhookConfigurationWebhookEventExtractPending ExtractV2JobCreateWebhookConfigurationWebhookEvent = "extract.pending"` - `const ExtractV2JobCreateWebhookConfigurationWebhookEventExtractSuccess ExtractV2JobCreateWebhookConfigurationWebhookEvent = "extract.success"` - `const ExtractV2JobCreateWebhookConfigurationWebhookEventExtractError ExtractV2JobCreateWebhookConfigurationWebhookEvent = "extract.error"` - `const ExtractV2JobCreateWebhookConfigurationWebhookEventExtractPartialSuccess ExtractV2JobCreateWebhookConfigurationWebhookEvent = "extract.partial_success"` - `const ExtractV2JobCreateWebhookConfigurationWebhookEventExtractCancelled ExtractV2JobCreateWebhookConfigurationWebhookEvent = "extract.cancelled"` - `const ExtractV2JobCreateWebhookConfigurationWebhookEventParsePending ExtractV2JobCreateWebhookConfigurationWebhookEvent = "parse.pending"` - `const ExtractV2JobCreateWebhookConfigurationWebhookEventParseRunning ExtractV2JobCreateWebhookConfigurationWebhookEvent = "parse.running"` - `const ExtractV2JobCreateWebhookConfigurationWebhookEventParseSuccess ExtractV2JobCreateWebhookConfigurationWebhookEvent = "parse.success"` - `const ExtractV2JobCreateWebhookConfigurationWebhookEventParseError ExtractV2JobCreateWebhookConfigurationWebhookEvent = "parse.error"` - `const ExtractV2JobCreateWebhookConfigurationWebhookEventParsePartialSuccess ExtractV2JobCreateWebhookConfigurationWebhookEvent = "parse.partial_success"` - `const ExtractV2JobCreateWebhookConfigurationWebhookEventParseCancelled ExtractV2JobCreateWebhookConfigurationWebhookEvent = "parse.cancelled"` - `const ExtractV2JobCreateWebhookConfigurationWebhookEventClassifyPending ExtractV2JobCreateWebhookConfigurationWebhookEvent = "classify.pending"` - `const ExtractV2JobCreateWebhookConfigurationWebhookEventClassifySuccess ExtractV2JobCreateWebhookConfigurationWebhookEvent = "classify.success"` - `const ExtractV2JobCreateWebhookConfigurationWebhookEventClassifyError ExtractV2JobCreateWebhookConfigurationWebhookEvent = "classify.error"` - `const ExtractV2JobCreateWebhookConfigurationWebhookEventClassifyPartialSuccess ExtractV2JobCreateWebhookConfigurationWebhookEvent = "classify.partial_success"` - `const ExtractV2JobCreateWebhookConfigurationWebhookEventClassifyCancelled ExtractV2JobCreateWebhookConfigurationWebhookEvent = "classify.cancelled"` - `const ExtractV2JobCreateWebhookConfigurationWebhookEventUnmappedEvent ExtractV2JobCreateWebhookConfigurationWebhookEvent = "unmapped_event"` - `WebhookHeaders map[string, string]` Custom HTTP headers sent with each webhook request (e.g. auth tokens) - `WebhookOutputFormat string` Response format sent to the webhook: 'string' (default) or 'json' - `WebhookURL string` URL to receive webhook POST notifications ### Extract V2 Job Query Response - `type ExtractV2JobQueryResponse struct{…}` Paginated list of extraction jobs. - `Items []ExtractV2Job` The list of items. - `ID string` Unique job identifier (job_id) - `CreatedAt Time` Creation timestamp - `FileInput string` File ID or parse job ID that was extracted - `ProjectID string` Project this job belongs to - `Status string` Current job status. - `PENDING` — queued, not yet started - `RUNNING` — actively processing - `COMPLETED` — finished successfully - `FAILED` — terminated with an error - `CANCELLED` — cancelled by user - `UpdatedAt Time` Last update timestamp - `Configuration ExtractConfiguration` Extract configuration combining parse and extract settings. - `DataSchema map[string, ExtractConfigurationDataSchemaUnion]` JSON Schema defining the fields to extract. Validate with the /schema/validate endpoint first. - `type ExtractConfigurationDataSchemaMap map[string, any]` - `type ExtractConfigurationDataSchemaArray []any` - `string` - `float64` - `bool` - `CiteSources bool` Include citations in results - `ConfidenceScores bool` Include confidence scores in results - `ExtractVersion string` Extract algorithm version. Use 'latest' for the default pipeline or a date string (e.g. '2026-01-08') to pin to a specific release. - `ExtractionTarget ExtractConfigurationExtractionTarget` Granularity of extraction: per_doc returns one object per document, per_page returns one object per page, per_table_row returns one object per table row - `const ExtractConfigurationExtractionTargetPerDoc ExtractConfigurationExtractionTarget = "per_doc"` - `const ExtractConfigurationExtractionTargetPerPage ExtractConfigurationExtractionTarget = "per_page"` - `const ExtractConfigurationExtractionTargetPerTableRow ExtractConfigurationExtractionTarget = "per_table_row"` - `MaxPages int64` Maximum number of pages to process. Omit for no limit. - `ParseConfigID string` Saved parse configuration ID to control how the document is parsed before extraction - `ParseTier string` Parse tier to use before extraction. Defaults to the extract tier if not specified. - `SystemPrompt string` Custom system prompt to guide extraction behavior - `TargetPages string` Comma-separated page numbers or ranges to process (1-based). Omit to process all pages. - `Tier ExtractConfigurationTier` Extract tier: cost_effective (5 credits/page) or agentic (15 credits/page) - `const ExtractConfigurationTierCostEffective ExtractConfigurationTier = "cost_effective"` - `const ExtractConfigurationTierAgentic ExtractConfigurationTier = "agentic"` - `ConfigurationID string` Saved extract configuration ID used for this job, if any - `ErrorMessage string` Error details when status is FAILED - `ExtractMetadata ExtractJobMetadata` Extraction metadata. - `FieldMetadata ExtractedFieldMetadata` Metadata for extracted fields including document, page, and row level info. - `DocumentMetadata map[string, ExtractedFieldMetadataDocumentMetadataUnion]` Per-field metadata keyed by field name from your schema. Scalar fields (e.g. `vendor`) map to a FieldMetadataEntry with citation and confidence. Array fields (e.g. `items`) map to a list where each element contains per-sub-field FieldMetadataEntry objects, indexed by array position. Nested objects contain sub-field entries recursively. - `type ExtractedFieldMetadataDocumentMetadataMap map[string, any]` - `type ExtractedFieldMetadataDocumentMetadataArray []any` - `string` - `float64` - `bool` - `PageMetadata []map[string, ExtractedFieldMetadataPageMetadataUnion]` Per-page metadata when extraction_target is per_page - `type ExtractedFieldMetadataPageMetadataMap map[string, any]` - `type ExtractedFieldMetadataPageMetadataArray []any` - `string` - `float64` - `bool` - `RowMetadata []map[string, ExtractedFieldMetadataRowMetadataUnion]` Per-row metadata when extraction_target is per_table_row - `type ExtractedFieldMetadataRowMetadataMap map[string, any]` - `type ExtractedFieldMetadataRowMetadataArray []any` - `string` - `float64` - `bool` - `ParseJobID string` Reference to the ParseJob ID used for parsing - `ParseTier string` Parse tier used for parsing the document - `ExtractResult ExtractV2JobExtractResultUnion` Extracted data conforming to the data_schema. Returns a single object for per_doc, or an array for per_page / per_table_row. - `type ExtractV2JobExtractResultMap map[string, ExtractV2JobExtractResultMapItemUnion]` - `type ExtractV2JobExtractResultMapItemMap map[string, any]` - `type ExtractV2JobExtractResultMapItemArray []any` - `string` - `float64` - `bool` - `type ExtractV2JobExtractResultArray []map[string, ExtractV2JobExtractResultArrayItemUnion]` - `type ExtractV2JobExtractResultArrayItemMap map[string, any]` - `type ExtractV2JobExtractResultArrayItemArray []any` - `string` - `float64` - `bool` - `Metadata ExtractV2JobMetadata` Job-level metadata. - `Usage ExtractJobUsage` Extraction usage metrics. - `NumDocumentTokens int64` Number of document tokens - `NumOutputTokens int64` Number of output tokens - `NumPagesExtracted int64` Number of pages extracted - `NextPageToken string` A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages. - `TotalSize int64` The total number of items available. This is only populated when specifically requested. The value may be an estimate and can be used for display purposes only. ### Extract V2 Schema Generate Request - `type ExtractV2SchemaGenerateRequest struct{…}` Request schema for generating an extraction schema. - `DataSchema map[string, ExtractV2SchemaGenerateRequestDataSchemaUnion]` Optional schema to validate, refine, or extend - `map[string, any]` - `[]any` - `string` - `float64` - `bool` - `FileID string` Optional file ID to analyze for schema generation - `Name string` Name for the generated configuration (auto-generated if omitted) - `Prompt string` Natural language description of the data structure to extract ### Extract V2 Schema Validate Request - `type ExtractV2SchemaValidateRequest struct{…}` Request schema for validating an extraction schema. - `DataSchema map[string, ExtractV2SchemaValidateRequestDataSchemaUnion]` JSON Schema to validate for use with extract jobs - `map[string, any]` - `[]any` - `string` - `float64` - `bool` ### Extract V2 Schema Validate Response - `type ExtractV2SchemaValidateResponse struct{…}` Response schema for schema validation. - `DataSchema map[string, ExtractV2SchemaValidateResponseDataSchemaUnion]` Validated JSON Schema, ready for use in extract jobs - `type ExtractV2SchemaValidateResponseDataSchemaMap map[string, any]` - `type ExtractV2SchemaValidateResponseDataSchemaArray []any` - `string` - `float64` - `bool` ### Extracted Field Metadata - `type ExtractedFieldMetadata struct{…}` Metadata for extracted fields including document, page, and row level info. - `DocumentMetadata map[string, ExtractedFieldMetadataDocumentMetadataUnion]` Per-field metadata keyed by field name from your schema. Scalar fields (e.g. `vendor`) map to a FieldMetadataEntry with citation and confidence. Array fields (e.g. `items`) map to a list where each element contains per-sub-field FieldMetadataEntry objects, indexed by array position. Nested objects contain sub-field entries recursively. - `type ExtractedFieldMetadataDocumentMetadataMap map[string, any]` - `type ExtractedFieldMetadataDocumentMetadataArray []any` - `string` - `float64` - `bool` - `PageMetadata []map[string, ExtractedFieldMetadataPageMetadataUnion]` Per-page metadata when extraction_target is per_page - `type ExtractedFieldMetadataPageMetadataMap map[string, any]` - `type ExtractedFieldMetadataPageMetadataArray []any` - `string` - `float64` - `bool` - `RowMetadata []map[string, ExtractedFieldMetadataRowMetadataUnion]` Per-row metadata when extraction_target is per_table_row - `type ExtractedFieldMetadataRowMetadataMap map[string, any]` - `type ExtractedFieldMetadataRowMetadataArray []any` - `string` - `float64` - `bool`