langchain_community.document_loaders.obsidian.ObsidianLoader

class langchain_community.document_loaders.obsidian.ObsidianLoader(path: Union[str, Path], encoding: str = 'UTF-8', collect_metadata: bool = True)[source]

从目录中加载 Obsidian 文件。

使用路径进行初始化。

参数
  • path (Union[str, Path]) – 包含 Obsidian 文件的目录路径。

  • encoding (str) – 字符集编码,默认为 “UTF-8”

  • collect_metadata (bool) – 是否从封面前端收集元数据。默认为 True。

属性

DATAVIEW_INLINE_BRACKET_REGEX

DATAVIEW_INLINE_PAREN_REGEX

DATAVIEW_LINE_REGEX

FRONT_MATTER_REGEX

TAG_REGEX

TEMPLATE_VARIABLE_REGEX

方法

__init__(path[, encoding, collect_metadata])

使用路径进行初始化。

alazy_load()

Documents 的懒加载器。

aload()

将数据加载到 Document 对象中。

lazy_load()

Documents 的懒加载器。

load()

将数据加载到 Document 对象中。

load_and_split([text_splitter])

加载 Documents 并分割成多个块。

__init__(path: Union[str, Path], encoding: str = 'UTF-8', collect_metadata: bool = True)[源代码]

使用路径进行初始化。

参数
  • path (Union[str, Path]) – 包含 Obsidian 文件的目录路径。

  • encoding (str) – 字符集编码,默认为 “UTF-8”

  • collect_metadata (bool) – 是否从封面前端收集元数据。默认为 True。

async alazy_load() AsyncIterator[Document]

Documents 的懒加载器。

返回类型

AsyncIterator[Document]

async aload() List[Document]

将数据加载到 Document 对象中。

返回类型

List[Document]

lazy_load() Iterator[Document][source]

Documents 的懒加载器。

返回类型

Iterator[Document]

load List[Document]

将数据加载到 Document 对象中。

返回类型

List[Document]

load_and_split(text_splitter: Optional[TextSplitter] = None) List[Document]

加载文档并将它们分割为块。块作为文档返回。

不要重写此方法。应考虑将其弃用!

参数

text_splitter (可选 [ TextSplitter ]) – 用于分割文档的 TextSplitter 实例。默认为 RecursiveCharacterTextSplitter。

返回

文档列表。

返回类型

文档列表[Document]

使用ObsidianLoader的示例