Package ai.extend.resources.classifyruns

Class ClassifyRunsClient

java.lang.Object

ai.extend.resources.classifyruns.ClassifyRunsClient

Direct Known Subclasses:

ClassifyRunsClient

public class ClassifyRunsClient
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
protected ClientOptions	clientOptions

Constructor Summary

Constructors

Constructor	Description
ClassifyRunsClient(ClientOptions clientOptions)

Method Summary

Modifier and Type	Method	Description
ClassifyRun	cancel(java.lang.String id)	Cancel an in-progress classify run.
ClassifyRun	cancel(java.lang.String id, RequestOptions requestOptions)	Cancel an in-progress classify run.
ClassifyRun	create(ClassifyRunsCreateRequest request)	Classify a document using an existing classifier or an inline configuration.
ClassifyRun	create(ClassifyRunsCreateRequest request, RequestOptions requestOptions)	Classify a document using an existing classifier or an inline configuration.
ClassifyRunsDeleteResponse	delete(java.lang.String id)	Delete a classify run and all associated data from Extend.
ClassifyRunsDeleteResponse	delete(java.lang.String id, RequestOptions requestOptions)	Delete a classify run and all associated data from Extend.
ClassifyRunsListResponse	list()	List all classify runs.
ClassifyRunsListResponse	list(RequestOptions requestOptions)	List all classify runs.
ClassifyRunsListResponse	list(ClassifyRunsListRequest request)	List all classify runs.
ClassifyRunsListResponse	list(ClassifyRunsListRequest request, RequestOptions requestOptions)	List all classify runs.
ClassifyRun	retrieve(java.lang.String id)	Retrieve details about a specific classify run, including its status and outputs.
ClassifyRun	retrieve(java.lang.String id, RequestOptions requestOptions)	Retrieve details about a specific classify run, including its status and outputs.
RawClassifyRunsClient	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

ClassifyRunsClient

public ClassifyRunsClient(ClientOptions clientOptions)

Method Detail

withRawResponse

public RawClassifyRunsClient withRawResponse()

Get responses with HTTP metadata like headers

list

public ClassifyRunsListResponse list()

List all classify runs.

Returns a summary of each run. Use GET /classify_runs/{id} to retrieve the full object including output and config.

list

public ClassifyRunsListResponse list(RequestOptions requestOptions)

List all classify runs.

Returns a summary of each run. Use GET /classify_runs/{id} to retrieve the full object including output and config.

list

public ClassifyRunsListResponse list(ClassifyRunsListRequest request)

List all classify runs.

Returns a summary of each run. Use GET /classify_runs/{id} to retrieve the full object including output and config.

list

public ClassifyRunsListResponse list(ClassifyRunsListRequest request,
                                     RequestOptions requestOptions)

List all classify runs.

Returns a summary of each run. Use GET /classify_runs/{id} to retrieve the full object including output and config.

create

public ClassifyRun create(ClassifyRunsCreateRequest request)

Classify a document using an existing classifier or an inline configuration.

The request returns immediately with a PROCESSING status. Use webhooks or poll the Get Classify Run endpoint for results.

create

public ClassifyRun create(ClassifyRunsCreateRequest request,
                          RequestOptions requestOptions)

Classify a document using an existing classifier or an inline configuration.

The request returns immediately with a PROCESSING status. Use webhooks or poll the Get Classify Run endpoint for results.

retrieve

public ClassifyRun retrieve(java.lang.String id)

Retrieve details about a specific classify run, including its status and outputs.

A common use case for this endpoint is to poll for the status and final output of a classify run when using the Create Classify Run endpoint. For instance, if you do not want to not configure webhooks to receive the output via completion/failure events.

retrieve

public ClassifyRun retrieve(java.lang.String id,
                            RequestOptions requestOptions)

Retrieve details about a specific classify run, including its status and outputs.

A common use case for this endpoint is to poll for the status and final output of a classify run when using the Create Classify Run endpoint. For instance, if you do not want to not configure webhooks to receive the output via completion/failure events.

delete

public ClassifyRunsDeleteResponse delete(java.lang.String id)

Delete a classify 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 ClassifyRunsDeleteResponse delete(java.lang.String id,
                                         RequestOptions requestOptions)

Delete a classify 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 ClassifyRun cancel(java.lang.String id)

Cancel an in-progress classify run.

Note: Only classify runs with a status of "PROCESSING" can be cancelled. Classifier runs that have already completed, failed, or been cancelled cannot be cancelled again.

cancel

public ClassifyRun cancel(java.lang.String id,
                          RequestOptions requestOptions)

Cancel an in-progress classify run.

Note: Only classify runs with a status of "PROCESSING" can be cancelled. Classifier runs that have already completed, failed, or been cancelled cannot be cancelled again.