Package ai.extend.resources.extractors

Class ExtractorsClient

java.lang.Object

ai.extend.resources.extractors.ExtractorsClient

public class ExtractorsClient
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
protected ClientOptions	clientOptions

Constructor Summary

Constructors

Constructor	Description
ExtractorsClient(ClientOptions clientOptions)

Method Summary

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

ExtractorsClient

public ExtractorsClient(ClientOptions clientOptions)

Method Detail

withRawResponse

public RawExtractorsClient withRawResponse()

Get responses with HTTP metadata like headers

list

public ExtractorsListResponse list()

List all extractors.

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

list

public 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 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 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 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 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 Extractor retrieve(java.lang.String id)

Get details of an extractor.

retrieve

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

Get details of an extractor.

retrieve

public Extractor retrieve(java.lang.String id,
                          ExtractorsRetrieveRequest request)

Get details of an extractor.

retrieve

public Extractor retrieve(java.lang.String id,
                          ExtractorsRetrieveRequest request,
                          RequestOptions requestOptions)

Get details of an extractor.

update

public Extractor update(java.lang.String id)

Update an existing extractor.

update

public Extractor update(java.lang.String id,
                        RequestOptions requestOptions)

Update an existing extractor.

update

public Extractor update(java.lang.String id,
                        ExtractorsUpdateRequest request)

Update an existing extractor.

update

public Extractor update(java.lang.String id,
                        ExtractorsUpdateRequest request,
                        RequestOptions requestOptions)

Update an existing extractor.