Package ai.extend.resources.editschemas

Class EditSchemasClient

java.lang.Object

ai.extend.resources.editschemas.EditSchemasClient

public class EditSchemasClient
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
protected ClientOptions	clientOptions

Constructor Summary

Constructors

Constructor	Description
EditSchemasClient(ClientOptions clientOptions)

Method Summary

Modifier and Type	Method	Description
EditSchemaGenerationResponse	generate(EditSchemasGenerateRequest request)	Detect fields in a PDF form and synchronously return an edit schema payload.
EditSchemaGenerationResponse	generate(EditSchemasGenerateRequest request, RequestOptions requestOptions)	Detect fields in a PDF form and synchronously return an edit schema payload.
RawEditSchemasClient	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

EditSchemasClient

public EditSchemasClient(ClientOptions clientOptions)

Method Detail

withRawResponse

public RawEditSchemasClient withRawResponse()

Get responses with HTTP metadata like headers

generate

public EditSchemaGenerationResponse generate(EditSchemasGenerateRequest request)

Detect fields in a PDF form and synchronously return an edit schema payload.

Use this endpoint when you want Extend to bootstrap an EditRootJSON schema from an existing form, optionally mapping an existing schema onto the detected fields.

This endpoint returns the generated schema directly. There are no schema generation run resources to poll or delete.

For more details, see the Generate Edit Schema guide and the Edit File guide.

generate

public EditSchemaGenerationResponse generate(EditSchemasGenerateRequest request,
                                             RequestOptions requestOptions)

Detect fields in a PDF form and synchronously return an edit schema payload.

Use this endpoint when you want Extend to bootstrap an EditRootJSON schema from an existing form, optionally mapping an existing schema onto the detected fields.

This endpoint returns the generated schema directly. There are no schema generation run resources to poll or delete.

For more details, see the Generate Edit Schema guide and the Edit File guide.