Docs /Templates/ sinapsis_langchain_readers

CSVLoaderExecuteNTimes

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

CSVLoader — inherited documentation

Load a `CSV` file into a list of Documents.

Each document represents one row of the CSV file. Every row is converted into a key/value pair and outputted to a new line in the document's page_content.

The source for each document loaded from csv is set to the value of the `file_path` argument for all documents by default. You can override this by setting the `source_column` argument to the name of a column in the CSV file. The source of each document will then be set to the value of the column with the name specified in `source_column`.

Output Example: .. code-block:: txt

column1: value1 column2: value2 column3: value3

Instantiate: .. code-block:: python

from langchain_community.document_loaders import CSVLoader

loader = CSVLoader(file_path='./hw_200.csv', csv_args={ 'delimiter': ',', 'quotechar': '"', 'fieldnames': ['Index', 'Height', 'Weight'] })

Load: .. code-block:: python

docs = loader.load() print(docs[0].page_content[:100]) print(docs[0].metadata)

.. code-block:: python

Index: Index Height: Height(Inches)" Weight: "Weight(Pounds)" {'source': './hw_200.csv', 'row': 0}

Async load: .. code-block:: python

docs = await loader.aload() print(docs[0].page_content[:100]) print(docs[0].metadata)

.. code-block:: python

Index: Index Height: Height(Inches)" Weight: "Weight(Pounds)" {'source': './hw_200.csv', 'row': 0}

Lazy load: .. code-block:: python

docs = [] docs_lazy = loader.lazy_load()

# async variant: # docs_lazy = await loader.alazy_load()

for doc in docs_lazy: docs.append(doc) print(docs[0].page_content[:100]) print(docs[0].metadata)

.. code-block:: python

Index: Index Height: Height(Inches)" Weight: "Weight(Pounds)" {'source': './hw_200.csv', 'row': 0}

Args: file_path: The path to the CSV file. source_column: The name of the column in the CSV file to use as the source. Optional. Defaults to None. metadata_columns: A sequence of column names to use as metadata. Optional. csv_args: A dictionary of arguments to pass to the csv.DictReader. Optional. Defaults to None. encoding: The encoding of the CSV file. Optional. Defaults to None. autodetect_encoding: Whether to try to autodetect the file encoding. content_columns: A sequence of column names to use for the document content. If not present, use all columns that are not part of the metadata.

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
csvloader_initRequired
__init__Attributes
Required
Default: null
csv_args
typing.Optional[typing.Dict]
Optional
Default: null
encoding
typing.Optional[str]
Optional
Default: null
file_path
typing.Union[str, pathlib._local.Path]
Optional
Default: null
source_column
typing.Optional[str]
Optional
Default: null
content_columns
typing.Sequence[str]
Optional
Default: []
metadata_columns
typing.Sequence[str]
Optional
Default: []
autodetect_encoding
bool
Optional
Default: false
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: "CSVLoaderExecuteNTimes"
    class_name: "CSVLoaderExecuteNTimes"
    attributes:
      csvloader_init:
        csv_args: null
        encoding: null
        file_path: null
        source_column: null
        content_columns: []
        metadata_columns: []
        autodetect_encoding: false
      n_times_execute: 1
      add_document_as_text_packet: false
View original docstring example

The source example references WikipediaLoaderWrapper, not CSVLoaderExecuteNTimes.

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