Interface FileService
- 
                    
                    
- All Implemented Interfaces:
 
public interface FileService 
- 
                
                    
                    
- 
                                
                            
                                
Nested Class Summary
Nested Classes Modifier and Type Class Description public interfaceFileService.WithRawResponseA view of FileService that provides access to raw HTTP responses for each method.
 
- 
                                
                            
                                
Method Summary
- 
                    
                    
                    
- 
                                
                            
                                
Method Detail
- 
                                        
withRawResponse
abstract FileService.WithRawResponse withRawResponse()
Returns a view of this service that provides access to raw HTTP responses for each method.
 
- 
                                        
withOptions
abstract FileService withOptions(Consumer<ClientOptions.Builder> modifier)
Returns a view of this service with the given option modifications applied.
The original service is not modified.
 
- 
                                        
create
VectorStoreFile create(String vectorStoreId, FileCreateParams params)
Create a vector store file by attaching a File to a vector store.
 
- 
                                        
create
VectorStoreFile create(String vectorStoreId, FileCreateParams params, RequestOptions requestOptions)
 
- 
                                        
create
VectorStoreFile create(FileCreateParams params)
 
- 
                                        
create
abstract VectorStoreFile create(FileCreateParams params, RequestOptions requestOptions)
 
- 
                                        
retrieve
VectorStoreFile retrieve(String fileId, FileRetrieveParams params)
Retrieves a vector store file.
 
- 
                                        
retrieve
VectorStoreFile retrieve(String fileId, FileRetrieveParams params, RequestOptions requestOptions)
 
- 
                                        
retrieve
VectorStoreFile retrieve(FileRetrieveParams params)
 
- 
                                        
retrieve
abstract VectorStoreFile retrieve(FileRetrieveParams params, RequestOptions requestOptions)
 
- 
                                        
update
VectorStoreFile update(String fileId, FileUpdateParams params)
Update attributes on a vector store file.
 
- 
                                        
update
VectorStoreFile update(String fileId, FileUpdateParams params, RequestOptions requestOptions)
 
- 
                                        
update
VectorStoreFile update(FileUpdateParams params)
 
- 
                                        
update
abstract VectorStoreFile update(FileUpdateParams params, RequestOptions requestOptions)
 
- 
                                        
list
FileListPage list(String vectorStoreId)
Returns a list of vector store files.
 
- 
                                        
list
FileListPage list(String vectorStoreId, FileListParams params, RequestOptions requestOptions)
 
- 
                                        
list
FileListPage list(String vectorStoreId, FileListParams params)
 
- 
                                        
list
abstract FileListPage list(FileListParams params, RequestOptions requestOptions)
 
- 
                                        
list
FileListPage list(FileListParams params)
 
- 
                                        
list
FileListPage list(String vectorStoreId, RequestOptions requestOptions)
 
- 
                                        
delete
VectorStoreFileDeleted delete(String fileId, 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
VectorStoreFileDeleted delete(String fileId, FileDeleteParams params, RequestOptions requestOptions)
 
- 
                                        
delete
VectorStoreFileDeleted delete(FileDeleteParams params)
 
- 
                                        
delete
abstract VectorStoreFileDeleted delete(FileDeleteParams params, RequestOptions requestOptions)
 
- 
                                        
content
FileContentPage content(String fileId, FileContentParams params)
Retrieve the parsed contents of a vector store file.
 
- 
                                        
content
FileContentPage content(String fileId, FileContentParams params, RequestOptions requestOptions)
 
- 
                                        
content
FileContentPage content(FileContentParams params)
 
- 
                                        
content
abstract FileContentPage content(FileContentParams params, RequestOptions requestOptions)
 
 - 
                                        
 
 - 
                                
                            
                                
 
 - 
                    
                    
                    
 
 -