java.lang.Object
- ai.extend.resources.splitruns.SplitRunsClient

Direct Known Subclasses:: SplitRunsClient

public class SplitRunsClient
extends java.lang.Object

Field Summary

Fields
Modifier and Type Field Description

protected ClientOptions clientOptions

Constructor Summary

Constructors
Constructor Description

SplitRunsClient(ClientOptions clientOptions)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`SplitRun`	`cancel(java.lang.String id)`	Cancel an in-progress split run.
`SplitRun`	`cancel(java.lang.String id, RequestOptions requestOptions)`	Cancel an in-progress split run.
`SplitRun`	`cancel(java.lang.String id, SplitRunsCancelRequest request)`	Cancel an in-progress split run.
`SplitRun`	`cancel(java.lang.String id, SplitRunsCancelRequest request, RequestOptions requestOptions)`	Cancel an in-progress split run.
`SplitRun`	`create(SplitRunsCreateRequest request)`	Split a document into multiple parts using an existing splitter or an inline configuration.
`SplitRun`	`create(SplitRunsCreateRequest request, RequestOptions requestOptions)`	Split a document into multiple parts using an existing splitter or an inline configuration.
`SplitRunsDeleteResponse`	`delete(java.lang.String id)`	Delete a split run and all associated data from Extend.
`SplitRunsDeleteResponse`	`delete(java.lang.String id, RequestOptions requestOptions)`	Delete a split run and all associated data from Extend.
`SplitRunsDeleteResponse`	`delete(java.lang.String id, SplitRunsDeleteRequest request)`	Delete a split run and all associated data from Extend.
`SplitRunsDeleteResponse`	`delete(java.lang.String id, SplitRunsDeleteRequest request, RequestOptions requestOptions)`	Delete a split run and all associated data from Extend.
`SplitRunsListResponse`	`list()`	List all split runs.
`SplitRunsListResponse`	`list(RequestOptions requestOptions)`	List all split runs.
`SplitRunsListResponse`	`list(SplitRunsListRequest request)`	List all split runs.
`SplitRunsListResponse`	`list(SplitRunsListRequest request, RequestOptions requestOptions)`	List all split runs.
`SplitRun`	`retrieve(java.lang.String id)`	Retrieve details about a specific split run, including its status and outputs.
`SplitRun`	`retrieve(java.lang.String id, RequestOptions requestOptions)`	Retrieve details about a specific split run, including its status and outputs.
`SplitRun`	`retrieve(java.lang.String id, SplitRunsRetrieveRequest request)`	Retrieve details about a specific split run, including its status and outputs.
`SplitRun`	`retrieve(java.lang.String id, SplitRunsRetrieveRequest request, RequestOptions requestOptions)`	Retrieve details about a specific split run, including its status and outputs.
`RawSplitRunsClient`	`withRawResponse()`	Get responses with HTTP metadata like headers

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - clientOptions
```
protected final ClientOptions clientOptions
```
- Constructor Detail
  - SplitRunsClient
```
public SplitRunsClient(ClientOptions clientOptions)
```
- Method Detail
  - withRawResponse
```
public RawSplitRunsClient withRawResponse()
```
    Get responses with HTTP metadata like headers
  - list
```
public SplitRunsListResponse list()
```
    List all split runs.
    Returns a summary of each run. Use GET /split_runs/{id} to retrieve the full object including output and config.
  - list
```
public SplitRunsListResponse list(RequestOptions requestOptions)
```
    List all split runs.
    Returns a summary of each run. Use GET /split_runs/{id} to retrieve the full object including output and config.
  - list
```
public SplitRunsListResponse list(SplitRunsListRequest request)
```
    List all split runs.
    Returns a summary of each run. Use GET /split_runs/{id} to retrieve the full object including output and config.
  - list
```
public SplitRunsListResponse list(SplitRunsListRequest request,
                                  RequestOptions requestOptions)
```
    List all split runs.
    Returns a summary of each run. Use GET /split_runs/{id} to retrieve the full object including output and config.
  - create
```
public SplitRun create(SplitRunsCreateRequest request)
```
    Split a document into multiple parts using an existing splitter or an inline configuration.
    The request returns immediately with a PROCESSING status. Use webhooks or poll the Get Split Run endpoint for results.
  - create
```
public SplitRun create(SplitRunsCreateRequest request,
                       RequestOptions requestOptions)
```
    Split a document into multiple parts using an existing splitter or an inline configuration.
    The request returns immediately with a PROCESSING status. Use webhooks or poll the Get Split Run endpoint for results.
  - retrieve
```
public SplitRun retrieve(java.lang.String id)
```
    Retrieve details about a specific split run, including its status and outputs.
    A common use case for this endpoint is to poll for the status and final output of a split run when using the Create Split Run endpoint. For instance, if you do not want to not configure webhooks to receive the output via completion/failure events.
  - retrieve
```
public SplitRun retrieve(java.lang.String id,
                         RequestOptions requestOptions)
```
    Retrieve details about a specific split run, including its status and outputs.
    A common use case for this endpoint is to poll for the status and final output of a split run when using the Create Split Run endpoint. For instance, if you do not want to not configure webhooks to receive the output via completion/failure events.
  - retrieve
```
public SplitRun retrieve(java.lang.String id,
                         SplitRunsRetrieveRequest request)
```
    Retrieve details about a specific split run, including its status and outputs.
    A common use case for this endpoint is to poll for the status and final output of a split run when using the Create Split Run endpoint. For instance, if you do not want to not configure webhooks to receive the output via completion/failure events.
  - retrieve
```
public SplitRun retrieve(java.lang.String id,
                         SplitRunsRetrieveRequest request,
                         RequestOptions requestOptions)
```
    Retrieve details about a specific split run, including its status and outputs.
    A common use case for this endpoint is to poll for the status and final output of a split run when using the Create Split Run endpoint. For instance, if you do not want to not configure webhooks to receive the output via completion/failure events.
  - delete
```
public SplitRunsDeleteResponse delete(java.lang.String id)
```
    Delete a split run and all associated data from Extend. This operation is permanent and cannot be undone.
    This endpoint can be used if you'd like to manage data retention on your own rather than automated data retention policies. Or make one-off deletions for your downstream customers.
  - delete
```
public SplitRunsDeleteResponse delete(java.lang.String id,
                                      RequestOptions requestOptions)
```
    Delete a split run and all associated data from Extend. This operation is permanent and cannot be undone.
    This endpoint can be used if you'd like to manage data retention on your own rather than automated data retention policies. Or make one-off deletions for your downstream customers.
  - delete
```
public SplitRunsDeleteResponse delete(java.lang.String id,
                                      SplitRunsDeleteRequest request)
```
    Delete a split run and all associated data from Extend. This operation is permanent and cannot be undone.
    This endpoint can be used if you'd like to manage data retention on your own rather than automated data retention policies. Or make one-off deletions for your downstream customers.
  - delete
```
public SplitRunsDeleteResponse delete(java.lang.String id,
                                      SplitRunsDeleteRequest request,
                                      RequestOptions requestOptions)
```
    Delete a split run and all associated data from Extend. This operation is permanent and cannot be undone.
    This endpoint can be used if you'd like to manage data retention on your own rather than automated data retention policies. Or make one-off deletions for your downstream customers.
  - cancel
```
public SplitRun cancel(java.lang.String id)
```
    Cancel an in-progress split run.
    Note: Only split runs with a status of "PROCESSING" can be cancelled. Splitter runs that have already completed, failed, or been cancelled cannot be cancelled again.
  - cancel
```
public SplitRun cancel(java.lang.String id,
                       RequestOptions requestOptions)
```
    Cancel an in-progress split run.
    Note: Only split runs with a status of "PROCESSING" can be cancelled. Splitter runs that have already completed, failed, or been cancelled cannot be cancelled again.
  - cancel
```
public SplitRun cancel(java.lang.String id,
                       SplitRunsCancelRequest request)
```
    Cancel an in-progress split run.
    Note: Only split runs with a status of "PROCESSING" can be cancelled. Splitter runs that have already completed, failed, or been cancelled cannot be cancelled again.
  - cancel
```
public SplitRun cancel(java.lang.String id,
                       SplitRunsCancelRequest request,
                       RequestOptions requestOptions)
```
    Cancel an in-progress split run.
    Note: Only split runs with a status of "PROCESSING" can be cancelled. Splitter runs that have already completed, failed, or been cancelled cannot be cancelled again.

Class SplitRunsClient

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

clientOptions

Constructor Detail

SplitRunsClient

Method Detail

withRawResponse

list

list

list

list

create

create

retrieve

retrieve

retrieve

retrieve

delete

delete

delete

delete

cancel

cancel

cancel

cancel