# Split ## Create Split Job `SplitCreateResponse Beta.Split.Create(SplitCreateParamsparameters, CancellationTokencancellationToken = default)` **post** `/api/v1/beta/split/jobs` Create a document split job. ### Parameters - `SplitCreateParams parameters` - `required SplitDocumentInput documentInput` Body param: Document to be split. - `string? organizationID` Query param - `string? projectID` Query param - `Configuration? configuration` Body param: Split configuration with categories and splitting strategy. - `required IReadOnlyList Categories` Categories to split documents into. - `required string Name` Name of the category. - `string? Description` Optional description of what content belongs in this category. - `SplittingStrategy SplittingStrategy` Strategy for splitting documents. - `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. - `"forbid"Forbid` - `"include"Include` - `"omit"Omit` - `string? configurationID` Body param: Saved split configuration ID. ### Returns - `class SplitCreateResponse:` Beta response — uses nested document_input object. - `required string ID` Unique identifier for the split job. - `required IReadOnlyList Categories` Categories used for splitting. - `required string Name` Name of the category. - `string? Description` Optional description of what content belongs in this category. - `required SplitDocumentInput DocumentInput` Document that was split. - `required string Type` Type of document input. Valid values are: file_id - `required string Value` Document identifier. - `required string ProjectID` Project ID this job belongs to. - `required string Status` Current status of the job. Valid values are: pending, processing, completed, failed, cancelled. - `required string UserID` User ID who created this job. - `string? ConfigurationID` Split configuration ID used for this job. - `DateTimeOffset? CreatedAt` Creation datetime - `string? ErrorMessage` Error message if the job failed. - `SplitResultResponse? Result` Result of a completed split job. - `required IReadOnlyList Segments` List of document segments. - `required string Category` Category name this split belongs to. - `required string ConfidenceCategory` Categorical confidence level. Valid values are: high, medium, low. - `required IReadOnlyList Pages` 1-indexed page numbers in this split. - `DateTimeOffset? UpdatedAt` Update datetime ### Example ```csharp SplitCreateParams parameters = new() { DocumentInput = new() { Type = "type", Value = "value", }, }; var split = await client.Beta.Split.Create(parameters); Console.WriteLine(split); ``` #### Response ```json { "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" } ``` ## List Split Jobs `SplitListPageResponse Beta.Split.List(SplitListParams?parameters, CancellationTokencancellationToken = default)` **get** `/api/v1/beta/split/jobs` List document split jobs. ### Parameters - `SplitListParams parameters` - `DateTimeOffset? createdAtOnOrAfter` Include items created at or after this timestamp (inclusive) - `DateTimeOffset? createdAtOnOrBefore` Include items created at or before this timestamp (inclusive) - `IReadOnlyList? jobIds` Filter by specific job IDs - `string? organizationID` - `Long? pageSize` - `string? pageToken` - `string? projectID` - `Status? status` Filter by job status (pending, processing, completed, failed, cancelled) - `"cancelled"Cancelled` - `"completed"Completed` - `"failed"Failed` - `"pending"Pending` - `"processing"Processing` ### Returns - `class SplitListPageResponse:` Beta paginated list of split jobs. - `required IReadOnlyList Items` The list of items. - `required string ID` Unique identifier for the split job. - `required IReadOnlyList Categories` Categories used for splitting. - `required string Name` Name of the category. - `string? Description` Optional description of what content belongs in this category. - `required SplitDocumentInput DocumentInput` Document that was split. - `required string Type` Type of document input. Valid values are: file_id - `required string Value` Document identifier. - `required string ProjectID` Project ID this job belongs to. - `required string Status` Current status of the job. Valid values are: pending, processing, completed, failed, cancelled. - `required string UserID` User ID who created this job. - `string? ConfigurationID` Split configuration ID used for this job. - `DateTimeOffset? CreatedAt` Creation datetime - `string? ErrorMessage` Error message if the job failed. - `SplitResultResponse? Result` Result of a completed split job. - `required IReadOnlyList Segments` List of document segments. - `required string Category` Category name this split belongs to. - `required string ConfidenceCategory` Categorical confidence level. Valid values are: high, medium, low. - `required IReadOnlyList Pages` 1-indexed page numbers in this split. - `DateTimeOffset? UpdatedAt` Update datetime - `string? NextPageToken` A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages. - `Long? TotalSize` 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. ### Example ```csharp SplitListParams parameters = new(); var page = await client.Beta.Split.List(parameters); await foreach (var item in page.Paginate()) { Console.WriteLine(item); } ``` #### Response ```json { "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 } ``` ## Get Split Job `SplitGetResponse Beta.Split.Get(SplitGetParamsparameters, CancellationTokencancellationToken = default)` **get** `/api/v1/beta/split/jobs/{split_job_id}` Get a document split job. ### Parameters - `SplitGetParams parameters` - `required string splitJobID` - `string? organizationID` - `string? projectID` ### Returns - `class SplitGetResponse:` Beta response — uses nested document_input object. - `required string ID` Unique identifier for the split job. - `required IReadOnlyList Categories` Categories used for splitting. - `required string Name` Name of the category. - `string? Description` Optional description of what content belongs in this category. - `required SplitDocumentInput DocumentInput` Document that was split. - `required string Type` Type of document input. Valid values are: file_id - `required string Value` Document identifier. - `required string ProjectID` Project ID this job belongs to. - `required string Status` Current status of the job. Valid values are: pending, processing, completed, failed, cancelled. - `required string UserID` User ID who created this job. - `string? ConfigurationID` Split configuration ID used for this job. - `DateTimeOffset? CreatedAt` Creation datetime - `string? ErrorMessage` Error message if the job failed. - `SplitResultResponse? Result` Result of a completed split job. - `required IReadOnlyList Segments` List of document segments. - `required string Category` Category name this split belongs to. - `required string ConfidenceCategory` Categorical confidence level. Valid values are: high, medium, low. - `required IReadOnlyList Pages` 1-indexed page numbers in this split. - `DateTimeOffset? UpdatedAt` Update datetime ### Example ```csharp SplitGetParams parameters = new() { SplitJobID = "split_job_id" }; var split = await client.Beta.Split.Get(parameters); Console.WriteLine(split); ``` #### Response ```json { "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" } ``` ## Domain Types ### Split Category - `class SplitCategory:` Category definition for document splitting. - `required string Name` Name of the category. - `string? Description` Optional description of what content belongs in this category. ### Split Document Input - `class SplitDocumentInput:` Document input specification for beta API. - `required string Type` Type of document input. Valid values are: file_id - `required string Value` Document identifier. ### Split Result Response - `class SplitResultResponse:` Result of a completed split job. - `required IReadOnlyList Segments` List of document segments. - `required string Category` Category name this split belongs to. - `required string ConfidenceCategory` Categorical confidence level. Valid values are: high, medium, low. - `required IReadOnlyList Pages` 1-indexed page numbers in this split. ### Split Segment Response - `class SplitSegmentResponse:` A segment of the split document. - `required string Category` Category name this split belongs to. - `required string ConfidenceCategory` Categorical confidence level. Valid values are: high, medium, low. - `required IReadOnlyList Pages` 1-indexed page numbers in this split.