Files

RequestedFile

A required output file declared on a request. The runtime tells the model about declared files; if produced by a tool, they surface in ChatCompletionResponse.files. If missing, an error placeholder is surfaced instead.

Field	Type
name	str
format	str | None
description	str | None

RequestedFile.__init__

__init__(
    name: str,
    format: str | None = None,
    description: str | None = None,
) -> None

InputFile

User-provided input file attached to a chat request.

Text-like files are previewed in prompt context and can be paginated by the built-in file tools when the agentic runtime is active. Binary files are stored and mounted into shell/code workdirs, but are metadata-only in prompt context.

Field	Type
id	str
name	str
mime_type	str | None
bytes	int

InputFile.__init__

__init__(name: str, data: bytes, mime_type: str | None = None) -> None

InputFile.from_text

from_text(
    name: str,
    text: str,
    mime_type: str = 'text/plain',
) -> 'InputFile'

InputFile.from_path

from_path(
    path: str,
    mime_type: str | None = None,
    name: str | None = None,
) -> 'InputFile'

FileSource

Where a file was produced.

Field	Type
tool	str
round	int
turn	int

File

First-class output from an agentic run.

Files exist independently of the transcript. The body is inline for small files (text for text content, data_base64 for binary). Large files have a server-side url and text/data_base64 will be None - use is_truncated() to detect.

Field	Type
id	str
name	str
format	str | None
mime_type	str | None
bytes	int
source	FileSource
text	str | None
data_base64	str | None
preview	str | None

File.is_text

is_text() -> bool

File.is_binary

is_binary() -> bool

File.is_image

is_image() -> bool

File.is_video

is_video() -> bool

File.is_error

is_error() -> bool

File.is_truncated

is_truncated() -> bool

File.save

save(path: str) -> None

---

Generated from mistralrs-pyo3/mistralrs.pyi.