Package ai.extend.resources.parseruns

Class ParseRunsClient

java.lang.Object

ai.extend.resources.parseruns.ParseRunsClient

Direct Known Subclasses:

ParseRunsClient

public class ParseRunsClient
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
protected ClientOptions	clientOptions

Constructor Summary

Constructors

Constructor	Description
ParseRunsClient(ClientOptions clientOptions)

Method Summary

Modifier and Type	Method	Description
ParseRun	create(ParseRunsCreateRequest request)	Parse files to get cleaned, chunked target content (e.g.
ParseRun	create(ParseRunsCreateRequest request, RequestOptions requestOptions)	Parse files to get cleaned, chunked target content (e.g.
ParseRunsDeleteResponse	delete(java.lang.String id)	Delete a parse run and all associated data from Extend.
ParseRunsDeleteResponse	delete(java.lang.String id, RequestOptions requestOptions)	Delete a parse run and all associated data from Extend.
ParseRun	retrieve(java.lang.String id)	Retrieve the status and results of a parse run.
ParseRun	retrieve(java.lang.String id, RequestOptions requestOptions)	Retrieve the status and results of a parse run.
ParseRun	retrieve(java.lang.String id, ParseRunsRetrieveRequest request)	Retrieve the status and results of a parse run.
ParseRun	retrieve(java.lang.String id, ParseRunsRetrieveRequest request, RequestOptions requestOptions)	Retrieve the status and results of a parse run.
RawParseRunsClient	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

ParseRunsClient

public ParseRunsClient(ClientOptions clientOptions)

Method Detail

withRawResponse

public RawParseRunsClient withRawResponse()

Get responses with HTTP metadata like headers

create

public ParseRun create(ParseRunsCreateRequest request)

Parse files to get cleaned, chunked target content (e.g. markdown).

The Parse endpoint allows you to convert documents into structured, machine-readable formats with fine-grained control over the parsing process. This endpoint is ideal for extracting cleaned document content to be used as context for downstream processing, e.g. RAG pipelines, custom ingestion pipelines, embeddings classification, etc.

For more details, see the Parse File guide.

create

public ParseRun create(ParseRunsCreateRequest request,
                       RequestOptions requestOptions)

Parse files to get cleaned, chunked target content (e.g. markdown).

The Parse endpoint allows you to convert documents into structured, machine-readable formats with fine-grained control over the parsing process. This endpoint is ideal for extracting cleaned document content to be used as context for downstream processing, e.g. RAG pipelines, custom ingestion pipelines, embeddings classification, etc.

For more details, see the Parse File guide.

retrieve

public ParseRun retrieve(java.lang.String id)

Retrieve the status and results of a parse run.

Use this endpoint to get results for a parse run that has already completed, or to check on the status of a parse run initiated by the Create Parse Run endpoint.

retrieve

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

Retrieve the status and results of a parse run.

Use this endpoint to get results for a parse run that has already completed, or to check on the status of a parse run initiated by the Create Parse Run endpoint.

retrieve

public ParseRun retrieve(java.lang.String id,
                         ParseRunsRetrieveRequest request)

Retrieve the status and results of a parse run.

Use this endpoint to get results for a parse run that has already completed, or to check on the status of a parse run initiated by the Create Parse Run endpoint.

retrieve

public ParseRun retrieve(java.lang.String id,
                         ParseRunsRetrieveRequest request,
                         RequestOptions requestOptions)

Retrieve the status and results of a parse run.

Use this endpoint to get results for a parse run that has already completed, or to check on the status of a parse run initiated by the Create Parse Run endpoint.

delete

public ParseRunsDeleteResponse delete(java.lang.String id)

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

Delete a parse 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.