Struct FileUploadRequest

pub struct FileUploadRequest { /* private fields */ }

Upload local file to OpenAI storage(usually for the purpose of fine-tuning). More details at https://platform.openai.com/docs/api-reference/files/upload

Usage example

 use openai_req::files::FileUploadRequest;
 use openai_req::FormRequest;

 let file = FileUploadRequest::with_str("tests/fine-tune.json","fine-tune");
 let response = file.run(&client).await?;

Implementations

impl FileUploadRequest

pub fn new(file: PathBuf, purpose: String) -> Result<FileUploadRequest, Error>

basic constructor, takes path to file and file purpose

pub fn with_str(file: &str, purpose: &str) -> Result<FileUploadRequest, Error>

same arguments as in ::new, but as str refs for convenience

Trait Implementations

impl Clone for FileUploadRequest

fn clone(&self) -> FileUploadRequest

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for FileUploadRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FileUploadRequest

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl FormRequest<FileInfo> for FileUploadRequest

const ENDPOINT: &'static str = "/files"

fn get_response<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, client: &'life1 Client, final_url: String, key: &'life2 str, ) -> Pin<Box<dyn Future<Output = Result<Response>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

fn run<'life0, 'life1, 'async_trait>( &'life0 self, client: &'life1 OpenAiClient, ) -> Pin<Box<dyn Future<Output = Result<TRes>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

impl Serialize for FileUploadRequest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.