JoplinLoader#

class langchain_community.document_loaders.joplin.JoplinLoader(access_token: str | None = None, port: int = 41184, host: str = 'localhost')[source]#

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/

Parameters:

  • access_token (str | None) – The access token to use.

  • port (int) – The port where the Web Clipper service is running. Default is 41184.

  • host (str) – The host where the Web Clipper service is running. Default is localhost.

Methods

__init__([access_token, port, host])

alazy_load()

A lazy loader for Documents.

aload()

Load data into Document objects.

lazy_load()

A lazy loader for Documents.

load()

Load data into Document objects.

load_and_split([text_splitter])

Load Documents and split into chunks.
__init__(access_token: str | None = None, port: int = 41184, host: str = 'localhost') → None[source]#
Parameters:

  • access_token (str | None) – The access token to use.

  • port (int) – The port where the Web Clipper service is running. Default is 41184.

  • host (str) – The host where the Web Clipper service is running. Default is localhost.

Return type:

None

async alazy_load() → AsyncIterator[Document]#

A lazy loader for Documents.

Return type:

AsyncIterator[Document]

async aload() → list[Document]#

Load data into Document objects.

Return type:

list[Document]

lazy_load() → Iterator[Document][source]#

A lazy loader for Documents.

Return type:

Iterator[Document]

load() → list[Document]#

Load data into Document objects.

Return type:

list[Document]

load_and_split(text_splitter: TextSplitter | None = None) → list[Document]#

Load Documents and split into chunks. Chunks are returned as Documents.

Do not override this method. It should be considered to be deprecated!

Parameters:

text_splitter (Optional[TextSplitter]) – TextSplitter instance to use for splitting documents. Defaults to RecursiveCharacterTextSplitter.

Returns:

List of Documents.

Return type:

list[Document]

Examples using JoplinLoader