Package ai.extend.resources.files

Class FilesClient

java.lang.Object

ai.extend.resources.files.FilesClient

public class FilesClient
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
protected ClientOptions	clientOptions

Constructor Summary

Constructors

Constructor	Description
FilesClient(ClientOptions clientOptions)

Method Summary

Modifier and Type	Method	Description
FilesDeleteResponse	delete(java.lang.String id)	Delete a file and all associated data from Extend.
FilesDeleteResponse	delete(java.lang.String id, RequestOptions requestOptions)	Delete a file and all associated data from Extend.
FilesListResponse	list()	List files.
FilesListResponse	list(RequestOptions requestOptions)	List files.
FilesListResponse	list(FilesListRequest request)	List files.
FilesListResponse	list(FilesListRequest request, RequestOptions requestOptions)	List files.
File	retrieve(java.lang.String id)	Fetch a file by its ID.
File	retrieve(java.lang.String id, RequestOptions requestOptions)	Fetch a file by its ID.
File	retrieve(java.lang.String id, FilesRetrieveRequest request)	Fetch a file by its ID.
File	retrieve(java.lang.String id, FilesRetrieveRequest request, RequestOptions requestOptions)	Fetch a file by its ID.
File	upload(java.io.File file, FilesUploadRequest request)	Upload and create a new file in Extend.
File	upload(java.io.File file, FilesUploadRequest request, RequestOptions requestOptions)	Upload and create a new file in Extend.
RawFilesClient	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

FilesClient

public FilesClient(ClientOptions clientOptions)

Method Detail

withRawResponse

public RawFilesClient withRawResponse()

Get responses with HTTP metadata like headers

list

public FilesListResponse list()

List files.

list

public FilesListResponse list(RequestOptions requestOptions)

List files.

list

public FilesListResponse list(FilesListRequest request)

List files.

list

public FilesListResponse list(FilesListRequest request,
                              RequestOptions requestOptions)

List files.

retrieve

public File retrieve(java.lang.String id)

Fetch a file by its ID.

retrieve

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

Fetch a file by its ID.

retrieve

public File retrieve(java.lang.String id,
                     FilesRetrieveRequest request)

Fetch a file by its ID.

retrieve

public File retrieve(java.lang.String id,
                     FilesRetrieveRequest request,
                     RequestOptions requestOptions)

Fetch a file by its ID.

delete

public FilesDeleteResponse delete(java.lang.String id)

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

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

upload

public File upload(java.io.File file,
                   FilesUploadRequest request)

Upload and create a new file in Extend.

This endpoint accepts file contents and registers them as a File in Extend, which can be used for running workflows, creating evaluation set items, parsing, etc.

If an uploaded file is detected as a Word or PowerPoint document, it will be automatically converted to a PDF.

Supported file types can be found here.

This endpoint requires multipart form encoding. Most HTTP clients will handle this encoding automatically (see the examples).

upload

public File upload(java.io.File file,
                   FilesUploadRequest request,
                   RequestOptions requestOptions)

Upload and create a new file in Extend.

This endpoint accepts file contents and registers them as a File in Extend, which can be used for running workflows, creating evaluation set items, parsing, etc.

If an uploaded file is detected as a Word or PowerPoint document, it will be automatically converted to a PDF.

Supported file types can be found here.

This endpoint requires multipart form encoding. Most HTTP clients will handle this encoding automatically (see the examples).