Package ai.extend.resources.extractors

Class AsyncExtractorsClient

java.lang.Object

ai.extend.resources.extractors.AsyncExtractorsClient

public class AsyncExtractorsClient
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
protected ClientOptions	clientOptions

Constructor Summary

Constructors

Constructor	Description
AsyncExtractorsClient(ClientOptions clientOptions)

Method Summary

Modifier and Type	Method	Description
java.util.concurrent.CompletableFuture<Extractor>	create(ExtractorsCreateRequest request)	Create a new extractor.
java.util.concurrent.CompletableFuture<Extractor>	create(ExtractorsCreateRequest request, RequestOptions requestOptions)	Create a new extractor.
java.util.concurrent.CompletableFuture<ExtractorsListResponse>	list()	List all extractors.
java.util.concurrent.CompletableFuture<ExtractorsListResponse>	list(RequestOptions requestOptions)	List all extractors.
java.util.concurrent.CompletableFuture<ExtractorsListResponse>	list(ExtractorsListRequest request)	List all extractors.
java.util.concurrent.CompletableFuture<ExtractorsListResponse>	list(ExtractorsListRequest request, RequestOptions requestOptions)	List all extractors.
java.util.concurrent.CompletableFuture<Extractor>	retrieve(java.lang.String id)	Get details of an extractor.
java.util.concurrent.CompletableFuture<Extractor>	retrieve(java.lang.String id, RequestOptions requestOptions)	Get details of an extractor.
java.util.concurrent.CompletableFuture<Extractor>	retrieve(java.lang.String id, ExtractorsRetrieveRequest request)	Get details of an extractor.
java.util.concurrent.CompletableFuture<Extractor>	retrieve(java.lang.String id, ExtractorsRetrieveRequest request, RequestOptions requestOptions)	Get details of an extractor.
java.util.concurrent.CompletableFuture<Extractor>	update(java.lang.String id)	Update an existing extractor.
java.util.concurrent.CompletableFuture<Extractor>	update(java.lang.String id, RequestOptions requestOptions)	Update an existing extractor.
java.util.concurrent.CompletableFuture<Extractor>	update(java.lang.String id, ExtractorsUpdateRequest request)	Update an existing extractor.
java.util.concurrent.CompletableFuture<Extractor>	update(java.lang.String id, ExtractorsUpdateRequest request, RequestOptions requestOptions)	Update an existing extractor.
AsyncRawExtractorsClient	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

AsyncExtractorsClient

public AsyncExtractorsClient(ClientOptions clientOptions)

Method Detail

withRawResponse

public AsyncRawExtractorsClient withRawResponse()

Get responses with HTTP metadata like headers

list

public java.util.concurrent.CompletableFuture<ExtractorsListResponse> list()

List all extractors.

Returns a summary of each extractor. Use GET /extractors/{id} to retrieve the full object including draftVersion.

list

public java.util.concurrent.CompletableFuture<ExtractorsListResponse> list(RequestOptions requestOptions)

List all extractors.

Returns a summary of each extractor. Use GET /extractors/{id} to retrieve the full object including draftVersion.

list

public java.util.concurrent.CompletableFuture<ExtractorsListResponse> list(ExtractorsListRequest request)

List all extractors.

Returns a summary of each extractor. Use GET /extractors/{id} to retrieve the full object including draftVersion.

list

public java.util.concurrent.CompletableFuture<ExtractorsListResponse> list(ExtractorsListRequest request,
                                                                           RequestOptions requestOptions)

List all extractors.

Returns a summary of each extractor. Use GET /extractors/{id} to retrieve the full object including draftVersion.

create

public java.util.concurrent.CompletableFuture<Extractor> create(ExtractorsCreateRequest request)

Create a new extractor.

You can optionally provide a generate object to automatically generate an extraction schema from sample documents using AI. generate is mutually exclusive with config and cloneExtractorId.

create

public java.util.concurrent.CompletableFuture<Extractor> create(ExtractorsCreateRequest request,
                                                                RequestOptions requestOptions)

Create a new extractor.

You can optionally provide a generate object to automatically generate an extraction schema from sample documents using AI. generate is mutually exclusive with config and cloneExtractorId.

retrieve

public java.util.concurrent.CompletableFuture<Extractor> retrieve(java.lang.String id)

Get details of an extractor.

retrieve

public java.util.concurrent.CompletableFuture<Extractor> retrieve(java.lang.String id,
                                                                  RequestOptions requestOptions)

Get details of an extractor.

retrieve

public java.util.concurrent.CompletableFuture<Extractor> retrieve(java.lang.String id,
                                                                  ExtractorsRetrieveRequest request)

Get details of an extractor.

retrieve

public java.util.concurrent.CompletableFuture<Extractor> retrieve(java.lang.String id,
                                                                  ExtractorsRetrieveRequest request,
                                                                  RequestOptions requestOptions)

Get details of an extractor.

update

public java.util.concurrent.CompletableFuture<Extractor> update(java.lang.String id)

Update an existing extractor.

update

public java.util.concurrent.CompletableFuture<Extractor> update(java.lang.String id,
                                                                RequestOptions requestOptions)

Update an existing extractor.

update

public java.util.concurrent.CompletableFuture<Extractor> update(java.lang.String id,
                                                                ExtractorsUpdateRequest request)

Update an existing extractor.

update

public java.util.concurrent.CompletableFuture<Extractor> update(java.lang.String id,
                                                                ExtractorsUpdateRequest request,
                                                                RequestOptions requestOptions)

Update an existing extractor.