List Split Jobs

client.Beta.Split.List(ctx, query) (*PaginatedCursor[BetaSplitListResponse], error)

GET/api/v1/beta/split/jobs

List document split jobs.

ParametersExpand Collapse

query BetaSplitListParams

CreatedAtOnOrAfter param.Field[Time]optional

Include items created at or after this timestamp (inclusive)

formatdate-time

CreatedAtOnOrBefore param.Field[Time]optional

Include items created at or before this timestamp (inclusive)

formatdate-time

JobIDs param.Field[[]string]optional

Filter by specific job IDs

OrganizationID param.Field[string]optional

PageSize param.Field[int64]optional

PageToken param.Field[string]optional

ProjectID param.Field[string]optional

Status param.Field[BetaSplitListParamsStatus]optional

Filter by job status (pending, processing, completed, failed, cancelled)

const BetaSplitListParamsStatusPending BetaSplitListParamsStatus = "pending"

const BetaSplitListParamsStatusProcessing BetaSplitListParamsStatus = "processing"

const BetaSplitListParamsStatusCompleted BetaSplitListParamsStatus = "completed"

const BetaSplitListParamsStatusFailed BetaSplitListParamsStatus = "failed"

const BetaSplitListParamsStatusCancelled BetaSplitListParamsStatus = "cancelled"

ReturnsExpand Collapse

type BetaSplitListResponse struct{…}

Beta response — uses nested document_input object.

ID string

Unique identifier for the split job.

Categories []SplitCategory

Categories used for splitting.

Name string

Name of the category.

maxLength200

minLength1

Description stringoptional

Optional description of what content belongs in this category.

maxLength2000

minLength1

DocumentInput SplitDocumentInput

Document that was split.

Type string

Type of document input. Valid values are: file_id

Value string

Document identifier.

ProjectID string

Project ID this job belongs to.

Status string

Current status of the job. Valid values are: pending, processing, completed, failed, cancelled.

UserID string

User ID who created this job.

ConfigurationID stringoptional

Split configuration ID used for this job.

CreatedAt Timeoptional

Creation datetime

formatdate-time

ErrorMessage stringoptional

Error message if the job failed.

Result SplitResultResponseoptional

Result of a completed split job.

Segments []SplitSegmentResponse

List of document segments.

Category string

Category name this split belongs to.

ConfidenceCategory string

Categorical confidence level. Valid values are: high, medium, low.

Pages []int64

1-indexed page numbers in this split.

UpdatedAt Timeoptional

Update datetime

formatdate-time

List Split Jobs

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.Beta.Split.List(context.TODO(), llamacloudprod.BetaSplitListParams{

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

{
  "items": [
    {
      "id": "id",
      "categories": [
        {
          "name": "x",
          "description": "x"
        }
      ],
      "document_input": {
        "type": "type",
        "value": "value"
      },
      "project_id": "project_id",
      "status": "status",
      "user_id": "user_id",
      "configuration_id": "configuration_id",
      "created_at": "2019-12-27T18:11:19.117Z",
      "error_message": "error_message",
      "result": {
        "segments": [
          {
            "category": "category",
            "confidence_category": "confidence_category",
            "pages": [
              0
            ]
          }
        ]
      },
      "updated_at": "2019-12-27T18:11:19.117Z"
    }
  ],
  "next_page_token": "next_page_token",
  "total_size": 0
}

Returns Examples

{
  "items": [
    {
      "id": "id",
      "categories": [
        {
          "name": "x",
          "description": "x"
        }
      ],
      "document_input": {
        "type": "type",
        "value": "value"
      },
      "project_id": "project_id",
      "status": "status",
      "user_id": "user_id",
      "configuration_id": "configuration_id",
      "created_at": "2019-12-27T18:11:19.117Z",
      "error_message": "error_message",
      "result": {
        "segments": [
          {
            "category": "category",
            "confidence_category": "confidence_category",
            "pages": [
              0
            ]
          }
        ]
      },
      "updated_at": "2019-12-27T18:11:19.117Z"
    }
  ],
  "next_page_token": "next_page_token",
  "total_size": 0
}