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'))[source]#

从Trello看板加载卡片。

初始化 Trello 加载器。

Parameters:

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`()	将数据加载到Document对象中。
`from_credentials`(board_name, *[, api_key, token])	方便的构造函数，为您构建TrelloClient的初始化参数。
`lazy_load`()	从指定的Trello看板加载所有卡片。
`load`()	将数据加载到Document对象中。
`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 加载器。

Parameters:

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]#

文档的懒加载器。

Return type:: AsyncIterator[Document]

async aload() → list[Document]#

将数据加载到Document对象中。

Return type:: 列表[Document]

classmethod from_credentials(board_name: str, *, api_key: str | None = None, token: str | None = None, **kwargs: Any) → TrelloLoader[来源]#

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

Parameters:

board_name (str) – Trello 看板的名称。
api_key (str | None) – Trello API 密钥。也可以指定为环境变量 TRELLO_API_KEY。
token (str | None) – Trello 令牌。也可以指定为环境变量 TRELLO_TOKEN。
include_card_name – 是否在文档中包含卡片的名称。
include_comments – 是否在文档中包含卡片上的评论。
include_checklist – 是否在文档中的卡片上包含检查清单。
card_filter – 根据卡片状态进行过滤。有效值为“closed”（已关闭）、“open”（打开）、“all”（全部）。
extra_metadata – 包含作为文档元数据的附加元数据字段列表。有效值为“due_date”、“labels”、“list”、“closed”。
kwargs (Any)

Return type:

TrelloLoader

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

从指定的Trello看板加载所有卡片。

You can filter the cards, metadata and text included by using the optional

参数。

Returns:: 文档列表，每个卡片在板上都有一个。

Return type:: 迭代器[文档]

load() → list[Document]#

将数据加载到Document对象中。

Return type:: 列表[Document]

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

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

不要重写此方法。它应该被视为已弃用！

Parameters:: text_splitter (可选[TextSplitter]) – 用于分割文档的TextSplitter实例。默认为RecursiveCharacterTextSplitter。
Returns:: 文档列表。
Return type:: 列表[Document]

使用 TrelloLoader 的示例

Trello