Struct File 

#[non_exhaustive]
pub struct File {
    pub media_type: String,
    pub source: MediaSource,
    pub filename: Option<String>,
    pub provider_data: ProviderData,
}

File input: a document (PDF, plain text, …), audio, or video.

What a provider takes depends on the media type: ChatCapability::FileInput covers documents, AudioInput an audio/* file and VideoInput a video/* one.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

media_type: String

IANA media type, e.g. application/pdf.

source: MediaSource

File data or location.

filename: Option<String>

Optional file name shown to the model.

provider_data: ProviderData

Provider-specific data.

Implementations

impl File

pub fn base64( media_type: impl Into<String>, data: impl Into<Base64Data>, ) -> Self

File from inline base64 data.

pub fn bytes(media_type: impl Into<String>, data: impl AsRef<[u8]>) -> Self

File from raw bytes, sent inline; see MediaSource::bytes.

pub fn url(media_type: impl Into<String>, url: impl Into<String>) -> Self

File from a URL.

pub fn provider_file( media_type: impl Into<String>, origin: impl Into<String>, id: impl Into<String>, ) -> Self

File stored by a provider; see MediaSource::provider_file.

use allama::File;

let file = File::provider_file("application/pdf", "anthropic", "file_011CNha8iCJcU1wXNR6q4V8w");
assert_eq!(file.source.provider_file_id().map(|(origin, _)| origin), Some("anthropic"));

pub fn new(media_type: impl Into<String>, source: MediaSource) -> Self

File from any source.

pub fn kind(&self) -> FileKind

The kind of media the file holds, from its media type.

pub fn with_filename(self, filename: impl Into<String>) -> Self

Set the file name.

pub fn with_provider_data(self, provider_data: ProviderData) -> Self

Attach provider data.

Trait Implementations

impl Clone for File

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for File

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for File

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for File

impl From<File> for ContentPart

fn from(value: File) -> Self

Converts to this type from the input type.

impl Hash for File

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for File

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for File

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 File