Docs /Templates/ sinapsis_langchain_readers

BlobExecuteNTimes

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

Blob — inherited documentation

Blob represents raw data by either reference or value.

Provides an interface to materialize the blob in different representations, and help to decouple the development of data loaders from the downstream parsing of the raw data.

Inspired by: https://developer.mozilla.org/en-US/docs/Web/API/Blob

Example: Initialize a blob from in-memory data

.. code-block:: python

from langchain_core.documents import Blob

blob = Blob.from_data("Hello, world!")

# Read the blob as a string print(blob.as_string())

# Read the blob as bytes print(blob.as_bytes())

# Read the blob as a byte stream with blob.as_bytes_io() as f: print(f.read())

Example: Load from memory and specify mime-type and metadata

.. code-block:: python

from langchain_core.documents import Blob

blob = Blob.from_data( data="Hello, world!", mime_type="text/plain", metadata={"source": "https://example.com"}, )

Example: Load the blob from a file

.. code-block:: python

from langchain_core.documents import Blob

blob = Blob.from_path("path/to/file.txt")

# Read the blob as a string print(blob.as_string())

# Read the blob as bytes print(blob.as_bytes())

# Read the blob as a byte stream with blob.as_bytes_io() as f: print(f.read())

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
blob_initRequired
BaseModel
Required
Default: null
n_times_execute
int
Optional
Default: 1
add_document_as_text_packet
bool
Optional
Default: false

Configuration example

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

yaml
templates:
  - template_name: "BlobExecuteNTimes"
    class_name: "BlobExecuteNTimes"
    attributes:
      blob_init: {}
      n_times_execute: 1
      add_document_as_text_packet: false
View original docstring example

The source example references WikipediaLoaderWrapper, not BlobExecuteNTimes.

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, 
n_times_execute determines the number of times the template's execute
method is called. By default, it only gets called once. Further calls
to execute are bypassed.

Inheritance

Immediate parent: sinapsis_langchain_readers.templates.langchain_data_readers.ExecuteNTimesLangchainDataReaders

Environment variables

Environment definitions belong to their canonical Python modules.

SINAPSIS_BUILD_DOCS · defined elsewhere