pub struct FilesApi { /* private fields */ }Expand description
Files API for uploading and managing files.
Implementations§
Source§impl FilesApi
impl FilesApi
Sourcepub async fn list(&self) -> Result<FileListResponse>
pub async fn list(&self) -> Result<FileListResponse>
List all uploaded files.
§Example
use xai_rust::XaiClient;
let client = XaiClient::from_env()?;
let files = client.files().list().await?;
for file in files.data {
println!("{}: {}", file.id, file.filename);
}Sourcepub async fn get(&self, file_id: &str) -> Result<FileObject>
pub async fn get(&self, file_id: &str) -> Result<FileObject>
Get a file by ID.
Sourcepub async fn delete(&self, file_id: &str) -> Result<DeleteFileResponse>
pub async fn delete(&self, file_id: &str) -> Result<DeleteFileResponse>
Delete a file.
Sourcepub fn upload(
&self,
filename: impl Into<String>,
data: Vec<u8>,
) -> UploadFileBuilder
pub fn upload( &self, filename: impl Into<String>, data: Vec<u8>, ) -> UploadFileBuilder
Upload a file.
§Example
use xai_rust::{XaiClient, FilePurpose};
let client = XaiClient::from_env()?;
let data = std::fs::read("document.pdf")?;
let file = client.files()
.upload("document.pdf", data)
.purpose(FilePurpose::Assistants)
.send()
.await?;
println!("Uploaded: {}", file.id);Sourcepub async fn download(&self, request: FileDownloadRequest) -> Result<Vec<u8>>
pub async fn download(&self, request: FileDownloadRequest) -> Result<Vec<u8>>
Download file contents by explicit file download endpoint.
Sourcepub async fn initialize_upload(
&self,
request: FileUploadInitializeRequest,
) -> Result<FileUploadInitializeResponse>
pub async fn initialize_upload( &self, request: FileUploadInitializeRequest, ) -> Result<FileUploadInitializeResponse>
Initialize a multi-part upload session.
Sourcepub async fn upload_chunks(
&self,
request: FileUploadChunksRequest,
) -> Result<FileUploadChunksResponse>
pub async fn upload_chunks( &self, request: FileUploadChunksRequest, ) -> Result<FileUploadChunksResponse>
Upload an individual file chunk.
Trait Implementations§
Auto Trait Implementations§
impl Freeze for FilesApi
impl !RefUnwindSafe for FilesApi
impl Send for FilesApi
impl Sync for FilesApi
impl Unpin for FilesApi
impl UnsafeUnpin for FilesApi
impl !UnwindSafe for FilesApi
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more