Reader
Parameter reference for the Reader base class shared by all Agno readers.
Reader is the base class for all reader classes in Agno.
| Parameter | Type | Default | Description |
|---|---|---|---|
chunk | bool | True | Whether to chunk the documents |
chunk_size | int | 5000 | Size of each chunk when chunking is enabled |
separators | Optional[List[str]] | None | Stored on the reader but not forwarded to its chunking strategy; configure the strategy directly to change splitting. Defaults to ["\n", "\n\n", "\r", "\r\n", "\n\r", "\t", " ", " "] when not set |
chunking_strategy | Optional[ChunkingStrategy] | None | Strategy used to chunk documents. When unset, FixedSizeChunking(chunk_size=chunk_size) is applied at chunking time |
name | Optional[str] | None | Name of the reader |
description | Optional[str] | None | Description of the reader |
max_results | int | 5 | Maximum number of results to return (used by search-based readers) |
encoding | Optional[str] | None | Text encoding used when reading files |
Runtime format discovery
Importing a reader class does not prove that every format it supports can be read in the current environment. These class methods expose its declared dependencies:
| Method | Returns | Purpose |
|---|---|---|
get_supported_content_types() | List[ContentType] | Formats the reader implements. |
get_supported_chunking_strategies() | List[ChunkingStrategyType] | Chunking strategies advertised by the reader. |
get_read_time_requirements() | Dict[ContentType, List[str]] | Packages imported at read time, grouped by format. |
get_missing_read_time_packages(content_type=None) | List[str] | Declared packages that cannot be located; accepts ContentType or its string value. Without a format, checks all declared formats. |
get_available_content_types() | List[ContentType] | Supported formats with no missing declared read-time packages. |
These checks locate packages without importing them. They do not test credentials, services, or file validity. Subclasses implement format-specific reading and must honor chunk themselves; ingestion does not chunk their output automatically.