File

Python SDK Reference / Platform / File

from agentstack_sdk.platform import File

Bases: BaseModel

Class Attributes

Attribute	Type	Default
id	str	—
filename	str	—
content_type	str	—
file_size_bytes	int	—
created_at	AwareDatetime	—
created_by	str	—
file_type	Literal['user_upload', 'extracted_text']	—
parent_file_id	str | None	None
url	PlatformFileUrl	—

Methods

async staticmethod create

Parameters

Name	Type	Default
filename	str	—
content	BinaryIO | bytes	—
content_type	str	'application/octet-stream'
client	PlatformClient | None	None
context_id	str | None | Literal['auto']	'auto'

Returns: 'File'

async get

Parameters

Name	Type	Default
client	PlatformClient | None	None
context_id	str | None | Literal['auto']	'auto'

Returns: 'File'

async delete

Parameters

Name	Type	Default
client	PlatformClient | None	None
context_id	str | None | Literal['auto']	'auto'

Returns: None

async load_content

Parameters

Name	Type	Default
stream	bool	False
client	PlatformClient | None	None
context_id	str | None | Literal['auto']	'auto'

Returns: AsyncIterator[LoadedFile]

async load_text_content

Parameters

Name	Type	Default
stream	bool	False
client	PlatformClient | None	None
context_id	str | None | Literal['auto']	'auto'

Returns: AsyncIterator[LoadedFile]

async load_json_content

Parameters

Name	Type	Default
stream	bool	False
client	PlatformClient | None	None
context_id	str | None | Literal['auto']	'auto'

Returns: AsyncIterator[LoadedFile]

async create_extraction

Parameters

Name	Type	Default
formats	builtins.list[ExtractionFormatLiteral] | None	None
client	PlatformClient | None	None
context_id	str | None | Literal['auto']	'auto'

Returns: Extraction

async get_extraction

Parameters

Name	Type	Default
client	PlatformClient | None	None
context_id	str | None | Literal['auto']	'auto'

Returns: Extraction

async delete_extraction

Parameters

Name	Type	Default
client	PlatformClient | None	None
context_id	str | None | Literal['auto']	'auto'

Returns: None

to_file_part

Returns: FilePart

async staticmethod list

Parameters

Name	Type	Default
content_type	str | None	None
filename_search	str | None	None
page_token	str | None	None
limit	int | None	None
order	Literal['asc'] | Literal['desc'] | None	'asc'
order_by	Literal['created_at'] | Literal['filename'] | Literal['file_size_bytes'] | None	None
client	PlatformClient | None	None
context_id	str | None | Literal['auto']	'auto'

Returns: PaginatedResult['File']