Struct InputFile 

pub struct InputFile {
    pub file_id: Option<String>,
    pub filename: Option<String>,
    pub file_data: Option<String>,
}

Represents a file input part, specified by File ID or embedded data. Learn about file inputs for text generation.

Used By

• InputContentPart
• ChatCompletionRequestMessageContentPartFile (within chat_shared.rs)

Fields

file_id: Option<String>

The ID of an uploaded file to use as input.

filename: Option<String>

The name of the file, used when passing the file to the model as a string.

file_data: Option<String>

The base64 encoded file data, used when passing the file to the model as a string.

Implementations

impl InputFile

pub fn former() -> InputFileFormer<InputFileFormerDefinition<(), InputFile, ReturnPreformed>>

Provides a mechanism to initiate the formation process with a default completion behavior.

Trait Implementations

impl Clone for InputFile

fn clone(&self) -> InputFile

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for InputFile

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

Formats the value using the given formatter.

impl Default for InputFile

fn default() -> InputFile

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for InputFile

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<__Context, __Formed, __End> EntityToDefinition<__Context, __Formed, __End> for InputFile

where __End: FormingEnd<InputFileFormerDefinitionTypes<__Context, __Formed>>,

type Definition = InputFileFormerDefinition<__Context, __Formed, __End>

The specific FormerDefinition associated with this entity.

type Types = InputFileFormerDefinitionTypes<__Context, __Formed>

The specific FormerDefinitionTypes associated with this entity.

impl<__Context, __Formed> EntityToDefinitionTypes<__Context, __Formed> for InputFile

type Types = InputFileFormerDefinitionTypes<__Context, __Formed>

Specifies the FormerDefinitionTypes that define the storage, formed entity, and context types used during formation.

impl<Definition> EntityToFormer<Definition> for InputFile

where Definition: FormerDefinition<Storage = InputFileFormerStorage>,

type Former = InputFileFormer<Definition>

The type of the former (builder) used for constructing the entity.

fn __f(_: &Definition)

A placeholder function to reference the definition without operational logic.

impl EntityToStorage for InputFile

type Storage = InputFileFormerStorage

The storage type used for forming the entity.

impl PartialEq for InputFile

fn eq(&self, other: &InputFile) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for InputFile

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for InputFile