Docs /Templates/ sinapsis_langchain_readers

GitbookLoaderExecuteNTimes

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

GitbookLoader — inherited documentation

Load `GitBook` data.

1. load from either a single page, or 2. load all (relative) paths in the navbar.Initialize with web page and whether to load all paths.

Args: web_page: The web page to load or the starting point from where relative paths are discovered. load_all_paths: If set to True, all relative paths in the navbar are loaded instead of only `web_page`. base_url: If `load_all_paths` is True, the relative paths are appended to this base url. Defaults to `web_page`. content_selector: The CSS selector for the content to load. Defaults to "main". continue_on_failure: whether to continue loading the sitemap if an error occurs loading a url, emitting a warning instead of raising an exception. Setting this to True makes the loader more robust, but also may result in missing data. Default: False show_progress: whether to show a progress bar while loading. Default: True sitemap_url: Custom sitemap URL to use when load_all_paths is True. Defaults to "{base_url}/sitemap.xml".

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
n_times_execute
int
Optional
Default: 1
gitbookloader_initRequired
__init__Attributes
Required
Default: null
base_url
typing.Optional[str]
Optional
Default: null
web_page
str
Optional
Default: null
sitemap_url
typing.Optional[str]
Optional
Default: null
show_progress
bool
Optional
Default: true
load_all_paths
bool
Optional
Default: false
content_selector
str
Optional
Default: "main"
continue_on_failure
bool
Optional
Default: false
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: "GitbookLoaderExecuteNTimes"
    class_name: "GitbookLoaderExecuteNTimes"
    attributes:
      n_times_execute: 1
      gitbookloader_init:
        base_url: null
        web_page: null
        sitemap_url: null
        show_progress: true
        load_all_paths: false
        content_selector: "main"
        continue_on_failure: false
      add_document_as_text_packet: false
View original docstring example

The source example references WikipediaLoaderWrapper, not GitbookLoaderExecuteNTimes.

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