langchain_community.document_loaders.trello.TrelloLoader

class langchain_community.document_loaders.trello.TrelloLoader(client: TrelloClient, board_name: str, *, include_card_name: bool = True, include_comments: bool = True, include_checklist: bool = True, card_filter: Literal['closed', 'open', 'all'] = 'all', extra_metadata: Tuple[str, ...] = ('due_date', 'labels', 'list', 'closed'))[源代码]

从Trello版面加载卡片。

初始化Trello加载器。

参数

  • client (TrelloClient) – Trello API客户端。

  • board_name (str) – Trello版面的名称。

  • include_card_name (bool) – 是否在文档中包含卡片的名称。

  • include_comments (bool) – 是否在文档中包含卡片的评论。

  • include_checklist (bool) – 是否在文档中包含卡片的清单。

  • card_filter (Literal['closed', 'open', 'all']) – 卡片状态的过滤。有效值是“closed”、“open”、“all”。

  • extra_metadata (Tuple[str, ...]) – 要作为文档元数据包含的附加元数据字段列表。有效值是“due_date”、“labels”、“list”、“closed”。

方法

__init__(client, board_name, *[, ...])

初始化Trello加载器。

alazy_load()

文档的懒加载器。

aload()

将数据加载到文档对象中。

from_credentials(board_name, *[, api_key, token])

方便的构造函数，为您构建TrelloClient初始化参数。

lazy_load()

加载指定Trello版面上的所有卡片。

load()

将数据加载到文档对象中。

load_and_split([text_splitter])

加载数据文档并将其分割成块。
__init__(client: TrelloClient, board_name: str, *, include_card_name: bool = True, include_comments: bool = True, include_checklist: bool = True, card_filter: Literal['closed', 'open', 'all'] = 'all', extra_metadata: Tuple[str, ...] = ('due_date', 'labels', 'list', 'closed'))[源代码]

初始化Trello加载器。

参数

  • client (TrelloClient) – Trello API客户端。

  • board_name (str) – Trello版面的名称。

  • include_card_name (bool) – 是否在文档中包含卡片的名称。

  • include_comments (bool) – 是否在文档中包含卡片的评论。

  • include_checklist (bool) – 是否在文档中包含卡片的清单。

  • card_filter (Literal['closed', 'open', 'all']) – 卡片状态的过滤。有效值是“closed”、“open”、“all”。

  • extra_metadata (Tuple[str, ...]) – 要作为文档元数据包含的附加元数据字段列表。有效值是“due_date”、“labels”、“list”、“closed”。

async alazy_load() → AsyncIterator[Document]

文档的懒加载器。

返回类型

AsyncIteratorDocument

async aload() → List[Document]

将数据加载到文档对象中。

返回类型

ListDocument

classmethod from_credentials(board_name: str, *, api_key: Optional[str] = None, token: Optional[str] = None, **kwargs: Any) → TrelloLoader[源代码]

方便的构造函数，为您构建TrelloClient初始化参数。

参数

  • board_name (str) – Trello版面的名称。

  • api_key (可选[字符串]) – Trello API密钥。也可以指定为环境变量TRELLO_API_KEY。

  • token (可选[字符串]) – Trello令牌。也可以指定为环境变量TRELLO_TOKEN。

  • include_card_name – 是否包含文档中的卡片名称。

  • include_comments – 是否包含文档中的卡片评论。

  • include_checklist – 是否包含文档中的卡片清单。

  • card_filter – 卡片状态的筛选。有效值是 "已关闭"，"打开"，"全部"。

  • extra_metadata – 包含文档元数据的附加元数据字段列表。有效值是 "due_date"，"labels"，"list"，"closed"。

  • kwargs (任何) –

返回类型

TrelloLoader

lazy_load() → Iterator[Document][源代码]

加载指定Trello版面上的所有卡片。

您可以使用可选参数来筛选包含的卡片、元数据和文本。

参数。

返回值

文档列表，每个文档对应板上的每个卡片。

返回类型

迭代器[Document]

load() → List[Document]

将数据加载到文档对象中。

返回类型

ListDocument

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

加载文档并将其分割成块。块以Document的形式返回。

不要重载此方法。应考虑将其视为已弃用！

参数

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

返回值

文档列表。

返回类型

Document列表[Document]

使用TrelloLoader的示例