Custom document loaders in LangChain - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is a custom document loader in Langchain?

A custom document loader is a user-defined class or function that reads and processes documents from a specific source or format, allowing Langchain to ingest data not supported by default.

beginner

Which method must you implement when creating a custom document loader in Langchain?

You must implement the load() method, which returns a list of documents after reading and processing the source data.

intermediate

Why create a custom document loader instead of using built-in loaders?

Because built-in loaders support common formats, but custom loaders let you handle unique file types, APIs, or data sources specific to your project needs.

beginner

What is the typical output of a custom document loader's load() method?

It returns a list of Document objects, each containing the text content and optional metadata for Langchain to process.

intermediate

How can you test your custom document loader to ensure it works correctly?

By running the load() method and checking if it returns the expected documents with correct content and metadata, often using simple print statements or assertions.

What does a custom document loader in Langchain primarily do?

A Deletes documents from storage

B Generates new documents automatically

C Visualizes document content

D Reads and processes documents from a specific source

Custom document loaders read and process documents from sources not covered by built-in loaders.

Which method is essential to implement in a custom document loader?

A delete()

B load()

C save()

D render()

The load() method reads and returns documents for Langchain to use.

What type of object does the load() method return?

A List of Document objects

B Single string

C Dictionary of metadata only

D Boolean value

The load() method returns a list of Document objects containing text and metadata.

Why might you need a custom document loader?

A To handle unique file types or data sources

B To speed up Langchain's built-in loaders

C To automatically summarize documents

D To encrypt documents

Custom loaders let you read data from sources not supported by default loaders.

How can you verify your custom loader works as expected?

A Run delete() and check file removal

B Run save() and check file creation

C Run load() and check returned documents

D Run render() and check UI output

Testing load() output ensures your loader reads and processes documents correctly.

Explain how to create a custom document loader in Langchain and what it should return.

Focus on the load() method and output format.

Describe why and when you would use a custom document loader instead of built-in loaders.

Think about data sources and format support.

Practice

1. What is the main purpose of creating a custom document loader in Langchain?

easy

A. To load and preprocess documents from any data source before use

B. To create user interfaces for document display

C. To train machine learning models directly

D. To manage database connections automatically

Solution

1. Step 1: Understand the role of document loaders

   Document loaders bring data into Langchain, preparing it for processing.

2. Step 2: Identify the purpose of custom loaders

   Custom loaders allow loading from any source and preprocessing like cleaning or adding metadata.

3. Final Answer:

   To load and preprocess documents from any data source before use -> Option A

4. Quick Check:

   Custom loaders = load + preprocess documents [OK]

Hint: Custom loaders bring in and prep data from any source [OK]

Common Mistakes:

• Confusing loaders with UI components
• Thinking loaders train models
• Assuming loaders manage databases

2. Which of the following is the correct way to start defining a custom document loader class in Langchain?

easy

A. class MyLoader():\n def load(self):\n pass

B. def MyLoader():\n return BaseLoader.load()

C. class MyLoader(BaseLoader):\n def load(self):\n pass

D. class MyLoader(BaseLoader):\n def read(self):\n pass

Solution

1. Step 1: Check inheritance from BaseLoader

   Custom loaders must inherit from BaseLoader to fit Langchain's pattern.

2. Step 2: Confirm the method name is load

   The required method to implement is load(), not read().

3. Final Answer:

   class MyLoader(BaseLoader):\n def load(self):\n pass -> Option C

4. Quick Check:

   Inherit BaseLoader + define load() method [OK]

Hint: Inherit BaseLoader and implement load() method [OK]

Common Mistakes:

• Not inheriting from BaseLoader
• Using wrong method name like read()
• Defining function instead of class

3. Given this custom loader code snippet, what will print(docs) output?

from langchain.schema import Document
from langchain.document_loaders.base import BaseLoader

class SimpleLoader(BaseLoader):
    def load(self):
        return [Document(page_content='Hello World', metadata={'source': 'test'})]

loader = SimpleLoader()
docs = loader.load()

medium

A. [Document(page_content='Hello World', metadata={'source': 'test'})]

B. ['Hello World']

C. None

D. SyntaxError

Solution

1. Step 1: Analyze the load method return value

   The load method returns a list with one Document object containing content and metadata.

2. Step 2: Understand what docs holds

   docs is assigned the list returned, so printing docs shows the list with the Document instance.

3. Final Answer:

   [Document(page_content='Hello World', metadata={'source': 'test'})] -> Option A

4. Quick Check:

   load() returns list of Document objects [OK]

Hint: load() returns list of Document objects, not strings [OK]

Common Mistakes:

• Expecting a list of strings instead of Document objects
• Thinking load() returns None
• Assuming syntax error due to imports

4. Identify the error in this custom loader code:

from langchain.document_loaders.base import BaseLoader

class FaultyLoader(BaseLoader):
    def load(self):
        docs = []
        docs.append('Just a string')
        return docs

loader = FaultyLoader()
loader.load()

medium

A. The load method must be named read

B. BaseLoader cannot be inherited directly

C. The class must not have a load method

D. The load method should return Document objects, not strings

Solution

1. Step 1: Check what load returns

   The load method returns a list with a string instead of Document objects.

2. Step 2: Recall Langchain expects Document objects

   Custom loaders must return Document instances, not plain strings, for proper processing.

3. Final Answer:

   The load method should return Document objects, not strings -> Option D

4. Quick Check:

   load() must return Document objects [OK]

Hint: load() must return Document objects, not plain strings [OK]

Common Mistakes:

• Returning strings instead of Document objects
• Misnaming the load method
• Thinking BaseLoader can't be inherited

5. You want to create a custom loader that reads text files from a folder, adds the filename as metadata, and returns Document objects. Which approach correctly implements this?

hard

A. Use BaseLoader directly without subclassing, call load() with folder path argument

B. Inherit BaseLoader, implement load() to read files, create Document with content and metadata filename, return list

C. Create a function that returns file contents as strings without Document wrapping

D. Subclass BaseLoader but return raw file paths as strings in load()

Solution

1. Step 1: Confirm inheritance and method implementation

   Custom loaders must subclass BaseLoader and implement load() method.

2. Step 2: Ensure load reads files and returns Document objects with metadata

   Reading files and wrapping content in Document with filename metadata is correct.

3. Final Answer:

   Inherit BaseLoader, implement load() to read files, create Document with content and metadata filename, return list -> Option B

4. Quick Check:

   Subclass + load() returns Document list with metadata [OK]

Hint: Subclass BaseLoader, load files, wrap in Document with metadata [OK]

Common Mistakes:

• Not subclassing BaseLoader
• Returning strings instead of Document objects
• Ignoring metadata addition