Package ai.extend.resources.file

Class FileClient

java.lang.Object

ai.extend.resources.file.FileClient

public class FileClient
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
protected ClientOptions	clientOptions

Constructor Summary

Constructors

Constructor	Description
FileClient(ClientOptions clientOptions)

Method Summary

Modifier and Type	Method	Description
FileDeleteResponse	delete(java.lang.String id)	Delete a file and all associated data from Extend.
FileDeleteResponse	delete(java.lang.String id, RequestOptions requestOptions)	Delete a file and all associated data from Extend.
FileGetResponse	get(java.lang.String id)	Fetch a file by its ID to obtain additional details and the raw file content.
FileGetResponse	get(java.lang.String id, FileGetRequest request)	Fetch a file by its ID to obtain additional details and the raw file content.
FileGetResponse	get(java.lang.String id, FileGetRequest request, RequestOptions requestOptions)	Fetch a file by its ID to obtain additional details and the raw file content.
FileListResponse	list()	List files in your account.
FileListResponse	list(FileListRequest request)	List files in your account.
FileListResponse	list(FileListRequest request, RequestOptions requestOptions)	List files in your account.
FileUploadResponse	upload(java.io.File file, FileUploadRequest request)	Upload and create a new file in Extend.
FileUploadResponse	upload(java.io.File file, FileUploadRequest request, RequestOptions requestOptions)	Upload and create a new file in Extend.
RawFileClient	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

FileClient

public FileClient(ClientOptions clientOptions)

Method Detail

withRawResponse

public RawFileClient withRawResponse()

Get responses with HTTP metadata like headers

list

public FileListResponse list()

List files in your account. Files represent documents that have been uploaded to Extend. This endpoint returns a paginated response. You can use the nextPageToken to fetch subsequent results.

list

public FileListResponse list(FileListRequest request)

List files in your account. Files represent documents that have been uploaded to Extend. This endpoint returns a paginated response. You can use the nextPageToken to fetch subsequent results.

list

public FileListResponse list(FileListRequest request,
                             RequestOptions requestOptions)

List files in your account. Files represent documents that have been uploaded to Extend. This endpoint returns a paginated response. You can use the nextPageToken to fetch subsequent results.

get

public FileGetResponse get(java.lang.String id)

Fetch a file by its ID to obtain additional details and the raw file content.

get

public FileGetResponse get(java.lang.String id,
                           FileGetRequest request)

Fetch a file by its ID to obtain additional details and the raw file content.

get

public FileGetResponse get(java.lang.String id,
                           FileGetRequest request,
                           RequestOptions requestOptions)

Fetch a file by its ID to obtain additional details and the raw file content.

delete

public FileDeleteResponse 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 FileDeleteResponse 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 FileUploadResponse upload(java.io.File file,
                                 FileUploadRequest 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 FileUploadResponse upload(java.io.File file,
                                 FileUploadRequest 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).