Docs /Templates/ sinapsis_langchain_readers

JoplinLoaderWrapper

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

JoplinLoader — inherited documentation

Load notes from `Joplin`.

In order to use this loader, you need to have Joplin running with the Web Clipper enabled (look for "Web Clipper" in the app settings).

To get the access token, you need to go to the Web Clipper options and under "Advanced Options" you will find the access token.

You can find more information about the Web Clipper service here: https://joplinapp.org/clipper/

Args: access_token: The access token to use. port: The port where the Web Clipper service is running. Default is 41184. host: The host where the Web Clipper service is running. Default is localhost.

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
joplinloader_initRequired
__init__Attributes
Required
Default: null
host
str
Optional
Default: "localhost"
port
int
Optional
Default: 41184
access_token
typing.Optional[str]
Optional
Default: null
add_document_as_text_packet

Whether to add document as text packet or not. joplinloader_init access_token typing.Optional[str]: default: None port <class 'int'>: default: 41184 host <class 'str'>: default: localhost

bool
Optional
Default: false

Configuration example

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

yaml
templates:
  - template_name: "JoplinLoaderWrapper"
    class_name: "JoplinLoaderWrapper"
    attributes:
      joplinloader_init:
        host: "localhost"
        port: 41184
        access_token: null
      add_document_as_text_packet: false
View original docstring example

The source example references WikipediaLoaderWrapper, not JoplinLoaderWrapper.

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