Create Batch Job

client.Beta.Batch.New(ctx, params) (*BetaBatchNewResponse, error)

POST/api/v1/beta/batch-processing

Create a batch processing job.

Processes files from a directory or a specific list of item IDs. Supports batch parsing and classification operations.

Provide either directory_id to process all files in a directory, or item_ids for specific items. The job runs asynchronously — poll GET /batch/{job_id} for progress.

ParametersExpand Collapse

params BetaBatchNewParams

JobConfig param.Field[BetaBatchNewParamsJobConfigUnion]

Body param: Job configuration — either a parse or classify config

type BetaBatchNewParamsJobConfigBatchParseJobRecordCreate struct{…}

Batch-specific parse job record for batch processing.

This model contains the metadata and configuration for a batch parse job, but excludes file-specific information. It's used as input to the batch parent workflow and combined with DirectoryFile data to create full ParseJobRecordCreate instances for each file.

Attributes: job_name: Must be PARSE_RAW_FILE partitions: Partitions for job output location parameters: Generic parse configuration (BatchParseJobConfig) session_id: Upstream request ID for tracking correlation_id: Correlation ID for cross-service tracking parent_job_execution_id: Parent job execution ID if nested user_id: User who created the job project_id: Project this job belongs to webhook_url: Optional webhook URL for job completion notifications

CorrelationID stringoptional

The correlation ID for this job. Used for tracking the job across services.

formatuuid

JobName stringoptional

Parameters BetaBatchNewParamsJobConfigBatchParseJobRecordCreateParametersoptional

Generic parse job configuration for batch processing.

This model contains the parsing configuration that applies to all files in a batch, but excludes file-specific fields like file_name, file_id, etc. Those file-specific fields are populated from DirectoryFile data when creating individual ParseJobRecordCreate instances for each file.

The fields in this model should be generic settings that apply uniformly to all files being processed in the batch.

AdaptiveLongTable booloptional

AggressiveTableExtraction booloptional

AnnotateLinks booloptional

AutoMode booloptional

AutoModeConfigurationJson stringoptional

AutoModeTriggerOnImageInPage booloptional

AutoModeTriggerOnRegexpInPage stringoptional

AutoModeTriggerOnTableInPage booloptional

AutoModeTriggerOnTextInPage stringoptional

AzureOpenAIAPIVersion stringoptional

AzureOpenAIDeploymentName stringoptional

AzureOpenAIEndpoint stringoptional

AzureOpenAIKey stringoptional

BboxBottom float64optional

BboxLeft float64optional

BboxRight float64optional

BboxTop float64optional

BoundingBox stringoptional

CompactMarkdownTable booloptional

ComplementalFormattingInstruction stringoptional

ContentGuidelineInstruction stringoptional

ContinuousMode booloptional

CustomMetadata map[string, any]optional

The custom metadata to attach to the documents.

DisableImageExtraction booloptional

DisableOcr booloptional

DisableReconstruction booloptional

DoNotCache booloptional

DoNotUnrollColumns booloptional

EnableCostOptimizer booloptional

ExtractCharts booloptional

ExtractLayout booloptional

ExtractPrintedPageNumber booloptional

FastMode booloptional

FormattingInstruction stringoptional

Gpt4oAPIKey stringoptional

Gpt4oMode booloptional

GuessXlsxSheetName booloptional

HideFooters booloptional

HideHeaders booloptional

HighResOcr booloptional

HTMLMakeAllElementsVisible booloptional

HTMLRemoveFixedElements booloptional

HTMLRemoveNavigationElements booloptional

HTTPProxy stringoptional

IgnoreDocumentElementsForLayoutDetection booloptional

ImagesToSave []stringoptional

One of the following:

const BetaBatchNewParamsJobConfigBatchParseJobRecordCreateParametersImagesToSaveScreenshot BetaBatchNewParamsJobConfigBatchParseJobRecordCreateParametersImagesToSave = "screenshot"

const BetaBatchNewParamsJobConfigBatchParseJobRecordCreateParametersImagesToSaveEmbedded BetaBatchNewParamsJobConfigBatchParseJobRecordCreateParametersImagesToSave = "embedded"

const BetaBatchNewParamsJobConfigBatchParseJobRecordCreateParametersImagesToSaveLayout BetaBatchNewParamsJobConfigBatchParseJobRecordCreateParametersImagesToSave = "layout"

InlineImagesInMarkdown booloptional

InputS3Path stringoptional

InputS3Region stringoptional

The region for the input S3 bucket.

InputURL stringoptional

InternalIsScreenshotJob booloptional

InvalidateCache booloptional

IsFormattingInstruction booloptional

JobTimeoutExtraTimePerPageInSeconds float64optional

JobTimeoutInSeconds float64optional

KeepPageSeparatorWhenMergingTables booloptional

Lang stringoptional

The language.

Languages []ParsingLanguagesoptional

One of the following:

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"

LayoutAware booloptional

LineLevelBoundingBox booloptional

MarkdownTableMultilineHeaderSeparator stringoptional

MaxPages int64optional

MaxPagesEnforced int64optional

MergeTablesAcrossPagesInMarkdown booloptional

Model stringoptional

OutlinedTableExtraction booloptional

OutputPdfOfDocument booloptional

OutputS3PathPrefix stringoptional

If specified, llamaParse will save the output to the specified path. All output file will use this 'prefix' should be a valid s3:// url

OutputS3Region stringoptional

The region for the output S3 bucket.

OutputTablesAsHTML booloptional

OutputBucket stringoptional

The output bucket.

PageErrorTolerance float64optional

PageFooterPrefix stringoptional

PageFooterSuffix stringoptional

PageHeaderPrefix stringoptional

PageHeaderSuffix stringoptional

PagePrefix stringoptional

PageSeparator stringoptional

PageSuffix stringoptional

ParseMode ParsingModeoptional

Enum for representing the mode of parsing to be used.

One of the following:

const ParsingModeParsePageWithoutLlm ParsingMode = "parse_page_without_llm"

const ParsingModeParsePageWithLlm ParsingMode = "parse_page_with_llm"

const ParsingModeParsePageWithLvm ParsingMode = "parse_page_with_lvm"

const ParsingModeParsePageWithAgent ParsingMode = "parse_page_with_agent"

const ParsingModeParsePageWithLayoutAgent ParsingMode = "parse_page_with_layout_agent"

const ParsingModeParseDocumentWithLlm ParsingMode = "parse_document_with_llm"

const ParsingModeParseDocumentWithLvm ParsingMode = "parse_document_with_lvm"

const ParsingModeParseDocumentWithAgent ParsingMode = "parse_document_with_agent"

ParsingInstruction stringoptional

PipelineID stringoptional

The pipeline ID.

PreciseBoundingBox booloptional

PremiumMode booloptional

PresentationOutOfBoundsContent booloptional

PresentationSkipEmbeddedData booloptional

PreserveLayoutAlignmentAcrossPages booloptional

PreserveVerySmallText booloptional

Preset stringoptional

Priority stringoptional

The priority for the request. This field may be ignored or overwritten depending on the organization tier.

One of the following:

const BetaBatchNewParamsJobConfigBatchParseJobRecordCreateParametersPriorityLow BetaBatchNewParamsJobConfigBatchParseJobRecordCreateParametersPriority = "low"

const BetaBatchNewParamsJobConfigBatchParseJobRecordCreateParametersPriorityMedium BetaBatchNewParamsJobConfigBatchParseJobRecordCreateParametersPriority = "medium"

const BetaBatchNewParamsJobConfigBatchParseJobRecordCreateParametersPriorityHigh BetaBatchNewParamsJobConfigBatchParseJobRecordCreateParametersPriority = "high"

const BetaBatchNewParamsJobConfigBatchParseJobRecordCreateParametersPriorityCritical BetaBatchNewParamsJobConfigBatchParseJobRecordCreateParametersPriority = "critical"

ProjectID stringoptional

RemoveHiddenText booloptional

ReplaceFailedPageMode FailPageModeoptional

Enum for representing the different available page error handling modes.

One of the following:

const FailPageModeRawText FailPageMode = "raw_text"

const FailPageModeBlankPage FailPageMode = "blank_page"

const FailPageModeErrorMessage FailPageMode = "error_message"

ReplaceFailedPageWithErrorMessagePrefix stringoptional

ReplaceFailedPageWithErrorMessageSuffix stringoptional

ResourceInfo map[string, any]optional

The resource info about the file

SaveImages booloptional

SkipDiagonalText booloptional

SpecializedChartParsingAgentic booloptional

SpecializedChartParsingEfficient booloptional

SpecializedChartParsingPlus booloptional

SpecializedImageParsing booloptional

SpreadsheetExtractSubTables booloptional

SpreadsheetForceFormulaComputation booloptional

SpreadsheetIncludeHiddenSheets booloptional

StrictModeBuggyFont booloptional

StrictModeImageExtraction booloptional

StrictModeImageOcr booloptional

StrictModeReconstruction booloptional

StructuredOutput booloptional

StructuredOutputJsonSchema stringoptional

StructuredOutputJsonSchemaName stringoptional

SystemPrompt stringoptional

SystemPromptAppend stringoptional

TakeScreenshot booloptional

TargetPages stringoptional

Tier stringoptional

Type stringoptional

UseVendorMultimodalModel booloptional

UserPrompt stringoptional

VendorMultimodalAPIKey stringoptional

VendorMultimodalModelName stringoptional

Version stringoptional

WebhookConfigurations []BetaBatchNewParamsJobConfigBatchParseJobRecordCreateParametersWebhookConfigurationoptional

Outbound webhook endpoints to notify on job status changes

WebhookEvents []stringoptional

Events to subscribe to (e.g. 'parse.success', 'extract.error'). If null, all events are delivered.

One of the following:

const BetaBatchNewParamsJobConfigBatchParseJobRecordCreateParametersWebhookConfigurationWebhookEventExtractPending BetaBatchNewParamsJobConfigBatchParseJobRecordCreateParametersWebhookConfigurationWebhookEvent = "extract.pending"

const BetaBatchNewParamsJobConfigBatchParseJobRecordCreateParametersWebhookConfigurationWebhookEventExtractSuccess BetaBatchNewParamsJobConfigBatchParseJobRecordCreateParametersWebhookConfigurationWebhookEvent = "extract.success"

const BetaBatchNewParamsJobConfigBatchParseJobRecordCreateParametersWebhookConfigurationWebhookEventExtractError BetaBatchNewParamsJobConfigBatchParseJobRecordCreateParametersWebhookConfigurationWebhookEvent = "extract.error"

const BetaBatchNewParamsJobConfigBatchParseJobRecordCreateParametersWebhookConfigurationWebhookEventExtractPartialSuccess BetaBatchNewParamsJobConfigBatchParseJobRecordCreateParametersWebhookConfigurationWebhookEvent = "extract.partial_success"

const BetaBatchNewParamsJobConfigBatchParseJobRecordCreateParametersWebhookConfigurationWebhookEventExtractCancelled BetaBatchNewParamsJobConfigBatchParseJobRecordCreateParametersWebhookConfigurationWebhookEvent = "extract.cancelled"

const BetaBatchNewParamsJobConfigBatchParseJobRecordCreateParametersWebhookConfigurationWebhookEventParsePending BetaBatchNewParamsJobConfigBatchParseJobRecordCreateParametersWebhookConfigurationWebhookEvent = "parse.pending"

const BetaBatchNewParamsJobConfigBatchParseJobRecordCreateParametersWebhookConfigurationWebhookEventParseRunning BetaBatchNewParamsJobConfigBatchParseJobRecordCreateParametersWebhookConfigurationWebhookEvent = "parse.running"

const BetaBatchNewParamsJobConfigBatchParseJobRecordCreateParametersWebhookConfigurationWebhookEventParseSuccess BetaBatchNewParamsJobConfigBatchParseJobRecordCreateParametersWebhookConfigurationWebhookEvent = "parse.success"

const BetaBatchNewParamsJobConfigBatchParseJobRecordCreateParametersWebhookConfigurationWebhookEventParseError BetaBatchNewParamsJobConfigBatchParseJobRecordCreateParametersWebhookConfigurationWebhookEvent = "parse.error"

const BetaBatchNewParamsJobConfigBatchParseJobRecordCreateParametersWebhookConfigurationWebhookEventParsePartialSuccess BetaBatchNewParamsJobConfigBatchParseJobRecordCreateParametersWebhookConfigurationWebhookEvent = "parse.partial_success"

const BetaBatchNewParamsJobConfigBatchParseJobRecordCreateParametersWebhookConfigurationWebhookEventParseCancelled BetaBatchNewParamsJobConfigBatchParseJobRecordCreateParametersWebhookConfigurationWebhookEvent = "parse.cancelled"

const BetaBatchNewParamsJobConfigBatchParseJobRecordCreateParametersWebhookConfigurationWebhookEventClassifyPending BetaBatchNewParamsJobConfigBatchParseJobRecordCreateParametersWebhookConfigurationWebhookEvent = "classify.pending"

const BetaBatchNewParamsJobConfigBatchParseJobRecordCreateParametersWebhookConfigurationWebhookEventClassifySuccess BetaBatchNewParamsJobConfigBatchParseJobRecordCreateParametersWebhookConfigurationWebhookEvent = "classify.success"

const BetaBatchNewParamsJobConfigBatchParseJobRecordCreateParametersWebhookConfigurationWebhookEventClassifyError BetaBatchNewParamsJobConfigBatchParseJobRecordCreateParametersWebhookConfigurationWebhookEvent = "classify.error"

const BetaBatchNewParamsJobConfigBatchParseJobRecordCreateParametersWebhookConfigurationWebhookEventClassifyPartialSuccess BetaBatchNewParamsJobConfigBatchParseJobRecordCreateParametersWebhookConfigurationWebhookEvent = "classify.partial_success"

const BetaBatchNewParamsJobConfigBatchParseJobRecordCreateParametersWebhookConfigurationWebhookEventClassifyCancelled BetaBatchNewParamsJobConfigBatchParseJobRecordCreateParametersWebhookConfigurationWebhookEvent = "classify.cancelled"

const BetaBatchNewParamsJobConfigBatchParseJobRecordCreateParametersWebhookConfigurationWebhookEventUnmappedEvent BetaBatchNewParamsJobConfigBatchParseJobRecordCreateParametersWebhookConfigurationWebhookEvent = "unmapped_event"

WebhookHeaders map[string, string]optional

Custom HTTP headers sent with each webhook request (e.g. auth tokens)

WebhookOutputFormat stringoptional

Response format sent to the webhook: 'string' (default) or 'json'

WebhookURL stringoptional

URL to receive webhook POST notifications

WebhookURL stringoptional

ParentJobExecutionID stringoptional

The ID of the parent job execution.

formatuuid

Partitions map[string, string]optional

The partitions for this execution. Used for determining where to save job output.

ProjectID stringoptional

The ID of the project this job belongs to.

formatuuid

SessionID stringoptional

The upstream request ID that created this job. Used for tracking the job across services.

formatuuid

UserID stringoptional

The ID of the user that created this job

WebhookURL stringoptional

The URL that needs to be called at the end of the parsing job.

type ClassifyJob struct{…}

A classify job.

ID string

Unique identifier

formatuuid

ProjectID string

The ID of the project

formatuuid

Rules []ClassifierRule

The rules to classify the files

Description string

Natural language description of what to classify. Be specific about the content characteristics that identify this document type.

maxLength500

minLength10

Type string

The document type to assign when this rule matches (e.g., 'invoice', 'receipt', 'contract')

maxLength50

minLength1

Status StatusEnum

The status of the classify job

One of the following:

const StatusEnumPending StatusEnum = "PENDING"

const StatusEnumSuccess StatusEnum = "SUCCESS"

const StatusEnumError StatusEnum = "ERROR"

const StatusEnumPartialSuccess StatusEnum = "PARTIAL_SUCCESS"

const StatusEnumCancelled StatusEnum = "CANCELLED"

UserID string

The ID of the user

CreatedAt Timeoptional

Creation datetime

formatdate-time

EffectiveAt Timeoptional

ErrorMessage stringoptional

Error message for the latest job attempt, if any.

JobRecordID stringoptional

The job record ID associated with this status, if any.

Mode ClassifyJobModeoptional

The classification mode to use

One of the following:

const ClassifyJobModeFast ClassifyJobMode = "FAST"

const ClassifyJobModeMultimodal ClassifyJobMode = "MULTIMODAL"

ParsingConfiguration ClassifyParsingConfigurationoptional

The configuration for the parsing job

Lang ParsingLanguagesoptional

The language to parse the files in

One of the following:

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"

MaxPages int64optional

The maximum number of pages to parse

TargetPages []int64optional

The pages to target for parsing (0-indexed, so first page is at 0)

UpdatedAt Timeoptional

Update datetime

formatdate-time

OrganizationID param.Field[string]optional

Query param

formatuuid

ProjectID param.Field[string]optional

Query param

formatuuid

ContinueAsNewThreshold param.Field[int64]optional

Body param: Maximum files to process per execution cycle in directory mode. Defaults to page_size.

DirectoryID param.Field[string]optional

Body param: ID of the directory containing files to process

ItemIDs param.Field[[]string]optional

Body param: List of specific item IDs to process. Either this or directory_id must be provided.

PageSize param.Field[int64]optional

Body param: Number of files to process per batch when using directory mode

maximum1000

minimum1

TemporalNamespace param.Field[string]optional

Header param

ReturnsExpand Collapse

type BetaBatchNewResponse struct{…}

Response schema for a batch processing job.

ID string

Unique identifier for the batch job

JobType BetaBatchNewResponseJobType

Type of processing operation (parse or classify)

One of the following:

const BetaBatchNewResponseJobTypeParse BetaBatchNewResponseJobType = "parse"

const BetaBatchNewResponseJobTypeExtract BetaBatchNewResponseJobType = "extract"

const BetaBatchNewResponseJobTypeClassify BetaBatchNewResponseJobType = "classify"

ProjectID string

Project this job belongs to

Status BetaBatchNewResponseStatus

Current job status

One of the following:

const BetaBatchNewResponseStatusPending BetaBatchNewResponseStatus = "pending"

const BetaBatchNewResponseStatusRunning BetaBatchNewResponseStatus = "running"

const BetaBatchNewResponseStatusDispatched BetaBatchNewResponseStatus = "dispatched"

const BetaBatchNewResponseStatusCompleted BetaBatchNewResponseStatus = "completed"

const BetaBatchNewResponseStatusFailed BetaBatchNewResponseStatus = "failed"

const BetaBatchNewResponseStatusCancelled BetaBatchNewResponseStatus = "cancelled"

TotalItems int64

Total number of items in the job

CompletedAt Timeoptional

Timestamp when job completed

formatdate-time

CreatedAt Timeoptional

Creation datetime

formatdate-time

DirectoryID stringoptional

Directory being processed

EffectiveAt Timeoptional

ErrorMessage stringoptional

Error message for the latest job attempt, if any.

FailedItems int64optional

Number of items that failed processing

JobRecordID stringoptional

The job record ID associated with this status, if any.

ProcessedItems int64optional

Number of items processed so far

SkippedItems int64optional

Number of items skipped (already processed or size limit)

StartedAt Timeoptional

Timestamp when job processing started

formatdate-time

UpdatedAt Timeoptional

Update datetime

formatdate-time

WorkflowID stringoptional

Async job tracking ID

Create Batch Job

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"),
  )
  batch, err := client.Beta.Batch.New(context.TODO(), llamacloudprod.BetaBatchNewParams{
    JobConfig: llamacloudprod.BetaBatchNewParamsJobConfigUnion{
      OfBatchParseJobRecordCreate: &llamacloudprod.BetaBatchNewParamsJobConfigBatchParseJobRecordCreate{

      },
    },
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", batch.ID)
}

{
  "id": "bjb-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
  "job_type": "parse",
  "project_id": "proj-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
  "status": "pending",
  "total_items": 0,
  "completed_at": "2019-12-27T18:11:19.117Z",
  "created_at": "2019-12-27T18:11:19.117Z",
  "directory_id": "dir-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
  "effective_at": "2019-12-27T18:11:19.117Z",
  "error_message": "error_message",
  "failed_items": 0,
  "job_record_id": "job_record_id",
  "processed_items": 0,
  "skipped_items": 0,
  "started_at": "2019-12-27T18:11:19.117Z",
  "updated_at": "2019-12-27T18:11:19.117Z",
  "workflow_id": "workflow_id"
}

Returns Examples

{
  "id": "bjb-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
  "job_type": "parse",
  "project_id": "proj-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
  "status": "pending",
  "total_items": 0,
  "completed_at": "2019-12-27T18:11:19.117Z",
  "created_at": "2019-12-27T18:11:19.117Z",
  "directory_id": "dir-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
  "effective_at": "2019-12-27T18:11:19.117Z",
  "error_message": "error_message",
  "failed_items": 0,
  "job_record_id": "job_record_id",
  "processed_items": 0,
  "skipped_items": 0,
  "started_at": "2019-12-27T18:11:19.117Z",
  "updated_at": "2019-12-27T18:11:19.117Z",
  "workflow_id": "workflow_id"
}