Package ai.extend.resources.formdetectionruns

Class FormDetectionRunsClient

java.lang.Object

ai.extend.resources.formdetectionruns.FormDetectionRunsClient

public class FormDetectionRunsClient
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
protected ClientOptions	clientOptions

Constructor Summary

Constructors

Constructor	Description
FormDetectionRunsClient(ClientOptions clientOptions)

Method Summary

Modifier and Type	Method	Description
FormDetectionRun	create(FormDetectionRunsCreateRequest request)	Start detecting fields in a PDF form and return immediately with a form_detection_run resource, typically in the PROCESSING state.
FormDetectionRun	create(FormDetectionRunsCreateRequest request, RequestOptions requestOptions)	Start detecting fields in a PDF form and return immediately with a form_detection_run resource, typically in the PROCESSING state.
FormDetectionRun	retrieve(java.lang.String id)	Retrieve the status and results of a form detection run.
FormDetectionRun	retrieve(java.lang.String id, RequestOptions requestOptions)	Retrieve the status and results of a form detection run.
FormDetectionRun	retrieve(java.lang.String id, FormDetectionRunsRetrieveRequest request)	Retrieve the status and results of a form detection run.
FormDetectionRun	retrieve(java.lang.String id, FormDetectionRunsRetrieveRequest request, RequestOptions requestOptions)	Retrieve the status and results of a form detection run.
RawFormDetectionRunsClient	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

FormDetectionRunsClient

public FormDetectionRunsClient(ClientOptions clientOptions)

Method Detail

withRawResponse

public RawFormDetectionRunsClient withRawResponse()

Get responses with HTTP metadata like headers

create

public FormDetectionRun create(FormDetectionRunsCreateRequest request)

Start detecting fields in a PDF form and return immediately with a form_detection_run resource, typically in the PROCESSING state.

Poll GET /form_detection_runs/{id} until the status is PROCESSED or FAILED. When processing succeeds, output.schema contains an edit schema you can pass directly to POST /edit or POST /edit_runs.

create

public FormDetectionRun create(FormDetectionRunsCreateRequest request,
                               RequestOptions requestOptions)

Start detecting fields in a PDF form and return immediately with a form_detection_run resource, typically in the PROCESSING state.

Poll GET /form_detection_runs/{id} until the status is PROCESSED or FAILED. When processing succeeds, output.schema contains an edit schema you can pass directly to POST /edit or POST /edit_runs.

retrieve

public FormDetectionRun retrieve(java.lang.String id)

Retrieve the status and results of a form detection run.

Use this endpoint to poll a run created with POST /form_detection_runs. When status is PROCESSED, output.schema contains the generated edit schema.

retrieve

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

Retrieve the status and results of a form detection run.

Use this endpoint to poll a run created with POST /form_detection_runs. When status is PROCESSED, output.schema contains the generated edit schema.

retrieve

public FormDetectionRun retrieve(java.lang.String id,
                                 FormDetectionRunsRetrieveRequest request)

Retrieve the status and results of a form detection run.

Use this endpoint to poll a run created with POST /form_detection_runs. When status is PROCESSED, output.schema contains the generated edit schema.

retrieve

public FormDetectionRun retrieve(java.lang.String id,
                                 FormDetectionRunsRetrieveRequest request,
                                 RequestOptions requestOptions)

Retrieve the status and results of a form detection run.

Use this endpoint to poll a run created with POST /form_detection_runs. When status is PROCESSED, output.schema contains the generated edit schema.