Docs /Templates/ sinapsis_langchain_readers

FileSystemBlobLoaderWrapper

sinapsis_langchain_readersLangChaindocumentsdocument_loadingdynamicfiles

Python template · sinapsis_langchain_readers.templates.langchain_data_readers

Overview

Dynamic Template to load documents from Langchain document_loaders module The template loads the document either as a Document object in the generic_data field of DataContainer of each string as a TextPacket if add_document_as_text_packet is set as True

FileSystemBlobLoader — inherited documentation

Load blobs in the local file system.

Example:

.. code-block:: python

from langchain_community.document_loaders.blob_loaders import FileSystemBlobLoader loader = FileSystemBlobLoader("/path/to/directory") for blob in loader.yield_blobs(): print(blob) # noqa: T201Initialize with a path to directory and how to glob over it.

Args: path: Path to directory to load from or path to file to load. If a path to a file is provided, glob/exclude/suffixes are ignored. glob: Glob pattern relative to the specified path by default set to pick up all non-hidden files exclude: patterns to exclude from results, use glob syntax suffixes: Provide to keep only files with these suffixes Useful when wanting to keep files with different suffixes Suffixes must include the dot, e.g. ".txt" show_progress: If true, will show a progress bar as the files are loaded. This forces an iteration through all matching files to count them prior to loading them.

Examples:

.. code-block:: python from langchain_community.document_loaders.blob_loaders import FileSystemBlobLoader

# Load a single file. loader = FileSystemBlobLoader("/path/to/file.txt")

# Recursively load all text files in a directory. loader = FileSystemBlobLoader("/path/to/directory", glob="**/*.txt")

# Recursively load all non-hidden files in a directory. loader = FileSystemBlobLoader("/path/to/directory", glob="**/[!.]*")

# Load all files in a directory without recursion. loader = FileSystemBlobLoader("/path/to/directory", glob="*")

# Recursively load all files in a directory, except for py or pyc files. loader = FileSystemBlobLoader( "/path/to/directory", glob="**/*.txt", exclude=["**/*.py", "**/*.pyc"] )

Capabilities

Capabilities: not set

Installation

Install the published package using pip or uv.

Terminalbash
pip install sinapsis_langchain_readers==1.0.0
uv pip install sinapsis_langchain_readers==1.0.0
uv add sinapsis_langchain_readers==1.0.0

Configuration

Effective fields from the inspector schema, including nested Pydantic model fields.

metadata
sinapsis_core.template_base.base_models.TemplateMetadata | None
Optional
Default: null
filesystemblobloader_initRequired
__init__Attributes
Required
Default: null
glob
str
Optional
Default: "**/[!.]*"
path
typing.Union[str, pathlib._local.Path]
Optional
Default: null
exclude
typing.Sequence[str]
Optional
Default: []
suffixes
typing.Optional[typing.Sequence[str]]
Optional
Default: null
show_progress
bool
Optional
Default: false
add_document_as_text_packet
Whether to add document as text packet or not. filesystemblobloader_init path typing.Union[str, pathlib._local.Path]: default: None glob <class 'str'>: default: **/[!.]* exclude typing.Sequence[str]: default: ()… Read full field description

Whether to add document as text packet or not. filesystemblobloader_init path typing.Union[str, pathlib._local.Path]: default: None glob <class 'str'>: default: **/[!.]* exclude typing.Sequence[str]: default: () suffixes typing.Optional[typing.Sequence[str]]: default: None show_progress <class 'bool'>: default: False

bool
Optional
Default: false

Configuration example

Generated from documented defaults. Replace any placeholders and complete required nested settings before running.

yaml
templates:
  - template_name: "FileSystemBlobLoaderWrapper"
    class_name: "FileSystemBlobLoaderWrapper"
    attributes:
      filesystemblobloader_init:
        glob: "**/[!.]*"
        path: null
        exclude: []
        suffixes: null
        show_progress: false
      add_document_as_text_packet: false
View original docstring example

The source example references WikipediaLoaderWrapper, not FileSystemBlobLoaderWrapper.

yaml
agent:
  name: my_test_agent
templates:
- template_name: InputTemplate
  class_name: InputTemplate
  attributes: {}
- template_name: WikipediaLoaderWrapper
  class_name: WikipediaLoaderWrapper    ## note that because it is a dynamic template,
  template_input: InputTemplate         ##  the class name depends on the actual class that is used.
  attributes:
    add_document_as_text_packet: false
    wikipedialoader_init:
        query: the query for wikipedia
        lang: en
        load_max_docs: 5000
        load_all_available_meta: False
        doc_content_chars_max: 4000

Inheritance

Immediate parent: sinapsis_langchain_readers.templates.langchain_data_readers.LangChainDataReaderBase

Environment variables

Environment definitions belong to their canonical Python modules.

SINAPSIS_BUILD_DOCS · defined elsewhere