Interface FileService
-
- All Implemented Interfaces:
public interface FileService
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public interface
FileService.WithRawResponse
A view of FileService that provides access to raw HTTP responses for each method.
-
Method Summary
Modifier and Type Method Description abstract FileService.WithRawResponse
withRawResponse()
Returns a view of this service that provides access to raw HTTP responses for each method. VectorStoreFile
create(FileCreateParams params)
Create a vector store file by attaching a File to a vector store. abstract VectorStoreFile
create(FileCreateParams params, RequestOptions requestOptions)
VectorStoreFile
retrieve(FileRetrieveParams params)
Retrieves a vector store file. abstract VectorStoreFile
retrieve(FileRetrieveParams params, RequestOptions requestOptions)
VectorStoreFile
update(FileUpdateParams params)
Update attributes on a vector store file. abstract VectorStoreFile
update(FileUpdateParams params, RequestOptions requestOptions)
FileListPage
list(FileListParams params)
Returns a list of vector store files. abstract FileListPage
list(FileListParams params, RequestOptions requestOptions)
VectorStoreFileDeleted
delete(FileDeleteParams params)
Delete a vector store file. abstract VectorStoreFileDeleted
delete(FileDeleteParams params, RequestOptions requestOptions)
FileContentPage
content(FileContentParams params)
Retrieve the parsed contents of a vector store file. abstract FileContentPage
content(FileContentParams params, RequestOptions requestOptions)
-
-
Method Detail
-
withRawResponse
abstract FileService.WithRawResponse withRawResponse()
Returns a view of this service that provides access to raw HTTP responses for each method.
-
create
VectorStoreFile create(FileCreateParams params)
Create a vector store file by attaching a File to a vector store.
-
create
abstract VectorStoreFile create(FileCreateParams params, RequestOptions requestOptions)
-
retrieve
VectorStoreFile retrieve(FileRetrieveParams params)
Retrieves a vector store file.
-
retrieve
abstract VectorStoreFile retrieve(FileRetrieveParams params, RequestOptions requestOptions)
-
update
VectorStoreFile update(FileUpdateParams params)
Update attributes on a vector store file.
-
update
abstract VectorStoreFile update(FileUpdateParams params, RequestOptions requestOptions)
-
list
FileListPage list(FileListParams params)
Returns a list of vector store files.
-
list
abstract FileListPage list(FileListParams params, RequestOptions requestOptions)
-
delete
VectorStoreFileDeleted delete(FileDeleteParams params)
Delete a vector store file. This will remove the file from the vector store but the file itself will not be deleted. To delete the file, use the delete file endpoint.
-
delete
abstract VectorStoreFileDeleted delete(FileDeleteParams params, RequestOptions requestOptions)
-
content
FileContentPage content(FileContentParams params)
Retrieve the parsed contents of a vector store file.
-
content
abstract FileContentPage content(FileContentParams params, RequestOptions requestOptions)
-
-
-
-