Create Split Job

SplitCreateResponse beta().split().create(, )

POST/api/v1/beta/split/jobs

Create a document split job.

ParametersExpand Collapse

SplitCreateParams params

Optional<String> organizationId

Optional<String> projectId

SplitDocumentInput documentInput

Document to be split.

Optional<Configuration> configuration

Split configuration with categories and splitting strategy.

List<SplitCategory> categories

Categories to split documents into.

String name

Name of the category.

maxLength200

minLength1

Optional<String> description

Optional description of what content belongs in this category.

maxLength2000

minLength1

Optional<SplittingStrategy> splittingStrategy

Strategy for splitting documents.

Optional<AllowUncategorized> allowUncategorized

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.

One of the following:

INCLUDE("include")

FORBID("forbid")

OMIT("omit")

Optional<String> configurationId

Saved split configuration ID.

ReturnsExpand Collapse

class SplitCreateResponse:

Beta response — uses nested document_input object.

String id

Unique identifier for the split job.

List<SplitCategory> categories

Categories used for splitting.

String name

Name of the category.

maxLength200

minLength1

Optional<String> description

Optional description of what content belongs in this category.

maxLength2000

minLength1

SplitDocumentInput documentInput

Document that was split.

String type

Type of document input. Valid values are: file_id

String value

Document identifier.

String projectId

Project ID this job belongs to.

String status

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

String userId

User ID who created this job.

Optional<String> configurationId

Split configuration ID used for this job.

Optional<LocalDateTime> createdAt

Creation datetime

formatdate-time

Optional<String> errorMessage

Error message if the job failed.

Optional<SplitResultResponse> result

Result of a completed split job.

List<SplitSegmentResponse> segments

List of document segments.

String category

Category name this split belongs to.

String confidenceCategory

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

List<long> pages

1-indexed page numbers in this split.

Optional<LocalDateTime> updatedAt

Update datetime

formatdate-time

Create Split Job

package com.llamacloud_prod.api.example;

import com.llamacloud_prod.api.client.LlamaCloudClient;
import com.llamacloud_prod.api.client.okhttp.LlamaCloudOkHttpClient;
import com.llamacloud_prod.api.models.beta.split.SplitCreateParams;
import com.llamacloud_prod.api.models.beta.split.SplitCreateResponse;
import com.llamacloud_prod.api.models.beta.split.SplitDocumentInput;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        LlamaCloudClient client = LlamaCloudOkHttpClient.fromEnv();

        SplitCreateParams params = SplitCreateParams.builder()
            .documentInput(SplitDocumentInput.builder()
                .type("type")
                .value("value")
                .build())
            .build();
        SplitCreateResponse split = client.beta().split().create(params);
    }
}

{
  "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"
}

Returns Examples

{
  "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"
}